blob: 587f31e0577ede6eaa72295eaad86ece61d23f95 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
159 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
179 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400191 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400192 if (!dentry)
193 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400194 if (IS_ERR(dentry))
195 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400207static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
209{
210 int error = 0;
211
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
216 break;
217 }
218 return error;
219}
220
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400221static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222{
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
225
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400228 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 spin_unlock(&sn->rpc_client_lock);
231 return clnt;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return NULL;
235}
236
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400237static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
238 void *ptr)
239{
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
242 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400243
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400245 error = __rpc_pipefs_event(clnt, event, sb);
246 if (error)
247 break;
248 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249 return error;
250}
251
252static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400267static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
268{
269 clnt->cl_nodelen = strlen(nodename);
270 if (clnt->cl_nodelen > UNX_MAXNODENAME)
271 clnt->cl_nodelen = UNX_MAXNODENAME;
272 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
273}
274
Chuck Leverd746e542013-10-17 14:12:17 -0400275static int rpc_client_register(struct rpc_clnt *clnt,
276 rpc_authflavor_t pseudoflavor,
277 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400278{
Trond Myklebustc2190662013-08-26 19:23:04 -0400279 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400280 .pseudoflavor = pseudoflavor,
281 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400282 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400283 struct rpc_auth *auth;
284 struct net *net = rpc_net_ns(clnt);
285 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400286 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400287
288 pipefs_sb = rpc_get_sb_net(net);
289 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400290 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400291 if (err)
292 goto out;
293 }
294
Trond Myklebusteeee2452013-07-10 15:33:01 -0400295 rpc_register_client(clnt);
296 if (pipefs_sb)
297 rpc_put_sb_net(net);
298
Trond Myklebustc2190662013-08-26 19:23:04 -0400299 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400300 if (IS_ERR(auth)) {
301 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400302 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400303 err = PTR_ERR(auth);
304 goto err_auth;
305 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400306 return 0;
307err_auth:
308 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400309 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400310 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400311out:
312 if (pipefs_sb)
313 rpc_put_sb_net(net);
314 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400315}
316
Trond Myklebust2f048db2013-09-04 21:51:44 -0400317static DEFINE_IDA(rpc_clids);
318
319static int rpc_alloc_clid(struct rpc_clnt *clnt)
320{
321 int clid;
322
323 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
324 if (clid < 0)
325 return clid;
326 clnt->cl_clid = clid;
327 return 0;
328}
329
330static void rpc_free_clid(struct rpc_clnt *clnt)
331{
332 ida_simple_remove(&rpc_clids, clnt->cl_clid);
333}
334
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400335static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
336 struct rpc_xprt *xprt,
337 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500339 const struct rpc_program *program = args->program;
340 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 struct rpc_clnt *clnt = NULL;
342 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400343
344 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500345 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500346 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Trond Myklebust4ada5392007-06-14 17:26:17 -0400348 err = rpciod_up();
349 if (err)
350 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500351
Trond Myklebustf05c1242013-04-05 14:13:21 -0400352 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500353 if (args->version >= program->nrvers)
354 goto out_err;
355 version = program->version[args->version];
356 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 goto out_err;
358
359 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700360 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 if (!clnt)
362 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400363 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Trond Myklebust2f048db2013-09-04 21:51:44 -0400365 err = rpc_alloc_clid(clnt);
366 if (err)
367 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Trond Myklebust2446ab62012-03-01 17:00:56 -0500369 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 clnt->cl_procinfo = version->procs;
371 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300372 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500375 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400376 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500377 err = -ENOMEM;
378 if (clnt->cl_metrics == NULL)
379 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500380 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400381 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400382 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
Trond Myklebust2446ab62012-03-01 17:00:56 -0500384 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 clnt->cl_autobind = 1;
386
Trond Myklebustba7392b2007-12-20 16:03:55 -0500387 clnt->cl_timeout = xprt->timeout;
388 if (args->timeout != NULL) {
389 memcpy(&clnt->cl_timeout_default, args->timeout,
390 sizeof(clnt->cl_timeout_default));
391 clnt->cl_timeout = &clnt->cl_timeout_default;
392 }
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500395 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Trond Myklebust006abe82010-09-12 19:55:25 -0400397 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400400 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400401
Chuck Leverd746e542013-10-17 14:12:17 -0400402 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400403 if (err)
404 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400405 if (parent)
406 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 return clnt;
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500410 rpc_free_iostats(clnt->cl_metrics);
411out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400412 rpc_free_clid(clnt);
413out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 kfree(clnt);
415out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400416 rpciod_down();
417out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400418 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 return ERR_PTR(err);
420}
421
Ben Hutchings2c530402012-07-10 10:55:09 +0000422/**
Chuck Leverc2866762006-08-22 20:06:20 -0400423 * rpc_create - create an RPC client and transport with one call
424 * @args: rpc_clnt create argument structure
425 *
426 * Creates and initializes an RPC transport and an RPC client.
427 *
428 * It can ping the server in order to determine if it is up, and to see if
429 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
430 * this behavior so asynchronous tasks can also use rpc_create.
431 */
432struct rpc_clnt *rpc_create(struct rpc_create_args *args)
433{
434 struct rpc_xprt *xprt;
435 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400436 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400437 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400438 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200439 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200440 .dstaddr = args->address,
441 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500442 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300443 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200444 };
Chuck Lever510deb02007-12-10 14:56:24 -0500445 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400446
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400447 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
448 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400449 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
450 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400451 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400452 * If the caller chooses not to specify a hostname, whip
453 * up a string representation of the passed-in address.
454 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500455 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400456 struct sockaddr_un *sun =
457 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400458 struct sockaddr_in *sin =
459 (struct sockaddr_in *)args->address;
460 struct sockaddr_in6 *sin6 =
461 (struct sockaddr_in6 *)args->address;
462
Chuck Lever510deb02007-12-10 14:56:24 -0500463 servername[0] = '\0';
464 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400465 case AF_LOCAL:
466 snprintf(servername, sizeof(servername), "%s",
467 sun->sun_path);
468 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400469 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700470 snprintf(servername, sizeof(servername), "%pI4",
471 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500472 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400473 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700474 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400475 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500476 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500477 default:
478 /* caller wants default server name, but
479 * address family isn't recognized. */
480 return ERR_PTR(-EINVAL);
481 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500482 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400483 }
484
Chuck Lever510deb02007-12-10 14:56:24 -0500485 xprt = xprt_create_transport(&xprtargs);
486 if (IS_ERR(xprt))
487 return (struct rpc_clnt *)xprt;
488
Chuck Lever43780b82007-07-01 12:13:22 -0400489 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400490 * By default, kernel RPC client connects from a reserved port.
491 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
492 * but it is always enabled for rpciod, which handles the connect
493 * operation.
494 */
495 xprt->resvport = 1;
496 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
497 xprt->resvport = 0;
498
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400499 clnt = rpc_new_client(args, xprt, NULL);
Chuck Leverc2866762006-08-22 20:06:20 -0400500 if (IS_ERR(clnt))
501 return clnt;
502
503 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500504 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400505 if (err != 0) {
506 rpc_shutdown_client(clnt);
507 return ERR_PTR(err);
508 }
509 }
510
511 clnt->cl_softrtry = 1;
512 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
513 clnt->cl_softrtry = 0;
514
Chuck Leverc2866762006-08-22 20:06:20 -0400515 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
516 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500517 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
518 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400519 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
520 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400521
522 return clnt;
523}
Chuck Leverb86acd52006-08-22 20:06:22 -0400524EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
527 * This function clones the RPC client structure. It allows us to share the
528 * same transport while varying parameters such as the authentication
529 * flavour.
530 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400531static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
532 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500534 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400535 struct rpc_clnt *new;
536 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Chuck Lever1b63a752012-09-14 17:23:52 -0400538 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500539 rcu_read_lock();
540 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
541 rcu_read_unlock();
542 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400543 goto out_err;
544 args->servername = xprt->servername;
545
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400546 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400547 if (IS_ERR(new)) {
548 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400549 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400550 }
551
Chuck Lever1b63a752012-09-14 17:23:52 -0400552 /* Turn off autobind on clones */
553 new->cl_autobind = 0;
554 new->cl_softrtry = clnt->cl_softrtry;
555 new->cl_discrtry = clnt->cl_discrtry;
556 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400558
Chuck Lever1b63a752012-09-14 17:23:52 -0400559out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800560 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500561 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562}
Chuck Lever1b63a752012-09-14 17:23:52 -0400563
564/**
565 * rpc_clone_client - Clone an RPC client structure
566 *
567 * @clnt: RPC client whose parameters are copied
568 *
569 * Returns a fresh RPC client or an ERR_PTR.
570 */
571struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
572{
573 struct rpc_create_args args = {
574 .program = clnt->cl_program,
575 .prognumber = clnt->cl_prog,
576 .version = clnt->cl_vers,
577 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400578 };
579 return __rpc_clone_client(&args, clnt);
580}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400581EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Chuck Leverba9b5842012-09-14 17:24:02 -0400583/**
584 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
585 *
586 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800587 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400588 *
589 * Returns a fresh RPC client or an ERR_PTR.
590 */
591struct rpc_clnt *
592rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
593{
594 struct rpc_create_args args = {
595 .program = clnt->cl_program,
596 .prognumber = clnt->cl_prog,
597 .version = clnt->cl_vers,
598 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400599 };
600 return __rpc_clone_client(&args, clnt);
601}
602EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400605 * Kill all tasks for the given client.
606 * XXX: kill their descendants as well?
607 */
608void rpc_killall_tasks(struct rpc_clnt *clnt)
609{
610 struct rpc_task *rovr;
611
612
613 if (list_empty(&clnt->cl_tasks))
614 return;
615 dprintk("RPC: killing all tasks for client %p\n", clnt);
616 /*
617 * Spin lock all_tasks to prevent changes...
618 */
619 spin_lock(&clnt->cl_lock);
620 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
621 if (!RPC_IS_ACTIVATED(rovr))
622 continue;
623 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
624 rovr->tk_flags |= RPC_TASK_KILLED;
625 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300626 if (RPC_IS_QUEUED(rovr))
627 rpc_wake_up_queued_task(rovr->tk_waitqueue,
628 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400629 }
630 }
631 spin_unlock(&clnt->cl_lock);
632}
633EXPORT_SYMBOL_GPL(rpc_killall_tasks);
634
635/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400637 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400639void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400641 might_sleep();
642
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500643 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400644 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500645 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Trond Myklebust34f52e32007-06-14 16:40:31 -0400647 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800649 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400650 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 }
652
Trond Myklebust4c402b42007-06-14 16:40:32 -0400653 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400655EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400658 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400660static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400661rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500663 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400664 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500665 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500666 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400667 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400668 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400669 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500670 rpc_free_iostats(clnt->cl_metrics);
671 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500672 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400673 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400674 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
677
678/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400679 * Free an RPC client
680 */
681static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400682rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400683{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400684 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400685 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400686 return;
687 }
688
689 /*
690 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
691 * release remaining GSS contexts. This mechanism ensures
692 * that it can do so safely.
693 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400694 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400695 rpcauth_release(clnt->cl_auth);
696 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400697 if (atomic_dec_and_test(&clnt->cl_count))
698 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400699}
700
701/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400702 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 */
704void
705rpc_release_client(struct rpc_clnt *clnt)
706{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400707 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Trond Myklebust34f52e32007-06-14 16:40:31 -0400709 if (list_empty(&clnt->cl_tasks))
710 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400711 if (atomic_dec_and_test(&clnt->cl_count))
712 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400713}
Simo Sorce1d658332012-05-25 18:09:55 -0400714EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400715
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000716/**
717 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800718 * @old: old rpc_client
719 * @program: rpc program to set
720 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000721 *
722 * Clones the rpc client and sets up a new RPC program. This is mainly
723 * of use for enabling different RPC programs to share the same transport.
724 * The Sun NFSv2/v3 ACL protocol can do this.
725 */
726struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500727 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400728 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000729{
Trond Myklebustf994c432012-11-01 12:14:14 -0400730 struct rpc_create_args args = {
731 .program = program,
732 .prognumber = program->number,
733 .version = vers,
734 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400735 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000736 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000737 int err;
738
Trond Myklebustf994c432012-11-01 12:14:14 -0400739 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000740 if (IS_ERR(clnt))
741 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500742 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000743 if (err != 0) {
744 rpc_shutdown_client(clnt);
745 clnt = ERR_PTR(err);
746 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800747out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000748 return clnt;
749}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400750EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000751
Trond Myklebust58f96122010-07-31 14:29:08 -0400752void rpc_task_release_client(struct rpc_task *task)
753{
754 struct rpc_clnt *clnt = task->tk_client;
755
756 if (clnt != NULL) {
757 /* Remove from client task list */
758 spin_lock(&clnt->cl_lock);
759 list_del(&task->tk_task);
760 spin_unlock(&clnt->cl_lock);
761 task->tk_client = NULL;
762
763 rpc_release_client(clnt);
764 }
765}
766
767static
768void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
769{
770 if (clnt != NULL) {
771 rpc_task_release_client(task);
772 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400773 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400774 if (clnt->cl_softrtry)
775 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400776 if (clnt->cl_noretranstimeo)
777 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700778 if (sk_memalloc_socks()) {
779 struct rpc_xprt *xprt;
780
781 rcu_read_lock();
782 xprt = rcu_dereference(clnt->cl_xprt);
783 if (xprt->swapper)
784 task->tk_flags |= RPC_TASK_SWAPPER;
785 rcu_read_unlock();
786 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400787 /* Add to the client's list of all tasks */
788 spin_lock(&clnt->cl_lock);
789 list_add_tail(&task->tk_task, &clnt->cl_tasks);
790 spin_unlock(&clnt->cl_lock);
791 }
792}
793
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000794void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
795{
796 rpc_task_release_client(task);
797 rpc_task_set_client(task, clnt);
798}
799EXPORT_SYMBOL_GPL(rpc_task_reset_client);
800
801
Trond Myklebust58f96122010-07-31 14:29:08 -0400802static void
803rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
804{
805 if (msg != NULL) {
806 task->tk_msg.rpc_proc = msg->rpc_proc;
807 task->tk_msg.rpc_argp = msg->rpc_argp;
808 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400809 if (msg->rpc_cred != NULL)
810 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400811 }
812}
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814/*
815 * Default callback for async RPC calls
816 */
817static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100818rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
820}
821
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100822static const struct rpc_call_ops rpc_default_ops = {
823 .rpc_call_done = rpc_default_callback,
824};
825
Trond Myklebustc970aa82007-07-14 15:39:59 -0400826/**
827 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
828 * @task_setup_data: pointer to task initialisation data
829 */
830struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400831{
Trond Myklebust19445b92010-04-16 16:41:10 -0400832 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400833
Trond Myklebust84115e12007-07-14 15:39:59 -0400834 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400835 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400836 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400837
Trond Myklebust58f96122010-07-31 14:29:08 -0400838 rpc_task_set_client(task, task_setup_data->rpc_client);
839 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
840
Trond Myklebust58f96122010-07-31 14:29:08 -0400841 if (task->tk_action == NULL)
842 rpc_call_start(task);
843
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400844 atomic_inc(&task->tk_count);
845 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400846out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400847 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400848}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400849EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400850
851/**
852 * rpc_call_sync - Perform a synchronous RPC call
853 * @clnt: pointer to RPC client
854 * @msg: RPC call parameters
855 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500857int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858{
859 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400860 struct rpc_task_setup task_setup_data = {
861 .rpc_client = clnt,
862 .rpc_message = msg,
863 .callback_ops = &rpc_default_ops,
864 .flags = flags,
865 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400866 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400868 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
869 if (flags & RPC_TASK_ASYNC) {
870 rpc_release_calldata(task_setup_data.callback_ops,
871 task_setup_data.callback_data);
872 return -EINVAL;
873 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Trond Myklebustc970aa82007-07-14 15:39:59 -0400875 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400876 if (IS_ERR(task))
877 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100878 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800879 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 return status;
881}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400882EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400884/**
885 * rpc_call_async - Perform an asynchronous RPC call
886 * @clnt: pointer to RPC client
887 * @msg: RPC call parameters
888 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800889 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400890 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 */
892int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500893rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100894 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895{
896 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400897 struct rpc_task_setup task_setup_data = {
898 .rpc_client = clnt,
899 .rpc_message = msg,
900 .callback_ops = tk_ops,
901 .callback_data = data,
902 .flags = flags|RPC_TASK_ASYNC,
903 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Trond Myklebustc970aa82007-07-14 15:39:59 -0400905 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400906 if (IS_ERR(task))
907 return PTR_ERR(task);
908 rpc_put_task(task);
909 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400911EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400913#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400914/**
915 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
916 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400917 * @req: RPC request
918 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400919 */
920struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400921 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400922{
923 struct rpc_task *task;
924 struct xdr_buf *xbufp = &req->rq_snd_buf;
925 struct rpc_task_setup task_setup_data = {
926 .callback_ops = tk_ops,
927 };
928
929 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
930 /*
931 * Create an rpc_task to send the data
932 */
933 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400934 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400935 xprt_free_bc_request(req);
936 goto out;
937 }
938 task->tk_rqstp = req;
939
940 /*
941 * Set up the xdr_buf length.
942 * This also indicates that the buffer is XDR encoded already.
943 */
944 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
945 xbufp->tail[0].iov_len;
946
947 task->tk_action = call_bc_transmit;
948 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400949 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400950 rpc_execute(task);
951
952out:
953 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
954 return task;
955}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400956#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400957
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400959rpc_call_start(struct rpc_task *task)
960{
961 task->tk_action = call_start;
962}
963EXPORT_SYMBOL_GPL(rpc_call_start);
964
Chuck Levered394402006-08-22 20:06:17 -0400965/**
966 * rpc_peeraddr - extract remote peer address from clnt's xprt
967 * @clnt: RPC client structure
968 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800969 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400970 *
971 * Returns the number of bytes that are actually in the stored address.
972 */
973size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
974{
975 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500976 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400977
Trond Myklebust2446ab62012-03-01 17:00:56 -0500978 rcu_read_lock();
979 xprt = rcu_dereference(clnt->cl_xprt);
980
981 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400982 if (bytes > bufsize)
983 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500984 memcpy(buf, &xprt->addr, bytes);
985 rcu_read_unlock();
986
987 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400988}
Chuck Leverb86acd52006-08-22 20:06:22 -0400989EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400990
Chuck Leverf425eba2006-08-22 20:06:18 -0400991/**
992 * rpc_peeraddr2str - return remote peer address in printable format
993 * @clnt: RPC client structure
994 * @format: address format
995 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500996 * NB: the lifetime of the memory referenced by the returned pointer is
997 * the same as the rpc_xprt itself. As long as the caller uses this
998 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400999 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001000const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1001 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001002{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001003 struct rpc_xprt *xprt;
1004
1005 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001006
1007 if (xprt->address_strings[format] != NULL)
1008 return xprt->address_strings[format];
1009 else
1010 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001011}
Chuck Leverb86acd52006-08-22 20:06:22 -04001012EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001013
Chuck Lever2e738fd2012-03-01 17:01:14 -05001014static const struct sockaddr_in rpc_inaddr_loopback = {
1015 .sin_family = AF_INET,
1016 .sin_addr.s_addr = htonl(INADDR_ANY),
1017};
1018
1019static const struct sockaddr_in6 rpc_in6addr_loopback = {
1020 .sin6_family = AF_INET6,
1021 .sin6_addr = IN6ADDR_ANY_INIT,
1022};
1023
1024/*
1025 * Try a getsockname() on a connected datagram socket. Using a
1026 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1027 * This conserves the ephemeral port number space.
1028 *
1029 * Returns zero and fills in "buf" if successful; otherwise, a
1030 * negative errno is returned.
1031 */
1032static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1033 struct sockaddr *buf, int buflen)
1034{
1035 struct socket *sock;
1036 int err;
1037
1038 err = __sock_create(net, sap->sa_family,
1039 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1040 if (err < 0) {
1041 dprintk("RPC: can't create UDP socket (%d)\n", err);
1042 goto out;
1043 }
1044
1045 switch (sap->sa_family) {
1046 case AF_INET:
1047 err = kernel_bind(sock,
1048 (struct sockaddr *)&rpc_inaddr_loopback,
1049 sizeof(rpc_inaddr_loopback));
1050 break;
1051 case AF_INET6:
1052 err = kernel_bind(sock,
1053 (struct sockaddr *)&rpc_in6addr_loopback,
1054 sizeof(rpc_in6addr_loopback));
1055 break;
1056 default:
1057 err = -EAFNOSUPPORT;
1058 goto out;
1059 }
1060 if (err < 0) {
1061 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1062 goto out_release;
1063 }
1064
1065 err = kernel_connect(sock, sap, salen, 0);
1066 if (err < 0) {
1067 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1068 goto out_release;
1069 }
1070
1071 err = kernel_getsockname(sock, buf, &buflen);
1072 if (err < 0) {
1073 dprintk("RPC: getsockname failed (%d)\n", err);
1074 goto out_release;
1075 }
1076
1077 err = 0;
1078 if (buf->sa_family == AF_INET6) {
1079 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1080 sin6->sin6_scope_id = 0;
1081 }
1082 dprintk("RPC: %s succeeded\n", __func__);
1083
1084out_release:
1085 sock_release(sock);
1086out:
1087 return err;
1088}
1089
1090/*
1091 * Scraping a connected socket failed, so we don't have a useable
1092 * local address. Fallback: generate an address that will prevent
1093 * the server from calling us back.
1094 *
1095 * Returns zero and fills in "buf" if successful; otherwise, a
1096 * negative errno is returned.
1097 */
1098static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1099{
1100 switch (family) {
1101 case AF_INET:
1102 if (buflen < sizeof(rpc_inaddr_loopback))
1103 return -EINVAL;
1104 memcpy(buf, &rpc_inaddr_loopback,
1105 sizeof(rpc_inaddr_loopback));
1106 break;
1107 case AF_INET6:
1108 if (buflen < sizeof(rpc_in6addr_loopback))
1109 return -EINVAL;
1110 memcpy(buf, &rpc_in6addr_loopback,
1111 sizeof(rpc_in6addr_loopback));
1112 default:
1113 dprintk("RPC: %s: address family not supported\n",
1114 __func__);
1115 return -EAFNOSUPPORT;
1116 }
1117 dprintk("RPC: %s: succeeded\n", __func__);
1118 return 0;
1119}
1120
1121/**
1122 * rpc_localaddr - discover local endpoint address for an RPC client
1123 * @clnt: RPC client structure
1124 * @buf: target buffer
1125 * @buflen: size of target buffer, in bytes
1126 *
1127 * Returns zero and fills in "buf" and "buflen" if successful;
1128 * otherwise, a negative errno is returned.
1129 *
1130 * This works even if the underlying transport is not currently connected,
1131 * or if the upper layer never previously provided a source address.
1132 *
1133 * The result of this function call is transient: multiple calls in
1134 * succession may give different results, depending on how local
1135 * networking configuration changes over time.
1136 */
1137int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1138{
1139 struct sockaddr_storage address;
1140 struct sockaddr *sap = (struct sockaddr *)&address;
1141 struct rpc_xprt *xprt;
1142 struct net *net;
1143 size_t salen;
1144 int err;
1145
1146 rcu_read_lock();
1147 xprt = rcu_dereference(clnt->cl_xprt);
1148 salen = xprt->addrlen;
1149 memcpy(sap, &xprt->addr, salen);
1150 net = get_net(xprt->xprt_net);
1151 rcu_read_unlock();
1152
1153 rpc_set_port(sap, 0);
1154 err = rpc_sockname(net, sap, salen, buf, buflen);
1155 put_net(net);
1156 if (err != 0)
1157 /* Couldn't discover local address, return ANYADDR */
1158 return rpc_anyaddr(sap->sa_family, buf, buflen);
1159 return 0;
1160}
1161EXPORT_SYMBOL_GPL(rpc_localaddr);
1162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163void
1164rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1165{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001166 struct rpc_xprt *xprt;
1167
1168 rcu_read_lock();
1169 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001170 if (xprt->ops->set_buffer_size)
1171 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001172 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001174EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Trond Myklebust2446ab62012-03-01 17:00:56 -05001176/**
1177 * rpc_protocol - Get transport protocol number for an RPC client
1178 * @clnt: RPC client to query
1179 *
1180 */
1181int rpc_protocol(struct rpc_clnt *clnt)
1182{
1183 int protocol;
1184
1185 rcu_read_lock();
1186 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1187 rcu_read_unlock();
1188 return protocol;
1189}
1190EXPORT_SYMBOL_GPL(rpc_protocol);
1191
1192/**
1193 * rpc_net_ns - Get the network namespace for this RPC client
1194 * @clnt: RPC client to query
1195 *
1196 */
1197struct net *rpc_net_ns(struct rpc_clnt *clnt)
1198{
1199 struct net *ret;
1200
1201 rcu_read_lock();
1202 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1203 rcu_read_unlock();
1204 return ret;
1205}
1206EXPORT_SYMBOL_GPL(rpc_net_ns);
1207
1208/**
1209 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1210 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 *
1212 * For stream transports, this is one RPC record fragment (see RFC
1213 * 1831), as we don't support multi-record requests yet. For datagram
1214 * transports, this is the size of an IP packet minus the IP, UDP, and
1215 * RPC header sizes.
1216 */
1217size_t rpc_max_payload(struct rpc_clnt *clnt)
1218{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001219 size_t ret;
1220
1221 rcu_read_lock();
1222 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1223 rcu_read_unlock();
1224 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225}
Chuck Leverb86acd52006-08-22 20:06:22 -04001226EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227
Chuck Lever35f5a422006-01-03 09:55:50 +01001228/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001229 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001230 * @clnt: RPC client to query
1231 */
1232unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1233{
1234 unsigned long ret;
1235
1236 rcu_read_lock();
1237 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1238 rcu_read_unlock();
1239 return ret;
1240}
1241EXPORT_SYMBOL_GPL(rpc_get_timeout);
1242
1243/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001244 * rpc_force_rebind - force transport to check that remote port is unchanged
1245 * @clnt: client to rebind
1246 *
1247 */
1248void rpc_force_rebind(struct rpc_clnt *clnt)
1249{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001250 if (clnt->cl_autobind) {
1251 rcu_read_lock();
1252 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1253 rcu_read_unlock();
1254 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001255}
Chuck Leverb86acd52006-08-22 20:06:22 -04001256EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001259 * Restart an (async) RPC call from the call_prepare state.
1260 * Usually called from within the exit handler.
1261 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001262int
Andy Adamsonaae20062009-04-01 09:22:40 -04001263rpc_restart_call_prepare(struct rpc_task *task)
1264{
1265 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001266 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001267 task->tk_action = call_start;
1268 if (task->tk_ops->rpc_call_prepare != NULL)
1269 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001270 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001271}
1272EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1273
1274/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 * Restart an (async) RPC call. Usually called from within the
1276 * exit handler.
1277 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001278int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279rpc_restart_call(struct rpc_task *task)
1280{
1281 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001282 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001284 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001286EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
Chuck Lever3748f1e2008-05-21 17:09:12 -04001288#ifdef RPC_DEBUG
1289static const char *rpc_proc_name(const struct rpc_task *task)
1290{
1291 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1292
1293 if (proc) {
1294 if (proc->p_name)
1295 return proc->p_name;
1296 else
1297 return "NULL";
1298 } else
1299 return "no proc";
1300}
1301#endif
1302
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303/*
1304 * 0. Initial state
1305 *
1306 * Other FSM states can be visited zero or more times, but
1307 * this state is visited exactly once for each RPC.
1308 */
1309static void
1310call_start(struct rpc_task *task)
1311{
1312 struct rpc_clnt *clnt = task->tk_client;
1313
Chuck Lever3748f1e2008-05-21 17:09:12 -04001314 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001315 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001316 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001317 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
1319 /* Increment call count */
1320 task->tk_msg.rpc_proc->p_count++;
1321 clnt->cl_stats->rpccnt++;
1322 task->tk_action = call_reserve;
1323}
1324
1325/*
1326 * 1. Reserve an RPC call slot
1327 */
1328static void
1329call_reserve(struct rpc_task *task)
1330{
Chuck Lever46121cf2007-01-31 12:14:08 -05001331 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 task->tk_status = 0;
1334 task->tk_action = call_reserveresult;
1335 xprt_reserve(task);
1336}
1337
Trond Myklebustba60eb22013-04-14 10:49:37 -04001338static void call_retry_reserve(struct rpc_task *task);
1339
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340/*
1341 * 1b. Grok the result of xprt_reserve()
1342 */
1343static void
1344call_reserveresult(struct rpc_task *task)
1345{
1346 int status = task->tk_status;
1347
Chuck Lever46121cf2007-01-31 12:14:08 -05001348 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
1350 /*
1351 * After a call to xprt_reserve(), we must have either
1352 * a request slot or else an error status.
1353 */
1354 task->tk_status = 0;
1355 if (status >= 0) {
1356 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001357 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 return;
1359 }
1360
1361 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001362 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 rpc_exit(task, -EIO);
1364 return;
1365 }
1366
1367 /*
1368 * Even though there was an error, we may have acquired
1369 * a request slot somehow. Make sure not to leak it.
1370 */
1371 if (task->tk_rqstp) {
1372 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001373 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 xprt_release(task);
1375 }
1376
1377 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001378 case -ENOMEM:
1379 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001381 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 return;
1383 case -EIO: /* probably a shutdown */
1384 break;
1385 default:
1386 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001387 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 break;
1389 }
1390 rpc_exit(task, status);
1391}
1392
1393/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001394 * 1c. Retry reserving an RPC call slot
1395 */
1396static void
1397call_retry_reserve(struct rpc_task *task)
1398{
1399 dprint_status(task);
1400
1401 task->tk_status = 0;
1402 task->tk_action = call_reserveresult;
1403 xprt_retry_reserve(task);
1404}
1405
1406/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001407 * 2. Bind and/or refresh the credentials
1408 */
1409static void
1410call_refresh(struct rpc_task *task)
1411{
1412 dprint_status(task);
1413
1414 task->tk_action = call_refreshresult;
1415 task->tk_status = 0;
1416 task->tk_client->cl_stats->rpcauthrefresh++;
1417 rpcauth_refreshcred(task);
1418}
1419
1420/*
1421 * 2a. Process the results of a credential refresh
1422 */
1423static void
1424call_refreshresult(struct rpc_task *task)
1425{
1426 int status = task->tk_status;
1427
1428 dprint_status(task);
1429
1430 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001431 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001432 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001433 case 0:
1434 if (rpcauth_uptodatecred(task))
1435 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001436 return;
1437 case -ETIMEDOUT:
1438 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001439 case -EAGAIN:
1440 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001441 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001442 if (!task->tk_cred_retry)
1443 break;
1444 task->tk_cred_retry--;
1445 dprintk("RPC: %5u %s: retry refresh creds\n",
1446 task->tk_pid, __func__);
1447 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001448 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001449 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1450 task->tk_pid, __func__, status);
1451 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001452}
1453
1454/*
1455 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001456 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 */
1458static void
1459call_allocate(struct rpc_task *task)
1460{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001461 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001462 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001463 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001464 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
Chuck Lever46121cf2007-01-31 12:14:08 -05001466 dprint_status(task);
1467
Chuck Lever2bea90d2007-03-29 16:47:53 -04001468 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001469 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001470
Chuck Lever02107142006-01-03 09:55:49 +01001471 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 return;
1473
Chuck Lever2bea90d2007-03-29 16:47:53 -04001474 if (proc->p_proc != 0) {
1475 BUG_ON(proc->p_arglen == 0);
1476 if (proc->p_decode != NULL)
1477 BUG_ON(proc->p_replen == 0);
1478 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
Chuck Lever2bea90d2007-03-29 16:47:53 -04001480 /*
1481 * Calculate the size (in quads) of the RPC call
1482 * and reply headers, and convert both values
1483 * to byte sizes.
1484 */
1485 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1486 req->rq_callsize <<= 2;
1487 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1488 req->rq_rcvsize <<= 2;
1489
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001490 req->rq_buffer = xprt->ops->buf_alloc(task,
1491 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001492 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001494
1495 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Trond Myklebust5afa9132011-06-17 10:14:59 -04001497 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001498 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 rpc_delay(task, HZ>>4);
1500 return;
1501 }
1502
1503 rpc_exit(task, -ERESTARTSYS);
1504}
1505
Trond Myklebust940e3312005-11-09 21:45:24 -05001506static inline int
1507rpc_task_need_encode(struct rpc_task *task)
1508{
1509 return task->tk_rqstp->rq_snd_buf.len == 0;
1510}
1511
1512static inline void
1513rpc_task_force_reencode(struct rpc_task *task)
1514{
1515 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001516 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001517}
1518
Chuck Lever2bea90d2007-03-29 16:47:53 -04001519static inline void
1520rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1521{
1522 buf->head[0].iov_base = start;
1523 buf->head[0].iov_len = len;
1524 buf->tail[0].iov_len = 0;
1525 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001526 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001527 buf->len = 0;
1528 buf->buflen = len;
1529}
1530
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531/*
1532 * 3. Encode arguments of an RPC call
1533 */
1534static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001535rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001538 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001539 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
Chuck Lever46121cf2007-01-31 12:14:08 -05001541 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Chuck Lever2bea90d2007-03-29 16:47:53 -04001543 rpc_xdr_buf_init(&req->rq_snd_buf,
1544 req->rq_buffer,
1545 req->rq_callsize);
1546 rpc_xdr_buf_init(&req->rq_rcv_buf,
1547 (char *)req->rq_buffer + req->rq_callsize,
1548 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Chuck Leverb0e1c572008-05-21 17:09:19 -04001550 p = rpc_encode_header(task);
1551 if (p == NULL) {
1552 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 rpc_exit(task, -EIO);
1554 return;
1555 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001556
1557 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001558 if (encode == NULL)
1559 return;
1560
1561 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1562 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563}
1564
1565/*
1566 * 4. Get the server port number if not yet set
1567 */
1568static void
1569call_bind(struct rpc_task *task)
1570{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001571 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Chuck Lever46121cf2007-01-31 12:14:08 -05001573 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Chuck Leverda351872005-08-11 16:25:11 -04001575 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001576 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001577 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001578 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001579 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 }
1581}
1582
1583/*
Chuck Leverda351872005-08-11 16:25:11 -04001584 * 4a. Sort out bind result
1585 */
1586static void
1587call_bind_status(struct rpc_task *task)
1588{
Chuck Lever906462a2007-09-11 18:00:47 -04001589 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001590
1591 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001592 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001593 task->tk_status = 0;
1594 task->tk_action = call_connect;
1595 return;
1596 }
1597
Steve Dickson5753cba2012-02-06 10:08:08 -05001598 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001599 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001600 case -ENOMEM:
1601 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1602 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001603 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001604 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001605 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1606 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001607 /* fail immediately if this is an RPC ping */
1608 if (task->tk_msg.rpc_proc->p_proc == 0) {
1609 status = -EOPNOTSUPP;
1610 break;
1611 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001612 if (task->tk_rebind_retry == 0)
1613 break;
1614 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001615 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001616 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001617 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001618 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001619 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001620 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001621 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001622 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001623 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001624 task->tk_pid);
1625 break;
1626 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001627 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001628 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001629 task->tk_status = 0;
1630 task->tk_action = call_bind;
1631 return;
Chuck Lever012da152009-12-03 15:58:56 -05001632 case -ECONNREFUSED: /* connection problems */
1633 case -ECONNRESET:
1634 case -ENOTCONN:
1635 case -EHOSTDOWN:
1636 case -EHOSTUNREACH:
1637 case -ENETUNREACH:
1638 case -EPIPE:
1639 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1640 task->tk_pid, task->tk_status);
1641 if (!RPC_IS_SOFTCONN(task)) {
1642 rpc_delay(task, 5*HZ);
1643 goto retry_timeout;
1644 }
1645 status = task->tk_status;
1646 break;
Chuck Leverda351872005-08-11 16:25:11 -04001647 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001648 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001649 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001650 }
1651
1652 rpc_exit(task, status);
1653 return;
1654
Trond Myklebustda458282006-08-31 15:44:52 -04001655retry_timeout:
1656 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001657}
1658
1659/*
1660 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 */
1662static void
1663call_connect(struct rpc_task *task)
1664{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001665 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Chuck Lever46121cf2007-01-31 12:14:08 -05001667 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001668 task->tk_pid, xprt,
1669 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670
Chuck Leverda351872005-08-11 16:25:11 -04001671 task->tk_action = call_transmit;
1672 if (!xprt_connected(xprt)) {
1673 task->tk_action = call_connect_status;
1674 if (task->tk_status < 0)
1675 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001676 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1677 rpc_exit(task, -ENOTCONN);
1678 return;
1679 }
Chuck Leverda351872005-08-11 16:25:11 -04001680 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682}
1683
1684/*
Chuck Leverda351872005-08-11 16:25:11 -04001685 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 */
1687static void
1688call_connect_status(struct rpc_task *task)
1689{
1690 struct rpc_clnt *clnt = task->tk_client;
1691 int status = task->tk_status;
1692
Chuck Lever46121cf2007-01-31 12:14:08 -05001693 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001694
Steve Dickson5753cba2012-02-06 10:08:08 -05001695 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001696 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001698 /* if soft mounted, test if we've timed out */
1699 case -ETIMEDOUT:
1700 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001701 return;
1702 case -ECONNREFUSED:
1703 case -ECONNRESET:
1704 case -ENETUNREACH:
Trond Myklebust561ec162013-09-26 15:22:45 -04001705 /* retry with existing socket, after a delay */
1706 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001707 if (RPC_IS_SOFTCONN(task))
1708 break;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001709 case -EAGAIN:
Trond Myklebust561ec162013-09-26 15:22:45 -04001710 task->tk_action = call_bind;
1711 return;
1712 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001713 clnt->cl_stats->netreconn++;
1714 task->tk_action = call_transmit;
1715 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001717 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718}
1719
1720/*
1721 * 5. Transmit the RPC request, and wait for reply
1722 */
1723static void
1724call_transmit(struct rpc_task *task)
1725{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001726 int is_retrans = RPC_WAS_SENT(task);
1727
Chuck Lever46121cf2007-01-31 12:14:08 -05001728 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
1730 task->tk_action = call_status;
1731 if (task->tk_status < 0)
1732 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001733 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001735 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001737 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001738 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001739 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001740 if (task->tk_status != 0) {
1741 /* Was the error nonfatal? */
1742 if (task->tk_status == -EAGAIN)
1743 rpc_delay(task, HZ >> 4);
1744 else
1745 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001746 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001747 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 xprt_transmit(task);
1750 if (task->tk_status < 0)
1751 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001752 if (is_retrans)
1753 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001754 /*
1755 * On success, ensure that we call xprt_end_transmit() before sleeping
1756 * in order to allow access to the socket to other RPC requests.
1757 */
1758 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001759 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001760 return;
1761 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001762 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001763}
1764
1765/*
1766 * 5a. Handle cleanup after a transmission
1767 */
1768static void
1769call_transmit_status(struct rpc_task *task)
1770{
1771 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001772
1773 /*
1774 * Common case: success. Force the compiler to put this
1775 * test first.
1776 */
1777 if (task->tk_status == 0) {
1778 xprt_end_transmit(task);
1779 rpc_task_force_reencode(task);
1780 return;
1781 }
1782
Trond Myklebust15f081c2009-03-11 14:37:57 -04001783 switch (task->tk_status) {
1784 case -EAGAIN:
1785 break;
1786 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001787 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001788 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001789 rpc_task_force_reencode(task);
1790 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001791 /*
1792 * Special cases: if we've been waiting on the
1793 * socket's write_space() callback, or if the
1794 * socket just returned a connection error,
1795 * then hold onto the transport lock.
1796 */
1797 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001798 case -EHOSTDOWN:
1799 case -EHOSTUNREACH:
1800 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001801 if (RPC_IS_SOFTCONN(task)) {
1802 xprt_end_transmit(task);
1803 rpc_exit(task, task->tk_status);
1804 break;
1805 }
1806 case -ECONNRESET:
1807 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001808 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001809 rpc_task_force_reencode(task);
1810 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811}
1812
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001813#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001814/*
1815 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1816 * addition, disconnect on connectivity errors.
1817 */
1818static void
1819call_bc_transmit(struct rpc_task *task)
1820{
1821 struct rpc_rqst *req = task->tk_rqstp;
1822
Trond Myklebust90051ea2013-09-25 12:17:18 -04001823 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001824 /*
1825 * Could not reserve the transport. Try again after the
1826 * transport is released.
1827 */
1828 task->tk_status = 0;
1829 task->tk_action = call_bc_transmit;
1830 return;
1831 }
1832
1833 task->tk_action = rpc_exit_task;
1834 if (task->tk_status < 0) {
1835 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1836 "error: %d\n", task->tk_status);
1837 return;
1838 }
1839
1840 xprt_transmit(task);
1841 xprt_end_transmit(task);
1842 dprint_status(task);
1843 switch (task->tk_status) {
1844 case 0:
1845 /* Success */
1846 break;
1847 case -EHOSTDOWN:
1848 case -EHOSTUNREACH:
1849 case -ENETUNREACH:
1850 case -ETIMEDOUT:
1851 /*
1852 * Problem reaching the server. Disconnect and let the
1853 * forechannel reestablish the connection. The server will
1854 * have to retransmit the backchannel request and we'll
1855 * reprocess it. Since these ops are idempotent, there's no
1856 * need to cache our reply at this time.
1857 */
1858 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1859 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001860 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001861 req->rq_connect_cookie);
1862 break;
1863 default:
1864 /*
1865 * We were unable to reply and will have to drop the
1866 * request. The server should reconnect and retransmit.
1867 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001868 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001869 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1870 "error: %d\n", task->tk_status);
1871 break;
1872 }
1873 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1874}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001875#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001876
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877/*
1878 * 6. Sort out the RPC call status
1879 */
1880static void
1881call_status(struct rpc_task *task)
1882{
1883 struct rpc_clnt *clnt = task->tk_client;
1884 struct rpc_rqst *req = task->tk_rqstp;
1885 int status;
1886
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001887 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1888 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
Chuck Lever46121cf2007-01-31 12:14:08 -05001890 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
1892 status = task->tk_status;
1893 if (status >= 0) {
1894 task->tk_action = call_decode;
1895 return;
1896 }
1897
Steve Dickson5753cba2012-02-06 10:08:08 -05001898 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 task->tk_status = 0;
1900 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001901 case -EHOSTDOWN:
1902 case -EHOSTUNREACH:
1903 case -ENETUNREACH:
1904 /*
1905 * Delay any retries for 3 seconds, then handle as if it
1906 * were a timeout.
1907 */
1908 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 case -ETIMEDOUT:
1910 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04001911 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
1912 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001913 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001914 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001916 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001918 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001919 rpc_delay(task, 3*HZ);
1920 case -EPIPE:
1921 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 task->tk_action = call_bind;
1923 break;
1924 case -EAGAIN:
1925 task->tk_action = call_transmit;
1926 break;
1927 case -EIO:
1928 /* shutdown or soft timeout */
1929 rpc_exit(task, status);
1930 break;
1931 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001932 if (clnt->cl_chatty)
1933 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001934 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 }
1937}
1938
1939/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001940 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 * We do not release the request slot, so we keep using the
1942 * same XID for all retransmits.
1943 */
1944static void
1945call_timeout(struct rpc_task *task)
1946{
1947 struct rpc_clnt *clnt = task->tk_client;
1948
1949 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001950 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 goto retry;
1952 }
1953
Chuck Lever46121cf2007-01-31 12:14:08 -05001954 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001955 task->tk_timeouts++;
1956
Chuck Lever3a28bec2009-12-03 15:58:56 -05001957 if (RPC_IS_SOFTCONN(task)) {
1958 rpc_exit(task, -ETIMEDOUT);
1959 return;
1960 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001962 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001963 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001964 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001965 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001966 rcu_dereference(clnt->cl_xprt)->servername);
1967 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001968 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001969 if (task->tk_flags & RPC_TASK_TIMEOUT)
1970 rpc_exit(task, -ETIMEDOUT);
1971 else
1972 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 return;
1974 }
1975
Chuck Leverf518e35a2006-01-03 09:55:52 +01001976 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001978 if (clnt->cl_chatty) {
1979 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001980 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001981 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001982 rcu_dereference(clnt->cl_xprt)->servername);
1983 rcu_read_unlock();
1984 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001986 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001987 /*
1988 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1989 * event? RFC2203 requires the server to drop all such requests.
1990 */
1991 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992
1993retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 task->tk_action = call_bind;
1995 task->tk_status = 0;
1996}
1997
1998/*
1999 * 7. Decode the RPC reply
2000 */
2001static void
2002call_decode(struct rpc_task *task)
2003{
2004 struct rpc_clnt *clnt = task->tk_client;
2005 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002006 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002007 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
Vasily Averin726fd6a2011-06-01 16:23:59 +04002009 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010
Chuck Leverf518e35a2006-01-03 09:55:52 +01002011 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002012 if (clnt->cl_chatty) {
2013 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002014 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002015 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002016 rcu_dereference(clnt->cl_xprt)->servername);
2017 rcu_read_unlock();
2018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2020 }
2021
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002022 /*
2023 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002024 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002025 */
2026 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 req->rq_rcv_buf.len = req->rq_private_buf.len;
2028
2029 /* Check that the softirq receive buffer is valid */
2030 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2031 sizeof(req->rq_rcv_buf)) != 0);
2032
Trond Myklebust1e799b62008-03-21 16:19:41 -04002033 if (req->rq_rcv_buf.len < 12) {
2034 if (!RPC_IS_SOFT(task)) {
2035 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002036 goto out_retry;
2037 }
2038 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002039 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002040 task->tk_action = call_timeout;
2041 goto out_retry;
2042 }
2043
Chuck Leverb0e1c572008-05-21 17:09:19 -04002044 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002045 if (IS_ERR(p)) {
2046 if (p == ERR_PTR(-EAGAIN))
2047 goto out_retry;
2048 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 }
2050
Trond Myklebustabbcf282006-01-03 09:55:03 +01002051 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002053 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2055 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002056 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002057 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2058 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 return;
2060out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002062 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002063 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002064 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002065 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002066 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002067 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002068 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069}
2070
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002071static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002072rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073{
2074 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002076 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
2078 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002079
Trond Myklebusta4f08352013-01-08 09:10:21 -05002080 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 *p++ = req->rq_xid; /* XID */
2082 *p++ = htonl(RPC_CALL); /* CALL */
2083 *p++ = htonl(RPC_VERSION); /* RPC version */
2084 *p++ = htonl(clnt->cl_prog); /* program number */
2085 *p++ = htonl(clnt->cl_vers); /* program version */
2086 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002087 p = rpcauth_marshcred(task, p);
2088 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2089 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090}
2091
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002092static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002093rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002095 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2097 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002098 __be32 *p = iov->iov_base;
2099 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 int error = -EACCES;
2101
David Howellse8896492006-08-24 15:44:19 -04002102 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2103 /* RFC-1014 says that the representation of XDR data must be a
2104 * multiple of four bytes
2105 * - if it isn't pointer subtraction in the NFS client may give
2106 * undefined results
2107 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002108 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002109 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002110 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002111 error = -EIO;
2112 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002113 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 if ((len -= 3) < 0)
2115 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002117 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002119 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002120 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002121 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002122 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002124
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2126 if (--len < 0)
2127 goto out_overflow;
2128 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002129 case RPC_AUTH_ERROR:
2130 break;
2131 case RPC_MISMATCH:
2132 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2133 task->tk_pid, __func__);
2134 error = -EPROTONOSUPPORT;
2135 goto out_err;
2136 default:
2137 dprintk("RPC: %5u %s: RPC call rejected, "
2138 "unknown error: %x\n",
2139 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002140 error = -EIO;
2141 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 }
2143 if (--len < 0)
2144 goto out_overflow;
2145 switch ((n = ntohl(*p++))) {
2146 case RPC_AUTH_REJECTEDCRED:
2147 case RPC_AUTH_REJECTEDVERF:
2148 case RPCSEC_GSS_CREDPROBLEM:
2149 case RPCSEC_GSS_CTXPROBLEM:
2150 if (!task->tk_cred_retry)
2151 break;
2152 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002153 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002154 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002156 /* Ensure we obtain a new XID! */
2157 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002158 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002159 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 case RPC_AUTH_BADCRED:
2161 case RPC_AUTH_BADVERF:
2162 /* possibly garbled cred/verf? */
2163 if (!task->tk_garb_retry)
2164 break;
2165 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002166 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002167 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002169 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002171 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002172 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002173 "authentication.\n",
2174 rcu_dereference(clnt->cl_xprt)->servername);
2175 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 break;
2177 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002178 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002179 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 error = -EIO;
2181 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002182 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002183 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 goto out_err;
2185 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002186 p = rpcauth_checkverf(task, p);
2187 if (IS_ERR(p)) {
2188 error = PTR_ERR(p);
2189 dprintk("RPC: %5u %s: auth check failed with %d\n",
2190 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002191 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002193 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 if (len < 0)
2195 goto out_overflow;
2196 switch ((n = ntohl(*p++))) {
2197 case RPC_SUCCESS:
2198 return p;
2199 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002200 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2201 "by server %s\n", task->tk_pid, __func__,
2202 (unsigned int)clnt->cl_prog,
2203 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002204 error = -EPFNOSUPPORT;
2205 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002207 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2208 "by server %s\n", task->tk_pid, __func__,
2209 (unsigned int)clnt->cl_prog,
2210 (unsigned int)clnt->cl_vers,
2211 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002212 error = -EPROTONOSUPPORT;
2213 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002215 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002216 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002217 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002218 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002219 clnt->cl_prog, clnt->cl_vers,
2220 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002221 error = -EOPNOTSUPP;
2222 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002224 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002225 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 break; /* retry */
2227 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002228 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002229 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 /* Also retry */
2231 }
2232
Trond Myklebustabbcf282006-01-03 09:55:03 +01002233out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002234 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 if (task->tk_garb_retry) {
2236 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002237 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002238 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002240out_retry:
2241 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243out_err:
2244 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002245 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002246 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002247 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002249 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002250 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002251 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002253
Chuck Lever9f06c712010-12-14 14:59:18 +00002254static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002255{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002256}
2257
Chuck Leverbf269552010-12-14 14:59:29 +00002258static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002259{
2260 return 0;
2261}
2262
2263static struct rpc_procinfo rpcproc_null = {
2264 .p_encode = rpcproc_encode_null,
2265 .p_decode = rpcproc_decode_null,
2266};
2267
Chuck Levercaabea82009-12-03 15:58:56 -05002268static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002269{
2270 struct rpc_message msg = {
2271 .rpc_proc = &rpcproc_null,
2272 };
2273 int err;
2274 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002275 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002276 put_rpccred(msg.rpc_cred);
2277 return err;
2278}
Trond Myklebust188fef12007-06-16 14:18:40 -04002279
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002280struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2281{
2282 struct rpc_message msg = {
2283 .rpc_proc = &rpcproc_null,
2284 .rpc_cred = cred,
2285 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002286 struct rpc_task_setup task_setup_data = {
2287 .rpc_client = clnt,
2288 .rpc_message = &msg,
2289 .callback_ops = &rpc_default_ops,
2290 .flags = flags,
2291 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002292 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002293}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002294EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002295
Trond Myklebust188fef12007-06-16 14:18:40 -04002296#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002297static void rpc_show_header(void)
2298{
Chuck Levercb3997b2008-05-21 17:09:41 -04002299 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2300 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002301}
2302
Chuck Lever38e886e2008-05-21 17:09:33 -04002303static void rpc_show_task(const struct rpc_clnt *clnt,
2304 const struct rpc_task *task)
2305{
2306 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002307
2308 if (RPC_IS_QUEUED(task))
2309 rpc_waitq = rpc_qname(task->tk_waitqueue);
2310
Joe Perchesb3bceda2010-12-21 10:52:24 -05002311 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 -04002312 task->tk_pid, task->tk_flags, task->tk_status,
2313 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002314 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002315 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002316}
2317
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002318void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002319{
2320 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002321 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002322 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002323 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002324
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002325 spin_lock(&sn->rpc_client_lock);
2326 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002327 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002328 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002329 if (!header) {
2330 rpc_show_header();
2331 header++;
2332 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002333 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002334 }
2335 spin_unlock(&clnt->cl_lock);
2336 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002337 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002338}
2339#endif