blob: dd2532c10324cd11b67f4d7bda1e427a7e76fbd3 [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{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400610 /*
611 * To avoid deadlock, never call rpc_shutdown_client from a
612 * workqueue context!
613 */
614 WARN_ON_ONCE(current->flags & PF_WQ_WORKER);
615 might_sleep();
616
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500617 dprintk_rcu("RPC: shutting down %s client for %s\n",
618 clnt->cl_protname,
619 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Trond Myklebust34f52e32007-06-14 16:40:31 -0400621 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800623 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400624 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 }
626
Trond Myklebust4c402b42007-06-14 16:40:32 -0400627 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400629EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400632 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400634static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400635rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500637 dprintk_rcu("RPC: destroying %s client for %s\n",
638 clnt->cl_protname,
639 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500640 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400641 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400642 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400643 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500644 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500645 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500646 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500647 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400648 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650}
651
652/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400653 * Free an RPC client
654 */
655static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400656rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400657{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400658 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400659 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400660 return;
661 }
662
663 /*
664 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
665 * release remaining GSS contexts. This mechanism ensures
666 * that it can do so safely.
667 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400668 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400669 rpcauth_release(clnt->cl_auth);
670 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400671 if (atomic_dec_and_test(&clnt->cl_count))
672 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400673}
674
675/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400676 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 */
678void
679rpc_release_client(struct rpc_clnt *clnt)
680{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400681 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Trond Myklebust34f52e32007-06-14 16:40:31 -0400683 if (list_empty(&clnt->cl_tasks))
684 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400685 if (atomic_dec_and_test(&clnt->cl_count))
686 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400687}
688
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000689/**
690 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800691 * @old: old rpc_client
692 * @program: rpc program to set
693 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000694 *
695 * Clones the rpc client and sets up a new RPC program. This is mainly
696 * of use for enabling different RPC programs to share the same transport.
697 * The Sun NFSv2/v3 ACL protocol can do this.
698 */
699struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500700 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400701 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000702{
703 struct rpc_clnt *clnt;
Trond Myklebusta613fa12012-01-20 13:53:56 -0500704 const struct rpc_version *version;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000705 int err;
706
707 BUG_ON(vers >= program->nrvers || !program->version[vers]);
708 version = program->version[vers];
709 clnt = rpc_clone_client(old);
710 if (IS_ERR(clnt))
711 goto out;
712 clnt->cl_procinfo = version->procs;
713 clnt->cl_maxproc = version->nrprocs;
714 clnt->cl_protname = program->name;
715 clnt->cl_prog = program->number;
716 clnt->cl_vers = version->number;
717 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500718 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000719 if (err != 0) {
720 rpc_shutdown_client(clnt);
721 clnt = ERR_PTR(err);
722 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800723out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000724 return clnt;
725}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400726EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000727
Trond Myklebust58f96122010-07-31 14:29:08 -0400728void rpc_task_release_client(struct rpc_task *task)
729{
730 struct rpc_clnt *clnt = task->tk_client;
731
732 if (clnt != NULL) {
733 /* Remove from client task list */
734 spin_lock(&clnt->cl_lock);
735 list_del(&task->tk_task);
736 spin_unlock(&clnt->cl_lock);
737 task->tk_client = NULL;
738
739 rpc_release_client(clnt);
740 }
741}
742
743static
744void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
745{
746 if (clnt != NULL) {
747 rpc_task_release_client(task);
748 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400749 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400750 if (clnt->cl_softrtry)
751 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700752 if (sk_memalloc_socks()) {
753 struct rpc_xprt *xprt;
754
755 rcu_read_lock();
756 xprt = rcu_dereference(clnt->cl_xprt);
757 if (xprt->swapper)
758 task->tk_flags |= RPC_TASK_SWAPPER;
759 rcu_read_unlock();
760 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400761 /* Add to the client's list of all tasks */
762 spin_lock(&clnt->cl_lock);
763 list_add_tail(&task->tk_task, &clnt->cl_tasks);
764 spin_unlock(&clnt->cl_lock);
765 }
766}
767
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000768void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
769{
770 rpc_task_release_client(task);
771 rpc_task_set_client(task, clnt);
772}
773EXPORT_SYMBOL_GPL(rpc_task_reset_client);
774
775
Trond Myklebust58f96122010-07-31 14:29:08 -0400776static void
777rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
778{
779 if (msg != NULL) {
780 task->tk_msg.rpc_proc = msg->rpc_proc;
781 task->tk_msg.rpc_argp = msg->rpc_argp;
782 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400783 if (msg->rpc_cred != NULL)
784 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400785 }
786}
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788/*
789 * Default callback for async RPC calls
790 */
791static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100792rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
794}
795
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100796static const struct rpc_call_ops rpc_default_ops = {
797 .rpc_call_done = rpc_default_callback,
798};
799
Trond Myklebustc970aa82007-07-14 15:39:59 -0400800/**
801 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
802 * @task_setup_data: pointer to task initialisation data
803 */
804struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400805{
Trond Myklebust19445b92010-04-16 16:41:10 -0400806 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400807
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400808 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400809 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400810 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400811
Trond Myklebust58f96122010-07-31 14:29:08 -0400812 rpc_task_set_client(task, task_setup_data->rpc_client);
813 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
814
Trond Myklebust58f96122010-07-31 14:29:08 -0400815 if (task->tk_action == NULL)
816 rpc_call_start(task);
817
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400818 atomic_inc(&task->tk_count);
819 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400820out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400821 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400822}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400823EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400824
825/**
826 * rpc_call_sync - Perform a synchronous RPC call
827 * @clnt: pointer to RPC client
828 * @msg: RPC call parameters
829 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500831int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
833 struct rpc_task *task;
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400834 struct rpc_task_setup task_setup_data = {
835 .rpc_client = clnt,
836 .rpc_message = msg,
837 .callback_ops = &rpc_default_ops,
838 .flags = flags,
839 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400840 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 BUG_ON(flags & RPC_TASK_ASYNC);
843
Trond Myklebustc970aa82007-07-14 15:39:59 -0400844 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400845 if (IS_ERR(task))
846 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100847 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800848 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 return status;
850}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400851EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400853/**
854 * rpc_call_async - Perform an asynchronous RPC call
855 * @clnt: pointer to RPC client
856 * @msg: RPC call parameters
857 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800858 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400859 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 */
861int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500862rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100863 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864{
865 struct rpc_task *task;
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400866 struct rpc_task_setup task_setup_data = {
867 .rpc_client = clnt,
868 .rpc_message = msg,
869 .callback_ops = tk_ops,
870 .callback_data = data,
871 .flags = flags|RPC_TASK_ASYNC,
872 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Trond Myklebustc970aa82007-07-14 15:39:59 -0400874 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400875 if (IS_ERR(task))
876 return PTR_ERR(task);
877 rpc_put_task(task);
878 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400880EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400882#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400883/**
884 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
885 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400886 * @req: RPC request
887 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400888 */
889struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400890 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400891{
892 struct rpc_task *task;
893 struct xdr_buf *xbufp = &req->rq_snd_buf;
894 struct rpc_task_setup task_setup_data = {
895 .callback_ops = tk_ops,
896 };
897
898 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
899 /*
900 * Create an rpc_task to send the data
901 */
902 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400903 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400904 xprt_free_bc_request(req);
905 goto out;
906 }
907 task->tk_rqstp = req;
908
909 /*
910 * Set up the xdr_buf length.
911 * This also indicates that the buffer is XDR encoded already.
912 */
913 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
914 xbufp->tail[0].iov_len;
915
916 task->tk_action = call_bc_transmit;
917 atomic_inc(&task->tk_count);
918 BUG_ON(atomic_read(&task->tk_count) != 2);
919 rpc_execute(task);
920
921out:
922 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
923 return task;
924}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400925#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400926
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400928rpc_call_start(struct rpc_task *task)
929{
930 task->tk_action = call_start;
931}
932EXPORT_SYMBOL_GPL(rpc_call_start);
933
Chuck Levered394402006-08-22 20:06:17 -0400934/**
935 * rpc_peeraddr - extract remote peer address from clnt's xprt
936 * @clnt: RPC client structure
937 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800938 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400939 *
940 * Returns the number of bytes that are actually in the stored address.
941 */
942size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
943{
944 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500945 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400946
Trond Myklebust2446ab62012-03-01 17:00:56 -0500947 rcu_read_lock();
948 xprt = rcu_dereference(clnt->cl_xprt);
949
950 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400951 if (bytes > bufsize)
952 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500953 memcpy(buf, &xprt->addr, bytes);
954 rcu_read_unlock();
955
956 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400957}
Chuck Leverb86acd52006-08-22 20:06:22 -0400958EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400959
Chuck Leverf425eba2006-08-22 20:06:18 -0400960/**
961 * rpc_peeraddr2str - return remote peer address in printable format
962 * @clnt: RPC client structure
963 * @format: address format
964 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500965 * NB: the lifetime of the memory referenced by the returned pointer is
966 * the same as the rpc_xprt itself. As long as the caller uses this
967 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400968 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500969const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
970 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400971{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500972 struct rpc_xprt *xprt;
973
974 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500975
976 if (xprt->address_strings[format] != NULL)
977 return xprt->address_strings[format];
978 else
979 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400980}
Chuck Leverb86acd52006-08-22 20:06:22 -0400981EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400982
Chuck Lever2e738fd2012-03-01 17:01:14 -0500983static const struct sockaddr_in rpc_inaddr_loopback = {
984 .sin_family = AF_INET,
985 .sin_addr.s_addr = htonl(INADDR_ANY),
986};
987
988static const struct sockaddr_in6 rpc_in6addr_loopback = {
989 .sin6_family = AF_INET6,
990 .sin6_addr = IN6ADDR_ANY_INIT,
991};
992
993/*
994 * Try a getsockname() on a connected datagram socket. Using a
995 * connected datagram socket prevents leaving a socket in TIME_WAIT.
996 * This conserves the ephemeral port number space.
997 *
998 * Returns zero and fills in "buf" if successful; otherwise, a
999 * negative errno is returned.
1000 */
1001static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1002 struct sockaddr *buf, int buflen)
1003{
1004 struct socket *sock;
1005 int err;
1006
1007 err = __sock_create(net, sap->sa_family,
1008 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1009 if (err < 0) {
1010 dprintk("RPC: can't create UDP socket (%d)\n", err);
1011 goto out;
1012 }
1013
1014 switch (sap->sa_family) {
1015 case AF_INET:
1016 err = kernel_bind(sock,
1017 (struct sockaddr *)&rpc_inaddr_loopback,
1018 sizeof(rpc_inaddr_loopback));
1019 break;
1020 case AF_INET6:
1021 err = kernel_bind(sock,
1022 (struct sockaddr *)&rpc_in6addr_loopback,
1023 sizeof(rpc_in6addr_loopback));
1024 break;
1025 default:
1026 err = -EAFNOSUPPORT;
1027 goto out;
1028 }
1029 if (err < 0) {
1030 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1031 goto out_release;
1032 }
1033
1034 err = kernel_connect(sock, sap, salen, 0);
1035 if (err < 0) {
1036 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1037 goto out_release;
1038 }
1039
1040 err = kernel_getsockname(sock, buf, &buflen);
1041 if (err < 0) {
1042 dprintk("RPC: getsockname failed (%d)\n", err);
1043 goto out_release;
1044 }
1045
1046 err = 0;
1047 if (buf->sa_family == AF_INET6) {
1048 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1049 sin6->sin6_scope_id = 0;
1050 }
1051 dprintk("RPC: %s succeeded\n", __func__);
1052
1053out_release:
1054 sock_release(sock);
1055out:
1056 return err;
1057}
1058
1059/*
1060 * Scraping a connected socket failed, so we don't have a useable
1061 * local address. Fallback: generate an address that will prevent
1062 * the server from calling us back.
1063 *
1064 * Returns zero and fills in "buf" if successful; otherwise, a
1065 * negative errno is returned.
1066 */
1067static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1068{
1069 switch (family) {
1070 case AF_INET:
1071 if (buflen < sizeof(rpc_inaddr_loopback))
1072 return -EINVAL;
1073 memcpy(buf, &rpc_inaddr_loopback,
1074 sizeof(rpc_inaddr_loopback));
1075 break;
1076 case AF_INET6:
1077 if (buflen < sizeof(rpc_in6addr_loopback))
1078 return -EINVAL;
1079 memcpy(buf, &rpc_in6addr_loopback,
1080 sizeof(rpc_in6addr_loopback));
1081 default:
1082 dprintk("RPC: %s: address family not supported\n",
1083 __func__);
1084 return -EAFNOSUPPORT;
1085 }
1086 dprintk("RPC: %s: succeeded\n", __func__);
1087 return 0;
1088}
1089
1090/**
1091 * rpc_localaddr - discover local endpoint address for an RPC client
1092 * @clnt: RPC client structure
1093 * @buf: target buffer
1094 * @buflen: size of target buffer, in bytes
1095 *
1096 * Returns zero and fills in "buf" and "buflen" if successful;
1097 * otherwise, a negative errno is returned.
1098 *
1099 * This works even if the underlying transport is not currently connected,
1100 * or if the upper layer never previously provided a source address.
1101 *
1102 * The result of this function call is transient: multiple calls in
1103 * succession may give different results, depending on how local
1104 * networking configuration changes over time.
1105 */
1106int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1107{
1108 struct sockaddr_storage address;
1109 struct sockaddr *sap = (struct sockaddr *)&address;
1110 struct rpc_xprt *xprt;
1111 struct net *net;
1112 size_t salen;
1113 int err;
1114
1115 rcu_read_lock();
1116 xprt = rcu_dereference(clnt->cl_xprt);
1117 salen = xprt->addrlen;
1118 memcpy(sap, &xprt->addr, salen);
1119 net = get_net(xprt->xprt_net);
1120 rcu_read_unlock();
1121
1122 rpc_set_port(sap, 0);
1123 err = rpc_sockname(net, sap, salen, buf, buflen);
1124 put_net(net);
1125 if (err != 0)
1126 /* Couldn't discover local address, return ANYADDR */
1127 return rpc_anyaddr(sap->sa_family, buf, buflen);
1128 return 0;
1129}
1130EXPORT_SYMBOL_GPL(rpc_localaddr);
1131
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132void
1133rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1134{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001135 struct rpc_xprt *xprt;
1136
1137 rcu_read_lock();
1138 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001139 if (xprt->ops->set_buffer_size)
1140 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001141 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001143EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Trond Myklebust2446ab62012-03-01 17:00:56 -05001145/**
1146 * rpc_protocol - Get transport protocol number for an RPC client
1147 * @clnt: RPC client to query
1148 *
1149 */
1150int rpc_protocol(struct rpc_clnt *clnt)
1151{
1152 int protocol;
1153
1154 rcu_read_lock();
1155 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1156 rcu_read_unlock();
1157 return protocol;
1158}
1159EXPORT_SYMBOL_GPL(rpc_protocol);
1160
1161/**
1162 * rpc_net_ns - Get the network namespace for this RPC client
1163 * @clnt: RPC client to query
1164 *
1165 */
1166struct net *rpc_net_ns(struct rpc_clnt *clnt)
1167{
1168 struct net *ret;
1169
1170 rcu_read_lock();
1171 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1172 rcu_read_unlock();
1173 return ret;
1174}
1175EXPORT_SYMBOL_GPL(rpc_net_ns);
1176
1177/**
1178 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1179 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 *
1181 * For stream transports, this is one RPC record fragment (see RFC
1182 * 1831), as we don't support multi-record requests yet. For datagram
1183 * transports, this is the size of an IP packet minus the IP, UDP, and
1184 * RPC header sizes.
1185 */
1186size_t rpc_max_payload(struct rpc_clnt *clnt)
1187{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001188 size_t ret;
1189
1190 rcu_read_lock();
1191 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1192 rcu_read_unlock();
1193 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194}
Chuck Leverb86acd52006-08-22 20:06:22 -04001195EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
Chuck Lever35f5a422006-01-03 09:55:50 +01001197/**
1198 * rpc_force_rebind - force transport to check that remote port is unchanged
1199 * @clnt: client to rebind
1200 *
1201 */
1202void rpc_force_rebind(struct rpc_clnt *clnt)
1203{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001204 if (clnt->cl_autobind) {
1205 rcu_read_lock();
1206 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1207 rcu_read_unlock();
1208 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001209}
Chuck Leverb86acd52006-08-22 20:06:22 -04001210EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001211
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001213 * Restart an (async) RPC call from the call_prepare state.
1214 * Usually called from within the exit handler.
1215 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001216int
Andy Adamsonaae20062009-04-01 09:22:40 -04001217rpc_restart_call_prepare(struct rpc_task *task)
1218{
1219 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001220 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001221 task->tk_action = call_start;
1222 if (task->tk_ops->rpc_call_prepare != NULL)
1223 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001224 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001225}
1226EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1227
1228/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 * Restart an (async) RPC call. Usually called from within the
1230 * exit handler.
1231 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001232int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233rpc_restart_call(struct rpc_task *task)
1234{
1235 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001236 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001238 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001240EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Chuck Lever3748f1e2008-05-21 17:09:12 -04001242#ifdef RPC_DEBUG
1243static const char *rpc_proc_name(const struct rpc_task *task)
1244{
1245 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1246
1247 if (proc) {
1248 if (proc->p_name)
1249 return proc->p_name;
1250 else
1251 return "NULL";
1252 } else
1253 return "no proc";
1254}
1255#endif
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257/*
1258 * 0. Initial state
1259 *
1260 * Other FSM states can be visited zero or more times, but
1261 * this state is visited exactly once for each RPC.
1262 */
1263static void
1264call_start(struct rpc_task *task)
1265{
1266 struct rpc_clnt *clnt = task->tk_client;
1267
Chuck Lever3748f1e2008-05-21 17:09:12 -04001268 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001269 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001270 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001271 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
1273 /* Increment call count */
1274 task->tk_msg.rpc_proc->p_count++;
1275 clnt->cl_stats->rpccnt++;
1276 task->tk_action = call_reserve;
1277}
1278
1279/*
1280 * 1. Reserve an RPC call slot
1281 */
1282static void
1283call_reserve(struct rpc_task *task)
1284{
Chuck Lever46121cf2007-01-31 12:14:08 -05001285 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 task->tk_status = 0;
1288 task->tk_action = call_reserveresult;
1289 xprt_reserve(task);
1290}
1291
1292/*
1293 * 1b. Grok the result of xprt_reserve()
1294 */
1295static void
1296call_reserveresult(struct rpc_task *task)
1297{
1298 int status = task->tk_status;
1299
Chuck Lever46121cf2007-01-31 12:14:08 -05001300 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
1302 /*
1303 * After a call to xprt_reserve(), we must have either
1304 * a request slot or else an error status.
1305 */
1306 task->tk_status = 0;
1307 if (status >= 0) {
1308 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001309 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 return;
1311 }
1312
1313 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001314 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 rpc_exit(task, -EIO);
1316 return;
1317 }
1318
1319 /*
1320 * Even though there was an error, we may have acquired
1321 * a request slot somehow. Make sure not to leak it.
1322 */
1323 if (task->tk_rqstp) {
1324 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001325 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 xprt_release(task);
1327 }
1328
1329 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001330 case -ENOMEM:
1331 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 case -EAGAIN: /* woken up; retry */
1333 task->tk_action = call_reserve;
1334 return;
1335 case -EIO: /* probably a shutdown */
1336 break;
1337 default:
1338 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001339 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 break;
1341 }
1342 rpc_exit(task, status);
1343}
1344
1345/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001346 * 2. Bind and/or refresh the credentials
1347 */
1348static void
1349call_refresh(struct rpc_task *task)
1350{
1351 dprint_status(task);
1352
1353 task->tk_action = call_refreshresult;
1354 task->tk_status = 0;
1355 task->tk_client->cl_stats->rpcauthrefresh++;
1356 rpcauth_refreshcred(task);
1357}
1358
1359/*
1360 * 2a. Process the results of a credential refresh
1361 */
1362static void
1363call_refreshresult(struct rpc_task *task)
1364{
1365 int status = task->tk_status;
1366
1367 dprint_status(task);
1368
1369 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001370 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001371 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001372 case 0:
1373 if (rpcauth_uptodatecred(task))
1374 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001375 return;
1376 case -ETIMEDOUT:
1377 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001378 case -EAGAIN:
1379 status = -EACCES;
1380 if (!task->tk_cred_retry)
1381 break;
1382 task->tk_cred_retry--;
1383 dprintk("RPC: %5u %s: retry refresh creds\n",
1384 task->tk_pid, __func__);
1385 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001386 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001387 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1388 task->tk_pid, __func__, status);
1389 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001390}
1391
1392/*
1393 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001394 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 */
1396static void
1397call_allocate(struct rpc_task *task)
1398{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001399 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001400 struct rpc_rqst *req = task->tk_rqstp;
1401 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001402 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
Chuck Lever46121cf2007-01-31 12:14:08 -05001404 dprint_status(task);
1405
Chuck Lever2bea90d2007-03-29 16:47:53 -04001406 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001407 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001408
Chuck Lever02107142006-01-03 09:55:49 +01001409 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 return;
1411
Chuck Lever2bea90d2007-03-29 16:47:53 -04001412 if (proc->p_proc != 0) {
1413 BUG_ON(proc->p_arglen == 0);
1414 if (proc->p_decode != NULL)
1415 BUG_ON(proc->p_replen == 0);
1416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
Chuck Lever2bea90d2007-03-29 16:47:53 -04001418 /*
1419 * Calculate the size (in quads) of the RPC call
1420 * and reply headers, and convert both values
1421 * to byte sizes.
1422 */
1423 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1424 req->rq_callsize <<= 2;
1425 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1426 req->rq_rcvsize <<= 2;
1427
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001428 req->rq_buffer = xprt->ops->buf_alloc(task,
1429 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001430 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001432
1433 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Trond Myklebust5afa91332011-06-17 10:14:59 -04001435 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001436 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 rpc_delay(task, HZ>>4);
1438 return;
1439 }
1440
1441 rpc_exit(task, -ERESTARTSYS);
1442}
1443
Trond Myklebust940e3312005-11-09 21:45:24 -05001444static inline int
1445rpc_task_need_encode(struct rpc_task *task)
1446{
1447 return task->tk_rqstp->rq_snd_buf.len == 0;
1448}
1449
1450static inline void
1451rpc_task_force_reencode(struct rpc_task *task)
1452{
1453 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001454 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001455}
1456
Chuck Lever2bea90d2007-03-29 16:47:53 -04001457static inline void
1458rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1459{
1460 buf->head[0].iov_base = start;
1461 buf->head[0].iov_len = len;
1462 buf->tail[0].iov_len = 0;
1463 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001464 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001465 buf->len = 0;
1466 buf->buflen = len;
1467}
1468
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469/*
1470 * 3. Encode arguments of an RPC call
1471 */
1472static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001473rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001476 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001477 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Chuck Lever46121cf2007-01-31 12:14:08 -05001479 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Chuck Lever2bea90d2007-03-29 16:47:53 -04001481 rpc_xdr_buf_init(&req->rq_snd_buf,
1482 req->rq_buffer,
1483 req->rq_callsize);
1484 rpc_xdr_buf_init(&req->rq_rcv_buf,
1485 (char *)req->rq_buffer + req->rq_callsize,
1486 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
Chuck Leverb0e1c572008-05-21 17:09:19 -04001488 p = rpc_encode_header(task);
1489 if (p == NULL) {
1490 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 rpc_exit(task, -EIO);
1492 return;
1493 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001494
1495 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001496 if (encode == NULL)
1497 return;
1498
1499 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1500 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
1502
1503/*
1504 * 4. Get the server port number if not yet set
1505 */
1506static void
1507call_bind(struct rpc_task *task)
1508{
Chuck Leverec739ef2006-08-22 20:06:15 -04001509 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Chuck Lever46121cf2007-01-31 12:14:08 -05001511 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Chuck Leverda351872005-08-11 16:25:11 -04001513 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001514 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001515 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001516 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001517 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 }
1519}
1520
1521/*
Chuck Leverda351872005-08-11 16:25:11 -04001522 * 4a. Sort out bind result
1523 */
1524static void
1525call_bind_status(struct rpc_task *task)
1526{
Chuck Lever906462a2007-09-11 18:00:47 -04001527 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001528
1529 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001530 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001531 task->tk_status = 0;
1532 task->tk_action = call_connect;
1533 return;
1534 }
1535
Steve Dickson5753cba2012-02-06 10:08:08 -05001536 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001537 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001538 case -ENOMEM:
1539 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1540 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001541 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001542 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001543 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1544 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001545 /* fail immediately if this is an RPC ping */
1546 if (task->tk_msg.rpc_proc->p_proc == 0) {
1547 status = -EOPNOTSUPP;
1548 break;
1549 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001550 if (task->tk_rebind_retry == 0)
1551 break;
1552 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001553 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001554 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001555 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001556 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001557 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001558 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001559 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001560 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001561 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001562 task->tk_pid);
1563 break;
1564 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001565 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001566 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001567 task->tk_status = 0;
1568 task->tk_action = call_bind;
1569 return;
Chuck Lever012da152009-12-03 15:58:56 -05001570 case -ECONNREFUSED: /* connection problems */
1571 case -ECONNRESET:
1572 case -ENOTCONN:
1573 case -EHOSTDOWN:
1574 case -EHOSTUNREACH:
1575 case -ENETUNREACH:
1576 case -EPIPE:
1577 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1578 task->tk_pid, task->tk_status);
1579 if (!RPC_IS_SOFTCONN(task)) {
1580 rpc_delay(task, 5*HZ);
1581 goto retry_timeout;
1582 }
1583 status = task->tk_status;
1584 break;
Chuck Leverda351872005-08-11 16:25:11 -04001585 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001586 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001587 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001588 }
1589
1590 rpc_exit(task, status);
1591 return;
1592
Trond Myklebustda458282006-08-31 15:44:52 -04001593retry_timeout:
1594 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001595}
1596
1597/*
1598 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 */
1600static void
1601call_connect(struct rpc_task *task)
1602{
Chuck Leverda351872005-08-11 16:25:11 -04001603 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
Chuck Lever46121cf2007-01-31 12:14:08 -05001605 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001606 task->tk_pid, xprt,
1607 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
Chuck Leverda351872005-08-11 16:25:11 -04001609 task->tk_action = call_transmit;
1610 if (!xprt_connected(xprt)) {
1611 task->tk_action = call_connect_status;
1612 if (task->tk_status < 0)
1613 return;
1614 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616}
1617
1618/*
Chuck Leverda351872005-08-11 16:25:11 -04001619 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 */
1621static void
1622call_connect_status(struct rpc_task *task)
1623{
1624 struct rpc_clnt *clnt = task->tk_client;
1625 int status = task->tk_status;
1626
Chuck Lever46121cf2007-01-31 12:14:08 -05001627 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001628
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001630 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 clnt->cl_stats->netreconn++;
1632 task->tk_action = call_transmit;
1633 return;
1634 }
1635
Steve Dickson5753cba2012-02-06 10:08:08 -05001636 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001638 /* if soft mounted, test if we've timed out */
1639 case -ETIMEDOUT:
1640 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001641 break;
1642 default:
1643 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 }
1645}
1646
1647/*
1648 * 5. Transmit the RPC request, and wait for reply
1649 */
1650static void
1651call_transmit(struct rpc_task *task)
1652{
Chuck Lever46121cf2007-01-31 12:14:08 -05001653 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
1655 task->tk_action = call_status;
1656 if (task->tk_status < 0)
1657 return;
1658 task->tk_status = xprt_prepare_transmit(task);
1659 if (task->tk_status != 0)
1660 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001661 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001663 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001664 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001665 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001666 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001667 if (task->tk_status != 0) {
1668 /* Was the error nonfatal? */
1669 if (task->tk_status == -EAGAIN)
1670 rpc_delay(task, HZ >> 4);
1671 else
1672 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001673 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001674 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 xprt_transmit(task);
1677 if (task->tk_status < 0)
1678 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001679 /*
1680 * On success, ensure that we call xprt_end_transmit() before sleeping
1681 * in order to allow access to the socket to other RPC requests.
1682 */
1683 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001684 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001685 return;
1686 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001687 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001688}
1689
1690/*
1691 * 5a. Handle cleanup after a transmission
1692 */
1693static void
1694call_transmit_status(struct rpc_task *task)
1695{
1696 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001697
1698 /*
1699 * Common case: success. Force the compiler to put this
1700 * test first.
1701 */
1702 if (task->tk_status == 0) {
1703 xprt_end_transmit(task);
1704 rpc_task_force_reencode(task);
1705 return;
1706 }
1707
Trond Myklebust15f081c2009-03-11 14:37:57 -04001708 switch (task->tk_status) {
1709 case -EAGAIN:
1710 break;
1711 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001712 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001713 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001714 rpc_task_force_reencode(task);
1715 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001716 /*
1717 * Special cases: if we've been waiting on the
1718 * socket's write_space() callback, or if the
1719 * socket just returned a connection error,
1720 * then hold onto the transport lock.
1721 */
1722 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001723 case -EHOSTDOWN:
1724 case -EHOSTUNREACH:
1725 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001726 if (RPC_IS_SOFTCONN(task)) {
1727 xprt_end_transmit(task);
1728 rpc_exit(task, task->tk_status);
1729 break;
1730 }
1731 case -ECONNRESET:
1732 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001733 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001734 rpc_task_force_reencode(task);
1735 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736}
1737
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001738#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001739/*
1740 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1741 * addition, disconnect on connectivity errors.
1742 */
1743static void
1744call_bc_transmit(struct rpc_task *task)
1745{
1746 struct rpc_rqst *req = task->tk_rqstp;
1747
1748 BUG_ON(task->tk_status != 0);
1749 task->tk_status = xprt_prepare_transmit(task);
1750 if (task->tk_status == -EAGAIN) {
1751 /*
1752 * Could not reserve the transport. Try again after the
1753 * transport is released.
1754 */
1755 task->tk_status = 0;
1756 task->tk_action = call_bc_transmit;
1757 return;
1758 }
1759
1760 task->tk_action = rpc_exit_task;
1761 if (task->tk_status < 0) {
1762 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1763 "error: %d\n", task->tk_status);
1764 return;
1765 }
1766
1767 xprt_transmit(task);
1768 xprt_end_transmit(task);
1769 dprint_status(task);
1770 switch (task->tk_status) {
1771 case 0:
1772 /* Success */
1773 break;
1774 case -EHOSTDOWN:
1775 case -EHOSTUNREACH:
1776 case -ENETUNREACH:
1777 case -ETIMEDOUT:
1778 /*
1779 * Problem reaching the server. Disconnect and let the
1780 * forechannel reestablish the connection. The server will
1781 * have to retransmit the backchannel request and we'll
1782 * reprocess it. Since these ops are idempotent, there's no
1783 * need to cache our reply at this time.
1784 */
1785 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1786 "error: %d\n", task->tk_status);
1787 xprt_conditional_disconnect(task->tk_xprt,
1788 req->rq_connect_cookie);
1789 break;
1790 default:
1791 /*
1792 * We were unable to reply and will have to drop the
1793 * request. The server should reconnect and retransmit.
1794 */
1795 BUG_ON(task->tk_status == -EAGAIN);
1796 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1797 "error: %d\n", task->tk_status);
1798 break;
1799 }
1800 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1801}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001802#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001803
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804/*
1805 * 6. Sort out the RPC call status
1806 */
1807static void
1808call_status(struct rpc_task *task)
1809{
1810 struct rpc_clnt *clnt = task->tk_client;
1811 struct rpc_rqst *req = task->tk_rqstp;
1812 int status;
1813
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001814 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1815 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Chuck Lever46121cf2007-01-31 12:14:08 -05001817 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818
1819 status = task->tk_status;
1820 if (status >= 0) {
1821 task->tk_action = call_decode;
1822 return;
1823 }
1824
Steve Dickson5753cba2012-02-06 10:08:08 -05001825 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 task->tk_status = 0;
1827 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001828 case -EHOSTDOWN:
1829 case -EHOSTUNREACH:
1830 case -ENETUNREACH:
1831 /*
1832 * Delay any retries for 3 seconds, then handle as if it
1833 * were a timeout.
1834 */
1835 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 case -ETIMEDOUT:
1837 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001838 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001839 xprt_conditional_disconnect(task->tk_xprt,
1840 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001842 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001844 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001845 rpc_delay(task, 3*HZ);
1846 case -EPIPE:
1847 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 task->tk_action = call_bind;
1849 break;
1850 case -EAGAIN:
1851 task->tk_action = call_transmit;
1852 break;
1853 case -EIO:
1854 /* shutdown or soft timeout */
1855 rpc_exit(task, status);
1856 break;
1857 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001858 if (clnt->cl_chatty)
1859 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 clnt->cl_protname, -status);
1861 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 }
1863}
1864
1865/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001866 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 * We do not release the request slot, so we keep using the
1868 * same XID for all retransmits.
1869 */
1870static void
1871call_timeout(struct rpc_task *task)
1872{
1873 struct rpc_clnt *clnt = task->tk_client;
1874
1875 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001876 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 goto retry;
1878 }
1879
Chuck Lever46121cf2007-01-31 12:14:08 -05001880 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001881 task->tk_timeouts++;
1882
Chuck Lever3a28bec2009-12-03 15:58:56 -05001883 if (RPC_IS_SOFTCONN(task)) {
1884 rpc_exit(task, -ETIMEDOUT);
1885 return;
1886 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001888 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001889 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001890 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001891 clnt->cl_protname,
1892 rcu_dereference(clnt->cl_xprt)->servername);
1893 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001894 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001895 if (task->tk_flags & RPC_TASK_TIMEOUT)
1896 rpc_exit(task, -ETIMEDOUT);
1897 else
1898 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 return;
1900 }
1901
Chuck Leverf518e35a2006-01-03 09:55:52 +01001902 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001904 if (clnt->cl_chatty) {
1905 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001906 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001907 clnt->cl_protname,
1908 rcu_dereference(clnt->cl_xprt)->servername);
1909 rcu_read_unlock();
1910 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001912 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001913 /*
1914 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1915 * event? RFC2203 requires the server to drop all such requests.
1916 */
1917 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
1919retry:
1920 clnt->cl_stats->rpcretrans++;
1921 task->tk_action = call_bind;
1922 task->tk_status = 0;
1923}
1924
1925/*
1926 * 7. Decode the RPC reply
1927 */
1928static void
1929call_decode(struct rpc_task *task)
1930{
1931 struct rpc_clnt *clnt = task->tk_client;
1932 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001933 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001934 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
Vasily Averin726fd6a2011-06-01 16:23:59 +04001936 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937
Chuck Leverf518e35a2006-01-03 09:55:52 +01001938 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001939 if (clnt->cl_chatty) {
1940 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001941 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001942 clnt->cl_protname,
1943 rcu_dereference(clnt->cl_xprt)->servername);
1944 rcu_read_unlock();
1945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1947 }
1948
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001949 /*
1950 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001951 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001952 */
1953 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 req->rq_rcv_buf.len = req->rq_private_buf.len;
1955
1956 /* Check that the softirq receive buffer is valid */
1957 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1958 sizeof(req->rq_rcv_buf)) != 0);
1959
Trond Myklebust1e799b62008-03-21 16:19:41 -04001960 if (req->rq_rcv_buf.len < 12) {
1961 if (!RPC_IS_SOFT(task)) {
1962 task->tk_action = call_bind;
1963 clnt->cl_stats->rpcretrans++;
1964 goto out_retry;
1965 }
1966 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1967 clnt->cl_protname, task->tk_status);
1968 task->tk_action = call_timeout;
1969 goto out_retry;
1970 }
1971
Chuck Leverb0e1c572008-05-21 17:09:19 -04001972 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001973 if (IS_ERR(p)) {
1974 if (p == ERR_PTR(-EAGAIN))
1975 goto out_retry;
1976 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 }
1978
Trond Myklebustabbcf282006-01-03 09:55:03 +01001979 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001981 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1983 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001984 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001985 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1986 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 return;
1988out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001990 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001991 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001992 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001993 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001994 xprt_conditional_disconnect(task->tk_xprt,
1995 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001996 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997}
1998
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001999static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002000rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001{
2002 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002004 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005
2006 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002007
2008 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 *p++ = req->rq_xid; /* XID */
2010 *p++ = htonl(RPC_CALL); /* CALL */
2011 *p++ = htonl(RPC_VERSION); /* RPC version */
2012 *p++ = htonl(clnt->cl_prog); /* program number */
2013 *p++ = htonl(clnt->cl_vers); /* program version */
2014 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002015 p = rpcauth_marshcred(task, p);
2016 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2017 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018}
2019
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002020static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002021rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002023 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2025 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002026 __be32 *p = iov->iov_base;
2027 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 int error = -EACCES;
2029
David Howellse8896492006-08-24 15:44:19 -04002030 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2031 /* RFC-1014 says that the representation of XDR data must be a
2032 * multiple of four bytes
2033 * - if it isn't pointer subtraction in the NFS client may give
2034 * undefined results
2035 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002036 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002037 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002038 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002039 goto out_eio;
2040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 if ((len -= 3) < 0)
2042 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002044 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002046 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002047 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002048 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002050
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2052 if (--len < 0)
2053 goto out_overflow;
2054 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002055 case RPC_AUTH_ERROR:
2056 break;
2057 case RPC_MISMATCH:
2058 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2059 task->tk_pid, __func__);
2060 error = -EPROTONOSUPPORT;
2061 goto out_err;
2062 default:
2063 dprintk("RPC: %5u %s: RPC call rejected, "
2064 "unknown error: %x\n",
2065 task->tk_pid, __func__, n);
2066 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 }
2068 if (--len < 0)
2069 goto out_overflow;
2070 switch ((n = ntohl(*p++))) {
2071 case RPC_AUTH_REJECTEDCRED:
2072 case RPC_AUTH_REJECTEDVERF:
2073 case RPCSEC_GSS_CREDPROBLEM:
2074 case RPCSEC_GSS_CTXPROBLEM:
2075 if (!task->tk_cred_retry)
2076 break;
2077 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002078 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002079 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002081 /* Ensure we obtain a new XID! */
2082 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002083 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002084 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 case RPC_AUTH_BADCRED:
2086 case RPC_AUTH_BADVERF:
2087 /* possibly garbled cred/verf? */
2088 if (!task->tk_garb_retry)
2089 break;
2090 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002091 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002092 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002094 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002096 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002097 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002098 "authentication.\n",
2099 rcu_dereference(clnt->cl_xprt)->servername);
2100 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 break;
2102 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002103 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002104 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 error = -EIO;
2106 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002107 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002108 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 goto out_err;
2110 }
2111 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002112 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002113 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002114 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002116 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 if (len < 0)
2118 goto out_overflow;
2119 switch ((n = ntohl(*p++))) {
2120 case RPC_SUCCESS:
2121 return p;
2122 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002123 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2124 "by server %s\n", task->tk_pid, __func__,
2125 (unsigned int)clnt->cl_prog,
2126 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002127 error = -EPFNOSUPPORT;
2128 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002130 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2131 "by server %s\n", task->tk_pid, __func__,
2132 (unsigned int)clnt->cl_prog,
2133 (unsigned int)clnt->cl_vers,
2134 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002135 error = -EPROTONOSUPPORT;
2136 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002138 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002139 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002140 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002141 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002142 clnt->cl_prog, clnt->cl_vers,
2143 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002144 error = -EOPNOTSUPP;
2145 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002147 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002148 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 break; /* retry */
2150 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002151 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002152 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 /* Also retry */
2154 }
2155
Trond Myklebustabbcf282006-01-03 09:55:03 +01002156out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002157 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 if (task->tk_garb_retry) {
2159 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002160 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002161 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002163out_retry:
2164 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166out_eio:
2167 error = -EIO;
2168out_err:
2169 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002170 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002171 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002172 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002174 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002175 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002176 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002178
Chuck Lever9f06c712010-12-14 14:59:18 +00002179static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002180{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002181}
2182
Chuck Leverbf269552010-12-14 14:59:29 +00002183static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002184{
2185 return 0;
2186}
2187
2188static struct rpc_procinfo rpcproc_null = {
2189 .p_encode = rpcproc_encode_null,
2190 .p_decode = rpcproc_decode_null,
2191};
2192
Chuck Levercaabea82009-12-03 15:58:56 -05002193static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002194{
2195 struct rpc_message msg = {
2196 .rpc_proc = &rpcproc_null,
2197 };
2198 int err;
2199 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002200 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002201 put_rpccred(msg.rpc_cred);
2202 return err;
2203}
Trond Myklebust188fef12007-06-16 14:18:40 -04002204
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002205struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2206{
2207 struct rpc_message msg = {
2208 .rpc_proc = &rpcproc_null,
2209 .rpc_cred = cred,
2210 };
Trond Myklebust84115e1c2007-07-14 15:39:59 -04002211 struct rpc_task_setup task_setup_data = {
2212 .rpc_client = clnt,
2213 .rpc_message = &msg,
2214 .callback_ops = &rpc_default_ops,
2215 .flags = flags,
2216 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002217 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002218}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002219EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002220
Trond Myklebust188fef12007-06-16 14:18:40 -04002221#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002222static void rpc_show_header(void)
2223{
Chuck Levercb3997b2008-05-21 17:09:41 -04002224 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2225 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002226}
2227
Chuck Lever38e886e2008-05-21 17:09:33 -04002228static void rpc_show_task(const struct rpc_clnt *clnt,
2229 const struct rpc_task *task)
2230{
2231 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002232
2233 if (RPC_IS_QUEUED(task))
2234 rpc_waitq = rpc_qname(task->tk_waitqueue);
2235
Joe Perchesb3bceda2010-12-21 10:52:24 -05002236 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 -04002237 task->tk_pid, task->tk_flags, task->tk_status,
2238 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2239 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002240 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002241}
2242
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002243void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002244{
2245 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002246 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002247 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002248 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002249
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002250 spin_lock(&sn->rpc_client_lock);
2251 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002252 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002253 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002254 if (!header) {
2255 rpc_show_header();
2256 header++;
2257 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002258 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002259 }
2260 spin_unlock(&clnt->cl_lock);
2261 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002262 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002263}
2264#endif