blob: 79d4bc2c316c198f3a4bd931507c8cf30918e1bf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400108 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400109 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400110 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500115 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117
Trond Myklebust2446ab62012-03-01 17:00:56 -0500118 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400120 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500121 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400126 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
Trond Myklebustf1345852005-09-23 11:08:25 -0400128 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400129 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400130 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400134 if (dir == NULL) {
135 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400136 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400137 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400139 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400141 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400142 if (!IS_ERR(dentry))
143 break;
Al Viroa95e6912013-07-14 16:43:54 +0400144 if (dentry == ERR_PTR(-EEXIST))
145 continue;
146 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
147 " %s/%s, error %ld\n",
148 dir_name, name, PTR_ERR(dentry));
149 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400150 }
151 dput(dir);
152 return dentry;
153}
154
155static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400156rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400157{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400158 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400159
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400160 if (clnt->cl_program->pipe_dir_name == NULL)
161 goto out;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400162 clnt->cl_dentry = NULL;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400164 if (IS_ERR(dentry))
165 return PTR_ERR(dentry);
166 clnt->cl_dentry = dentry;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167out:
Trond Myklebust23ac6582009-08-09 15:14:25 -0400168 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
170
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400171static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400172{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400173 if (clnt->cl_program->pipe_dir_name == NULL)
174 return 1;
175
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400176 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
177 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
178 return 1;
Stanislav Kinsbursky4f6bb242013-06-24 11:52:59 +0400179 if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
180 return 1;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400181 return 0;
182}
183
184static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
185 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400186{
187 struct dentry *dentry;
188 int err = 0;
189
190 switch (event) {
191 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400192 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400193 if (!dentry)
194 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 if (IS_ERR(dentry))
196 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400197 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400198 if (clnt->cl_auth->au_ops->pipes_create) {
199 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
200 if (err)
201 __rpc_clnt_remove_pipedir(clnt);
202 }
203 break;
204 case RPC_PIPEFS_UMOUNT:
205 __rpc_clnt_remove_pipedir(clnt);
206 break;
207 default:
208 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
209 return -ENOTSUPP;
210 }
211 return err;
212}
213
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400214static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
215 struct super_block *sb)
216{
217 int error = 0;
218
219 for (;; clnt = clnt->cl_parent) {
220 if (!rpc_clnt_skip_event(clnt, event))
221 error = __rpc_clnt_handle_event(clnt, event, sb);
222 if (error || clnt == clnt->cl_parent)
223 break;
224 }
225 return error;
226}
227
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400228static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
229{
230 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
231 struct rpc_clnt *clnt;
232
233 spin_lock(&sn->rpc_client_lock);
234 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400235 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400236 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400237 spin_unlock(&sn->rpc_client_lock);
238 return clnt;
239 }
240 spin_unlock(&sn->rpc_client_lock);
241 return NULL;
242}
243
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
245 void *ptr)
246{
247 struct super_block *sb = ptr;
248 struct rpc_clnt *clnt;
249 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400250
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400251 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400252 error = __rpc_pipefs_event(clnt, event, sb);
253 if (error)
254 break;
255 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400256 return error;
257}
258
259static struct notifier_block rpc_clients_block = {
260 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400261 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400262};
263
264int rpc_clients_notifier_register(void)
265{
266 return rpc_pipefs_notifier_register(&rpc_clients_block);
267}
268
269void rpc_clients_notifier_unregister(void)
270{
271 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
272}
273
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400274static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
275{
276 clnt->cl_nodelen = strlen(nodename);
277 if (clnt->cl_nodelen > UNX_MAXNODENAME)
278 clnt->cl_nodelen = UNX_MAXNODENAME;
279 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
280}
281
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400282static int rpc_client_register(const struct rpc_create_args *args,
283 struct rpc_clnt *clnt)
284{
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400285 struct rpc_auth *auth;
286 struct net *net = rpc_net_ns(clnt);
287 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400288 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400289
290 pipefs_sb = rpc_get_sb_net(net);
291 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400292 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400293 if (err)
294 goto out;
295 }
296
Trond Myklebusteeee2452013-07-10 15:33:01 -0400297 rpc_register_client(clnt);
298 if (pipefs_sb)
299 rpc_put_sb_net(net);
300
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400301 auth = rpcauth_create(args->authflavor, clnt);
302 if (IS_ERR(auth)) {
303 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
304 args->authflavor);
305 err = PTR_ERR(auth);
306 goto err_auth;
307 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400308 return 0;
309err_auth:
310 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400311 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400312 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400313out:
314 if (pipefs_sb)
315 rpc_put_sb_net(net);
316 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400317}
318
Trond Myklebust698b6d02007-12-20 16:03:53 -0500319static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500321 const struct rpc_program *program = args->program;
322 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 struct rpc_clnt *clnt = NULL;
324 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400325
326 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500327 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500328 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Trond Myklebust4ada5392007-06-14 17:26:17 -0400330 err = rpciod_up();
331 if (err)
332 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500333
Trond Myklebustf05c1242013-04-05 14:13:21 -0400334 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500335 if (args->version >= program->nrvers)
336 goto out_err;
337 version = program->version[args->version];
338 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 goto out_err;
340
341 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700342 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 if (!clnt)
344 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 clnt->cl_parent = clnt;
346
Trond Myklebust2446ab62012-03-01 17:00:56 -0500347 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 clnt->cl_procinfo = version->procs;
349 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300350 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500353 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500354 err = -ENOMEM;
355 if (clnt->cl_metrics == NULL)
356 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500357 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400358 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400359 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Trond Myklebust2446ab62012-03-01 17:00:56 -0500361 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 clnt->cl_autobind = 1;
363
Trond Myklebustba7392b2007-12-20 16:03:55 -0500364 clnt->cl_timeout = xprt->timeout;
365 if (args->timeout != NULL) {
366 memcpy(&clnt->cl_timeout_default, args->timeout,
367 sizeof(clnt->cl_timeout_default));
368 clnt->cl_timeout = &clnt->cl_timeout_default;
369 }
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500372 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500373 clnt->cl_principal = NULL;
374 if (args->client_name) {
375 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
376 if (!clnt->cl_principal)
377 goto out_no_principal;
378 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
Trond Myklebust006abe82010-09-12 19:55:25 -0400380 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400383 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400384
385 err = rpc_client_register(args, clnt);
386 if (err)
387 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 return clnt;
389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500391 kfree(clnt->cl_principal);
392out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500393 rpc_free_iostats(clnt->cl_metrics);
394out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 kfree(clnt);
396out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400397 rpciod_down();
398out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400399 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 return ERR_PTR(err);
401}
402
Ben Hutchings2c530402012-07-10 10:55:09 +0000403/**
Chuck Leverc2866762006-08-22 20:06:20 -0400404 * rpc_create - create an RPC client and transport with one call
405 * @args: rpc_clnt create argument structure
406 *
407 * Creates and initializes an RPC transport and an RPC client.
408 *
409 * It can ping the server in order to determine if it is up, and to see if
410 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
411 * this behavior so asynchronous tasks can also use rpc_create.
412 */
413struct rpc_clnt *rpc_create(struct rpc_create_args *args)
414{
415 struct rpc_xprt *xprt;
416 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400417 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400418 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400419 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200420 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200421 .dstaddr = args->address,
422 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500423 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300424 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200425 };
Chuck Lever510deb02007-12-10 14:56:24 -0500426 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400427
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400428 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
429 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400430 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
431 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400432 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400433 * If the caller chooses not to specify a hostname, whip
434 * up a string representation of the passed-in address.
435 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500436 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400437 struct sockaddr_un *sun =
438 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400439 struct sockaddr_in *sin =
440 (struct sockaddr_in *)args->address;
441 struct sockaddr_in6 *sin6 =
442 (struct sockaddr_in6 *)args->address;
443
Chuck Lever510deb02007-12-10 14:56:24 -0500444 servername[0] = '\0';
445 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400446 case AF_LOCAL:
447 snprintf(servername, sizeof(servername), "%s",
448 sun->sun_path);
449 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400450 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700451 snprintf(servername, sizeof(servername), "%pI4",
452 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500453 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400454 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700455 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400456 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500457 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500458 default:
459 /* caller wants default server name, but
460 * address family isn't recognized. */
461 return ERR_PTR(-EINVAL);
462 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500463 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400464 }
465
Chuck Lever510deb02007-12-10 14:56:24 -0500466 xprt = xprt_create_transport(&xprtargs);
467 if (IS_ERR(xprt))
468 return (struct rpc_clnt *)xprt;
469
Chuck Lever43780b82007-07-01 12:13:22 -0400470 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400471 * By default, kernel RPC client connects from a reserved port.
472 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
473 * but it is always enabled for rpciod, which handles the connect
474 * operation.
475 */
476 xprt->resvport = 1;
477 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
478 xprt->resvport = 0;
479
Trond Myklebust698b6d02007-12-20 16:03:53 -0500480 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400481 if (IS_ERR(clnt))
482 return clnt;
483
484 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500485 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400486 if (err != 0) {
487 rpc_shutdown_client(clnt);
488 return ERR_PTR(err);
489 }
490 }
491
492 clnt->cl_softrtry = 1;
493 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
494 clnt->cl_softrtry = 0;
495
Chuck Leverc2866762006-08-22 20:06:20 -0400496 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
497 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500498 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
499 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400500 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
501 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400502
503 return clnt;
504}
Chuck Leverb86acd52006-08-22 20:06:22 -0400505EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507/*
508 * This function clones the RPC client structure. It allows us to share the
509 * same transport while varying parameters such as the authentication
510 * flavour.
511 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400512static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
513 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500515 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400516 struct rpc_clnt *new;
517 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Chuck Lever1b63a752012-09-14 17:23:52 -0400519 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500520 rcu_read_lock();
521 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
522 rcu_read_unlock();
523 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400524 goto out_err;
525 args->servername = xprt->servername;
526
527 new = rpc_new_client(args, xprt);
528 if (IS_ERR(new)) {
529 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400530 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400531 }
532
Trond Myklebust006abe82010-09-12 19:55:25 -0400533 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400534 new->cl_parent = clnt;
535
536 /* Turn off autobind on clones */
537 new->cl_autobind = 0;
538 new->cl_softrtry = clnt->cl_softrtry;
539 new->cl_discrtry = clnt->cl_discrtry;
540 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400542
Chuck Lever1b63a752012-09-14 17:23:52 -0400543out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800544 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500545 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
Chuck Lever1b63a752012-09-14 17:23:52 -0400547
548/**
549 * rpc_clone_client - Clone an RPC client structure
550 *
551 * @clnt: RPC client whose parameters are copied
552 *
553 * Returns a fresh RPC client or an ERR_PTR.
554 */
555struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
556{
557 struct rpc_create_args args = {
558 .program = clnt->cl_program,
559 .prognumber = clnt->cl_prog,
560 .version = clnt->cl_vers,
561 .authflavor = clnt->cl_auth->au_flavor,
562 .client_name = clnt->cl_principal,
563 };
564 return __rpc_clone_client(&args, clnt);
565}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400566EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Chuck Leverba9b5842012-09-14 17:24:02 -0400568/**
569 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
570 *
571 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800572 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400573 *
574 * Returns a fresh RPC client or an ERR_PTR.
575 */
576struct rpc_clnt *
577rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
578{
579 struct rpc_create_args args = {
580 .program = clnt->cl_program,
581 .prognumber = clnt->cl_prog,
582 .version = clnt->cl_vers,
583 .authflavor = flavor,
584 .client_name = clnt->cl_principal,
585 };
586 return __rpc_clone_client(&args, clnt);
587}
588EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400591 * Kill all tasks for the given client.
592 * XXX: kill their descendants as well?
593 */
594void rpc_killall_tasks(struct rpc_clnt *clnt)
595{
596 struct rpc_task *rovr;
597
598
599 if (list_empty(&clnt->cl_tasks))
600 return;
601 dprintk("RPC: killing all tasks for client %p\n", clnt);
602 /*
603 * Spin lock all_tasks to prevent changes...
604 */
605 spin_lock(&clnt->cl_lock);
606 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
607 if (!RPC_IS_ACTIVATED(rovr))
608 continue;
609 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
610 rovr->tk_flags |= RPC_TASK_KILLED;
611 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300612 if (RPC_IS_QUEUED(rovr))
613 rpc_wake_up_queued_task(rovr->tk_waitqueue,
614 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400615 }
616 }
617 spin_unlock(&clnt->cl_lock);
618}
619EXPORT_SYMBOL_GPL(rpc_killall_tasks);
620
621/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400623 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400625void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400627 might_sleep();
628
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500629 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400630 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500631 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Trond Myklebust34f52e32007-06-14 16:40:31 -0400633 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800635 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400636 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 }
638
Trond Myklebust4c402b42007-06-14 16:40:32 -0400639 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400641EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
643/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400644 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400646static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400647rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500649 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400650 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500651 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500652 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400653 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400654 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400655 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500656 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500657 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500658 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500659 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400660 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662}
663
664/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400665 * Free an RPC client
666 */
667static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400668rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400669{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400670 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400671 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400672 return;
673 }
674
675 /*
676 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
677 * release remaining GSS contexts. This mechanism ensures
678 * that it can do so safely.
679 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400680 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400681 rpcauth_release(clnt->cl_auth);
682 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400683 if (atomic_dec_and_test(&clnt->cl_count))
684 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400685}
686
687/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400688 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 */
690void
691rpc_release_client(struct rpc_clnt *clnt)
692{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400693 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Trond Myklebust34f52e32007-06-14 16:40:31 -0400695 if (list_empty(&clnt->cl_tasks))
696 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400697 if (atomic_dec_and_test(&clnt->cl_count))
698 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400699}
Simo Sorce1d658332012-05-25 18:09:55 -0400700EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400701
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000702/**
703 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800704 * @old: old rpc_client
705 * @program: rpc program to set
706 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000707 *
708 * Clones the rpc client and sets up a new RPC program. This is mainly
709 * of use for enabling different RPC programs to share the same transport.
710 * The Sun NFSv2/v3 ACL protocol can do this.
711 */
712struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500713 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400714 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000715{
Trond Myklebustf994c432012-11-01 12:14:14 -0400716 struct rpc_create_args args = {
717 .program = program,
718 .prognumber = program->number,
719 .version = vers,
720 .authflavor = old->cl_auth->au_flavor,
721 .client_name = old->cl_principal,
722 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000723 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000724 int err;
725
Trond Myklebustf994c432012-11-01 12:14:14 -0400726 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000727 if (IS_ERR(clnt))
728 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500729 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000730 if (err != 0) {
731 rpc_shutdown_client(clnt);
732 clnt = ERR_PTR(err);
733 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800734out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000735 return clnt;
736}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400737EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000738
Trond Myklebust58f96122010-07-31 14:29:08 -0400739void rpc_task_release_client(struct rpc_task *task)
740{
741 struct rpc_clnt *clnt = task->tk_client;
742
743 if (clnt != NULL) {
744 /* Remove from client task list */
745 spin_lock(&clnt->cl_lock);
746 list_del(&task->tk_task);
747 spin_unlock(&clnt->cl_lock);
748 task->tk_client = NULL;
749
750 rpc_release_client(clnt);
751 }
752}
753
754static
755void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
756{
757 if (clnt != NULL) {
758 rpc_task_release_client(task);
759 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400760 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400761 if (clnt->cl_softrtry)
762 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700763 if (sk_memalloc_socks()) {
764 struct rpc_xprt *xprt;
765
766 rcu_read_lock();
767 xprt = rcu_dereference(clnt->cl_xprt);
768 if (xprt->swapper)
769 task->tk_flags |= RPC_TASK_SWAPPER;
770 rcu_read_unlock();
771 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400772 /* Add to the client's list of all tasks */
773 spin_lock(&clnt->cl_lock);
774 list_add_tail(&task->tk_task, &clnt->cl_tasks);
775 spin_unlock(&clnt->cl_lock);
776 }
777}
778
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000779void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
780{
781 rpc_task_release_client(task);
782 rpc_task_set_client(task, clnt);
783}
784EXPORT_SYMBOL_GPL(rpc_task_reset_client);
785
786
Trond Myklebust58f96122010-07-31 14:29:08 -0400787static void
788rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
789{
790 if (msg != NULL) {
791 task->tk_msg.rpc_proc = msg->rpc_proc;
792 task->tk_msg.rpc_argp = msg->rpc_argp;
793 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400794 if (msg->rpc_cred != NULL)
795 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400796 }
797}
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799/*
800 * Default callback for async RPC calls
801 */
802static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100803rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804{
805}
806
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100807static const struct rpc_call_ops rpc_default_ops = {
808 .rpc_call_done = rpc_default_callback,
809};
810
Trond Myklebustc970aa82007-07-14 15:39:59 -0400811/**
812 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
813 * @task_setup_data: pointer to task initialisation data
814 */
815struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400816{
Trond Myklebust19445b92010-04-16 16:41:10 -0400817 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400818
Trond Myklebust84115e12007-07-14 15:39:59 -0400819 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400820 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400821 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400822
Trond Myklebust58f96122010-07-31 14:29:08 -0400823 rpc_task_set_client(task, task_setup_data->rpc_client);
824 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
825
Trond Myklebust58f96122010-07-31 14:29:08 -0400826 if (task->tk_action == NULL)
827 rpc_call_start(task);
828
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400829 atomic_inc(&task->tk_count);
830 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400831out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400832 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400833}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400834EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400835
836/**
837 * rpc_call_sync - Perform a synchronous RPC call
838 * @clnt: pointer to RPC client
839 * @msg: RPC call parameters
840 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500842int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843{
844 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400845 struct rpc_task_setup task_setup_data = {
846 .rpc_client = clnt,
847 .rpc_message = msg,
848 .callback_ops = &rpc_default_ops,
849 .flags = flags,
850 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400851 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400853 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
854 if (flags & RPC_TASK_ASYNC) {
855 rpc_release_calldata(task_setup_data.callback_ops,
856 task_setup_data.callback_data);
857 return -EINVAL;
858 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Trond Myklebustc970aa82007-07-14 15:39:59 -0400860 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400861 if (IS_ERR(task))
862 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100863 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800864 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 return status;
866}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400867EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400869/**
870 * rpc_call_async - Perform an asynchronous RPC call
871 * @clnt: pointer to RPC client
872 * @msg: RPC call parameters
873 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800874 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400875 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 */
877int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500878rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100879 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
881 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400882 struct rpc_task_setup task_setup_data = {
883 .rpc_client = clnt,
884 .rpc_message = msg,
885 .callback_ops = tk_ops,
886 .callback_data = data,
887 .flags = flags|RPC_TASK_ASYNC,
888 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Trond Myklebustc970aa82007-07-14 15:39:59 -0400890 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400891 if (IS_ERR(task))
892 return PTR_ERR(task);
893 rpc_put_task(task);
894 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400896EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400898#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400899/**
900 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
901 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400902 * @req: RPC request
903 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400904 */
905struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400906 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400907{
908 struct rpc_task *task;
909 struct xdr_buf *xbufp = &req->rq_snd_buf;
910 struct rpc_task_setup task_setup_data = {
911 .callback_ops = tk_ops,
912 };
913
914 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
915 /*
916 * Create an rpc_task to send the data
917 */
918 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400919 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400920 xprt_free_bc_request(req);
921 goto out;
922 }
923 task->tk_rqstp = req;
924
925 /*
926 * Set up the xdr_buf length.
927 * This also indicates that the buffer is XDR encoded already.
928 */
929 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
930 xbufp->tail[0].iov_len;
931
932 task->tk_action = call_bc_transmit;
933 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400934 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400935 rpc_execute(task);
936
937out:
938 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
939 return task;
940}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400941#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400942
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400944rpc_call_start(struct rpc_task *task)
945{
946 task->tk_action = call_start;
947}
948EXPORT_SYMBOL_GPL(rpc_call_start);
949
Chuck Levered394402006-08-22 20:06:17 -0400950/**
951 * rpc_peeraddr - extract remote peer address from clnt's xprt
952 * @clnt: RPC client structure
953 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800954 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400955 *
956 * Returns the number of bytes that are actually in the stored address.
957 */
958size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
959{
960 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500961 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400962
Trond Myklebust2446ab62012-03-01 17:00:56 -0500963 rcu_read_lock();
964 xprt = rcu_dereference(clnt->cl_xprt);
965
966 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400967 if (bytes > bufsize)
968 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500969 memcpy(buf, &xprt->addr, bytes);
970 rcu_read_unlock();
971
972 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400973}
Chuck Leverb86acd52006-08-22 20:06:22 -0400974EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400975
Chuck Leverf425eba2006-08-22 20:06:18 -0400976/**
977 * rpc_peeraddr2str - return remote peer address in printable format
978 * @clnt: RPC client structure
979 * @format: address format
980 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500981 * NB: the lifetime of the memory referenced by the returned pointer is
982 * the same as the rpc_xprt itself. As long as the caller uses this
983 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400984 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500985const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
986 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400987{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500988 struct rpc_xprt *xprt;
989
990 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500991
992 if (xprt->address_strings[format] != NULL)
993 return xprt->address_strings[format];
994 else
995 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400996}
Chuck Leverb86acd52006-08-22 20:06:22 -0400997EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400998
Chuck Lever2e738fd2012-03-01 17:01:14 -0500999static const struct sockaddr_in rpc_inaddr_loopback = {
1000 .sin_family = AF_INET,
1001 .sin_addr.s_addr = htonl(INADDR_ANY),
1002};
1003
1004static const struct sockaddr_in6 rpc_in6addr_loopback = {
1005 .sin6_family = AF_INET6,
1006 .sin6_addr = IN6ADDR_ANY_INIT,
1007};
1008
1009/*
1010 * Try a getsockname() on a connected datagram socket. Using a
1011 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1012 * This conserves the ephemeral port number space.
1013 *
1014 * Returns zero and fills in "buf" if successful; otherwise, a
1015 * negative errno is returned.
1016 */
1017static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1018 struct sockaddr *buf, int buflen)
1019{
1020 struct socket *sock;
1021 int err;
1022
1023 err = __sock_create(net, sap->sa_family,
1024 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1025 if (err < 0) {
1026 dprintk("RPC: can't create UDP socket (%d)\n", err);
1027 goto out;
1028 }
1029
1030 switch (sap->sa_family) {
1031 case AF_INET:
1032 err = kernel_bind(sock,
1033 (struct sockaddr *)&rpc_inaddr_loopback,
1034 sizeof(rpc_inaddr_loopback));
1035 break;
1036 case AF_INET6:
1037 err = kernel_bind(sock,
1038 (struct sockaddr *)&rpc_in6addr_loopback,
1039 sizeof(rpc_in6addr_loopback));
1040 break;
1041 default:
1042 err = -EAFNOSUPPORT;
1043 goto out;
1044 }
1045 if (err < 0) {
1046 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1047 goto out_release;
1048 }
1049
1050 err = kernel_connect(sock, sap, salen, 0);
1051 if (err < 0) {
1052 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1053 goto out_release;
1054 }
1055
1056 err = kernel_getsockname(sock, buf, &buflen);
1057 if (err < 0) {
1058 dprintk("RPC: getsockname failed (%d)\n", err);
1059 goto out_release;
1060 }
1061
1062 err = 0;
1063 if (buf->sa_family == AF_INET6) {
1064 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1065 sin6->sin6_scope_id = 0;
1066 }
1067 dprintk("RPC: %s succeeded\n", __func__);
1068
1069out_release:
1070 sock_release(sock);
1071out:
1072 return err;
1073}
1074
1075/*
1076 * Scraping a connected socket failed, so we don't have a useable
1077 * local address. Fallback: generate an address that will prevent
1078 * the server from calling us back.
1079 *
1080 * Returns zero and fills in "buf" if successful; otherwise, a
1081 * negative errno is returned.
1082 */
1083static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1084{
1085 switch (family) {
1086 case AF_INET:
1087 if (buflen < sizeof(rpc_inaddr_loopback))
1088 return -EINVAL;
1089 memcpy(buf, &rpc_inaddr_loopback,
1090 sizeof(rpc_inaddr_loopback));
1091 break;
1092 case AF_INET6:
1093 if (buflen < sizeof(rpc_in6addr_loopback))
1094 return -EINVAL;
1095 memcpy(buf, &rpc_in6addr_loopback,
1096 sizeof(rpc_in6addr_loopback));
1097 default:
1098 dprintk("RPC: %s: address family not supported\n",
1099 __func__);
1100 return -EAFNOSUPPORT;
1101 }
1102 dprintk("RPC: %s: succeeded\n", __func__);
1103 return 0;
1104}
1105
1106/**
1107 * rpc_localaddr - discover local endpoint address for an RPC client
1108 * @clnt: RPC client structure
1109 * @buf: target buffer
1110 * @buflen: size of target buffer, in bytes
1111 *
1112 * Returns zero and fills in "buf" and "buflen" if successful;
1113 * otherwise, a negative errno is returned.
1114 *
1115 * This works even if the underlying transport is not currently connected,
1116 * or if the upper layer never previously provided a source address.
1117 *
1118 * The result of this function call is transient: multiple calls in
1119 * succession may give different results, depending on how local
1120 * networking configuration changes over time.
1121 */
1122int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1123{
1124 struct sockaddr_storage address;
1125 struct sockaddr *sap = (struct sockaddr *)&address;
1126 struct rpc_xprt *xprt;
1127 struct net *net;
1128 size_t salen;
1129 int err;
1130
1131 rcu_read_lock();
1132 xprt = rcu_dereference(clnt->cl_xprt);
1133 salen = xprt->addrlen;
1134 memcpy(sap, &xprt->addr, salen);
1135 net = get_net(xprt->xprt_net);
1136 rcu_read_unlock();
1137
1138 rpc_set_port(sap, 0);
1139 err = rpc_sockname(net, sap, salen, buf, buflen);
1140 put_net(net);
1141 if (err != 0)
1142 /* Couldn't discover local address, return ANYADDR */
1143 return rpc_anyaddr(sap->sa_family, buf, buflen);
1144 return 0;
1145}
1146EXPORT_SYMBOL_GPL(rpc_localaddr);
1147
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148void
1149rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1150{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001151 struct rpc_xprt *xprt;
1152
1153 rcu_read_lock();
1154 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001155 if (xprt->ops->set_buffer_size)
1156 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001157 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001159EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Trond Myklebust2446ab62012-03-01 17:00:56 -05001161/**
1162 * rpc_protocol - Get transport protocol number for an RPC client
1163 * @clnt: RPC client to query
1164 *
1165 */
1166int rpc_protocol(struct rpc_clnt *clnt)
1167{
1168 int protocol;
1169
1170 rcu_read_lock();
1171 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1172 rcu_read_unlock();
1173 return protocol;
1174}
1175EXPORT_SYMBOL_GPL(rpc_protocol);
1176
1177/**
1178 * rpc_net_ns - Get the network namespace for this RPC client
1179 * @clnt: RPC client to query
1180 *
1181 */
1182struct net *rpc_net_ns(struct rpc_clnt *clnt)
1183{
1184 struct net *ret;
1185
1186 rcu_read_lock();
1187 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1188 rcu_read_unlock();
1189 return ret;
1190}
1191EXPORT_SYMBOL_GPL(rpc_net_ns);
1192
1193/**
1194 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1195 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 *
1197 * For stream transports, this is one RPC record fragment (see RFC
1198 * 1831), as we don't support multi-record requests yet. For datagram
1199 * transports, this is the size of an IP packet minus the IP, UDP, and
1200 * RPC header sizes.
1201 */
1202size_t rpc_max_payload(struct rpc_clnt *clnt)
1203{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001204 size_t ret;
1205
1206 rcu_read_lock();
1207 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1208 rcu_read_unlock();
1209 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210}
Chuck Leverb86acd52006-08-22 20:06:22 -04001211EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Chuck Lever35f5a422006-01-03 09:55:50 +01001213/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001214 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001215 * @clnt: RPC client to query
1216 */
1217unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1218{
1219 unsigned long ret;
1220
1221 rcu_read_lock();
1222 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1223 rcu_read_unlock();
1224 return ret;
1225}
1226EXPORT_SYMBOL_GPL(rpc_get_timeout);
1227
1228/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001229 * rpc_force_rebind - force transport to check that remote port is unchanged
1230 * @clnt: client to rebind
1231 *
1232 */
1233void rpc_force_rebind(struct rpc_clnt *clnt)
1234{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001235 if (clnt->cl_autobind) {
1236 rcu_read_lock();
1237 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1238 rcu_read_unlock();
1239 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001240}
Chuck Leverb86acd52006-08-22 20:06:22 -04001241EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001242
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001244 * Restart an (async) RPC call from the call_prepare state.
1245 * Usually called from within the exit handler.
1246 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001247int
Andy Adamsonaae20062009-04-01 09:22:40 -04001248rpc_restart_call_prepare(struct rpc_task *task)
1249{
1250 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001251 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001252 task->tk_action = call_start;
1253 if (task->tk_ops->rpc_call_prepare != NULL)
1254 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001255 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001256}
1257EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1258
1259/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 * Restart an (async) RPC call. Usually called from within the
1261 * exit handler.
1262 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001263int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264rpc_restart_call(struct rpc_task *task)
1265{
1266 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001267 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001269 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001271EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Chuck Lever3748f1e2008-05-21 17:09:12 -04001273#ifdef RPC_DEBUG
1274static const char *rpc_proc_name(const struct rpc_task *task)
1275{
1276 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1277
1278 if (proc) {
1279 if (proc->p_name)
1280 return proc->p_name;
1281 else
1282 return "NULL";
1283 } else
1284 return "no proc";
1285}
1286#endif
1287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288/*
1289 * 0. Initial state
1290 *
1291 * Other FSM states can be visited zero or more times, but
1292 * this state is visited exactly once for each RPC.
1293 */
1294static void
1295call_start(struct rpc_task *task)
1296{
1297 struct rpc_clnt *clnt = task->tk_client;
1298
Chuck Lever3748f1e2008-05-21 17:09:12 -04001299 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001300 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001301 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001302 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
1304 /* Increment call count */
1305 task->tk_msg.rpc_proc->p_count++;
1306 clnt->cl_stats->rpccnt++;
1307 task->tk_action = call_reserve;
1308}
1309
1310/*
1311 * 1. Reserve an RPC call slot
1312 */
1313static void
1314call_reserve(struct rpc_task *task)
1315{
Chuck Lever46121cf2007-01-31 12:14:08 -05001316 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 task->tk_status = 0;
1319 task->tk_action = call_reserveresult;
1320 xprt_reserve(task);
1321}
1322
Trond Myklebustba60eb22013-04-14 10:49:37 -04001323static void call_retry_reserve(struct rpc_task *task);
1324
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325/*
1326 * 1b. Grok the result of xprt_reserve()
1327 */
1328static void
1329call_reserveresult(struct rpc_task *task)
1330{
1331 int status = task->tk_status;
1332
Chuck Lever46121cf2007-01-31 12:14:08 -05001333 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
1335 /*
1336 * After a call to xprt_reserve(), we must have either
1337 * a request slot or else an error status.
1338 */
1339 task->tk_status = 0;
1340 if (status >= 0) {
1341 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001342 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 return;
1344 }
1345
1346 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001347 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 rpc_exit(task, -EIO);
1349 return;
1350 }
1351
1352 /*
1353 * Even though there was an error, we may have acquired
1354 * a request slot somehow. Make sure not to leak it.
1355 */
1356 if (task->tk_rqstp) {
1357 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001358 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 xprt_release(task);
1360 }
1361
1362 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001363 case -ENOMEM:
1364 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001366 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 return;
1368 case -EIO: /* probably a shutdown */
1369 break;
1370 default:
1371 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001372 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 break;
1374 }
1375 rpc_exit(task, status);
1376}
1377
1378/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001379 * 1c. Retry reserving an RPC call slot
1380 */
1381static void
1382call_retry_reserve(struct rpc_task *task)
1383{
1384 dprint_status(task);
1385
1386 task->tk_status = 0;
1387 task->tk_action = call_reserveresult;
1388 xprt_retry_reserve(task);
1389}
1390
1391/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001392 * 2. Bind and/or refresh the credentials
1393 */
1394static void
1395call_refresh(struct rpc_task *task)
1396{
1397 dprint_status(task);
1398
1399 task->tk_action = call_refreshresult;
1400 task->tk_status = 0;
1401 task->tk_client->cl_stats->rpcauthrefresh++;
1402 rpcauth_refreshcred(task);
1403}
1404
1405/*
1406 * 2a. Process the results of a credential refresh
1407 */
1408static void
1409call_refreshresult(struct rpc_task *task)
1410{
1411 int status = task->tk_status;
1412
1413 dprint_status(task);
1414
1415 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001416 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001417 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001418 case 0:
1419 if (rpcauth_uptodatecred(task))
1420 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001421 return;
1422 case -ETIMEDOUT:
1423 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001424 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001425 case -EAGAIN:
1426 status = -EACCES;
1427 if (!task->tk_cred_retry)
1428 break;
1429 task->tk_cred_retry--;
1430 dprintk("RPC: %5u %s: retry refresh creds\n",
1431 task->tk_pid, __func__);
1432 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001433 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001434 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1435 task->tk_pid, __func__, status);
1436 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001437}
1438
1439/*
1440 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001441 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 */
1443static void
1444call_allocate(struct rpc_task *task)
1445{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001446 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001447 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001448 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001449 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Chuck Lever46121cf2007-01-31 12:14:08 -05001451 dprint_status(task);
1452
Chuck Lever2bea90d2007-03-29 16:47:53 -04001453 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001454 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001455
Chuck Lever02107142006-01-03 09:55:49 +01001456 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 return;
1458
Chuck Lever2bea90d2007-03-29 16:47:53 -04001459 if (proc->p_proc != 0) {
1460 BUG_ON(proc->p_arglen == 0);
1461 if (proc->p_decode != NULL)
1462 BUG_ON(proc->p_replen == 0);
1463 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
Chuck Lever2bea90d2007-03-29 16:47:53 -04001465 /*
1466 * Calculate the size (in quads) of the RPC call
1467 * and reply headers, and convert both values
1468 * to byte sizes.
1469 */
1470 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1471 req->rq_callsize <<= 2;
1472 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1473 req->rq_rcvsize <<= 2;
1474
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001475 req->rq_buffer = xprt->ops->buf_alloc(task,
1476 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001477 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001479
1480 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481
Trond Myklebust5afa9132011-06-17 10:14:59 -04001482 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001483 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 rpc_delay(task, HZ>>4);
1485 return;
1486 }
1487
1488 rpc_exit(task, -ERESTARTSYS);
1489}
1490
Trond Myklebust940e3312005-11-09 21:45:24 -05001491static inline int
1492rpc_task_need_encode(struct rpc_task *task)
1493{
1494 return task->tk_rqstp->rq_snd_buf.len == 0;
1495}
1496
1497static inline void
1498rpc_task_force_reencode(struct rpc_task *task)
1499{
1500 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001501 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001502}
1503
Chuck Lever2bea90d2007-03-29 16:47:53 -04001504static inline void
1505rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1506{
1507 buf->head[0].iov_base = start;
1508 buf->head[0].iov_len = len;
1509 buf->tail[0].iov_len = 0;
1510 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001511 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001512 buf->len = 0;
1513 buf->buflen = len;
1514}
1515
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516/*
1517 * 3. Encode arguments of an RPC call
1518 */
1519static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001520rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001523 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001524 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
Chuck Lever46121cf2007-01-31 12:14:08 -05001526 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Chuck Lever2bea90d2007-03-29 16:47:53 -04001528 rpc_xdr_buf_init(&req->rq_snd_buf,
1529 req->rq_buffer,
1530 req->rq_callsize);
1531 rpc_xdr_buf_init(&req->rq_rcv_buf,
1532 (char *)req->rq_buffer + req->rq_callsize,
1533 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
Chuck Leverb0e1c572008-05-21 17:09:19 -04001535 p = rpc_encode_header(task);
1536 if (p == NULL) {
1537 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 rpc_exit(task, -EIO);
1539 return;
1540 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001541
1542 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001543 if (encode == NULL)
1544 return;
1545
1546 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1547 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548}
1549
1550/*
1551 * 4. Get the server port number if not yet set
1552 */
1553static void
1554call_bind(struct rpc_task *task)
1555{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001556 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Chuck Lever46121cf2007-01-31 12:14:08 -05001558 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Chuck Leverda351872005-08-11 16:25:11 -04001560 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001561 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001562 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001563 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001564 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 }
1566}
1567
1568/*
Chuck Leverda351872005-08-11 16:25:11 -04001569 * 4a. Sort out bind result
1570 */
1571static void
1572call_bind_status(struct rpc_task *task)
1573{
Chuck Lever906462a2007-09-11 18:00:47 -04001574 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001575
1576 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001577 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001578 task->tk_status = 0;
1579 task->tk_action = call_connect;
1580 return;
1581 }
1582
Steve Dickson5753cba2012-02-06 10:08:08 -05001583 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001584 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001585 case -ENOMEM:
1586 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1587 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001588 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001589 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001590 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1591 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001592 /* fail immediately if this is an RPC ping */
1593 if (task->tk_msg.rpc_proc->p_proc == 0) {
1594 status = -EOPNOTSUPP;
1595 break;
1596 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001597 if (task->tk_rebind_retry == 0)
1598 break;
1599 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001600 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001601 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001602 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001603 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001604 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001605 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001606 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001607 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001608 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001609 task->tk_pid);
1610 break;
1611 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001612 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001613 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001614 task->tk_status = 0;
1615 task->tk_action = call_bind;
1616 return;
Chuck Lever012da152009-12-03 15:58:56 -05001617 case -ECONNREFUSED: /* connection problems */
1618 case -ECONNRESET:
1619 case -ENOTCONN:
1620 case -EHOSTDOWN:
1621 case -EHOSTUNREACH:
1622 case -ENETUNREACH:
1623 case -EPIPE:
1624 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1625 task->tk_pid, task->tk_status);
1626 if (!RPC_IS_SOFTCONN(task)) {
1627 rpc_delay(task, 5*HZ);
1628 goto retry_timeout;
1629 }
1630 status = task->tk_status;
1631 break;
Chuck Leverda351872005-08-11 16:25:11 -04001632 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001633 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001634 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001635 }
1636
1637 rpc_exit(task, status);
1638 return;
1639
Trond Myklebustda458282006-08-31 15:44:52 -04001640retry_timeout:
1641 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001642}
1643
1644/*
1645 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 */
1647static void
1648call_connect(struct rpc_task *task)
1649{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001650 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
Chuck Lever46121cf2007-01-31 12:14:08 -05001652 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001653 task->tk_pid, xprt,
1654 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
Chuck Leverda351872005-08-11 16:25:11 -04001656 task->tk_action = call_transmit;
1657 if (!xprt_connected(xprt)) {
1658 task->tk_action = call_connect_status;
1659 if (task->tk_status < 0)
1660 return;
1661 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663}
1664
1665/*
Chuck Leverda351872005-08-11 16:25:11 -04001666 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 */
1668static void
1669call_connect_status(struct rpc_task *task)
1670{
1671 struct rpc_clnt *clnt = task->tk_client;
1672 int status = task->tk_status;
1673
Chuck Lever46121cf2007-01-31 12:14:08 -05001674 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001675
Steve Dickson5753cba2012-02-06 10:08:08 -05001676 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001678 /* if soft mounted, test if we've timed out */
1679 case -ETIMEDOUT:
1680 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001681 return;
1682 case -ECONNREFUSED:
1683 case -ECONNRESET:
1684 case -ENETUNREACH:
1685 if (RPC_IS_SOFTCONN(task))
1686 break;
1687 /* retry with existing socket, after a delay */
1688 case 0:
1689 case -EAGAIN:
1690 task->tk_status = 0;
1691 clnt->cl_stats->netreconn++;
1692 task->tk_action = call_transmit;
1693 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001695 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696}
1697
1698/*
1699 * 5. Transmit the RPC request, and wait for reply
1700 */
1701static void
1702call_transmit(struct rpc_task *task)
1703{
Chuck Lever46121cf2007-01-31 12:14:08 -05001704 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
1706 task->tk_action = call_status;
1707 if (task->tk_status < 0)
1708 return;
1709 task->tk_status = xprt_prepare_transmit(task);
1710 if (task->tk_status != 0)
1711 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001712 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001714 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001715 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001716 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001717 if (task->tk_status != 0) {
1718 /* Was the error nonfatal? */
1719 if (task->tk_status == -EAGAIN)
1720 rpc_delay(task, HZ >> 4);
1721 else
1722 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001723 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001724 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 xprt_transmit(task);
1727 if (task->tk_status < 0)
1728 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001729 /*
1730 * On success, ensure that we call xprt_end_transmit() before sleeping
1731 * in order to allow access to the socket to other RPC requests.
1732 */
1733 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001734 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001735 return;
1736 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001737 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001738}
1739
1740/*
1741 * 5a. Handle cleanup after a transmission
1742 */
1743static void
1744call_transmit_status(struct rpc_task *task)
1745{
1746 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001747
1748 /*
1749 * Common case: success. Force the compiler to put this
1750 * test first.
1751 */
1752 if (task->tk_status == 0) {
1753 xprt_end_transmit(task);
1754 rpc_task_force_reencode(task);
1755 return;
1756 }
1757
Trond Myklebust15f081c2009-03-11 14:37:57 -04001758 switch (task->tk_status) {
1759 case -EAGAIN:
1760 break;
1761 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001762 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001763 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001764 rpc_task_force_reencode(task);
1765 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001766 /*
1767 * Special cases: if we've been waiting on the
1768 * socket's write_space() callback, or if the
1769 * socket just returned a connection error,
1770 * then hold onto the transport lock.
1771 */
1772 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001773 case -EHOSTDOWN:
1774 case -EHOSTUNREACH:
1775 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001776 if (RPC_IS_SOFTCONN(task)) {
1777 xprt_end_transmit(task);
1778 rpc_exit(task, task->tk_status);
1779 break;
1780 }
1781 case -ECONNRESET:
1782 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001783 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001784 rpc_task_force_reencode(task);
1785 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786}
1787
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001788#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001789/*
1790 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1791 * addition, disconnect on connectivity errors.
1792 */
1793static void
1794call_bc_transmit(struct rpc_task *task)
1795{
1796 struct rpc_rqst *req = task->tk_rqstp;
1797
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001798 task->tk_status = xprt_prepare_transmit(task);
1799 if (task->tk_status == -EAGAIN) {
1800 /*
1801 * Could not reserve the transport. Try again after the
1802 * transport is released.
1803 */
1804 task->tk_status = 0;
1805 task->tk_action = call_bc_transmit;
1806 return;
1807 }
1808
1809 task->tk_action = rpc_exit_task;
1810 if (task->tk_status < 0) {
1811 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1812 "error: %d\n", task->tk_status);
1813 return;
1814 }
1815
1816 xprt_transmit(task);
1817 xprt_end_transmit(task);
1818 dprint_status(task);
1819 switch (task->tk_status) {
1820 case 0:
1821 /* Success */
1822 break;
1823 case -EHOSTDOWN:
1824 case -EHOSTUNREACH:
1825 case -ENETUNREACH:
1826 case -ETIMEDOUT:
1827 /*
1828 * Problem reaching the server. Disconnect and let the
1829 * forechannel reestablish the connection. The server will
1830 * have to retransmit the backchannel request and we'll
1831 * reprocess it. Since these ops are idempotent, there's no
1832 * need to cache our reply at this time.
1833 */
1834 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1835 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001836 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001837 req->rq_connect_cookie);
1838 break;
1839 default:
1840 /*
1841 * We were unable to reply and will have to drop the
1842 * request. The server should reconnect and retransmit.
1843 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001844 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001845 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1846 "error: %d\n", task->tk_status);
1847 break;
1848 }
1849 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1850}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001851#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001852
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853/*
1854 * 6. Sort out the RPC call status
1855 */
1856static void
1857call_status(struct rpc_task *task)
1858{
1859 struct rpc_clnt *clnt = task->tk_client;
1860 struct rpc_rqst *req = task->tk_rqstp;
1861 int status;
1862
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001863 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1864 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
Chuck Lever46121cf2007-01-31 12:14:08 -05001866 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867
1868 status = task->tk_status;
1869 if (status >= 0) {
1870 task->tk_action = call_decode;
1871 return;
1872 }
1873
Steve Dickson5753cba2012-02-06 10:08:08 -05001874 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 task->tk_status = 0;
1876 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001877 case -EHOSTDOWN:
1878 case -EHOSTUNREACH:
1879 case -ENETUNREACH:
1880 /*
1881 * Delay any retries for 3 seconds, then handle as if it
1882 * were a timeout.
1883 */
1884 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 case -ETIMEDOUT:
1886 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001887 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001888 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001889 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001891 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001893 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001894 rpc_delay(task, 3*HZ);
1895 case -EPIPE:
1896 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 task->tk_action = call_bind;
1898 break;
1899 case -EAGAIN:
1900 task->tk_action = call_transmit;
1901 break;
1902 case -EIO:
1903 /* shutdown or soft timeout */
1904 rpc_exit(task, status);
1905 break;
1906 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001907 if (clnt->cl_chatty)
1908 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001909 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 }
1912}
1913
1914/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001915 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 * We do not release the request slot, so we keep using the
1917 * same XID for all retransmits.
1918 */
1919static void
1920call_timeout(struct rpc_task *task)
1921{
1922 struct rpc_clnt *clnt = task->tk_client;
1923
1924 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001925 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 goto retry;
1927 }
1928
Chuck Lever46121cf2007-01-31 12:14:08 -05001929 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001930 task->tk_timeouts++;
1931
Chuck Lever3a28bec2009-12-03 15:58:56 -05001932 if (RPC_IS_SOFTCONN(task)) {
1933 rpc_exit(task, -ETIMEDOUT);
1934 return;
1935 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001937 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001938 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001939 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001940 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001941 rcu_dereference(clnt->cl_xprt)->servername);
1942 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001943 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001944 if (task->tk_flags & RPC_TASK_TIMEOUT)
1945 rpc_exit(task, -ETIMEDOUT);
1946 else
1947 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 return;
1949 }
1950
Chuck Leverf518e35a2006-01-03 09:55:52 +01001951 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001953 if (clnt->cl_chatty) {
1954 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001955 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001956 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001957 rcu_dereference(clnt->cl_xprt)->servername);
1958 rcu_read_unlock();
1959 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001961 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001962 /*
1963 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1964 * event? RFC2203 requires the server to drop all such requests.
1965 */
1966 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
1968retry:
1969 clnt->cl_stats->rpcretrans++;
1970 task->tk_action = call_bind;
1971 task->tk_status = 0;
1972}
1973
1974/*
1975 * 7. Decode the RPC reply
1976 */
1977static void
1978call_decode(struct rpc_task *task)
1979{
1980 struct rpc_clnt *clnt = task->tk_client;
1981 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001982 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001983 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
Vasily Averin726fd6a2011-06-01 16:23:59 +04001985 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986
Chuck Leverf518e35a2006-01-03 09:55:52 +01001987 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001988 if (clnt->cl_chatty) {
1989 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001990 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001991 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001992 rcu_dereference(clnt->cl_xprt)->servername);
1993 rcu_read_unlock();
1994 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1996 }
1997
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001998 /*
1999 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002000 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002001 */
2002 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 req->rq_rcv_buf.len = req->rq_private_buf.len;
2004
2005 /* Check that the softirq receive buffer is valid */
2006 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2007 sizeof(req->rq_rcv_buf)) != 0);
2008
Trond Myklebust1e799b62008-03-21 16:19:41 -04002009 if (req->rq_rcv_buf.len < 12) {
2010 if (!RPC_IS_SOFT(task)) {
2011 task->tk_action = call_bind;
2012 clnt->cl_stats->rpcretrans++;
2013 goto out_retry;
2014 }
2015 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002016 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002017 task->tk_action = call_timeout;
2018 goto out_retry;
2019 }
2020
Chuck Leverb0e1c572008-05-21 17:09:19 -04002021 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002022 if (IS_ERR(p)) {
2023 if (p == ERR_PTR(-EAGAIN))
2024 goto out_retry;
2025 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 }
2027
Trond Myklebustabbcf282006-01-03 09:55:03 +01002028 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002030 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2032 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002033 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002034 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2035 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 return;
2037out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002039 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002040 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002041 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002042 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002043 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002044 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002045 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046}
2047
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002048static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002049rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050{
2051 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002053 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
2055 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002056
Trond Myklebusta4f08352013-01-08 09:10:21 -05002057 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 *p++ = req->rq_xid; /* XID */
2059 *p++ = htonl(RPC_CALL); /* CALL */
2060 *p++ = htonl(RPC_VERSION); /* RPC version */
2061 *p++ = htonl(clnt->cl_prog); /* program number */
2062 *p++ = htonl(clnt->cl_vers); /* program version */
2063 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002064 p = rpcauth_marshcred(task, p);
2065 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2066 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067}
2068
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002069static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002070rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002072 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2074 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002075 __be32 *p = iov->iov_base;
2076 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 int error = -EACCES;
2078
David Howellse8896492006-08-24 15:44:19 -04002079 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2080 /* RFC-1014 says that the representation of XDR data must be a
2081 * multiple of four bytes
2082 * - if it isn't pointer subtraction in the NFS client may give
2083 * undefined results
2084 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002085 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002086 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002087 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002088 goto out_eio;
2089 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 if ((len -= 3) < 0)
2091 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002093 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002095 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002096 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002097 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002099
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2101 if (--len < 0)
2102 goto out_overflow;
2103 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002104 case RPC_AUTH_ERROR:
2105 break;
2106 case RPC_MISMATCH:
2107 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2108 task->tk_pid, __func__);
2109 error = -EPROTONOSUPPORT;
2110 goto out_err;
2111 default:
2112 dprintk("RPC: %5u %s: RPC call rejected, "
2113 "unknown error: %x\n",
2114 task->tk_pid, __func__, n);
2115 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 }
2117 if (--len < 0)
2118 goto out_overflow;
2119 switch ((n = ntohl(*p++))) {
2120 case RPC_AUTH_REJECTEDCRED:
2121 case RPC_AUTH_REJECTEDVERF:
2122 case RPCSEC_GSS_CREDPROBLEM:
2123 case RPCSEC_GSS_CTXPROBLEM:
2124 if (!task->tk_cred_retry)
2125 break;
2126 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002127 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002128 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002130 /* Ensure we obtain a new XID! */
2131 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002132 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002133 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 case RPC_AUTH_BADCRED:
2135 case RPC_AUTH_BADVERF:
2136 /* possibly garbled cred/verf? */
2137 if (!task->tk_garb_retry)
2138 break;
2139 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002140 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002141 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002143 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002145 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002146 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002147 "authentication.\n",
2148 rcu_dereference(clnt->cl_xprt)->servername);
2149 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 break;
2151 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002152 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002153 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 error = -EIO;
2155 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002156 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002157 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 goto out_err;
2159 }
2160 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002161 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002162 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002163 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002165 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 if (len < 0)
2167 goto out_overflow;
2168 switch ((n = ntohl(*p++))) {
2169 case RPC_SUCCESS:
2170 return p;
2171 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002172 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2173 "by server %s\n", task->tk_pid, __func__,
2174 (unsigned int)clnt->cl_prog,
2175 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002176 error = -EPFNOSUPPORT;
2177 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002179 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2180 "by server %s\n", task->tk_pid, __func__,
2181 (unsigned int)clnt->cl_prog,
2182 (unsigned int)clnt->cl_vers,
2183 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002184 error = -EPROTONOSUPPORT;
2185 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002187 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002188 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002189 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002190 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002191 clnt->cl_prog, clnt->cl_vers,
2192 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002193 error = -EOPNOTSUPP;
2194 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002196 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002197 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 break; /* retry */
2199 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002200 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002201 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 /* Also retry */
2203 }
2204
Trond Myklebustabbcf282006-01-03 09:55:03 +01002205out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002206 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 if (task->tk_garb_retry) {
2208 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002209 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002210 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002212out_retry:
2213 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215out_eio:
2216 error = -EIO;
2217out_err:
2218 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002219 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002220 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002221 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002223 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002224 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002225 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002227
Chuck Lever9f06c712010-12-14 14:59:18 +00002228static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002229{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002230}
2231
Chuck Leverbf269552010-12-14 14:59:29 +00002232static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002233{
2234 return 0;
2235}
2236
2237static struct rpc_procinfo rpcproc_null = {
2238 .p_encode = rpcproc_encode_null,
2239 .p_decode = rpcproc_decode_null,
2240};
2241
Chuck Levercaabea82009-12-03 15:58:56 -05002242static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002243{
2244 struct rpc_message msg = {
2245 .rpc_proc = &rpcproc_null,
2246 };
2247 int err;
2248 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002249 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002250 put_rpccred(msg.rpc_cred);
2251 return err;
2252}
Trond Myklebust188fef12007-06-16 14:18:40 -04002253
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002254struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2255{
2256 struct rpc_message msg = {
2257 .rpc_proc = &rpcproc_null,
2258 .rpc_cred = cred,
2259 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002260 struct rpc_task_setup task_setup_data = {
2261 .rpc_client = clnt,
2262 .rpc_message = &msg,
2263 .callback_ops = &rpc_default_ops,
2264 .flags = flags,
2265 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002266 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002267}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002268EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002269
Trond Myklebust188fef12007-06-16 14:18:40 -04002270#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002271static void rpc_show_header(void)
2272{
Chuck Levercb3997b2008-05-21 17:09:41 -04002273 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2274 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002275}
2276
Chuck Lever38e886e2008-05-21 17:09:33 -04002277static void rpc_show_task(const struct rpc_clnt *clnt,
2278 const struct rpc_task *task)
2279{
2280 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002281
2282 if (RPC_IS_QUEUED(task))
2283 rpc_waitq = rpc_qname(task->tk_waitqueue);
2284
Joe Perchesb3bceda2010-12-21 10:52:24 -05002285 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 -04002286 task->tk_pid, task->tk_flags, task->tk_status,
2287 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002288 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002289 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002290}
2291
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002292void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002293{
2294 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002295 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002296 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002297 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002298
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002299 spin_lock(&sn->rpc_client_lock);
2300 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002301 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002302 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002303 if (!header) {
2304 rpc_show_header();
2305 header++;
2306 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002307 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002308 }
2309 spin_unlock(&clnt->cl_lock);
2310 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002311 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002312}
2313#endif