blob: adf2990acebfd2ff7513f2344f0a143c326eb6ef [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];
130 struct qstr q = {
131 .name = name,
132 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 int error;
135
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400136 dir = rpc_d_lookup_sb(sb, dir_name);
137 if (dir == NULL)
138 return dir;
139 for (;;) {
140 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
141 name[sizeof(name) - 1] = '\0';
142 q.hash = full_name_hash(q.name, q.len);
143 dentry = rpc_create_client_dir(dir, &q, clnt);
144 if (!IS_ERR(dentry))
145 break;
146 error = PTR_ERR(dentry);
147 if (error != -EEXIST) {
148 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
149 " %s/%s, error %d\n",
150 dir_name, name, error);
151 break;
152 }
153 }
154 dput(dir);
155 return dentry;
156}
157
158static int
Trond Myklebust080b7942012-01-20 13:53:56 -0500159rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400160{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500161 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400162 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400163 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400164
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400165 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 if (dir_name == NULL)
167 return 0;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500168 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400169 if (!pipefs_sb)
170 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400171 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500172 rpc_put_sb_net(net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400173 if (IS_ERR(dentry))
174 return PTR_ERR(dentry);
175 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400176 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177}
178
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400179static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
180{
181 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
182 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
183 return 1;
184 return 0;
185}
186
187static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
188 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400189{
190 struct dentry *dentry;
191 int err = 0;
192
193 switch (event) {
194 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 dentry = rpc_setup_pipedir_sb(sb, clnt,
196 clnt->cl_program->pipe_dir_name);
197 BUG_ON(dentry == NULL);
198 if (IS_ERR(dentry))
199 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400200 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400201 if (clnt->cl_auth->au_ops->pipes_create) {
202 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
203 if (err)
204 __rpc_clnt_remove_pipedir(clnt);
205 }
206 break;
207 case RPC_PIPEFS_UMOUNT:
208 __rpc_clnt_remove_pipedir(clnt);
209 break;
210 default:
211 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
212 return -ENOTSUPP;
213 }
214 return err;
215}
216
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400217static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
218 struct super_block *sb)
219{
220 int error = 0;
221
222 for (;; clnt = clnt->cl_parent) {
223 if (!rpc_clnt_skip_event(clnt, event))
224 error = __rpc_clnt_handle_event(clnt, event, sb);
225 if (error || clnt == clnt->cl_parent)
226 break;
227 }
228 return error;
229}
230
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400231static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
232{
233 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
234 struct rpc_clnt *clnt;
235
236 spin_lock(&sn->rpc_client_lock);
237 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400238 if (clnt->cl_program->pipe_dir_name == NULL)
239 break;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400240 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400241 continue;
Stanislav Kinsburskya4dff1b2012-04-20 18:11:02 +0400242 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
243 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 spin_unlock(&sn->rpc_client_lock);
245 return clnt;
246 }
247 spin_unlock(&sn->rpc_client_lock);
248 return NULL;
249}
250
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400251static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
252 void *ptr)
253{
254 struct super_block *sb = ptr;
255 struct rpc_clnt *clnt;
256 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400257
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400258 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400259 error = __rpc_pipefs_event(clnt, event, sb);
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400260 rpc_release_client(clnt);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400261 if (error)
262 break;
263 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400264 return error;
265}
266
267static struct notifier_block rpc_clients_block = {
268 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400269 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400270};
271
272int rpc_clients_notifier_register(void)
273{
274 return rpc_pipefs_notifier_register(&rpc_clients_block);
275}
276
277void rpc_clients_notifier_unregister(void)
278{
279 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
280}
281
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400282static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
283{
284 clnt->cl_nodelen = strlen(nodename);
285 if (clnt->cl_nodelen > UNX_MAXNODENAME)
286 clnt->cl_nodelen = UNX_MAXNODENAME;
287 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
288}
289
Trond Myklebust698b6d02007-12-20 16:03:53 -0500290static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500292 const struct rpc_program *program = args->program;
293 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000295 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400297
298 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500299 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500300 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
Trond Myklebust4ada5392007-06-14 17:26:17 -0400302 err = rpciod_up();
303 if (err)
304 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 err = -EINVAL;
306 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800307 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500308
309 if (args->version >= program->nrvers)
310 goto out_err;
311 version = program->version[args->version];
312 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 goto out_err;
314
315 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700316 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 if (!clnt)
318 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 clnt->cl_parent = clnt;
320
Trond Myklebust2446ab62012-03-01 17:00:56 -0500321 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 clnt->cl_procinfo = version->procs;
323 clnt->cl_maxproc = version->nrprocs;
324 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300325 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500328 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500329 err = -ENOMEM;
330 if (clnt->cl_metrics == NULL)
331 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500332 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400333 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400334 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Trond Myklebust2446ab62012-03-01 17:00:56 -0500336 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 clnt->cl_autobind = 1;
338
Trond Myklebustba7392b2007-12-20 16:03:55 -0500339 clnt->cl_timeout = xprt->timeout;
340 if (args->timeout != NULL) {
341 memcpy(&clnt->cl_timeout_default, args->timeout,
342 sizeof(clnt->cl_timeout_default));
343 clnt->cl_timeout = &clnt->cl_timeout_default;
344 }
345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500347 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500348 clnt->cl_principal = NULL;
349 if (args->client_name) {
350 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
351 if (!clnt->cl_principal)
352 goto out_no_principal;
353 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Trond Myklebust006abe82010-09-12 19:55:25 -0400355 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
358 if (err < 0)
359 goto out_no_path;
360
Trond Myklebust698b6d02007-12-20 16:03:53 -0500361 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000362 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500364 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000365 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 goto out_no_auth;
367 }
368
369 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400370 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400371 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 return clnt;
373
374out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400375 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500377 kfree(clnt->cl_principal);
378out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500379 rpc_free_iostats(clnt->cl_metrics);
380out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 kfree(clnt);
382out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400383 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800384out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400385 rpciod_down();
386out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 return ERR_PTR(err);
388}
389
Chuck Leverc2866762006-08-22 20:06:20 -0400390/*
391 * rpc_create - create an RPC client and transport with one call
392 * @args: rpc_clnt create argument structure
393 *
394 * Creates and initializes an RPC transport and an RPC client.
395 *
396 * It can ping the server in order to determine if it is up, and to see if
397 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
398 * this behavior so asynchronous tasks can also use rpc_create.
399 */
400struct rpc_clnt *rpc_create(struct rpc_create_args *args)
401{
402 struct rpc_xprt *xprt;
403 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b02007-09-10 13:47:07 -0400404 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400405 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400406 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200407 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200408 .dstaddr = args->address,
409 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500410 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300411 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200412 };
Chuck Lever510deb02007-12-10 14:56:24 -0500413 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400414
Chuck Leverc2866762006-08-22 20:06:20 -0400415 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400416 * If the caller chooses not to specify a hostname, whip
417 * up a string representation of the passed-in address.
418 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500419 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400420 struct sockaddr_un *sun =
421 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400422 struct sockaddr_in *sin =
423 (struct sockaddr_in *)args->address;
424 struct sockaddr_in6 *sin6 =
425 (struct sockaddr_in6 *)args->address;
426
Chuck Lever510deb02007-12-10 14:56:24 -0500427 servername[0] = '\0';
428 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400429 case AF_LOCAL:
430 snprintf(servername, sizeof(servername), "%s",
431 sun->sun_path);
432 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400433 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700434 snprintf(servername, sizeof(servername), "%pI4",
435 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500436 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400437 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700438 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400439 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500440 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500441 default:
442 /* caller wants default server name, but
443 * address family isn't recognized. */
444 return ERR_PTR(-EINVAL);
445 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500446 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400447 }
448
Chuck Lever510deb02007-12-10 14:56:24 -0500449 xprt = xprt_create_transport(&xprtargs);
450 if (IS_ERR(xprt))
451 return (struct rpc_clnt *)xprt;
452
Chuck Lever43780b82007-07-01 12:13:22 -0400453 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400454 * By default, kernel RPC client connects from a reserved port.
455 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
456 * but it is always enabled for rpciod, which handles the connect
457 * operation.
458 */
459 xprt->resvport = 1;
460 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
461 xprt->resvport = 0;
462
Trond Myklebust698b6d02007-12-20 16:03:53 -0500463 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400464 if (IS_ERR(clnt))
465 return clnt;
466
467 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500468 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400469 if (err != 0) {
470 rpc_shutdown_client(clnt);
471 return ERR_PTR(err);
472 }
473 }
474
475 clnt->cl_softrtry = 1;
476 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
477 clnt->cl_softrtry = 0;
478
Chuck Leverc2866762006-08-22 20:06:20 -0400479 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
480 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500481 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
482 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400483 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
484 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400485
486 return clnt;
487}
Chuck Leverb86acd52006-08-22 20:06:22 -0400488EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490/*
491 * This function clones the RPC client structure. It allows us to share the
492 * same transport while varying parameters such as the authentication
493 * flavour.
494 */
495struct rpc_clnt *
496rpc_clone_client(struct rpc_clnt *clnt)
497{
498 struct rpc_clnt *new;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500499 struct rpc_xprt *xprt;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500500 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200502 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 if (!new)
504 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400505 new->cl_parent = clnt;
506 /* Turn off autobind on clones */
507 new->cl_autobind = 0;
508 INIT_LIST_HEAD(&new->cl_tasks);
509 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500510 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500511 new->cl_metrics = rpc_alloc_iostats(clnt);
512 if (new->cl_metrics == NULL)
513 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500514 if (clnt->cl_principal) {
515 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
516 if (new->cl_principal == NULL)
517 goto out_no_principal;
518 }
Trond Myklebust2446ab62012-03-01 17:00:56 -0500519 rcu_read_lock();
520 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
521 rcu_read_unlock();
522 if (xprt == NULL)
523 goto out_no_transport;
524 rcu_assign_pointer(new->cl_xprt, xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400525 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500526 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
527 if (err != 0)
528 goto out_no_path;
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400529 rpc_clnt_set_nodename(new, utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 if (new->cl_auth)
531 atomic_inc(&new->cl_auth->au_count);
Trond Myklebust006abe82010-09-12 19:55:25 -0400532 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400533 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400534 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500536out_no_path:
Trond Myklebust2446ab62012-03-01 17:00:56 -0500537 xprt_put(xprt);
538out_no_transport:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500539 kfree(new->cl_principal);
540out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500541 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500542out_no_stats:
543 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800545 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500546 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400548EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400551 * Kill all tasks for the given client.
552 * XXX: kill their descendants as well?
553 */
554void rpc_killall_tasks(struct rpc_clnt *clnt)
555{
556 struct rpc_task *rovr;
557
558
559 if (list_empty(&clnt->cl_tasks))
560 return;
561 dprintk("RPC: killing all tasks for client %p\n", clnt);
562 /*
563 * Spin lock all_tasks to prevent changes...
564 */
565 spin_lock(&clnt->cl_lock);
566 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
567 if (!RPC_IS_ACTIVATED(rovr))
568 continue;
569 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
570 rovr->tk_flags |= RPC_TASK_KILLED;
571 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300572 if (RPC_IS_QUEUED(rovr))
573 rpc_wake_up_queued_task(rovr->tk_waitqueue,
574 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400575 }
576 }
577 spin_unlock(&clnt->cl_lock);
578}
579EXPORT_SYMBOL_GPL(rpc_killall_tasks);
580
581/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400583 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400585void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500587 dprintk_rcu("RPC: shutting down %s client for %s\n",
588 clnt->cl_protname,
589 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Trond Myklebust34f52e32007-06-14 16:40:31 -0400591 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800593 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400594 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 }
596
Trond Myklebust4c402b42007-06-14 16:40:32 -0400597 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400599EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
601/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400602 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400604static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400605rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500607 dprintk_rcu("RPC: destroying %s client for %s\n",
608 clnt->cl_protname,
609 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500610 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400611 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400612 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400613 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500614 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500615 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500616 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500617 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400618 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
621
622/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400623 * Free an RPC client
624 */
625static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400626rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400627{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400628 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400629 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400630 return;
631 }
632
633 /*
634 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
635 * release remaining GSS contexts. This mechanism ensures
636 * that it can do so safely.
637 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400638 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400639 rpcauth_release(clnt->cl_auth);
640 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400641 if (atomic_dec_and_test(&clnt->cl_count))
642 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400643}
644
645/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400646 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 */
648void
649rpc_release_client(struct rpc_clnt *clnt)
650{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400651 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Trond Myklebust34f52e32007-06-14 16:40:31 -0400653 if (list_empty(&clnt->cl_tasks))
654 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400655 if (atomic_dec_and_test(&clnt->cl_count))
656 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400657}
658
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000659/**
660 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800661 * @old: old rpc_client
662 * @program: rpc program to set
663 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000664 *
665 * Clones the rpc client and sets up a new RPC program. This is mainly
666 * of use for enabling different RPC programs to share the same transport.
667 * The Sun NFSv2/v3 ACL protocol can do this.
668 */
669struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500670 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400671 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000672{
673 struct rpc_clnt *clnt;
Trond Myklebusta613fa12012-01-20 13:53:56 -0500674 const struct rpc_version *version;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000675 int err;
676
677 BUG_ON(vers >= program->nrvers || !program->version[vers]);
678 version = program->version[vers];
679 clnt = rpc_clone_client(old);
680 if (IS_ERR(clnt))
681 goto out;
682 clnt->cl_procinfo = version->procs;
683 clnt->cl_maxproc = version->nrprocs;
684 clnt->cl_protname = program->name;
685 clnt->cl_prog = program->number;
686 clnt->cl_vers = version->number;
687 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500688 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000689 if (err != 0) {
690 rpc_shutdown_client(clnt);
691 clnt = ERR_PTR(err);
692 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800693out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000694 return clnt;
695}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400696EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000697
Trond Myklebust58f96122010-07-31 14:29:08 -0400698void rpc_task_release_client(struct rpc_task *task)
699{
700 struct rpc_clnt *clnt = task->tk_client;
701
702 if (clnt != NULL) {
703 /* Remove from client task list */
704 spin_lock(&clnt->cl_lock);
705 list_del(&task->tk_task);
706 spin_unlock(&clnt->cl_lock);
707 task->tk_client = NULL;
708
709 rpc_release_client(clnt);
710 }
711}
712
713static
714void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
715{
716 if (clnt != NULL) {
717 rpc_task_release_client(task);
718 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400719 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400720 if (clnt->cl_softrtry)
721 task->tk_flags |= RPC_TASK_SOFT;
722 /* Add to the client's list of all tasks */
723 spin_lock(&clnt->cl_lock);
724 list_add_tail(&task->tk_task, &clnt->cl_tasks);
725 spin_unlock(&clnt->cl_lock);
726 }
727}
728
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000729void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
730{
731 rpc_task_release_client(task);
732 rpc_task_set_client(task, clnt);
733}
734EXPORT_SYMBOL_GPL(rpc_task_reset_client);
735
736
Trond Myklebust58f96122010-07-31 14:29:08 -0400737static void
738rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
739{
740 if (msg != NULL) {
741 task->tk_msg.rpc_proc = msg->rpc_proc;
742 task->tk_msg.rpc_argp = msg->rpc_argp;
743 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400744 if (msg->rpc_cred != NULL)
745 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400746 }
747}
748
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749/*
750 * Default callback for async RPC calls
751 */
752static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100753rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754{
755}
756
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100757static const struct rpc_call_ops rpc_default_ops = {
758 .rpc_call_done = rpc_default_callback,
759};
760
Trond Myklebustc970aa82007-07-14 15:39:59 -0400761/**
762 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
763 * @task_setup_data: pointer to task initialisation data
764 */
765struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400766{
Trond Myklebust19445b92010-04-16 16:41:10 -0400767 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400768
Trond Myklebust84115e12007-07-14 15:39:59 -0400769 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400770 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400771 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400772
Trond Myklebust58f96122010-07-31 14:29:08 -0400773 rpc_task_set_client(task, task_setup_data->rpc_client);
774 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
775
Trond Myklebust58f96122010-07-31 14:29:08 -0400776 if (task->tk_action == NULL)
777 rpc_call_start(task);
778
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400779 atomic_inc(&task->tk_count);
780 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400781out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400782 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400783}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400784EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400785
786/**
787 * rpc_call_sync - Perform a synchronous RPC call
788 * @clnt: pointer to RPC client
789 * @msg: RPC call parameters
790 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500792int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
794 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400795 struct rpc_task_setup task_setup_data = {
796 .rpc_client = clnt,
797 .rpc_message = msg,
798 .callback_ops = &rpc_default_ops,
799 .flags = flags,
800 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400801 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 BUG_ON(flags & RPC_TASK_ASYNC);
804
Trond Myklebustc970aa82007-07-14 15:39:59 -0400805 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400806 if (IS_ERR(task))
807 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100808 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800809 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 return status;
811}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400812EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400814/**
815 * rpc_call_async - Perform an asynchronous RPC call
816 * @clnt: pointer to RPC client
817 * @msg: RPC call parameters
818 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800819 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400820 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 */
822int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500823rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100824 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
826 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400827 struct rpc_task_setup task_setup_data = {
828 .rpc_client = clnt,
829 .rpc_message = msg,
830 .callback_ops = tk_ops,
831 .callback_data = data,
832 .flags = flags|RPC_TASK_ASYNC,
833 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Trond Myklebustc970aa82007-07-14 15:39:59 -0400835 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400836 if (IS_ERR(task))
837 return PTR_ERR(task);
838 rpc_put_task(task);
839 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400841EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400843#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400844/**
845 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
846 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400847 * @req: RPC request
848 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400849 */
850struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400851 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400852{
853 struct rpc_task *task;
854 struct xdr_buf *xbufp = &req->rq_snd_buf;
855 struct rpc_task_setup task_setup_data = {
856 .callback_ops = tk_ops,
857 };
858
859 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
860 /*
861 * Create an rpc_task to send the data
862 */
863 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400864 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400865 xprt_free_bc_request(req);
866 goto out;
867 }
868 task->tk_rqstp = req;
869
870 /*
871 * Set up the xdr_buf length.
872 * This also indicates that the buffer is XDR encoded already.
873 */
874 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
875 xbufp->tail[0].iov_len;
876
877 task->tk_action = call_bc_transmit;
878 atomic_inc(&task->tk_count);
879 BUG_ON(atomic_read(&task->tk_count) != 2);
880 rpc_execute(task);
881
882out:
883 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
884 return task;
885}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400886#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400887
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400889rpc_call_start(struct rpc_task *task)
890{
891 task->tk_action = call_start;
892}
893EXPORT_SYMBOL_GPL(rpc_call_start);
894
Chuck Levered394402006-08-22 20:06:17 -0400895/**
896 * rpc_peeraddr - extract remote peer address from clnt's xprt
897 * @clnt: RPC client structure
898 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800899 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400900 *
901 * Returns the number of bytes that are actually in the stored address.
902 */
903size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
904{
905 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500906 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400907
Trond Myklebust2446ab62012-03-01 17:00:56 -0500908 rcu_read_lock();
909 xprt = rcu_dereference(clnt->cl_xprt);
910
911 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400912 if (bytes > bufsize)
913 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500914 memcpy(buf, &xprt->addr, bytes);
915 rcu_read_unlock();
916
917 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400918}
Chuck Leverb86acd52006-08-22 20:06:22 -0400919EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400920
Chuck Leverf425eba2006-08-22 20:06:18 -0400921/**
922 * rpc_peeraddr2str - return remote peer address in printable format
923 * @clnt: RPC client structure
924 * @format: address format
925 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500926 * NB: the lifetime of the memory referenced by the returned pointer is
927 * the same as the rpc_xprt itself. As long as the caller uses this
928 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400929 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500930const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
931 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400932{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500933 struct rpc_xprt *xprt;
934
935 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500936
937 if (xprt->address_strings[format] != NULL)
938 return xprt->address_strings[format];
939 else
940 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400941}
Chuck Leverb86acd52006-08-22 20:06:22 -0400942EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400943
Chuck Lever2e738fd2012-03-01 17:01:14 -0500944static const struct sockaddr_in rpc_inaddr_loopback = {
945 .sin_family = AF_INET,
946 .sin_addr.s_addr = htonl(INADDR_ANY),
947};
948
949static const struct sockaddr_in6 rpc_in6addr_loopback = {
950 .sin6_family = AF_INET6,
951 .sin6_addr = IN6ADDR_ANY_INIT,
952};
953
954/*
955 * Try a getsockname() on a connected datagram socket. Using a
956 * connected datagram socket prevents leaving a socket in TIME_WAIT.
957 * This conserves the ephemeral port number space.
958 *
959 * Returns zero and fills in "buf" if successful; otherwise, a
960 * negative errno is returned.
961 */
962static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
963 struct sockaddr *buf, int buflen)
964{
965 struct socket *sock;
966 int err;
967
968 err = __sock_create(net, sap->sa_family,
969 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
970 if (err < 0) {
971 dprintk("RPC: can't create UDP socket (%d)\n", err);
972 goto out;
973 }
974
975 switch (sap->sa_family) {
976 case AF_INET:
977 err = kernel_bind(sock,
978 (struct sockaddr *)&rpc_inaddr_loopback,
979 sizeof(rpc_inaddr_loopback));
980 break;
981 case AF_INET6:
982 err = kernel_bind(sock,
983 (struct sockaddr *)&rpc_in6addr_loopback,
984 sizeof(rpc_in6addr_loopback));
985 break;
986 default:
987 err = -EAFNOSUPPORT;
988 goto out;
989 }
990 if (err < 0) {
991 dprintk("RPC: can't bind UDP socket (%d)\n", err);
992 goto out_release;
993 }
994
995 err = kernel_connect(sock, sap, salen, 0);
996 if (err < 0) {
997 dprintk("RPC: can't connect UDP socket (%d)\n", err);
998 goto out_release;
999 }
1000
1001 err = kernel_getsockname(sock, buf, &buflen);
1002 if (err < 0) {
1003 dprintk("RPC: getsockname failed (%d)\n", err);
1004 goto out_release;
1005 }
1006
1007 err = 0;
1008 if (buf->sa_family == AF_INET6) {
1009 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1010 sin6->sin6_scope_id = 0;
1011 }
1012 dprintk("RPC: %s succeeded\n", __func__);
1013
1014out_release:
1015 sock_release(sock);
1016out:
1017 return err;
1018}
1019
1020/*
1021 * Scraping a connected socket failed, so we don't have a useable
1022 * local address. Fallback: generate an address that will prevent
1023 * the server from calling us back.
1024 *
1025 * Returns zero and fills in "buf" if successful; otherwise, a
1026 * negative errno is returned.
1027 */
1028static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1029{
1030 switch (family) {
1031 case AF_INET:
1032 if (buflen < sizeof(rpc_inaddr_loopback))
1033 return -EINVAL;
1034 memcpy(buf, &rpc_inaddr_loopback,
1035 sizeof(rpc_inaddr_loopback));
1036 break;
1037 case AF_INET6:
1038 if (buflen < sizeof(rpc_in6addr_loopback))
1039 return -EINVAL;
1040 memcpy(buf, &rpc_in6addr_loopback,
1041 sizeof(rpc_in6addr_loopback));
1042 default:
1043 dprintk("RPC: %s: address family not supported\n",
1044 __func__);
1045 return -EAFNOSUPPORT;
1046 }
1047 dprintk("RPC: %s: succeeded\n", __func__);
1048 return 0;
1049}
1050
1051/**
1052 * rpc_localaddr - discover local endpoint address for an RPC client
1053 * @clnt: RPC client structure
1054 * @buf: target buffer
1055 * @buflen: size of target buffer, in bytes
1056 *
1057 * Returns zero and fills in "buf" and "buflen" if successful;
1058 * otherwise, a negative errno is returned.
1059 *
1060 * This works even if the underlying transport is not currently connected,
1061 * or if the upper layer never previously provided a source address.
1062 *
1063 * The result of this function call is transient: multiple calls in
1064 * succession may give different results, depending on how local
1065 * networking configuration changes over time.
1066 */
1067int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1068{
1069 struct sockaddr_storage address;
1070 struct sockaddr *sap = (struct sockaddr *)&address;
1071 struct rpc_xprt *xprt;
1072 struct net *net;
1073 size_t salen;
1074 int err;
1075
1076 rcu_read_lock();
1077 xprt = rcu_dereference(clnt->cl_xprt);
1078 salen = xprt->addrlen;
1079 memcpy(sap, &xprt->addr, salen);
1080 net = get_net(xprt->xprt_net);
1081 rcu_read_unlock();
1082
1083 rpc_set_port(sap, 0);
1084 err = rpc_sockname(net, sap, salen, buf, buflen);
1085 put_net(net);
1086 if (err != 0)
1087 /* Couldn't discover local address, return ANYADDR */
1088 return rpc_anyaddr(sap->sa_family, buf, buflen);
1089 return 0;
1090}
1091EXPORT_SYMBOL_GPL(rpc_localaddr);
1092
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093void
1094rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1095{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001096 struct rpc_xprt *xprt;
1097
1098 rcu_read_lock();
1099 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001100 if (xprt->ops->set_buffer_size)
1101 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001102 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001104EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
Trond Myklebust2446ab62012-03-01 17:00:56 -05001106/**
1107 * rpc_protocol - Get transport protocol number for an RPC client
1108 * @clnt: RPC client to query
1109 *
1110 */
1111int rpc_protocol(struct rpc_clnt *clnt)
1112{
1113 int protocol;
1114
1115 rcu_read_lock();
1116 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1117 rcu_read_unlock();
1118 return protocol;
1119}
1120EXPORT_SYMBOL_GPL(rpc_protocol);
1121
1122/**
1123 * rpc_net_ns - Get the network namespace for this RPC client
1124 * @clnt: RPC client to query
1125 *
1126 */
1127struct net *rpc_net_ns(struct rpc_clnt *clnt)
1128{
1129 struct net *ret;
1130
1131 rcu_read_lock();
1132 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1133 rcu_read_unlock();
1134 return ret;
1135}
1136EXPORT_SYMBOL_GPL(rpc_net_ns);
1137
1138/**
1139 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1140 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 *
1142 * For stream transports, this is one RPC record fragment (see RFC
1143 * 1831), as we don't support multi-record requests yet. For datagram
1144 * transports, this is the size of an IP packet minus the IP, UDP, and
1145 * RPC header sizes.
1146 */
1147size_t rpc_max_payload(struct rpc_clnt *clnt)
1148{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001149 size_t ret;
1150
1151 rcu_read_lock();
1152 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1153 rcu_read_unlock();
1154 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155}
Chuck Leverb86acd52006-08-22 20:06:22 -04001156EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
Chuck Lever35f5a422006-01-03 09:55:50 +01001158/**
1159 * rpc_force_rebind - force transport to check that remote port is unchanged
1160 * @clnt: client to rebind
1161 *
1162 */
1163void rpc_force_rebind(struct rpc_clnt *clnt)
1164{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001165 if (clnt->cl_autobind) {
1166 rcu_read_lock();
1167 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1168 rcu_read_unlock();
1169 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001170}
Chuck Leverb86acd52006-08-22 20:06:22 -04001171EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001174 * Restart an (async) RPC call from the call_prepare state.
1175 * Usually called from within the exit handler.
1176 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001177int
Andy Adamsonaae20062009-04-01 09:22:40 -04001178rpc_restart_call_prepare(struct rpc_task *task)
1179{
1180 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001181 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001182 task->tk_action = call_start;
1183 if (task->tk_ops->rpc_call_prepare != NULL)
1184 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001185 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001186}
1187EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1188
1189/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 * Restart an (async) RPC call. Usually called from within the
1191 * exit handler.
1192 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001193int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194rpc_restart_call(struct rpc_task *task)
1195{
1196 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001197 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001199 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001201EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Chuck Lever3748f1e2008-05-21 17:09:12 -04001203#ifdef RPC_DEBUG
1204static const char *rpc_proc_name(const struct rpc_task *task)
1205{
1206 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1207
1208 if (proc) {
1209 if (proc->p_name)
1210 return proc->p_name;
1211 else
1212 return "NULL";
1213 } else
1214 return "no proc";
1215}
1216#endif
1217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218/*
1219 * 0. Initial state
1220 *
1221 * Other FSM states can be visited zero or more times, but
1222 * this state is visited exactly once for each RPC.
1223 */
1224static void
1225call_start(struct rpc_task *task)
1226{
1227 struct rpc_clnt *clnt = task->tk_client;
1228
Chuck Lever3748f1e2008-05-21 17:09:12 -04001229 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001230 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001231 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001232 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
1234 /* Increment call count */
1235 task->tk_msg.rpc_proc->p_count++;
1236 clnt->cl_stats->rpccnt++;
1237 task->tk_action = call_reserve;
1238}
1239
1240/*
1241 * 1. Reserve an RPC call slot
1242 */
1243static void
1244call_reserve(struct rpc_task *task)
1245{
Chuck Lever46121cf2007-01-31 12:14:08 -05001246 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 task->tk_status = 0;
1249 task->tk_action = call_reserveresult;
1250 xprt_reserve(task);
1251}
1252
1253/*
1254 * 1b. Grok the result of xprt_reserve()
1255 */
1256static void
1257call_reserveresult(struct rpc_task *task)
1258{
1259 int status = task->tk_status;
1260
Chuck Lever46121cf2007-01-31 12:14:08 -05001261 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262
1263 /*
1264 * After a call to xprt_reserve(), we must have either
1265 * a request slot or else an error status.
1266 */
1267 task->tk_status = 0;
1268 if (status >= 0) {
1269 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001270 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 return;
1272 }
1273
1274 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001275 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 rpc_exit(task, -EIO);
1277 return;
1278 }
1279
1280 /*
1281 * Even though there was an error, we may have acquired
1282 * a request slot somehow. Make sure not to leak it.
1283 */
1284 if (task->tk_rqstp) {
1285 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001286 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 xprt_release(task);
1288 }
1289
1290 switch (status) {
1291 case -EAGAIN: /* woken up; retry */
1292 task->tk_action = call_reserve;
1293 return;
1294 case -EIO: /* probably a shutdown */
1295 break;
1296 default:
1297 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001298 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 break;
1300 }
1301 rpc_exit(task, status);
1302}
1303
1304/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001305 * 2. Bind and/or refresh the credentials
1306 */
1307static void
1308call_refresh(struct rpc_task *task)
1309{
1310 dprint_status(task);
1311
1312 task->tk_action = call_refreshresult;
1313 task->tk_status = 0;
1314 task->tk_client->cl_stats->rpcauthrefresh++;
1315 rpcauth_refreshcred(task);
1316}
1317
1318/*
1319 * 2a. Process the results of a credential refresh
1320 */
1321static void
1322call_refreshresult(struct rpc_task *task)
1323{
1324 int status = task->tk_status;
1325
1326 dprint_status(task);
1327
1328 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001329 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001330 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001331 case 0:
1332 if (rpcauth_uptodatecred(task))
1333 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001334 return;
1335 case -ETIMEDOUT:
1336 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001337 case -EAGAIN:
1338 status = -EACCES;
1339 if (!task->tk_cred_retry)
1340 break;
1341 task->tk_cred_retry--;
1342 dprintk("RPC: %5u %s: retry refresh creds\n",
1343 task->tk_pid, __func__);
1344 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001345 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001346 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1347 task->tk_pid, __func__, status);
1348 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001349}
1350
1351/*
1352 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001353 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 */
1355static void
1356call_allocate(struct rpc_task *task)
1357{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001358 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001359 struct rpc_rqst *req = task->tk_rqstp;
1360 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001361 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362
Chuck Lever46121cf2007-01-31 12:14:08 -05001363 dprint_status(task);
1364
Chuck Lever2bea90d2007-03-29 16:47:53 -04001365 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001366 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001367
Chuck Lever02107142006-01-03 09:55:49 +01001368 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 return;
1370
Chuck Lever2bea90d2007-03-29 16:47:53 -04001371 if (proc->p_proc != 0) {
1372 BUG_ON(proc->p_arglen == 0);
1373 if (proc->p_decode != NULL)
1374 BUG_ON(proc->p_replen == 0);
1375 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Chuck Lever2bea90d2007-03-29 16:47:53 -04001377 /*
1378 * Calculate the size (in quads) of the RPC call
1379 * and reply headers, and convert both values
1380 * to byte sizes.
1381 */
1382 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1383 req->rq_callsize <<= 2;
1384 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1385 req->rq_rcvsize <<= 2;
1386
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001387 req->rq_buffer = xprt->ops->buf_alloc(task,
1388 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001389 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001391
1392 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Trond Myklebust5afa9132011-06-17 10:14:59 -04001394 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001395 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 rpc_delay(task, HZ>>4);
1397 return;
1398 }
1399
1400 rpc_exit(task, -ERESTARTSYS);
1401}
1402
Trond Myklebust940e3312005-11-09 21:45:24 -05001403static inline int
1404rpc_task_need_encode(struct rpc_task *task)
1405{
1406 return task->tk_rqstp->rq_snd_buf.len == 0;
1407}
1408
1409static inline void
1410rpc_task_force_reencode(struct rpc_task *task)
1411{
1412 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001413 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001414}
1415
Chuck Lever2bea90d2007-03-29 16:47:53 -04001416static inline void
1417rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1418{
1419 buf->head[0].iov_base = start;
1420 buf->head[0].iov_len = len;
1421 buf->tail[0].iov_len = 0;
1422 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001423 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001424 buf->len = 0;
1425 buf->buflen = len;
1426}
1427
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428/*
1429 * 3. Encode arguments of an RPC call
1430 */
1431static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001432rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001435 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001436 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Chuck Lever46121cf2007-01-31 12:14:08 -05001438 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
Chuck Lever2bea90d2007-03-29 16:47:53 -04001440 rpc_xdr_buf_init(&req->rq_snd_buf,
1441 req->rq_buffer,
1442 req->rq_callsize);
1443 rpc_xdr_buf_init(&req->rq_rcv_buf,
1444 (char *)req->rq_buffer + req->rq_callsize,
1445 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
Chuck Leverb0e1c572008-05-21 17:09:19 -04001447 p = rpc_encode_header(task);
1448 if (p == NULL) {
1449 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 rpc_exit(task, -EIO);
1451 return;
1452 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001453
1454 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001455 if (encode == NULL)
1456 return;
1457
1458 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1459 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460}
1461
1462/*
1463 * 4. Get the server port number if not yet set
1464 */
1465static void
1466call_bind(struct rpc_task *task)
1467{
Chuck Leverec739ef2006-08-22 20:06:15 -04001468 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
Chuck Lever46121cf2007-01-31 12:14:08 -05001470 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Chuck Leverda351872005-08-11 16:25:11 -04001472 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001473 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001474 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001475 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001476 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 }
1478}
1479
1480/*
Chuck Leverda351872005-08-11 16:25:11 -04001481 * 4a. Sort out bind result
1482 */
1483static void
1484call_bind_status(struct rpc_task *task)
1485{
Chuck Lever906462a2007-09-11 18:00:47 -04001486 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001487
1488 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001489 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001490 task->tk_status = 0;
1491 task->tk_action = call_connect;
1492 return;
1493 }
1494
Steve Dickson5753cba2012-02-06 10:08:08 -05001495 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001496 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001497 case -ENOMEM:
1498 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1499 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001500 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001501 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001502 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1503 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001504 /* fail immediately if this is an RPC ping */
1505 if (task->tk_msg.rpc_proc->p_proc == 0) {
1506 status = -EOPNOTSUPP;
1507 break;
1508 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001509 if (task->tk_rebind_retry == 0)
1510 break;
1511 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001512 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001513 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001514 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001515 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001516 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001517 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001518 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001519 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001520 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001521 task->tk_pid);
1522 break;
1523 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001524 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001525 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001526 task->tk_status = 0;
1527 task->tk_action = call_bind;
1528 return;
Chuck Lever012da152009-12-03 15:58:56 -05001529 case -ECONNREFUSED: /* connection problems */
1530 case -ECONNRESET:
1531 case -ENOTCONN:
1532 case -EHOSTDOWN:
1533 case -EHOSTUNREACH:
1534 case -ENETUNREACH:
1535 case -EPIPE:
1536 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1537 task->tk_pid, task->tk_status);
1538 if (!RPC_IS_SOFTCONN(task)) {
1539 rpc_delay(task, 5*HZ);
1540 goto retry_timeout;
1541 }
1542 status = task->tk_status;
1543 break;
Chuck Leverda351872005-08-11 16:25:11 -04001544 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001545 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001546 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001547 }
1548
1549 rpc_exit(task, status);
1550 return;
1551
Trond Myklebustda458282006-08-31 15:44:52 -04001552retry_timeout:
1553 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001554}
1555
1556/*
1557 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 */
1559static void
1560call_connect(struct rpc_task *task)
1561{
Chuck Leverda351872005-08-11 16:25:11 -04001562 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563
Chuck Lever46121cf2007-01-31 12:14:08 -05001564 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001565 task->tk_pid, xprt,
1566 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Chuck Leverda351872005-08-11 16:25:11 -04001568 task->tk_action = call_transmit;
1569 if (!xprt_connected(xprt)) {
1570 task->tk_action = call_connect_status;
1571 if (task->tk_status < 0)
1572 return;
1573 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575}
1576
1577/*
Chuck Leverda351872005-08-11 16:25:11 -04001578 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 */
1580static void
1581call_connect_status(struct rpc_task *task)
1582{
1583 struct rpc_clnt *clnt = task->tk_client;
1584 int status = task->tk_status;
1585
Chuck Lever46121cf2007-01-31 12:14:08 -05001586 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001589 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 clnt->cl_stats->netreconn++;
1591 task->tk_action = call_transmit;
1592 return;
1593 }
1594
Steve Dickson5753cba2012-02-06 10:08:08 -05001595 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001597 /* if soft mounted, test if we've timed out */
1598 case -ETIMEDOUT:
1599 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001600 break;
1601 default:
1602 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 }
1604}
1605
1606/*
1607 * 5. Transmit the RPC request, and wait for reply
1608 */
1609static void
1610call_transmit(struct rpc_task *task)
1611{
Chuck Lever46121cf2007-01-31 12:14:08 -05001612 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
1614 task->tk_action = call_status;
1615 if (task->tk_status < 0)
1616 return;
1617 task->tk_status = xprt_prepare_transmit(task);
1618 if (task->tk_status != 0)
1619 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001620 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001622 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001623 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001624 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001625 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001626 if (task->tk_status != 0) {
1627 /* Was the error nonfatal? */
1628 if (task->tk_status == -EAGAIN)
1629 rpc_delay(task, HZ >> 4);
1630 else
1631 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001632 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001633 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001634 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 xprt_transmit(task);
1636 if (task->tk_status < 0)
1637 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001638 /*
1639 * On success, ensure that we call xprt_end_transmit() before sleeping
1640 * in order to allow access to the socket to other RPC requests.
1641 */
1642 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001643 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001644 return;
1645 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001646 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001647}
1648
1649/*
1650 * 5a. Handle cleanup after a transmission
1651 */
1652static void
1653call_transmit_status(struct rpc_task *task)
1654{
1655 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001656
1657 /*
1658 * Common case: success. Force the compiler to put this
1659 * test first.
1660 */
1661 if (task->tk_status == 0) {
1662 xprt_end_transmit(task);
1663 rpc_task_force_reencode(task);
1664 return;
1665 }
1666
Trond Myklebust15f081c2009-03-11 14:37:57 -04001667 switch (task->tk_status) {
1668 case -EAGAIN:
1669 break;
1670 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001671 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001672 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001673 rpc_task_force_reencode(task);
1674 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001675 /*
1676 * Special cases: if we've been waiting on the
1677 * socket's write_space() callback, or if the
1678 * socket just returned a connection error,
1679 * then hold onto the transport lock.
1680 */
1681 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001682 case -EHOSTDOWN:
1683 case -EHOSTUNREACH:
1684 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001685 if (RPC_IS_SOFTCONN(task)) {
1686 xprt_end_transmit(task);
1687 rpc_exit(task, task->tk_status);
1688 break;
1689 }
1690 case -ECONNRESET:
1691 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001692 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001693 rpc_task_force_reencode(task);
1694 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695}
1696
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001697#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001698/*
1699 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1700 * addition, disconnect on connectivity errors.
1701 */
1702static void
1703call_bc_transmit(struct rpc_task *task)
1704{
1705 struct rpc_rqst *req = task->tk_rqstp;
1706
1707 BUG_ON(task->tk_status != 0);
1708 task->tk_status = xprt_prepare_transmit(task);
1709 if (task->tk_status == -EAGAIN) {
1710 /*
1711 * Could not reserve the transport. Try again after the
1712 * transport is released.
1713 */
1714 task->tk_status = 0;
1715 task->tk_action = call_bc_transmit;
1716 return;
1717 }
1718
1719 task->tk_action = rpc_exit_task;
1720 if (task->tk_status < 0) {
1721 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1722 "error: %d\n", task->tk_status);
1723 return;
1724 }
1725
1726 xprt_transmit(task);
1727 xprt_end_transmit(task);
1728 dprint_status(task);
1729 switch (task->tk_status) {
1730 case 0:
1731 /* Success */
1732 break;
1733 case -EHOSTDOWN:
1734 case -EHOSTUNREACH:
1735 case -ENETUNREACH:
1736 case -ETIMEDOUT:
1737 /*
1738 * Problem reaching the server. Disconnect and let the
1739 * forechannel reestablish the connection. The server will
1740 * have to retransmit the backchannel request and we'll
1741 * reprocess it. Since these ops are idempotent, there's no
1742 * need to cache our reply at this time.
1743 */
1744 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1745 "error: %d\n", task->tk_status);
1746 xprt_conditional_disconnect(task->tk_xprt,
1747 req->rq_connect_cookie);
1748 break;
1749 default:
1750 /*
1751 * We were unable to reply and will have to drop the
1752 * request. The server should reconnect and retransmit.
1753 */
1754 BUG_ON(task->tk_status == -EAGAIN);
1755 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1756 "error: %d\n", task->tk_status);
1757 break;
1758 }
1759 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1760}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001761#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001762
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763/*
1764 * 6. Sort out the RPC call status
1765 */
1766static void
1767call_status(struct rpc_task *task)
1768{
1769 struct rpc_clnt *clnt = task->tk_client;
1770 struct rpc_rqst *req = task->tk_rqstp;
1771 int status;
1772
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001773 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1774 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775
Chuck Lever46121cf2007-01-31 12:14:08 -05001776 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778 status = task->tk_status;
1779 if (status >= 0) {
1780 task->tk_action = call_decode;
1781 return;
1782 }
1783
Steve Dickson5753cba2012-02-06 10:08:08 -05001784 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 task->tk_status = 0;
1786 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001787 case -EHOSTDOWN:
1788 case -EHOSTUNREACH:
1789 case -ENETUNREACH:
1790 /*
1791 * Delay any retries for 3 seconds, then handle as if it
1792 * were a timeout.
1793 */
1794 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 case -ETIMEDOUT:
1796 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001797 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001798 xprt_conditional_disconnect(task->tk_xprt,
1799 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001801 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001803 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001804 rpc_delay(task, 3*HZ);
1805 case -EPIPE:
1806 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 task->tk_action = call_bind;
1808 break;
1809 case -EAGAIN:
1810 task->tk_action = call_transmit;
1811 break;
1812 case -EIO:
1813 /* shutdown or soft timeout */
1814 rpc_exit(task, status);
1815 break;
1816 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001817 if (clnt->cl_chatty)
1818 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 clnt->cl_protname, -status);
1820 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 }
1822}
1823
1824/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001825 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 * We do not release the request slot, so we keep using the
1827 * same XID for all retransmits.
1828 */
1829static void
1830call_timeout(struct rpc_task *task)
1831{
1832 struct rpc_clnt *clnt = task->tk_client;
1833
1834 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001835 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 goto retry;
1837 }
1838
Chuck Lever46121cf2007-01-31 12:14:08 -05001839 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001840 task->tk_timeouts++;
1841
Chuck Lever3a28bec2009-12-03 15:58:56 -05001842 if (RPC_IS_SOFTCONN(task)) {
1843 rpc_exit(task, -ETIMEDOUT);
1844 return;
1845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001847 if (clnt->cl_chatty)
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001848 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001849 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001850 clnt->cl_protname,
1851 rcu_dereference(clnt->cl_xprt)->servername);
1852 rcu_read_unlock();
Trond Myklebust7494d002011-04-24 14:28:45 -04001853 if (task->tk_flags & RPC_TASK_TIMEOUT)
1854 rpc_exit(task, -ETIMEDOUT);
1855 else
1856 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 return;
1858 }
1859
Chuck Leverf518e352006-01-03 09:55:52 +01001860 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001862 if (clnt->cl_chatty) {
1863 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001864 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001865 clnt->cl_protname,
1866 rcu_dereference(clnt->cl_xprt)->servername);
1867 rcu_read_unlock();
1868 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001870 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001871 /*
1872 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1873 * event? RFC2203 requires the server to drop all such requests.
1874 */
1875 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876
1877retry:
1878 clnt->cl_stats->rpcretrans++;
1879 task->tk_action = call_bind;
1880 task->tk_status = 0;
1881}
1882
1883/*
1884 * 7. Decode the RPC reply
1885 */
1886static void
1887call_decode(struct rpc_task *task)
1888{
1889 struct rpc_clnt *clnt = task->tk_client;
1890 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001891 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001892 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
Vasily Averin726fd6a2011-06-01 16:23:59 +04001894 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895
Chuck Leverf518e352006-01-03 09:55:52 +01001896 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001897 if (clnt->cl_chatty) {
1898 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001899 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001900 clnt->cl_protname,
1901 rcu_dereference(clnt->cl_xprt)->servername);
1902 rcu_read_unlock();
1903 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1905 }
1906
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001907 /*
1908 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001909 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001910 */
1911 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 req->rq_rcv_buf.len = req->rq_private_buf.len;
1913
1914 /* Check that the softirq receive buffer is valid */
1915 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1916 sizeof(req->rq_rcv_buf)) != 0);
1917
Trond Myklebust1e799b62008-03-21 16:19:41 -04001918 if (req->rq_rcv_buf.len < 12) {
1919 if (!RPC_IS_SOFT(task)) {
1920 task->tk_action = call_bind;
1921 clnt->cl_stats->rpcretrans++;
1922 goto out_retry;
1923 }
1924 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1925 clnt->cl_protname, task->tk_status);
1926 task->tk_action = call_timeout;
1927 goto out_retry;
1928 }
1929
Chuck Leverb0e1c572008-05-21 17:09:19 -04001930 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001931 if (IS_ERR(p)) {
1932 if (p == ERR_PTR(-EAGAIN))
1933 goto out_retry;
1934 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 }
1936
Trond Myklebustabbcf282006-01-03 09:55:03 +01001937 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001939 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1941 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001942 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001943 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1944 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 return;
1946out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001948 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001949 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001950 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001951 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001952 xprt_conditional_disconnect(task->tk_xprt,
1953 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001954 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955}
1956
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001957static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001958rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959{
1960 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001962 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963
1964 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001965
1966 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 *p++ = req->rq_xid; /* XID */
1968 *p++ = htonl(RPC_CALL); /* CALL */
1969 *p++ = htonl(RPC_VERSION); /* RPC version */
1970 *p++ = htonl(clnt->cl_prog); /* program number */
1971 *p++ = htonl(clnt->cl_vers); /* program version */
1972 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001973 p = rpcauth_marshcred(task, p);
1974 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1975 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976}
1977
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001978static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001979rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001981 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1983 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001984 __be32 *p = iov->iov_base;
1985 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 int error = -EACCES;
1987
David Howellse8896492006-08-24 15:44:19 -04001988 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1989 /* RFC-1014 says that the representation of XDR data must be a
1990 * multiple of four bytes
1991 * - if it isn't pointer subtraction in the NFS client may give
1992 * undefined results
1993 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001994 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001995 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001996 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001997 goto out_eio;
1998 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 if ((len -= 3) < 0)
2000 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002002 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002004 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002005 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002006 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002008
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2010 if (--len < 0)
2011 goto out_overflow;
2012 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002013 case RPC_AUTH_ERROR:
2014 break;
2015 case RPC_MISMATCH:
2016 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2017 task->tk_pid, __func__);
2018 error = -EPROTONOSUPPORT;
2019 goto out_err;
2020 default:
2021 dprintk("RPC: %5u %s: RPC call rejected, "
2022 "unknown error: %x\n",
2023 task->tk_pid, __func__, n);
2024 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 }
2026 if (--len < 0)
2027 goto out_overflow;
2028 switch ((n = ntohl(*p++))) {
2029 case RPC_AUTH_REJECTEDCRED:
2030 case RPC_AUTH_REJECTEDVERF:
2031 case RPCSEC_GSS_CREDPROBLEM:
2032 case RPCSEC_GSS_CTXPROBLEM:
2033 if (!task->tk_cred_retry)
2034 break;
2035 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002036 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002037 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002039 /* Ensure we obtain a new XID! */
2040 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002041 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002042 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 case RPC_AUTH_BADCRED:
2044 case RPC_AUTH_BADVERF:
2045 /* possibly garbled cred/verf? */
2046 if (!task->tk_garb_retry)
2047 break;
2048 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002049 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002050 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002052 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002054 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002055 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002056 "authentication.\n",
2057 rcu_dereference(clnt->cl_xprt)->servername);
2058 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 break;
2060 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002061 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002062 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 error = -EIO;
2064 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002065 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002066 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 goto out_err;
2068 }
2069 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002070 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002071 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002072 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002074 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 if (len < 0)
2076 goto out_overflow;
2077 switch ((n = ntohl(*p++))) {
2078 case RPC_SUCCESS:
2079 return p;
2080 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002081 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2082 "by server %s\n", task->tk_pid, __func__,
2083 (unsigned int)clnt->cl_prog,
2084 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002085 error = -EPFNOSUPPORT;
2086 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002088 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2089 "by server %s\n", task->tk_pid, __func__,
2090 (unsigned int)clnt->cl_prog,
2091 (unsigned int)clnt->cl_vers,
2092 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002093 error = -EPROTONOSUPPORT;
2094 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002096 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002097 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002098 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002099 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002100 clnt->cl_prog, clnt->cl_vers,
2101 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002102 error = -EOPNOTSUPP;
2103 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002105 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002106 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 break; /* retry */
2108 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002109 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002110 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 /* Also retry */
2112 }
2113
Trond Myklebustabbcf282006-01-03 09:55:03 +01002114out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002115 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 if (task->tk_garb_retry) {
2117 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002118 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002119 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002121out_retry:
2122 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124out_eio:
2125 error = -EIO;
2126out_err:
2127 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002128 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002129 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002130 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002132 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002133 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002134 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002136
Chuck Lever9f06c712010-12-14 14:59:18 +00002137static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002138{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002139}
2140
Chuck Leverbf269552010-12-14 14:59:29 +00002141static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002142{
2143 return 0;
2144}
2145
2146static struct rpc_procinfo rpcproc_null = {
2147 .p_encode = rpcproc_encode_null,
2148 .p_decode = rpcproc_decode_null,
2149};
2150
Chuck Levercaabea82009-12-03 15:58:56 -05002151static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002152{
2153 struct rpc_message msg = {
2154 .rpc_proc = &rpcproc_null,
2155 };
2156 int err;
2157 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002158 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002159 put_rpccred(msg.rpc_cred);
2160 return err;
2161}
Trond Myklebust188fef12007-06-16 14:18:40 -04002162
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002163struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2164{
2165 struct rpc_message msg = {
2166 .rpc_proc = &rpcproc_null,
2167 .rpc_cred = cred,
2168 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002169 struct rpc_task_setup task_setup_data = {
2170 .rpc_client = clnt,
2171 .rpc_message = &msg,
2172 .callback_ops = &rpc_default_ops,
2173 .flags = flags,
2174 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002175 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002176}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002177EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002178
Trond Myklebust188fef12007-06-16 14:18:40 -04002179#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002180static void rpc_show_header(void)
2181{
Chuck Levercb3997b2008-05-21 17:09:41 -04002182 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2183 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002184}
2185
Chuck Lever38e886e2008-05-21 17:09:33 -04002186static void rpc_show_task(const struct rpc_clnt *clnt,
2187 const struct rpc_task *task)
2188{
2189 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002190
2191 if (RPC_IS_QUEUED(task))
2192 rpc_waitq = rpc_qname(task->tk_waitqueue);
2193
Joe Perchesb3bceda2010-12-21 10:52:24 -05002194 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 -04002195 task->tk_pid, task->tk_flags, task->tk_status,
2196 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2197 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002198 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002199}
2200
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002201void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002202{
2203 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002204 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002205 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002206 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002207
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002208 spin_lock(&sn->rpc_client_lock);
2209 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002210 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002211 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002212 if (!header) {
2213 rpc_show_header();
2214 header++;
2215 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002216 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002217 }
2218 spin_unlock(&clnt->cl_lock);
2219 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002220 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002221}
2222#endif