blob: cdc7564b4512d7f79606bc87fb7726a668a9b9a0 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050037#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040038#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050039#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040041#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040042#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifdef RPC_DEBUG
45# define RPCDBG_FACILITY RPCDBG_CALL
46#endif
47
Chuck Lever46121cf2007-01-31 12:14:08 -050048#define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080050 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050051
Trond Myklebust188fef12007-06-16 14:18:40 -040052/*
53 * All RPC clients are linked into this list
54 */
Trond Myklebust188fef12007-06-16 14:18:40 -040055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
57
58
59static void call_start(struct rpc_task *task);
60static void call_reserve(struct rpc_task *task);
61static void call_reserveresult(struct rpc_task *task);
62static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063static void call_decode(struct rpc_task *task);
64static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040065static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040067#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040068static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040069#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050071static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_refresh(struct rpc_task *task);
73static void call_refreshresult(struct rpc_task *task);
74static void call_timeout(struct rpc_task *task);
75static void call_connect(struct rpc_task *task);
76static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Chuck Leverb0e1c572008-05-21 17:09:19 -040078static __be32 *rpc_encode_header(struct rpc_task *task);
79static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050080static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040081
Trond Myklebust188fef12007-06-16 14:18:40 -040082static void rpc_register_client(struct rpc_clnt *clnt)
83{
Trond Myklebust2446ab62012-03-01 17:00:56 -050084 struct net *net = rpc_net_ns(clnt);
85 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040086
87 spin_lock(&sn->rpc_client_lock);
88 list_add(&clnt->cl_clients, &sn->all_clients);
89 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040090}
91
92static void rpc_unregister_client(struct rpc_clnt *clnt)
93{
Trond Myklebust2446ab62012-03-01 17:00:56 -050094 struct net *net = rpc_net_ns(clnt);
95 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040096
97 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040098 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040099 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400100}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400102static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
103{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400104 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400105 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
106 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400107 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400108 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400109 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400110}
111
112static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
113{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500114 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116
Trond Myklebust2446ab62012-03-01 17:00:56 -0500117 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500120 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400121 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122}
123
124static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500125 struct rpc_clnt *clnt,
126 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
Trond Myklebustf1345852005-09-23 11:08:25 -0400128 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400129 char name[15];
Linus Torvalds26fe5752012-05-10 13:14:12 -0700130 struct qstr q = { .name = name };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 int error;
133
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400134 dir = rpc_d_lookup_sb(sb, dir_name);
135 if (dir == NULL)
136 return dir;
137 for (;;) {
138 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
139 name[sizeof(name) - 1] = '\0';
140 q.hash = full_name_hash(q.name, q.len);
141 dentry = rpc_create_client_dir(dir, &q, clnt);
142 if (!IS_ERR(dentry))
143 break;
144 error = PTR_ERR(dentry);
145 if (error != -EEXIST) {
146 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
147 " %s/%s, error %d\n",
148 dir_name, name, error);
149 break;
150 }
151 }
152 dput(dir);
153 return dentry;
154}
155
156static int
Trond Myklebust080b7942012-01-20 13:53:56 -0500157rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400158{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500159 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400160 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400161 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400162
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400163 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 if (dir_name == NULL)
165 return 0;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500166 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400167 if (!pipefs_sb)
168 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400169 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500170 rpc_put_sb_net(net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400171 if (IS_ERR(dentry))
172 return PTR_ERR(dentry);
173 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400174 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175}
176
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400177static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
178{
179 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
180 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
181 return 1;
182 return 0;
183}
184
185static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
186 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400187{
188 struct dentry *dentry;
189 int err = 0;
190
191 switch (event) {
192 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400193 dentry = rpc_setup_pipedir_sb(sb, clnt,
194 clnt->cl_program->pipe_dir_name);
195 BUG_ON(dentry == NULL);
196 if (IS_ERR(dentry))
197 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400198 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400199 if (clnt->cl_auth->au_ops->pipes_create) {
200 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
201 if (err)
202 __rpc_clnt_remove_pipedir(clnt);
203 }
204 break;
205 case RPC_PIPEFS_UMOUNT:
206 __rpc_clnt_remove_pipedir(clnt);
207 break;
208 default:
209 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
210 return -ENOTSUPP;
211 }
212 return err;
213}
214
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400215static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
216 struct super_block *sb)
217{
218 int error = 0;
219
220 for (;; clnt = clnt->cl_parent) {
221 if (!rpc_clnt_skip_event(clnt, event))
222 error = __rpc_clnt_handle_event(clnt, event, sb);
223 if (error || clnt == clnt->cl_parent)
224 break;
225 }
226 return error;
227}
228
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
230{
231 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
232 struct rpc_clnt *clnt;
233
234 spin_lock(&sn->rpc_client_lock);
235 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400236 if (clnt->cl_program->pipe_dir_name == NULL)
237 break;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400238 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400239 continue;
Stanislav Kinsburskya4dff1b2012-04-20 18:11:02 +0400240 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
241 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400242 spin_unlock(&sn->rpc_client_lock);
243 return clnt;
244 }
245 spin_unlock(&sn->rpc_client_lock);
246 return NULL;
247}
248
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
250 void *ptr)
251{
252 struct super_block *sb = ptr;
253 struct rpc_clnt *clnt;
254 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400256 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400257 error = __rpc_pipefs_event(clnt, event, sb);
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400258 rpc_release_client(clnt);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400259 if (error)
260 break;
261 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400262 return error;
263}
264
265static struct notifier_block rpc_clients_block = {
266 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400267 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400268};
269
270int rpc_clients_notifier_register(void)
271{
272 return rpc_pipefs_notifier_register(&rpc_clients_block);
273}
274
275void rpc_clients_notifier_unregister(void)
276{
277 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
278}
279
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400280static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
281{
282 clnt->cl_nodelen = strlen(nodename);
283 if (clnt->cl_nodelen > UNX_MAXNODENAME)
284 clnt->cl_nodelen = UNX_MAXNODENAME;
285 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
286}
287
Trond Myklebust698b6d02007-12-20 16:03:53 -0500288static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500290 const struct rpc_program *program = args->program;
291 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000293 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400295
296 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500297 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500298 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Trond Myklebust4ada5392007-06-14 17:26:17 -0400300 err = rpciod_up();
301 if (err)
302 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 err = -EINVAL;
304 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800305 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500306
307 if (args->version >= program->nrvers)
308 goto out_err;
309 version = program->version[args->version];
310 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 goto out_err;
312
313 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700314 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 if (!clnt)
316 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 clnt->cl_parent = clnt;
318
Trond Myklebust2446ab62012-03-01 17:00:56 -0500319 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 clnt->cl_procinfo = version->procs;
321 clnt->cl_maxproc = version->nrprocs;
322 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300323 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500326 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500327 err = -ENOMEM;
328 if (clnt->cl_metrics == NULL)
329 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500330 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400331 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400332 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Trond Myklebust2446ab62012-03-01 17:00:56 -0500334 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 clnt->cl_autobind = 1;
336
Trond Myklebustba7392b2007-12-20 16:03:55 -0500337 clnt->cl_timeout = xprt->timeout;
338 if (args->timeout != NULL) {
339 memcpy(&clnt->cl_timeout_default, args->timeout,
340 sizeof(clnt->cl_timeout_default));
341 clnt->cl_timeout = &clnt->cl_timeout_default;
342 }
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500345 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500346 clnt->cl_principal = NULL;
347 if (args->client_name) {
348 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
349 if (!clnt->cl_principal)
350 goto out_no_principal;
351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Trond Myklebust006abe82010-09-12 19:55:25 -0400353 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
356 if (err < 0)
357 goto out_no_path;
358
Trond Myklebust698b6d02007-12-20 16:03:53 -0500359 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000360 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500362 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000363 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 goto out_no_auth;
365 }
366
367 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400368 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400369 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 return clnt;
371
372out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400373 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500375 kfree(clnt->cl_principal);
376out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500377 rpc_free_iostats(clnt->cl_metrics);
378out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 kfree(clnt);
380out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400381 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800382out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400383 rpciod_down();
384out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 return ERR_PTR(err);
386}
387
Ben Hutchings2c530402012-07-10 10:55:09 +0000388/**
Chuck Leverc2866762006-08-22 20:06:20 -0400389 * rpc_create - create an RPC client and transport with one call
390 * @args: rpc_clnt create argument structure
391 *
392 * Creates and initializes an RPC transport and an RPC client.
393 *
394 * It can ping the server in order to determine if it is up, and to see if
395 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
396 * this behavior so asynchronous tasks can also use rpc_create.
397 */
398struct rpc_clnt *rpc_create(struct rpc_create_args *args)
399{
400 struct rpc_xprt *xprt;
401 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400402 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400403 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400404 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200405 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200406 .dstaddr = args->address,
407 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500408 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300409 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200410 };
Chuck Lever510deb02007-12-10 14:56:24 -0500411 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400412
Chuck Leverc2866762006-08-22 20:06:20 -0400413 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400414 * If the caller chooses not to specify a hostname, whip
415 * up a string representation of the passed-in address.
416 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500417 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400418 struct sockaddr_un *sun =
419 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400420 struct sockaddr_in *sin =
421 (struct sockaddr_in *)args->address;
422 struct sockaddr_in6 *sin6 =
423 (struct sockaddr_in6 *)args->address;
424
Chuck Lever510deb02007-12-10 14:56:24 -0500425 servername[0] = '\0';
426 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400427 case AF_LOCAL:
428 snprintf(servername, sizeof(servername), "%s",
429 sun->sun_path);
430 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400431 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700432 snprintf(servername, sizeof(servername), "%pI4",
433 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500434 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400435 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700436 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400437 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500438 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500439 default:
440 /* caller wants default server name, but
441 * address family isn't recognized. */
442 return ERR_PTR(-EINVAL);
443 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500444 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400445 }
446
Chuck Lever510deb02007-12-10 14:56:24 -0500447 xprt = xprt_create_transport(&xprtargs);
448 if (IS_ERR(xprt))
449 return (struct rpc_clnt *)xprt;
450
Chuck Lever43780b82007-07-01 12:13:22 -0400451 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400452 * By default, kernel RPC client connects from a reserved port.
453 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
454 * but it is always enabled for rpciod, which handles the connect
455 * operation.
456 */
457 xprt->resvport = 1;
458 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
459 xprt->resvport = 0;
460
Trond Myklebust698b6d02007-12-20 16:03:53 -0500461 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400462 if (IS_ERR(clnt))
463 return clnt;
464
465 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500466 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400467 if (err != 0) {
468 rpc_shutdown_client(clnt);
469 return ERR_PTR(err);
470 }
471 }
472
473 clnt->cl_softrtry = 1;
474 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
475 clnt->cl_softrtry = 0;
476
Chuck Leverc2866762006-08-22 20:06:20 -0400477 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
478 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500479 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
480 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400481 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
482 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400483
484 return clnt;
485}
Chuck Leverb86acd52006-08-22 20:06:22 -0400486EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488/*
489 * This function clones the RPC client structure. It allows us to share the
490 * same transport while varying parameters such as the authentication
491 * flavour.
492 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400493static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
494 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500496 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400497 struct rpc_clnt *new;
498 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
Chuck Lever1b63a752012-09-14 17:23:52 -0400500 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500501 rcu_read_lock();
502 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
503 rcu_read_unlock();
504 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400505 goto out_err;
506 args->servername = xprt->servername;
507
508 new = rpc_new_client(args, xprt);
509 if (IS_ERR(new)) {
510 err = PTR_ERR(new);
511 goto out_put;
512 }
513
Trond Myklebust006abe82010-09-12 19:55:25 -0400514 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400515 new->cl_parent = clnt;
516
517 /* Turn off autobind on clones */
518 new->cl_autobind = 0;
519 new->cl_softrtry = clnt->cl_softrtry;
520 new->cl_discrtry = clnt->cl_discrtry;
521 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400523
524out_put:
Trond Myklebust2446ab62012-03-01 17:00:56 -0500525 xprt_put(xprt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400526out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800527 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500528 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529}
Chuck Lever1b63a752012-09-14 17:23:52 -0400530
531/**
532 * rpc_clone_client - Clone an RPC client structure
533 *
534 * @clnt: RPC client whose parameters are copied
535 *
536 * Returns a fresh RPC client or an ERR_PTR.
537 */
538struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
539{
540 struct rpc_create_args args = {
541 .program = clnt->cl_program,
542 .prognumber = clnt->cl_prog,
543 .version = clnt->cl_vers,
544 .authflavor = clnt->cl_auth->au_flavor,
545 .client_name = clnt->cl_principal,
546 };
547 return __rpc_clone_client(&args, clnt);
548}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400549EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Chuck Leverba9b5842012-09-14 17:24:02 -0400551/**
552 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
553 *
554 * @clnt: RPC client whose parameters are copied
555 * @auth: security flavor for new client
556 *
557 * Returns a fresh RPC client or an ERR_PTR.
558 */
559struct rpc_clnt *
560rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
561{
562 struct rpc_create_args args = {
563 .program = clnt->cl_program,
564 .prognumber = clnt->cl_prog,
565 .version = clnt->cl_vers,
566 .authflavor = flavor,
567 .client_name = clnt->cl_principal,
568 };
569 return __rpc_clone_client(&args, clnt);
570}
571EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
572
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400574 * Kill all tasks for the given client.
575 * XXX: kill their descendants as well?
576 */
577void rpc_killall_tasks(struct rpc_clnt *clnt)
578{
579 struct rpc_task *rovr;
580
581
582 if (list_empty(&clnt->cl_tasks))
583 return;
584 dprintk("RPC: killing all tasks for client %p\n", clnt);
585 /*
586 * Spin lock all_tasks to prevent changes...
587 */
588 spin_lock(&clnt->cl_lock);
589 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
590 if (!RPC_IS_ACTIVATED(rovr))
591 continue;
592 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
593 rovr->tk_flags |= RPC_TASK_KILLED;
594 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300595 if (RPC_IS_QUEUED(rovr))
596 rpc_wake_up_queued_task(rovr->tk_waitqueue,
597 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400598 }
599 }
600 spin_unlock(&clnt->cl_lock);
601}
602EXPORT_SYMBOL_GPL(rpc_killall_tasks);
603
604/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400606 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400608void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500610 dprintk_rcu("RPC: shutting down %s client for %s\n",
611 clnt->cl_protname,
612 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Trond Myklebust34f52e32007-06-14 16:40:31 -0400614 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800616 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400617 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 }
619
Trond Myklebust4c402b42007-06-14 16:40:32 -0400620 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400622EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
624/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400625 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400627static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400628rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500630 dprintk_rcu("RPC: destroying %s client for %s\n",
631 clnt->cl_protname,
632 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500633 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400634 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400635 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400636 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500637 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500638 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500639 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500640 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400641 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
644
645/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400646 * Free an RPC client
647 */
648static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400649rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400650{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400651 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400652 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400653 return;
654 }
655
656 /*
657 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
658 * release remaining GSS contexts. This mechanism ensures
659 * that it can do so safely.
660 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400661 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400662 rpcauth_release(clnt->cl_auth);
663 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400664 if (atomic_dec_and_test(&clnt->cl_count))
665 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400666}
667
668/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400669 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 */
671void
672rpc_release_client(struct rpc_clnt *clnt)
673{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400674 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Trond Myklebust34f52e32007-06-14 16:40:31 -0400676 if (list_empty(&clnt->cl_tasks))
677 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400678 if (atomic_dec_and_test(&clnt->cl_count))
679 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400680}
681
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000682/**
683 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800684 * @old: old rpc_client
685 * @program: rpc program to set
686 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000687 *
688 * Clones the rpc client and sets up a new RPC program. This is mainly
689 * of use for enabling different RPC programs to share the same transport.
690 * The Sun NFSv2/v3 ACL protocol can do this.
691 */
692struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500693 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400694 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000695{
696 struct rpc_clnt *clnt;
Trond Myklebusta613fa12012-01-20 13:53:56 -0500697 const struct rpc_version *version;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000698 int err;
699
700 BUG_ON(vers >= program->nrvers || !program->version[vers]);
701 version = program->version[vers];
702 clnt = rpc_clone_client(old);
703 if (IS_ERR(clnt))
704 goto out;
705 clnt->cl_procinfo = version->procs;
706 clnt->cl_maxproc = version->nrprocs;
707 clnt->cl_protname = program->name;
708 clnt->cl_prog = program->number;
709 clnt->cl_vers = version->number;
710 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500711 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000712 if (err != 0) {
713 rpc_shutdown_client(clnt);
714 clnt = ERR_PTR(err);
715 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800716out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000717 return clnt;
718}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400719EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000720
Trond Myklebust58f96122010-07-31 14:29:08 -0400721void rpc_task_release_client(struct rpc_task *task)
722{
723 struct rpc_clnt *clnt = task->tk_client;
724
725 if (clnt != NULL) {
726 /* Remove from client task list */
727 spin_lock(&clnt->cl_lock);
728 list_del(&task->tk_task);
729 spin_unlock(&clnt->cl_lock);
730 task->tk_client = NULL;
731
732 rpc_release_client(clnt);
733 }
734}
735
736static
737void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
738{
739 if (clnt != NULL) {
740 rpc_task_release_client(task);
741 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400742 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400743 if (clnt->cl_softrtry)
744 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700745 if (sk_memalloc_socks()) {
746 struct rpc_xprt *xprt;
747
748 rcu_read_lock();
749 xprt = rcu_dereference(clnt->cl_xprt);
750 if (xprt->swapper)
751 task->tk_flags |= RPC_TASK_SWAPPER;
752 rcu_read_unlock();
753 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400754 /* Add to the client's list of all tasks */
755 spin_lock(&clnt->cl_lock);
756 list_add_tail(&task->tk_task, &clnt->cl_tasks);
757 spin_unlock(&clnt->cl_lock);
758 }
759}
760
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000761void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
762{
763 rpc_task_release_client(task);
764 rpc_task_set_client(task, clnt);
765}
766EXPORT_SYMBOL_GPL(rpc_task_reset_client);
767
768
Trond Myklebust58f96122010-07-31 14:29:08 -0400769static void
770rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
771{
772 if (msg != NULL) {
773 task->tk_msg.rpc_proc = msg->rpc_proc;
774 task->tk_msg.rpc_argp = msg->rpc_argp;
775 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400776 if (msg->rpc_cred != NULL)
777 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400778 }
779}
780
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781/*
782 * Default callback for async RPC calls
783 */
784static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100785rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
787}
788
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100789static const struct rpc_call_ops rpc_default_ops = {
790 .rpc_call_done = rpc_default_callback,
791};
792
Trond Myklebustc970aa82007-07-14 15:39:59 -0400793/**
794 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
795 * @task_setup_data: pointer to task initialisation data
796 */
797struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400798{
Trond Myklebust19445b92010-04-16 16:41:10 -0400799 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400800
Trond Myklebust84115e12007-07-14 15:39:59 -0400801 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400802 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400803 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400804
Trond Myklebust58f96122010-07-31 14:29:08 -0400805 rpc_task_set_client(task, task_setup_data->rpc_client);
806 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
807
Trond Myklebust58f96122010-07-31 14:29:08 -0400808 if (task->tk_action == NULL)
809 rpc_call_start(task);
810
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400811 atomic_inc(&task->tk_count);
812 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400813out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400814 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400815}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400816EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400817
818/**
819 * rpc_call_sync - Perform a synchronous RPC call
820 * @clnt: pointer to RPC client
821 * @msg: RPC call parameters
822 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500824int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
826 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400827 struct rpc_task_setup task_setup_data = {
828 .rpc_client = clnt,
829 .rpc_message = msg,
830 .callback_ops = &rpc_default_ops,
831 .flags = flags,
832 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400833 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 BUG_ON(flags & RPC_TASK_ASYNC);
836
Trond Myklebustc970aa82007-07-14 15:39:59 -0400837 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400838 if (IS_ERR(task))
839 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100840 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800841 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 return status;
843}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400844EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400846/**
847 * rpc_call_async - Perform an asynchronous RPC call
848 * @clnt: pointer to RPC client
849 * @msg: RPC call parameters
850 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800851 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400852 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 */
854int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500855rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100856 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
858 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400859 struct rpc_task_setup task_setup_data = {
860 .rpc_client = clnt,
861 .rpc_message = msg,
862 .callback_ops = tk_ops,
863 .callback_data = data,
864 .flags = flags|RPC_TASK_ASYNC,
865 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Trond Myklebustc970aa82007-07-14 15:39:59 -0400867 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400868 if (IS_ERR(task))
869 return PTR_ERR(task);
870 rpc_put_task(task);
871 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400873EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400875#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400876/**
877 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
878 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400879 * @req: RPC request
880 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400881 */
882struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400883 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400884{
885 struct rpc_task *task;
886 struct xdr_buf *xbufp = &req->rq_snd_buf;
887 struct rpc_task_setup task_setup_data = {
888 .callback_ops = tk_ops,
889 };
890
891 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
892 /*
893 * Create an rpc_task to send the data
894 */
895 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400896 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400897 xprt_free_bc_request(req);
898 goto out;
899 }
900 task->tk_rqstp = req;
901
902 /*
903 * Set up the xdr_buf length.
904 * This also indicates that the buffer is XDR encoded already.
905 */
906 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
907 xbufp->tail[0].iov_len;
908
909 task->tk_action = call_bc_transmit;
910 atomic_inc(&task->tk_count);
911 BUG_ON(atomic_read(&task->tk_count) != 2);
912 rpc_execute(task);
913
914out:
915 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
916 return task;
917}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400918#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400919
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400921rpc_call_start(struct rpc_task *task)
922{
923 task->tk_action = call_start;
924}
925EXPORT_SYMBOL_GPL(rpc_call_start);
926
Chuck Levered394402006-08-22 20:06:17 -0400927/**
928 * rpc_peeraddr - extract remote peer address from clnt's xprt
929 * @clnt: RPC client structure
930 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800931 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400932 *
933 * Returns the number of bytes that are actually in the stored address.
934 */
935size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
936{
937 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500938 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400939
Trond Myklebust2446ab62012-03-01 17:00:56 -0500940 rcu_read_lock();
941 xprt = rcu_dereference(clnt->cl_xprt);
942
943 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400944 if (bytes > bufsize)
945 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500946 memcpy(buf, &xprt->addr, bytes);
947 rcu_read_unlock();
948
949 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400950}
Chuck Leverb86acd52006-08-22 20:06:22 -0400951EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400952
Chuck Leverf425eba2006-08-22 20:06:18 -0400953/**
954 * rpc_peeraddr2str - return remote peer address in printable format
955 * @clnt: RPC client structure
956 * @format: address format
957 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500958 * NB: the lifetime of the memory referenced by the returned pointer is
959 * the same as the rpc_xprt itself. As long as the caller uses this
960 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400961 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500962const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
963 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400964{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500965 struct rpc_xprt *xprt;
966
967 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500968
969 if (xprt->address_strings[format] != NULL)
970 return xprt->address_strings[format];
971 else
972 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400973}
Chuck Leverb86acd52006-08-22 20:06:22 -0400974EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400975
Chuck Lever2e738fd2012-03-01 17:01:14 -0500976static const struct sockaddr_in rpc_inaddr_loopback = {
977 .sin_family = AF_INET,
978 .sin_addr.s_addr = htonl(INADDR_ANY),
979};
980
981static const struct sockaddr_in6 rpc_in6addr_loopback = {
982 .sin6_family = AF_INET6,
983 .sin6_addr = IN6ADDR_ANY_INIT,
984};
985
986/*
987 * Try a getsockname() on a connected datagram socket. Using a
988 * connected datagram socket prevents leaving a socket in TIME_WAIT.
989 * This conserves the ephemeral port number space.
990 *
991 * Returns zero and fills in "buf" if successful; otherwise, a
992 * negative errno is returned.
993 */
994static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
995 struct sockaddr *buf, int buflen)
996{
997 struct socket *sock;
998 int err;
999
1000 err = __sock_create(net, sap->sa_family,
1001 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1002 if (err < 0) {
1003 dprintk("RPC: can't create UDP socket (%d)\n", err);
1004 goto out;
1005 }
1006
1007 switch (sap->sa_family) {
1008 case AF_INET:
1009 err = kernel_bind(sock,
1010 (struct sockaddr *)&rpc_inaddr_loopback,
1011 sizeof(rpc_inaddr_loopback));
1012 break;
1013 case AF_INET6:
1014 err = kernel_bind(sock,
1015 (struct sockaddr *)&rpc_in6addr_loopback,
1016 sizeof(rpc_in6addr_loopback));
1017 break;
1018 default:
1019 err = -EAFNOSUPPORT;
1020 goto out;
1021 }
1022 if (err < 0) {
1023 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1024 goto out_release;
1025 }
1026
1027 err = kernel_connect(sock, sap, salen, 0);
1028 if (err < 0) {
1029 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1030 goto out_release;
1031 }
1032
1033 err = kernel_getsockname(sock, buf, &buflen);
1034 if (err < 0) {
1035 dprintk("RPC: getsockname failed (%d)\n", err);
1036 goto out_release;
1037 }
1038
1039 err = 0;
1040 if (buf->sa_family == AF_INET6) {
1041 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1042 sin6->sin6_scope_id = 0;
1043 }
1044 dprintk("RPC: %s succeeded\n", __func__);
1045
1046out_release:
1047 sock_release(sock);
1048out:
1049 return err;
1050}
1051
1052/*
1053 * Scraping a connected socket failed, so we don't have a useable
1054 * local address. Fallback: generate an address that will prevent
1055 * the server from calling us back.
1056 *
1057 * Returns zero and fills in "buf" if successful; otherwise, a
1058 * negative errno is returned.
1059 */
1060static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1061{
1062 switch (family) {
1063 case AF_INET:
1064 if (buflen < sizeof(rpc_inaddr_loopback))
1065 return -EINVAL;
1066 memcpy(buf, &rpc_inaddr_loopback,
1067 sizeof(rpc_inaddr_loopback));
1068 break;
1069 case AF_INET6:
1070 if (buflen < sizeof(rpc_in6addr_loopback))
1071 return -EINVAL;
1072 memcpy(buf, &rpc_in6addr_loopback,
1073 sizeof(rpc_in6addr_loopback));
1074 default:
1075 dprintk("RPC: %s: address family not supported\n",
1076 __func__);
1077 return -EAFNOSUPPORT;
1078 }
1079 dprintk("RPC: %s: succeeded\n", __func__);
1080 return 0;
1081}
1082
1083/**
1084 * rpc_localaddr - discover local endpoint address for an RPC client
1085 * @clnt: RPC client structure
1086 * @buf: target buffer
1087 * @buflen: size of target buffer, in bytes
1088 *
1089 * Returns zero and fills in "buf" and "buflen" if successful;
1090 * otherwise, a negative errno is returned.
1091 *
1092 * This works even if the underlying transport is not currently connected,
1093 * or if the upper layer never previously provided a source address.
1094 *
1095 * The result of this function call is transient: multiple calls in
1096 * succession may give different results, depending on how local
1097 * networking configuration changes over time.
1098 */
1099int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1100{
1101 struct sockaddr_storage address;
1102 struct sockaddr *sap = (struct sockaddr *)&address;
1103 struct rpc_xprt *xprt;
1104 struct net *net;
1105 size_t salen;
1106 int err;
1107
1108 rcu_read_lock();
1109 xprt = rcu_dereference(clnt->cl_xprt);
1110 salen = xprt->addrlen;
1111 memcpy(sap, &xprt->addr, salen);
1112 net = get_net(xprt->xprt_net);
1113 rcu_read_unlock();
1114
1115 rpc_set_port(sap, 0);
1116 err = rpc_sockname(net, sap, salen, buf, buflen);
1117 put_net(net);
1118 if (err != 0)
1119 /* Couldn't discover local address, return ANYADDR */
1120 return rpc_anyaddr(sap->sa_family, buf, buflen);
1121 return 0;
1122}
1123EXPORT_SYMBOL_GPL(rpc_localaddr);
1124
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125void
1126rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1127{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001128 struct rpc_xprt *xprt;
1129
1130 rcu_read_lock();
1131 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001132 if (xprt->ops->set_buffer_size)
1133 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001134 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001136EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
Trond Myklebust2446ab62012-03-01 17:00:56 -05001138/**
1139 * rpc_protocol - Get transport protocol number for an RPC client
1140 * @clnt: RPC client to query
1141 *
1142 */
1143int rpc_protocol(struct rpc_clnt *clnt)
1144{
1145 int protocol;
1146
1147 rcu_read_lock();
1148 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1149 rcu_read_unlock();
1150 return protocol;
1151}
1152EXPORT_SYMBOL_GPL(rpc_protocol);
1153
1154/**
1155 * rpc_net_ns - Get the network namespace for this RPC client
1156 * @clnt: RPC client to query
1157 *
1158 */
1159struct net *rpc_net_ns(struct rpc_clnt *clnt)
1160{
1161 struct net *ret;
1162
1163 rcu_read_lock();
1164 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1165 rcu_read_unlock();
1166 return ret;
1167}
1168EXPORT_SYMBOL_GPL(rpc_net_ns);
1169
1170/**
1171 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1172 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 *
1174 * For stream transports, this is one RPC record fragment (see RFC
1175 * 1831), as we don't support multi-record requests yet. For datagram
1176 * transports, this is the size of an IP packet minus the IP, UDP, and
1177 * RPC header sizes.
1178 */
1179size_t rpc_max_payload(struct rpc_clnt *clnt)
1180{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001181 size_t ret;
1182
1183 rcu_read_lock();
1184 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1185 rcu_read_unlock();
1186 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187}
Chuck Leverb86acd52006-08-22 20:06:22 -04001188EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189
Chuck Lever35f5a422006-01-03 09:55:50 +01001190/**
1191 * rpc_force_rebind - force transport to check that remote port is unchanged
1192 * @clnt: client to rebind
1193 *
1194 */
1195void rpc_force_rebind(struct rpc_clnt *clnt)
1196{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001197 if (clnt->cl_autobind) {
1198 rcu_read_lock();
1199 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1200 rcu_read_unlock();
1201 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001202}
Chuck Leverb86acd52006-08-22 20:06:22 -04001203EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001204
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001206 * Restart an (async) RPC call from the call_prepare state.
1207 * Usually called from within the exit handler.
1208 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001209int
Andy Adamsonaae20062009-04-01 09:22:40 -04001210rpc_restart_call_prepare(struct rpc_task *task)
1211{
1212 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001213 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001214 task->tk_action = call_start;
1215 if (task->tk_ops->rpc_call_prepare != NULL)
1216 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001217 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001218}
1219EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1220
1221/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 * Restart an (async) RPC call. Usually called from within the
1223 * exit handler.
1224 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001225int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226rpc_restart_call(struct rpc_task *task)
1227{
1228 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001229 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001231 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001233EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Chuck Lever3748f1e2008-05-21 17:09:12 -04001235#ifdef RPC_DEBUG
1236static const char *rpc_proc_name(const struct rpc_task *task)
1237{
1238 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1239
1240 if (proc) {
1241 if (proc->p_name)
1242 return proc->p_name;
1243 else
1244 return "NULL";
1245 } else
1246 return "no proc";
1247}
1248#endif
1249
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250/*
1251 * 0. Initial state
1252 *
1253 * Other FSM states can be visited zero or more times, but
1254 * this state is visited exactly once for each RPC.
1255 */
1256static void
1257call_start(struct rpc_task *task)
1258{
1259 struct rpc_clnt *clnt = task->tk_client;
1260
Chuck Lever3748f1e2008-05-21 17:09:12 -04001261 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001262 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001263 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001264 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
1266 /* Increment call count */
1267 task->tk_msg.rpc_proc->p_count++;
1268 clnt->cl_stats->rpccnt++;
1269 task->tk_action = call_reserve;
1270}
1271
1272/*
1273 * 1. Reserve an RPC call slot
1274 */
1275static void
1276call_reserve(struct rpc_task *task)
1277{
Chuck Lever46121cf2007-01-31 12:14:08 -05001278 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 task->tk_status = 0;
1281 task->tk_action = call_reserveresult;
1282 xprt_reserve(task);
1283}
1284
1285/*
1286 * 1b. Grok the result of xprt_reserve()
1287 */
1288static void
1289call_reserveresult(struct rpc_task *task)
1290{
1291 int status = task->tk_status;
1292
Chuck Lever46121cf2007-01-31 12:14:08 -05001293 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
1295 /*
1296 * After a call to xprt_reserve(), we must have either
1297 * a request slot or else an error status.
1298 */
1299 task->tk_status = 0;
1300 if (status >= 0) {
1301 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001302 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 return;
1304 }
1305
1306 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001307 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 rpc_exit(task, -EIO);
1309 return;
1310 }
1311
1312 /*
1313 * Even though there was an error, we may have acquired
1314 * a request slot somehow. Make sure not to leak it.
1315 */
1316 if (task->tk_rqstp) {
1317 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001318 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 xprt_release(task);
1320 }
1321
1322 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001323 case -ENOMEM:
1324 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 case -EAGAIN: /* woken up; retry */
1326 task->tk_action = call_reserve;
1327 return;
1328 case -EIO: /* probably a shutdown */
1329 break;
1330 default:
1331 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001332 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 break;
1334 }
1335 rpc_exit(task, status);
1336}
1337
1338/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001339 * 2. Bind and/or refresh the credentials
1340 */
1341static void
1342call_refresh(struct rpc_task *task)
1343{
1344 dprint_status(task);
1345
1346 task->tk_action = call_refreshresult;
1347 task->tk_status = 0;
1348 task->tk_client->cl_stats->rpcauthrefresh++;
1349 rpcauth_refreshcred(task);
1350}
1351
1352/*
1353 * 2a. Process the results of a credential refresh
1354 */
1355static void
1356call_refreshresult(struct rpc_task *task)
1357{
1358 int status = task->tk_status;
1359
1360 dprint_status(task);
1361
1362 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001363 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001364 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001365 case 0:
1366 if (rpcauth_uptodatecred(task))
1367 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001368 return;
1369 case -ETIMEDOUT:
1370 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001371 case -EAGAIN:
1372 status = -EACCES;
1373 if (!task->tk_cred_retry)
1374 break;
1375 task->tk_cred_retry--;
1376 dprintk("RPC: %5u %s: retry refresh creds\n",
1377 task->tk_pid, __func__);
1378 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001379 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001380 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1381 task->tk_pid, __func__, status);
1382 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001383}
1384
1385/*
1386 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001387 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 */
1389static void
1390call_allocate(struct rpc_task *task)
1391{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001392 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001393 struct rpc_rqst *req = task->tk_rqstp;
1394 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001395 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
Chuck Lever46121cf2007-01-31 12:14:08 -05001397 dprint_status(task);
1398
Chuck Lever2bea90d2007-03-29 16:47:53 -04001399 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001400 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001401
Chuck Lever02107142006-01-03 09:55:49 +01001402 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 return;
1404
Chuck Lever2bea90d2007-03-29 16:47:53 -04001405 if (proc->p_proc != 0) {
1406 BUG_ON(proc->p_arglen == 0);
1407 if (proc->p_decode != NULL)
1408 BUG_ON(proc->p_replen == 0);
1409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
Chuck Lever2bea90d2007-03-29 16:47:53 -04001411 /*
1412 * Calculate the size (in quads) of the RPC call
1413 * and reply headers, and convert both values
1414 * to byte sizes.
1415 */
1416 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1417 req->rq_callsize <<= 2;
1418 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1419 req->rq_rcvsize <<= 2;
1420
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001421 req->rq_buffer = xprt->ops->buf_alloc(task,
1422 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001423 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001425
1426 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Trond Myklebust5afa9132011-06-17 10:14:59 -04001428 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001429 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 rpc_delay(task, HZ>>4);
1431 return;
1432 }
1433
1434 rpc_exit(task, -ERESTARTSYS);
1435}
1436
Trond Myklebust940e3312005-11-09 21:45:24 -05001437static inline int
1438rpc_task_need_encode(struct rpc_task *task)
1439{
1440 return task->tk_rqstp->rq_snd_buf.len == 0;
1441}
1442
1443static inline void
1444rpc_task_force_reencode(struct rpc_task *task)
1445{
1446 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001447 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001448}
1449
Chuck Lever2bea90d2007-03-29 16:47:53 -04001450static inline void
1451rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1452{
1453 buf->head[0].iov_base = start;
1454 buf->head[0].iov_len = len;
1455 buf->tail[0].iov_len = 0;
1456 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001457 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001458 buf->len = 0;
1459 buf->buflen = len;
1460}
1461
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462/*
1463 * 3. Encode arguments of an RPC call
1464 */
1465static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001466rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001469 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001470 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Chuck Lever46121cf2007-01-31 12:14:08 -05001472 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Chuck Lever2bea90d2007-03-29 16:47:53 -04001474 rpc_xdr_buf_init(&req->rq_snd_buf,
1475 req->rq_buffer,
1476 req->rq_callsize);
1477 rpc_xdr_buf_init(&req->rq_rcv_buf,
1478 (char *)req->rq_buffer + req->rq_callsize,
1479 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Chuck Leverb0e1c572008-05-21 17:09:19 -04001481 p = rpc_encode_header(task);
1482 if (p == NULL) {
1483 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 rpc_exit(task, -EIO);
1485 return;
1486 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001487
1488 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001489 if (encode == NULL)
1490 return;
1491
1492 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1493 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494}
1495
1496/*
1497 * 4. Get the server port number if not yet set
1498 */
1499static void
1500call_bind(struct rpc_task *task)
1501{
Chuck Leverec739ef2006-08-22 20:06:15 -04001502 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Chuck Lever46121cf2007-01-31 12:14:08 -05001504 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505
Chuck Leverda351872005-08-11 16:25:11 -04001506 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001507 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001508 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001509 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001510 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 }
1512}
1513
1514/*
Chuck Leverda351872005-08-11 16:25:11 -04001515 * 4a. Sort out bind result
1516 */
1517static void
1518call_bind_status(struct rpc_task *task)
1519{
Chuck Lever906462a2007-09-11 18:00:47 -04001520 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001521
1522 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001523 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001524 task->tk_status = 0;
1525 task->tk_action = call_connect;
1526 return;
1527 }
1528
Steve Dickson5753cba2012-02-06 10:08:08 -05001529 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001530 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001531 case -ENOMEM:
1532 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1533 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001534 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001535 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001536 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1537 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001538 /* fail immediately if this is an RPC ping */
1539 if (task->tk_msg.rpc_proc->p_proc == 0) {
1540 status = -EOPNOTSUPP;
1541 break;
1542 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001543 if (task->tk_rebind_retry == 0)
1544 break;
1545 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001546 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001547 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001548 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001549 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001550 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001551 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001552 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001553 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001554 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001555 task->tk_pid);
1556 break;
1557 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001558 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001559 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001560 task->tk_status = 0;
1561 task->tk_action = call_bind;
1562 return;
Chuck Lever012da152009-12-03 15:58:56 -05001563 case -ECONNREFUSED: /* connection problems */
1564 case -ECONNRESET:
1565 case -ENOTCONN:
1566 case -EHOSTDOWN:
1567 case -EHOSTUNREACH:
1568 case -ENETUNREACH:
1569 case -EPIPE:
1570 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1571 task->tk_pid, task->tk_status);
1572 if (!RPC_IS_SOFTCONN(task)) {
1573 rpc_delay(task, 5*HZ);
1574 goto retry_timeout;
1575 }
1576 status = task->tk_status;
1577 break;
Chuck Leverda351872005-08-11 16:25:11 -04001578 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001579 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001580 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001581 }
1582
1583 rpc_exit(task, status);
1584 return;
1585
Trond Myklebustda458282006-08-31 15:44:52 -04001586retry_timeout:
1587 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001588}
1589
1590/*
1591 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 */
1593static void
1594call_connect(struct rpc_task *task)
1595{
Chuck Leverda351872005-08-11 16:25:11 -04001596 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
Chuck Lever46121cf2007-01-31 12:14:08 -05001598 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001599 task->tk_pid, xprt,
1600 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Chuck Leverda351872005-08-11 16:25:11 -04001602 task->tk_action = call_transmit;
1603 if (!xprt_connected(xprt)) {
1604 task->tk_action = call_connect_status;
1605 if (task->tk_status < 0)
1606 return;
1607 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609}
1610
1611/*
Chuck Leverda351872005-08-11 16:25:11 -04001612 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 */
1614static void
1615call_connect_status(struct rpc_task *task)
1616{
1617 struct rpc_clnt *clnt = task->tk_client;
1618 int status = task->tk_status;
1619
Chuck Lever46121cf2007-01-31 12:14:08 -05001620 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001621
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001623 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 clnt->cl_stats->netreconn++;
1625 task->tk_action = call_transmit;
1626 return;
1627 }
1628
Steve Dickson5753cba2012-02-06 10:08:08 -05001629 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001631 /* if soft mounted, test if we've timed out */
1632 case -ETIMEDOUT:
1633 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001634 break;
1635 default:
1636 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 }
1638}
1639
1640/*
1641 * 5. Transmit the RPC request, and wait for reply
1642 */
1643static void
1644call_transmit(struct rpc_task *task)
1645{
Chuck Lever46121cf2007-01-31 12:14:08 -05001646 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
1648 task->tk_action = call_status;
1649 if (task->tk_status < 0)
1650 return;
1651 task->tk_status = xprt_prepare_transmit(task);
1652 if (task->tk_status != 0)
1653 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001654 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001656 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001657 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001658 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001659 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001660 if (task->tk_status != 0) {
1661 /* Was the error nonfatal? */
1662 if (task->tk_status == -EAGAIN)
1663 rpc_delay(task, HZ >> 4);
1664 else
1665 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001666 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001667 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001668 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 xprt_transmit(task);
1670 if (task->tk_status < 0)
1671 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001672 /*
1673 * On success, ensure that we call xprt_end_transmit() before sleeping
1674 * in order to allow access to the socket to other RPC requests.
1675 */
1676 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001677 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001678 return;
1679 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001680 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001681}
1682
1683/*
1684 * 5a. Handle cleanup after a transmission
1685 */
1686static void
1687call_transmit_status(struct rpc_task *task)
1688{
1689 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001690
1691 /*
1692 * Common case: success. Force the compiler to put this
1693 * test first.
1694 */
1695 if (task->tk_status == 0) {
1696 xprt_end_transmit(task);
1697 rpc_task_force_reencode(task);
1698 return;
1699 }
1700
Trond Myklebust15f081c2009-03-11 14:37:57 -04001701 switch (task->tk_status) {
1702 case -EAGAIN:
1703 break;
1704 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001705 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001706 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001707 rpc_task_force_reencode(task);
1708 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001709 /*
1710 * Special cases: if we've been waiting on the
1711 * socket's write_space() callback, or if the
1712 * socket just returned a connection error,
1713 * then hold onto the transport lock.
1714 */
1715 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001716 case -EHOSTDOWN:
1717 case -EHOSTUNREACH:
1718 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001719 if (RPC_IS_SOFTCONN(task)) {
1720 xprt_end_transmit(task);
1721 rpc_exit(task, task->tk_status);
1722 break;
1723 }
1724 case -ECONNRESET:
1725 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001726 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001727 rpc_task_force_reencode(task);
1728 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729}
1730
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001731#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001732/*
1733 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1734 * addition, disconnect on connectivity errors.
1735 */
1736static void
1737call_bc_transmit(struct rpc_task *task)
1738{
1739 struct rpc_rqst *req = task->tk_rqstp;
1740
1741 BUG_ON(task->tk_status != 0);
1742 task->tk_status = xprt_prepare_transmit(task);
1743 if (task->tk_status == -EAGAIN) {
1744 /*
1745 * Could not reserve the transport. Try again after the
1746 * transport is released.
1747 */
1748 task->tk_status = 0;
1749 task->tk_action = call_bc_transmit;
1750 return;
1751 }
1752
1753 task->tk_action = rpc_exit_task;
1754 if (task->tk_status < 0) {
1755 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1756 "error: %d\n", task->tk_status);
1757 return;
1758 }
1759
1760 xprt_transmit(task);
1761 xprt_end_transmit(task);
1762 dprint_status(task);
1763 switch (task->tk_status) {
1764 case 0:
1765 /* Success */
1766 break;
1767 case -EHOSTDOWN:
1768 case -EHOSTUNREACH:
1769 case -ENETUNREACH:
1770 case -ETIMEDOUT:
1771 /*
1772 * Problem reaching the server. Disconnect and let the
1773 * forechannel reestablish the connection. The server will
1774 * have to retransmit the backchannel request and we'll
1775 * reprocess it. Since these ops are idempotent, there's no
1776 * need to cache our reply at this time.
1777 */
1778 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1779 "error: %d\n", task->tk_status);
1780 xprt_conditional_disconnect(task->tk_xprt,
1781 req->rq_connect_cookie);
1782 break;
1783 default:
1784 /*
1785 * We were unable to reply and will have to drop the
1786 * request. The server should reconnect and retransmit.
1787 */
1788 BUG_ON(task->tk_status == -EAGAIN);
1789 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1790 "error: %d\n", task->tk_status);
1791 break;
1792 }
1793 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1794}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001795#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797/*
1798 * 6. Sort out the RPC call status
1799 */
1800static void
1801call_status(struct rpc_task *task)
1802{
1803 struct rpc_clnt *clnt = task->tk_client;
1804 struct rpc_rqst *req = task->tk_rqstp;
1805 int status;
1806
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001807 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1808 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
Chuck Lever46121cf2007-01-31 12:14:08 -05001810 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
1812 status = task->tk_status;
1813 if (status >= 0) {
1814 task->tk_action = call_decode;
1815 return;
1816 }
1817
Steve Dickson5753cba2012-02-06 10:08:08 -05001818 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 task->tk_status = 0;
1820 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001821 case -EHOSTDOWN:
1822 case -EHOSTUNREACH:
1823 case -ENETUNREACH:
1824 /*
1825 * Delay any retries for 3 seconds, then handle as if it
1826 * were a timeout.
1827 */
1828 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 case -ETIMEDOUT:
1830 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001831 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001832 xprt_conditional_disconnect(task->tk_xprt,
1833 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001835 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001837 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001838 rpc_delay(task, 3*HZ);
1839 case -EPIPE:
1840 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 task->tk_action = call_bind;
1842 break;
1843 case -EAGAIN:
1844 task->tk_action = call_transmit;
1845 break;
1846 case -EIO:
1847 /* shutdown or soft timeout */
1848 rpc_exit(task, status);
1849 break;
1850 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001851 if (clnt->cl_chatty)
1852 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 clnt->cl_protname, -status);
1854 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 }
1856}
1857
1858/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001859 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 * We do not release the request slot, so we keep using the
1861 * same XID for all retransmits.
1862 */
1863static void
1864call_timeout(struct rpc_task *task)
1865{
1866 struct rpc_clnt *clnt = task->tk_client;
1867
1868 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001869 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 goto retry;
1871 }
1872
Chuck Lever46121cf2007-01-31 12:14:08 -05001873 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001874 task->tk_timeouts++;
1875
Chuck Lever3a28bec2009-12-03 15:58:56 -05001876 if (RPC_IS_SOFTCONN(task)) {
1877 rpc_exit(task, -ETIMEDOUT);
1878 return;
1879 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001881 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001882 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001883 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001884 clnt->cl_protname,
1885 rcu_dereference(clnt->cl_xprt)->servername);
1886 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001887 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001888 if (task->tk_flags & RPC_TASK_TIMEOUT)
1889 rpc_exit(task, -ETIMEDOUT);
1890 else
1891 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 return;
1893 }
1894
Chuck Leverf518e35a2006-01-03 09:55:52 +01001895 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001897 if (clnt->cl_chatty) {
1898 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001899 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001900 clnt->cl_protname,
1901 rcu_dereference(clnt->cl_xprt)->servername);
1902 rcu_read_unlock();
1903 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001905 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001906 /*
1907 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1908 * event? RFC2203 requires the server to drop all such requests.
1909 */
1910 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911
1912retry:
1913 clnt->cl_stats->rpcretrans++;
1914 task->tk_action = call_bind;
1915 task->tk_status = 0;
1916}
1917
1918/*
1919 * 7. Decode the RPC reply
1920 */
1921static void
1922call_decode(struct rpc_task *task)
1923{
1924 struct rpc_clnt *clnt = task->tk_client;
1925 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001926 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001927 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928
Vasily Averin726fd6a2011-06-01 16:23:59 +04001929 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
Chuck Leverf518e35a2006-01-03 09:55:52 +01001931 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001932 if (clnt->cl_chatty) {
1933 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001934 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001935 clnt->cl_protname,
1936 rcu_dereference(clnt->cl_xprt)->servername);
1937 rcu_read_unlock();
1938 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1940 }
1941
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001942 /*
1943 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001944 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001945 */
1946 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 req->rq_rcv_buf.len = req->rq_private_buf.len;
1948
1949 /* Check that the softirq receive buffer is valid */
1950 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1951 sizeof(req->rq_rcv_buf)) != 0);
1952
Trond Myklebust1e799b62008-03-21 16:19:41 -04001953 if (req->rq_rcv_buf.len < 12) {
1954 if (!RPC_IS_SOFT(task)) {
1955 task->tk_action = call_bind;
1956 clnt->cl_stats->rpcretrans++;
1957 goto out_retry;
1958 }
1959 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1960 clnt->cl_protname, task->tk_status);
1961 task->tk_action = call_timeout;
1962 goto out_retry;
1963 }
1964
Chuck Leverb0e1c572008-05-21 17:09:19 -04001965 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001966 if (IS_ERR(p)) {
1967 if (p == ERR_PTR(-EAGAIN))
1968 goto out_retry;
1969 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 }
1971
Trond Myklebustabbcf282006-01-03 09:55:03 +01001972 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001974 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1976 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001977 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001978 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1979 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 return;
1981out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001983 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001984 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001985 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001986 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001987 xprt_conditional_disconnect(task->tk_xprt,
1988 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001989 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990}
1991
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001992static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001993rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994{
1995 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001997 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
1999 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002000
2001 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 *p++ = req->rq_xid; /* XID */
2003 *p++ = htonl(RPC_CALL); /* CALL */
2004 *p++ = htonl(RPC_VERSION); /* RPC version */
2005 *p++ = htonl(clnt->cl_prog); /* program number */
2006 *p++ = htonl(clnt->cl_vers); /* program version */
2007 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002008 p = rpcauth_marshcred(task, p);
2009 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2010 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011}
2012
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002013static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002014rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002016 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2018 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002019 __be32 *p = iov->iov_base;
2020 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 int error = -EACCES;
2022
David Howellse8896492006-08-24 15:44:19 -04002023 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2024 /* RFC-1014 says that the representation of XDR data must be a
2025 * multiple of four bytes
2026 * - if it isn't pointer subtraction in the NFS client may give
2027 * undefined results
2028 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002029 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002030 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002031 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002032 goto out_eio;
2033 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 if ((len -= 3) < 0)
2035 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002037 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002039 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002040 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002041 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002043
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2045 if (--len < 0)
2046 goto out_overflow;
2047 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002048 case RPC_AUTH_ERROR:
2049 break;
2050 case RPC_MISMATCH:
2051 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2052 task->tk_pid, __func__);
2053 error = -EPROTONOSUPPORT;
2054 goto out_err;
2055 default:
2056 dprintk("RPC: %5u %s: RPC call rejected, "
2057 "unknown error: %x\n",
2058 task->tk_pid, __func__, n);
2059 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 }
2061 if (--len < 0)
2062 goto out_overflow;
2063 switch ((n = ntohl(*p++))) {
2064 case RPC_AUTH_REJECTEDCRED:
2065 case RPC_AUTH_REJECTEDVERF:
2066 case RPCSEC_GSS_CREDPROBLEM:
2067 case RPCSEC_GSS_CTXPROBLEM:
2068 if (!task->tk_cred_retry)
2069 break;
2070 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002071 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002072 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002074 /* Ensure we obtain a new XID! */
2075 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002076 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002077 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 case RPC_AUTH_BADCRED:
2079 case RPC_AUTH_BADVERF:
2080 /* possibly garbled cred/verf? */
2081 if (!task->tk_garb_retry)
2082 break;
2083 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002084 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002085 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002087 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002089 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002090 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002091 "authentication.\n",
2092 rcu_dereference(clnt->cl_xprt)->servername);
2093 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 break;
2095 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002096 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002097 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 error = -EIO;
2099 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002100 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002101 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 goto out_err;
2103 }
2104 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002105 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002106 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002107 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002109 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110 if (len < 0)
2111 goto out_overflow;
2112 switch ((n = ntohl(*p++))) {
2113 case RPC_SUCCESS:
2114 return p;
2115 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002116 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2117 "by server %s\n", task->tk_pid, __func__,
2118 (unsigned int)clnt->cl_prog,
2119 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002120 error = -EPFNOSUPPORT;
2121 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002123 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2124 "by server %s\n", task->tk_pid, __func__,
2125 (unsigned int)clnt->cl_prog,
2126 (unsigned int)clnt->cl_vers,
2127 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002128 error = -EPROTONOSUPPORT;
2129 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002131 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002132 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002133 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002134 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002135 clnt->cl_prog, clnt->cl_vers,
2136 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002137 error = -EOPNOTSUPP;
2138 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002140 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002141 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 break; /* retry */
2143 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002144 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002145 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 /* Also retry */
2147 }
2148
Trond Myklebustabbcf282006-01-03 09:55:03 +01002149out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002150 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 if (task->tk_garb_retry) {
2152 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002153 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002154 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002156out_retry:
2157 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159out_eio:
2160 error = -EIO;
2161out_err:
2162 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002163 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002164 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002165 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002167 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002168 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002169 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002171
Chuck Lever9f06c712010-12-14 14:59:18 +00002172static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002173{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002174}
2175
Chuck Leverbf269552010-12-14 14:59:29 +00002176static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002177{
2178 return 0;
2179}
2180
2181static struct rpc_procinfo rpcproc_null = {
2182 .p_encode = rpcproc_encode_null,
2183 .p_decode = rpcproc_decode_null,
2184};
2185
Chuck Levercaabea82009-12-03 15:58:56 -05002186static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002187{
2188 struct rpc_message msg = {
2189 .rpc_proc = &rpcproc_null,
2190 };
2191 int err;
2192 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002193 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002194 put_rpccred(msg.rpc_cred);
2195 return err;
2196}
Trond Myklebust188fef12007-06-16 14:18:40 -04002197
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002198struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2199{
2200 struct rpc_message msg = {
2201 .rpc_proc = &rpcproc_null,
2202 .rpc_cred = cred,
2203 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002204 struct rpc_task_setup task_setup_data = {
2205 .rpc_client = clnt,
2206 .rpc_message = &msg,
2207 .callback_ops = &rpc_default_ops,
2208 .flags = flags,
2209 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002210 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002211}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002212EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002213
Trond Myklebust188fef12007-06-16 14:18:40 -04002214#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002215static void rpc_show_header(void)
2216{
Chuck Levercb3997b2008-05-21 17:09:41 -04002217 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2218 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002219}
2220
Chuck Lever38e886e2008-05-21 17:09:33 -04002221static void rpc_show_task(const struct rpc_clnt *clnt,
2222 const struct rpc_task *task)
2223{
2224 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002225
2226 if (RPC_IS_QUEUED(task))
2227 rpc_waitq = rpc_qname(task->tk_waitqueue);
2228
Joe Perchesb3bceda2010-12-21 10:52:24 -05002229 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 -04002230 task->tk_pid, task->tk_flags, task->tk_status,
2231 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2232 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002233 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002234}
2235
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002236void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002237{
2238 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002239 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002240 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002241 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002242
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002243 spin_lock(&sn->rpc_client_lock);
2244 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002245 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002246 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002247 if (!header) {
2248 rpc_show_header();
2249 header++;
2250 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002251 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002252 }
2253 spin_unlock(&clnt->cl_lock);
2254 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002255 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002256}
2257#endif