blob: c69e199b10829d2bc88ca2a435014aa66e0cbbb9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050037#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040038#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050039#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040041#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040042#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifdef RPC_DEBUG
45# define RPCDBG_FACILITY RPCDBG_CALL
46#endif
47
Chuck Lever46121cf2007-01-31 12:14:08 -050048#define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080050 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050051
Trond Myklebust188fef12007-06-16 14:18:40 -040052/*
53 * All RPC clients are linked into this list
54 */
Trond Myklebust188fef12007-06-16 14:18:40 -040055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
57
58
59static void call_start(struct rpc_task *task);
60static void call_reserve(struct rpc_task *task);
61static void call_reserveresult(struct rpc_task *task);
62static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063static void call_decode(struct rpc_task *task);
64static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040065static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040067#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040068static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040069#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050071static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_refresh(struct rpc_task *task);
73static void call_refreshresult(struct rpc_task *task);
74static void call_timeout(struct rpc_task *task);
75static void call_connect(struct rpc_task *task);
76static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Chuck Leverb0e1c572008-05-21 17:09:19 -040078static __be32 *rpc_encode_header(struct rpc_task *task);
79static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050080static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040081
Trond Myklebust188fef12007-06-16 14:18:40 -040082static void rpc_register_client(struct rpc_clnt *clnt)
83{
Trond Myklebust2446ab62012-03-01 17:00:56 -050084 struct net *net = rpc_net_ns(clnt);
85 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040086
87 spin_lock(&sn->rpc_client_lock);
88 list_add(&clnt->cl_clients, &sn->all_clients);
89 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040090}
91
92static void rpc_unregister_client(struct rpc_clnt *clnt)
93{
Trond Myklebust2446ab62012-03-01 17:00:56 -050094 struct net *net = rpc_net_ns(clnt);
95 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040096
97 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040098 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040099 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400100}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400102static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
103{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400104 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400105 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
106 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400107 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400108 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400109 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400110}
111
112static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
113{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500114 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116
Trond Myklebust2446ab62012-03-01 17:00:56 -0500117 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500120 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400121 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122}
123
124static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500125 struct rpc_clnt *clnt,
126 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
Trond Myklebustf1345852005-09-23 11:08:25 -0400128 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400129 char name[15];
Linus Torvalds26fe5752012-05-10 13:14:12 -0700130 struct qstr q = { .name = name };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 int error;
133
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400134 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400135 if (dir == NULL) {
136 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400138 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400139 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);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400197 if (!dentry)
198 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400199 if (IS_ERR(dentry))
200 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400201 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400202 if (clnt->cl_auth->au_ops->pipes_create) {
203 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
204 if (err)
205 __rpc_clnt_remove_pipedir(clnt);
206 }
207 break;
208 case RPC_PIPEFS_UMOUNT:
209 __rpc_clnt_remove_pipedir(clnt);
210 break;
211 default:
212 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
213 return -ENOTSUPP;
214 }
215 return err;
216}
217
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400218static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
219 struct super_block *sb)
220{
221 int error = 0;
222
223 for (;; clnt = clnt->cl_parent) {
224 if (!rpc_clnt_skip_event(clnt, event))
225 error = __rpc_clnt_handle_event(clnt, event, sb);
226 if (error || clnt == clnt->cl_parent)
227 break;
228 }
229 return error;
230}
231
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400232static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
233{
234 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
235 struct rpc_clnt *clnt;
236
237 spin_lock(&sn->rpc_client_lock);
238 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400239 if (clnt->cl_program->pipe_dir_name == NULL)
240 break;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400241 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400242 continue;
Stanislav Kinsburskya4dff1b2012-04-20 18:11:02 +0400243 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
244 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400245 spin_unlock(&sn->rpc_client_lock);
246 return clnt;
247 }
248 spin_unlock(&sn->rpc_client_lock);
249 return NULL;
250}
251
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400252static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
253 void *ptr)
254{
255 struct super_block *sb = ptr;
256 struct rpc_clnt *clnt;
257 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400258
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400259 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400260 error = __rpc_pipefs_event(clnt, event, sb);
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400261 rpc_release_client(clnt);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400262 if (error)
263 break;
264 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400265 return error;
266}
267
268static struct notifier_block rpc_clients_block = {
269 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400270 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400271};
272
273int rpc_clients_notifier_register(void)
274{
275 return rpc_pipefs_notifier_register(&rpc_clients_block);
276}
277
278void rpc_clients_notifier_unregister(void)
279{
280 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
281}
282
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400283static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
284{
285 clnt->cl_nodelen = strlen(nodename);
286 if (clnt->cl_nodelen > UNX_MAXNODENAME)
287 clnt->cl_nodelen = UNX_MAXNODENAME;
288 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
289}
290
Trond Myklebust698b6d02007-12-20 16:03:53 -0500291static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500293 const struct rpc_program *program = args->program;
294 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000296 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400298
299 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500300 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500301 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Trond Myklebust4ada5392007-06-14 17:26:17 -0400303 err = rpciod_up();
304 if (err)
305 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 err = -EINVAL;
307 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800308 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500309
310 if (args->version >= program->nrvers)
311 goto out_err;
312 version = program->version[args->version];
313 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 goto out_err;
315
316 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700317 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 if (!clnt)
319 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 clnt->cl_parent = clnt;
321
Trond Myklebust2446ab62012-03-01 17:00:56 -0500322 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 clnt->cl_procinfo = version->procs;
324 clnt->cl_maxproc = version->nrprocs;
325 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300326 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500329 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500330 err = -ENOMEM;
331 if (clnt->cl_metrics == NULL)
332 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500333 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400334 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400335 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
Trond Myklebust2446ab62012-03-01 17:00:56 -0500337 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 clnt->cl_autobind = 1;
339
Trond Myklebustba7392b2007-12-20 16:03:55 -0500340 clnt->cl_timeout = xprt->timeout;
341 if (args->timeout != NULL) {
342 memcpy(&clnt->cl_timeout_default, args->timeout,
343 sizeof(clnt->cl_timeout_default));
344 clnt->cl_timeout = &clnt->cl_timeout_default;
345 }
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500348 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500349 clnt->cl_principal = NULL;
350 if (args->client_name) {
351 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
352 if (!clnt->cl_principal)
353 goto out_no_principal;
354 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
Trond Myklebust006abe82010-09-12 19:55:25 -0400356 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
359 if (err < 0)
360 goto out_no_path;
361
Trond Myklebust698b6d02007-12-20 16:03:53 -0500362 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000363 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500365 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000366 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 goto out_no_auth;
368 }
369
370 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400371 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400372 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 return clnt;
374
375out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400376 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500378 kfree(clnt->cl_principal);
379out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500380 rpc_free_iostats(clnt->cl_metrics);
381out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 kfree(clnt);
383out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400384 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800385out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400386 rpciod_down();
387out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 return ERR_PTR(err);
389}
390
Ben Hutchings2c530402012-07-10 10:55:09 +0000391/**
Chuck Leverc2866762006-08-22 20:06:20 -0400392 * rpc_create - create an RPC client and transport with one call
393 * @args: rpc_clnt create argument structure
394 *
395 * Creates and initializes an RPC transport and an RPC client.
396 *
397 * It can ping the server in order to determine if it is up, and to see if
398 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
399 * this behavior so asynchronous tasks can also use rpc_create.
400 */
401struct rpc_clnt *rpc_create(struct rpc_create_args *args)
402{
403 struct rpc_xprt *xprt;
404 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400405 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400406 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400407 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200408 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200409 .dstaddr = args->address,
410 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500411 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300412 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200413 };
Chuck Lever510deb02007-12-10 14:56:24 -0500414 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400415
Chuck Leverc2866762006-08-22 20:06:20 -0400416 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400417 * If the caller chooses not to specify a hostname, whip
418 * up a string representation of the passed-in address.
419 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500420 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400421 struct sockaddr_un *sun =
422 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400423 struct sockaddr_in *sin =
424 (struct sockaddr_in *)args->address;
425 struct sockaddr_in6 *sin6 =
426 (struct sockaddr_in6 *)args->address;
427
Chuck Lever510deb02007-12-10 14:56:24 -0500428 servername[0] = '\0';
429 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400430 case AF_LOCAL:
431 snprintf(servername, sizeof(servername), "%s",
432 sun->sun_path);
433 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400434 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700435 snprintf(servername, sizeof(servername), "%pI4",
436 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500437 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400438 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700439 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400440 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500441 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500442 default:
443 /* caller wants default server name, but
444 * address family isn't recognized. */
445 return ERR_PTR(-EINVAL);
446 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500447 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400448 }
449
Chuck Lever510deb02007-12-10 14:56:24 -0500450 xprt = xprt_create_transport(&xprtargs);
451 if (IS_ERR(xprt))
452 return (struct rpc_clnt *)xprt;
453
Chuck Lever43780b82007-07-01 12:13:22 -0400454 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400455 * By default, kernel RPC client connects from a reserved port.
456 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
457 * but it is always enabled for rpciod, which handles the connect
458 * operation.
459 */
460 xprt->resvport = 1;
461 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
462 xprt->resvport = 0;
463
Trond Myklebust698b6d02007-12-20 16:03:53 -0500464 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400465 if (IS_ERR(clnt))
466 return clnt;
467
468 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500469 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400470 if (err != 0) {
471 rpc_shutdown_client(clnt);
472 return ERR_PTR(err);
473 }
474 }
475
476 clnt->cl_softrtry = 1;
477 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
478 clnt->cl_softrtry = 0;
479
Chuck Leverc2866762006-08-22 20:06:20 -0400480 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
481 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500482 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
483 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400484 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
485 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400486
487 return clnt;
488}
Chuck Leverb86acd52006-08-22 20:06:22 -0400489EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491/*
492 * This function clones the RPC client structure. It allows us to share the
493 * same transport while varying parameters such as the authentication
494 * flavour.
495 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400496static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
497 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500499 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400500 struct rpc_clnt *new;
501 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Chuck Lever1b63a752012-09-14 17:23:52 -0400503 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500504 rcu_read_lock();
505 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
506 rcu_read_unlock();
507 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400508 goto out_err;
509 args->servername = xprt->servername;
510
511 new = rpc_new_client(args, xprt);
512 if (IS_ERR(new)) {
513 err = PTR_ERR(new);
514 goto out_put;
515 }
516
Trond Myklebust006abe82010-09-12 19:55:25 -0400517 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400518 new->cl_parent = clnt;
519
520 /* Turn off autobind on clones */
521 new->cl_autobind = 0;
522 new->cl_softrtry = clnt->cl_softrtry;
523 new->cl_discrtry = clnt->cl_discrtry;
524 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400526
527out_put:
Trond Myklebust2446ab62012-03-01 17:00:56 -0500528 xprt_put(xprt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400529out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800530 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500531 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
Chuck Lever1b63a752012-09-14 17:23:52 -0400533
534/**
535 * rpc_clone_client - Clone an RPC client structure
536 *
537 * @clnt: RPC client whose parameters are copied
538 *
539 * Returns a fresh RPC client or an ERR_PTR.
540 */
541struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
542{
543 struct rpc_create_args args = {
544 .program = clnt->cl_program,
545 .prognumber = clnt->cl_prog,
546 .version = clnt->cl_vers,
547 .authflavor = clnt->cl_auth->au_flavor,
548 .client_name = clnt->cl_principal,
549 };
550 return __rpc_clone_client(&args, clnt);
551}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400552EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Chuck Leverba9b5842012-09-14 17:24:02 -0400554/**
555 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
556 *
557 * @clnt: RPC client whose parameters are copied
558 * @auth: security flavor for new client
559 *
560 * Returns a fresh RPC client or an ERR_PTR.
561 */
562struct rpc_clnt *
563rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
564{
565 struct rpc_create_args args = {
566 .program = clnt->cl_program,
567 .prognumber = clnt->cl_prog,
568 .version = clnt->cl_vers,
569 .authflavor = flavor,
570 .client_name = clnt->cl_principal,
571 };
572 return __rpc_clone_client(&args, clnt);
573}
574EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400577 * Kill all tasks for the given client.
578 * XXX: kill their descendants as well?
579 */
580void rpc_killall_tasks(struct rpc_clnt *clnt)
581{
582 struct rpc_task *rovr;
583
584
585 if (list_empty(&clnt->cl_tasks))
586 return;
587 dprintk("RPC: killing all tasks for client %p\n", clnt);
588 /*
589 * Spin lock all_tasks to prevent changes...
590 */
591 spin_lock(&clnt->cl_lock);
592 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
593 if (!RPC_IS_ACTIVATED(rovr))
594 continue;
595 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
596 rovr->tk_flags |= RPC_TASK_KILLED;
597 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300598 if (RPC_IS_QUEUED(rovr))
599 rpc_wake_up_queued_task(rovr->tk_waitqueue,
600 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400601 }
602 }
603 spin_unlock(&clnt->cl_lock);
604}
605EXPORT_SYMBOL_GPL(rpc_killall_tasks);
606
607/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400609 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400611void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400613 /*
614 * To avoid deadlock, never call rpc_shutdown_client from a
615 * workqueue context!
616 */
617 WARN_ON_ONCE(current->flags & PF_WQ_WORKER);
618 might_sleep();
619
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500620 dprintk_rcu("RPC: shutting down %s client for %s\n",
621 clnt->cl_protname,
622 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Trond Myklebust34f52e32007-06-14 16:40:31 -0400624 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800626 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400627 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 }
629
Trond Myklebust4c402b42007-06-14 16:40:32 -0400630 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400632EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400635 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400637static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400638rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500640 dprintk_rcu("RPC: destroying %s client for %s\n",
641 clnt->cl_protname,
642 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500643 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400644 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400645 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400646 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500647 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500648 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500649 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500650 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400651 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
654
655/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400656 * Free an RPC client
657 */
658static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400659rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400660{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400661 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400662 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400663 return;
664 }
665
666 /*
667 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
668 * release remaining GSS contexts. This mechanism ensures
669 * that it can do so safely.
670 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400671 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400672 rpcauth_release(clnt->cl_auth);
673 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400674 if (atomic_dec_and_test(&clnt->cl_count))
675 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400676}
677
678/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400679 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 */
681void
682rpc_release_client(struct rpc_clnt *clnt)
683{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400684 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Trond Myklebust34f52e32007-06-14 16:40:31 -0400686 if (list_empty(&clnt->cl_tasks))
687 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400688 if (atomic_dec_and_test(&clnt->cl_count))
689 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400690}
691
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000692/**
693 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800694 * @old: old rpc_client
695 * @program: rpc program to set
696 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000697 *
698 * Clones the rpc client and sets up a new RPC program. This is mainly
699 * of use for enabling different RPC programs to share the same transport.
700 * The Sun NFSv2/v3 ACL protocol can do this.
701 */
702struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500703 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400704 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000705{
Trond Myklebustf994c432012-11-01 12:14:14 -0400706 struct rpc_create_args args = {
707 .program = program,
708 .prognumber = program->number,
709 .version = vers,
710 .authflavor = old->cl_auth->au_flavor,
711 .client_name = old->cl_principal,
712 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000713 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000714 int err;
715
Trond Myklebustf994c432012-11-01 12:14:14 -0400716 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000717 if (IS_ERR(clnt))
718 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500719 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000720 if (err != 0) {
721 rpc_shutdown_client(clnt);
722 clnt = ERR_PTR(err);
723 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800724out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000725 return clnt;
726}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400727EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000728
Trond Myklebust58f96122010-07-31 14:29:08 -0400729void rpc_task_release_client(struct rpc_task *task)
730{
731 struct rpc_clnt *clnt = task->tk_client;
732
733 if (clnt != NULL) {
734 /* Remove from client task list */
735 spin_lock(&clnt->cl_lock);
736 list_del(&task->tk_task);
737 spin_unlock(&clnt->cl_lock);
738 task->tk_client = NULL;
739
740 rpc_release_client(clnt);
741 }
742}
743
744static
745void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
746{
747 if (clnt != NULL) {
748 rpc_task_release_client(task);
749 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400750 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400751 if (clnt->cl_softrtry)
752 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700753 if (sk_memalloc_socks()) {
754 struct rpc_xprt *xprt;
755
756 rcu_read_lock();
757 xprt = rcu_dereference(clnt->cl_xprt);
758 if (xprt->swapper)
759 task->tk_flags |= RPC_TASK_SWAPPER;
760 rcu_read_unlock();
761 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400762 /* Add to the client's list of all tasks */
763 spin_lock(&clnt->cl_lock);
764 list_add_tail(&task->tk_task, &clnt->cl_tasks);
765 spin_unlock(&clnt->cl_lock);
766 }
767}
768
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000769void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
770{
771 rpc_task_release_client(task);
772 rpc_task_set_client(task, clnt);
773}
774EXPORT_SYMBOL_GPL(rpc_task_reset_client);
775
776
Trond Myklebust58f96122010-07-31 14:29:08 -0400777static void
778rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
779{
780 if (msg != NULL) {
781 task->tk_msg.rpc_proc = msg->rpc_proc;
782 task->tk_msg.rpc_argp = msg->rpc_argp;
783 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400784 if (msg->rpc_cred != NULL)
785 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400786 }
787}
788
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789/*
790 * Default callback for async RPC calls
791 */
792static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100793rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
795}
796
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100797static const struct rpc_call_ops rpc_default_ops = {
798 .rpc_call_done = rpc_default_callback,
799};
800
Trond Myklebustc970aa82007-07-14 15:39:59 -0400801/**
802 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
803 * @task_setup_data: pointer to task initialisation data
804 */
805struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400806{
Trond Myklebust19445b92010-04-16 16:41:10 -0400807 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400808
Trond Myklebust84115e12007-07-14 15:39:59 -0400809 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400810 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400811 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400812
Trond Myklebust58f96122010-07-31 14:29:08 -0400813 rpc_task_set_client(task, task_setup_data->rpc_client);
814 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
815
Trond Myklebust58f96122010-07-31 14:29:08 -0400816 if (task->tk_action == NULL)
817 rpc_call_start(task);
818
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400819 atomic_inc(&task->tk_count);
820 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400821out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400822 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400823}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400824EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400825
826/**
827 * rpc_call_sync - Perform a synchronous RPC call
828 * @clnt: pointer to RPC client
829 * @msg: RPC call parameters
830 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500832int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833{
834 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400835 struct rpc_task_setup task_setup_data = {
836 .rpc_client = clnt,
837 .rpc_message = msg,
838 .callback_ops = &rpc_default_ops,
839 .flags = flags,
840 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400841 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400843 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
844 if (flags & RPC_TASK_ASYNC) {
845 rpc_release_calldata(task_setup_data.callback_ops,
846 task_setup_data.callback_data);
847 return -EINVAL;
848 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
Trond Myklebustc970aa82007-07-14 15:39:59 -0400850 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400851 if (IS_ERR(task))
852 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100853 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800854 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 return status;
856}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400857EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400859/**
860 * rpc_call_async - Perform an asynchronous RPC call
861 * @clnt: pointer to RPC client
862 * @msg: RPC call parameters
863 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800864 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400865 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 */
867int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500868rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100869 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870{
871 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400872 struct rpc_task_setup task_setup_data = {
873 .rpc_client = clnt,
874 .rpc_message = msg,
875 .callback_ops = tk_ops,
876 .callback_data = data,
877 .flags = flags|RPC_TASK_ASYNC,
878 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
Trond Myklebustc970aa82007-07-14 15:39:59 -0400880 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400881 if (IS_ERR(task))
882 return PTR_ERR(task);
883 rpc_put_task(task);
884 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400886EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400888#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400889/**
890 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
891 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400892 * @req: RPC request
893 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400894 */
895struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400896 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400897{
898 struct rpc_task *task;
899 struct xdr_buf *xbufp = &req->rq_snd_buf;
900 struct rpc_task_setup task_setup_data = {
901 .callback_ops = tk_ops,
902 };
903
904 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
905 /*
906 * Create an rpc_task to send the data
907 */
908 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400909 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400910 xprt_free_bc_request(req);
911 goto out;
912 }
913 task->tk_rqstp = req;
914
915 /*
916 * Set up the xdr_buf length.
917 * This also indicates that the buffer is XDR encoded already.
918 */
919 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
920 xbufp->tail[0].iov_len;
921
922 task->tk_action = call_bc_transmit;
923 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400924 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400925 rpc_execute(task);
926
927out:
928 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
929 return task;
930}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400931#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400932
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400934rpc_call_start(struct rpc_task *task)
935{
936 task->tk_action = call_start;
937}
938EXPORT_SYMBOL_GPL(rpc_call_start);
939
Chuck Levered394402006-08-22 20:06:17 -0400940/**
941 * rpc_peeraddr - extract remote peer address from clnt's xprt
942 * @clnt: RPC client structure
943 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800944 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400945 *
946 * Returns the number of bytes that are actually in the stored address.
947 */
948size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
949{
950 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500951 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400952
Trond Myklebust2446ab62012-03-01 17:00:56 -0500953 rcu_read_lock();
954 xprt = rcu_dereference(clnt->cl_xprt);
955
956 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400957 if (bytes > bufsize)
958 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500959 memcpy(buf, &xprt->addr, bytes);
960 rcu_read_unlock();
961
962 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400963}
Chuck Leverb86acd52006-08-22 20:06:22 -0400964EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400965
Chuck Leverf425eba2006-08-22 20:06:18 -0400966/**
967 * rpc_peeraddr2str - return remote peer address in printable format
968 * @clnt: RPC client structure
969 * @format: address format
970 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500971 * NB: the lifetime of the memory referenced by the returned pointer is
972 * the same as the rpc_xprt itself. As long as the caller uses this
973 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400974 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500975const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
976 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400977{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500978 struct rpc_xprt *xprt;
979
980 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500981
982 if (xprt->address_strings[format] != NULL)
983 return xprt->address_strings[format];
984 else
985 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400986}
Chuck Leverb86acd52006-08-22 20:06:22 -0400987EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400988
Chuck Lever2e738fd2012-03-01 17:01:14 -0500989static const struct sockaddr_in rpc_inaddr_loopback = {
990 .sin_family = AF_INET,
991 .sin_addr.s_addr = htonl(INADDR_ANY),
992};
993
994static const struct sockaddr_in6 rpc_in6addr_loopback = {
995 .sin6_family = AF_INET6,
996 .sin6_addr = IN6ADDR_ANY_INIT,
997};
998
999/*
1000 * Try a getsockname() on a connected datagram socket. Using a
1001 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1002 * This conserves the ephemeral port number space.
1003 *
1004 * Returns zero and fills in "buf" if successful; otherwise, a
1005 * negative errno is returned.
1006 */
1007static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1008 struct sockaddr *buf, int buflen)
1009{
1010 struct socket *sock;
1011 int err;
1012
1013 err = __sock_create(net, sap->sa_family,
1014 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1015 if (err < 0) {
1016 dprintk("RPC: can't create UDP socket (%d)\n", err);
1017 goto out;
1018 }
1019
1020 switch (sap->sa_family) {
1021 case AF_INET:
1022 err = kernel_bind(sock,
1023 (struct sockaddr *)&rpc_inaddr_loopback,
1024 sizeof(rpc_inaddr_loopback));
1025 break;
1026 case AF_INET6:
1027 err = kernel_bind(sock,
1028 (struct sockaddr *)&rpc_in6addr_loopback,
1029 sizeof(rpc_in6addr_loopback));
1030 break;
1031 default:
1032 err = -EAFNOSUPPORT;
1033 goto out;
1034 }
1035 if (err < 0) {
1036 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1037 goto out_release;
1038 }
1039
1040 err = kernel_connect(sock, sap, salen, 0);
1041 if (err < 0) {
1042 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1043 goto out_release;
1044 }
1045
1046 err = kernel_getsockname(sock, buf, &buflen);
1047 if (err < 0) {
1048 dprintk("RPC: getsockname failed (%d)\n", err);
1049 goto out_release;
1050 }
1051
1052 err = 0;
1053 if (buf->sa_family == AF_INET6) {
1054 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1055 sin6->sin6_scope_id = 0;
1056 }
1057 dprintk("RPC: %s succeeded\n", __func__);
1058
1059out_release:
1060 sock_release(sock);
1061out:
1062 return err;
1063}
1064
1065/*
1066 * Scraping a connected socket failed, so we don't have a useable
1067 * local address. Fallback: generate an address that will prevent
1068 * the server from calling us back.
1069 *
1070 * Returns zero and fills in "buf" if successful; otherwise, a
1071 * negative errno is returned.
1072 */
1073static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1074{
1075 switch (family) {
1076 case AF_INET:
1077 if (buflen < sizeof(rpc_inaddr_loopback))
1078 return -EINVAL;
1079 memcpy(buf, &rpc_inaddr_loopback,
1080 sizeof(rpc_inaddr_loopback));
1081 break;
1082 case AF_INET6:
1083 if (buflen < sizeof(rpc_in6addr_loopback))
1084 return -EINVAL;
1085 memcpy(buf, &rpc_in6addr_loopback,
1086 sizeof(rpc_in6addr_loopback));
1087 default:
1088 dprintk("RPC: %s: address family not supported\n",
1089 __func__);
1090 return -EAFNOSUPPORT;
1091 }
1092 dprintk("RPC: %s: succeeded\n", __func__);
1093 return 0;
1094}
1095
1096/**
1097 * rpc_localaddr - discover local endpoint address for an RPC client
1098 * @clnt: RPC client structure
1099 * @buf: target buffer
1100 * @buflen: size of target buffer, in bytes
1101 *
1102 * Returns zero and fills in "buf" and "buflen" if successful;
1103 * otherwise, a negative errno is returned.
1104 *
1105 * This works even if the underlying transport is not currently connected,
1106 * or if the upper layer never previously provided a source address.
1107 *
1108 * The result of this function call is transient: multiple calls in
1109 * succession may give different results, depending on how local
1110 * networking configuration changes over time.
1111 */
1112int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1113{
1114 struct sockaddr_storage address;
1115 struct sockaddr *sap = (struct sockaddr *)&address;
1116 struct rpc_xprt *xprt;
1117 struct net *net;
1118 size_t salen;
1119 int err;
1120
1121 rcu_read_lock();
1122 xprt = rcu_dereference(clnt->cl_xprt);
1123 salen = xprt->addrlen;
1124 memcpy(sap, &xprt->addr, salen);
1125 net = get_net(xprt->xprt_net);
1126 rcu_read_unlock();
1127
1128 rpc_set_port(sap, 0);
1129 err = rpc_sockname(net, sap, salen, buf, buflen);
1130 put_net(net);
1131 if (err != 0)
1132 /* Couldn't discover local address, return ANYADDR */
1133 return rpc_anyaddr(sap->sa_family, buf, buflen);
1134 return 0;
1135}
1136EXPORT_SYMBOL_GPL(rpc_localaddr);
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138void
1139rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1140{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001141 struct rpc_xprt *xprt;
1142
1143 rcu_read_lock();
1144 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001145 if (xprt->ops->set_buffer_size)
1146 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001147 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001149EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Trond Myklebust2446ab62012-03-01 17:00:56 -05001151/**
1152 * rpc_protocol - Get transport protocol number for an RPC client
1153 * @clnt: RPC client to query
1154 *
1155 */
1156int rpc_protocol(struct rpc_clnt *clnt)
1157{
1158 int protocol;
1159
1160 rcu_read_lock();
1161 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1162 rcu_read_unlock();
1163 return protocol;
1164}
1165EXPORT_SYMBOL_GPL(rpc_protocol);
1166
1167/**
1168 * rpc_net_ns - Get the network namespace for this RPC client
1169 * @clnt: RPC client to query
1170 *
1171 */
1172struct net *rpc_net_ns(struct rpc_clnt *clnt)
1173{
1174 struct net *ret;
1175
1176 rcu_read_lock();
1177 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1178 rcu_read_unlock();
1179 return ret;
1180}
1181EXPORT_SYMBOL_GPL(rpc_net_ns);
1182
1183/**
1184 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1185 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 *
1187 * For stream transports, this is one RPC record fragment (see RFC
1188 * 1831), as we don't support multi-record requests yet. For datagram
1189 * transports, this is the size of an IP packet minus the IP, UDP, and
1190 * RPC header sizes.
1191 */
1192size_t rpc_max_payload(struct rpc_clnt *clnt)
1193{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001194 size_t ret;
1195
1196 rcu_read_lock();
1197 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1198 rcu_read_unlock();
1199 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200}
Chuck Leverb86acd52006-08-22 20:06:22 -04001201EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Chuck Lever35f5a422006-01-03 09:55:50 +01001203/**
1204 * rpc_force_rebind - force transport to check that remote port is unchanged
1205 * @clnt: client to rebind
1206 *
1207 */
1208void rpc_force_rebind(struct rpc_clnt *clnt)
1209{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001210 if (clnt->cl_autobind) {
1211 rcu_read_lock();
1212 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1213 rcu_read_unlock();
1214 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001215}
Chuck Leverb86acd52006-08-22 20:06:22 -04001216EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001219 * Restart an (async) RPC call from the call_prepare state.
1220 * Usually called from within the exit handler.
1221 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001222int
Andy Adamsonaae20062009-04-01 09:22:40 -04001223rpc_restart_call_prepare(struct rpc_task *task)
1224{
1225 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001226 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001227 task->tk_action = call_start;
1228 if (task->tk_ops->rpc_call_prepare != NULL)
1229 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001230 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001231}
1232EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1233
1234/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 * Restart an (async) RPC call. Usually called from within the
1236 * exit handler.
1237 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001238int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239rpc_restart_call(struct rpc_task *task)
1240{
1241 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001242 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001244 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001246EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247
Chuck Lever3748f1e2008-05-21 17:09:12 -04001248#ifdef RPC_DEBUG
1249static const char *rpc_proc_name(const struct rpc_task *task)
1250{
1251 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1252
1253 if (proc) {
1254 if (proc->p_name)
1255 return proc->p_name;
1256 else
1257 return "NULL";
1258 } else
1259 return "no proc";
1260}
1261#endif
1262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263/*
1264 * 0. Initial state
1265 *
1266 * Other FSM states can be visited zero or more times, but
1267 * this state is visited exactly once for each RPC.
1268 */
1269static void
1270call_start(struct rpc_task *task)
1271{
1272 struct rpc_clnt *clnt = task->tk_client;
1273
Chuck Lever3748f1e2008-05-21 17:09:12 -04001274 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001275 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001276 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001277 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278
1279 /* Increment call count */
1280 task->tk_msg.rpc_proc->p_count++;
1281 clnt->cl_stats->rpccnt++;
1282 task->tk_action = call_reserve;
1283}
1284
1285/*
1286 * 1. Reserve an RPC call slot
1287 */
1288static void
1289call_reserve(struct rpc_task *task)
1290{
Chuck Lever46121cf2007-01-31 12:14:08 -05001291 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 task->tk_status = 0;
1294 task->tk_action = call_reserveresult;
1295 xprt_reserve(task);
1296}
1297
1298/*
1299 * 1b. Grok the result of xprt_reserve()
1300 */
1301static void
1302call_reserveresult(struct rpc_task *task)
1303{
1304 int status = task->tk_status;
1305
Chuck Lever46121cf2007-01-31 12:14:08 -05001306 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
1308 /*
1309 * After a call to xprt_reserve(), we must have either
1310 * a request slot or else an error status.
1311 */
1312 task->tk_status = 0;
1313 if (status >= 0) {
1314 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001315 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 return;
1317 }
1318
1319 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001320 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 rpc_exit(task, -EIO);
1322 return;
1323 }
1324
1325 /*
1326 * Even though there was an error, we may have acquired
1327 * a request slot somehow. Make sure not to leak it.
1328 */
1329 if (task->tk_rqstp) {
1330 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001331 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 xprt_release(task);
1333 }
1334
1335 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001336 case -ENOMEM:
1337 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 case -EAGAIN: /* woken up; retry */
1339 task->tk_action = call_reserve;
1340 return;
1341 case -EIO: /* probably a shutdown */
1342 break;
1343 default:
1344 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001345 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 break;
1347 }
1348 rpc_exit(task, status);
1349}
1350
1351/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001352 * 2. Bind and/or refresh the credentials
1353 */
1354static void
1355call_refresh(struct rpc_task *task)
1356{
1357 dprint_status(task);
1358
1359 task->tk_action = call_refreshresult;
1360 task->tk_status = 0;
1361 task->tk_client->cl_stats->rpcauthrefresh++;
1362 rpcauth_refreshcred(task);
1363}
1364
1365/*
1366 * 2a. Process the results of a credential refresh
1367 */
1368static void
1369call_refreshresult(struct rpc_task *task)
1370{
1371 int status = task->tk_status;
1372
1373 dprint_status(task);
1374
1375 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001376 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001377 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001378 case 0:
1379 if (rpcauth_uptodatecred(task))
1380 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001381 return;
1382 case -ETIMEDOUT:
1383 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001384 case -EAGAIN:
1385 status = -EACCES;
1386 if (!task->tk_cred_retry)
1387 break;
1388 task->tk_cred_retry--;
1389 dprintk("RPC: %5u %s: retry refresh creds\n",
1390 task->tk_pid, __func__);
1391 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001392 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001393 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1394 task->tk_pid, __func__, status);
1395 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001396}
1397
1398/*
1399 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001400 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 */
1402static void
1403call_allocate(struct rpc_task *task)
1404{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001405 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001406 struct rpc_rqst *req = task->tk_rqstp;
1407 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001408 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
Chuck Lever46121cf2007-01-31 12:14:08 -05001410 dprint_status(task);
1411
Chuck Lever2bea90d2007-03-29 16:47:53 -04001412 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001413 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001414
Chuck Lever02107142006-01-03 09:55:49 +01001415 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 return;
1417
Chuck Lever2bea90d2007-03-29 16:47:53 -04001418 if (proc->p_proc != 0) {
1419 BUG_ON(proc->p_arglen == 0);
1420 if (proc->p_decode != NULL)
1421 BUG_ON(proc->p_replen == 0);
1422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
Chuck Lever2bea90d2007-03-29 16:47:53 -04001424 /*
1425 * Calculate the size (in quads) of the RPC call
1426 * and reply headers, and convert both values
1427 * to byte sizes.
1428 */
1429 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1430 req->rq_callsize <<= 2;
1431 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1432 req->rq_rcvsize <<= 2;
1433
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001434 req->rq_buffer = xprt->ops->buf_alloc(task,
1435 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001436 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001438
1439 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Trond Myklebust5afa9132011-06-17 10:14:59 -04001441 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001442 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 rpc_delay(task, HZ>>4);
1444 return;
1445 }
1446
1447 rpc_exit(task, -ERESTARTSYS);
1448}
1449
Trond Myklebust940e3312005-11-09 21:45:24 -05001450static inline int
1451rpc_task_need_encode(struct rpc_task *task)
1452{
1453 return task->tk_rqstp->rq_snd_buf.len == 0;
1454}
1455
1456static inline void
1457rpc_task_force_reencode(struct rpc_task *task)
1458{
1459 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001460 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001461}
1462
Chuck Lever2bea90d2007-03-29 16:47:53 -04001463static inline void
1464rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1465{
1466 buf->head[0].iov_base = start;
1467 buf->head[0].iov_len = len;
1468 buf->tail[0].iov_len = 0;
1469 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001470 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001471 buf->len = 0;
1472 buf->buflen = len;
1473}
1474
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475/*
1476 * 3. Encode arguments of an RPC call
1477 */
1478static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001479rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001482 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001483 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Chuck Lever46121cf2007-01-31 12:14:08 -05001485 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Chuck Lever2bea90d2007-03-29 16:47:53 -04001487 rpc_xdr_buf_init(&req->rq_snd_buf,
1488 req->rq_buffer,
1489 req->rq_callsize);
1490 rpc_xdr_buf_init(&req->rq_rcv_buf,
1491 (char *)req->rq_buffer + req->rq_callsize,
1492 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Chuck Leverb0e1c572008-05-21 17:09:19 -04001494 p = rpc_encode_header(task);
1495 if (p == NULL) {
1496 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 rpc_exit(task, -EIO);
1498 return;
1499 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001500
1501 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001502 if (encode == NULL)
1503 return;
1504
1505 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1506 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507}
1508
1509/*
1510 * 4. Get the server port number if not yet set
1511 */
1512static void
1513call_bind(struct rpc_task *task)
1514{
Chuck Leverec739ef2006-08-22 20:06:15 -04001515 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
Chuck Lever46121cf2007-01-31 12:14:08 -05001517 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Chuck Leverda351872005-08-11 16:25:11 -04001519 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001520 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001521 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001522 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001523 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 }
1525}
1526
1527/*
Chuck Leverda351872005-08-11 16:25:11 -04001528 * 4a. Sort out bind result
1529 */
1530static void
1531call_bind_status(struct rpc_task *task)
1532{
Chuck Lever906462a2007-09-11 18:00:47 -04001533 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001534
1535 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001536 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001537 task->tk_status = 0;
1538 task->tk_action = call_connect;
1539 return;
1540 }
1541
Steve Dickson5753cba2012-02-06 10:08:08 -05001542 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001543 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001544 case -ENOMEM:
1545 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1546 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001547 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001548 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001549 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1550 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001551 /* fail immediately if this is an RPC ping */
1552 if (task->tk_msg.rpc_proc->p_proc == 0) {
1553 status = -EOPNOTSUPP;
1554 break;
1555 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001556 if (task->tk_rebind_retry == 0)
1557 break;
1558 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001559 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001560 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001561 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001562 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001563 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001564 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001565 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001566 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001567 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001568 task->tk_pid);
1569 break;
1570 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001571 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001572 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001573 task->tk_status = 0;
1574 task->tk_action = call_bind;
1575 return;
Chuck Lever012da152009-12-03 15:58:56 -05001576 case -ECONNREFUSED: /* connection problems */
1577 case -ECONNRESET:
1578 case -ENOTCONN:
1579 case -EHOSTDOWN:
1580 case -EHOSTUNREACH:
1581 case -ENETUNREACH:
1582 case -EPIPE:
1583 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1584 task->tk_pid, task->tk_status);
1585 if (!RPC_IS_SOFTCONN(task)) {
1586 rpc_delay(task, 5*HZ);
1587 goto retry_timeout;
1588 }
1589 status = task->tk_status;
1590 break;
Chuck Leverda351872005-08-11 16:25:11 -04001591 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001592 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001593 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001594 }
1595
1596 rpc_exit(task, status);
1597 return;
1598
Trond Myklebustda458282006-08-31 15:44:52 -04001599retry_timeout:
1600 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001601}
1602
1603/*
1604 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 */
1606static void
1607call_connect(struct rpc_task *task)
1608{
Chuck Leverda351872005-08-11 16:25:11 -04001609 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Chuck Lever46121cf2007-01-31 12:14:08 -05001611 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001612 task->tk_pid, xprt,
1613 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
Chuck Leverda351872005-08-11 16:25:11 -04001615 task->tk_action = call_transmit;
1616 if (!xprt_connected(xprt)) {
1617 task->tk_action = call_connect_status;
1618 if (task->tk_status < 0)
1619 return;
1620 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622}
1623
1624/*
Chuck Leverda351872005-08-11 16:25:11 -04001625 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 */
1627static void
1628call_connect_status(struct rpc_task *task)
1629{
1630 struct rpc_clnt *clnt = task->tk_client;
1631 int status = task->tk_status;
1632
Chuck Lever46121cf2007-01-31 12:14:08 -05001633 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001634
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001636 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 clnt->cl_stats->netreconn++;
1638 task->tk_action = call_transmit;
1639 return;
1640 }
1641
Steve Dickson5753cba2012-02-06 10:08:08 -05001642 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001644 /* if soft mounted, test if we've timed out */
1645 case -ETIMEDOUT:
1646 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001647 break;
1648 default:
1649 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 }
1651}
1652
1653/*
1654 * 5. Transmit the RPC request, and wait for reply
1655 */
1656static void
1657call_transmit(struct rpc_task *task)
1658{
Chuck Lever46121cf2007-01-31 12:14:08 -05001659 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
1661 task->tk_action = call_status;
1662 if (task->tk_status < 0)
1663 return;
1664 task->tk_status = xprt_prepare_transmit(task);
1665 if (task->tk_status != 0)
1666 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001667 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001669 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001670 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001671 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001672 if (task->tk_status != 0) {
1673 /* Was the error nonfatal? */
1674 if (task->tk_status == -EAGAIN)
1675 rpc_delay(task, HZ >> 4);
1676 else
1677 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001678 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001679 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 xprt_transmit(task);
1682 if (task->tk_status < 0)
1683 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001684 /*
1685 * On success, ensure that we call xprt_end_transmit() before sleeping
1686 * in order to allow access to the socket to other RPC requests.
1687 */
1688 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001689 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001690 return;
1691 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001692 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001693}
1694
1695/*
1696 * 5a. Handle cleanup after a transmission
1697 */
1698static void
1699call_transmit_status(struct rpc_task *task)
1700{
1701 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001702
1703 /*
1704 * Common case: success. Force the compiler to put this
1705 * test first.
1706 */
1707 if (task->tk_status == 0) {
1708 xprt_end_transmit(task);
1709 rpc_task_force_reencode(task);
1710 return;
1711 }
1712
Trond Myklebust15f081c2009-03-11 14:37:57 -04001713 switch (task->tk_status) {
1714 case -EAGAIN:
1715 break;
1716 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001717 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001718 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001719 rpc_task_force_reencode(task);
1720 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001721 /*
1722 * Special cases: if we've been waiting on the
1723 * socket's write_space() callback, or if the
1724 * socket just returned a connection error,
1725 * then hold onto the transport lock.
1726 */
1727 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001728 case -EHOSTDOWN:
1729 case -EHOSTUNREACH:
1730 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001731 if (RPC_IS_SOFTCONN(task)) {
1732 xprt_end_transmit(task);
1733 rpc_exit(task, task->tk_status);
1734 break;
1735 }
1736 case -ECONNRESET:
1737 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001738 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001739 rpc_task_force_reencode(task);
1740 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741}
1742
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001743#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001744/*
1745 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1746 * addition, disconnect on connectivity errors.
1747 */
1748static void
1749call_bc_transmit(struct rpc_task *task)
1750{
1751 struct rpc_rqst *req = task->tk_rqstp;
1752
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001753 task->tk_status = xprt_prepare_transmit(task);
1754 if (task->tk_status == -EAGAIN) {
1755 /*
1756 * Could not reserve the transport. Try again after the
1757 * transport is released.
1758 */
1759 task->tk_status = 0;
1760 task->tk_action = call_bc_transmit;
1761 return;
1762 }
1763
1764 task->tk_action = rpc_exit_task;
1765 if (task->tk_status < 0) {
1766 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1767 "error: %d\n", task->tk_status);
1768 return;
1769 }
1770
1771 xprt_transmit(task);
1772 xprt_end_transmit(task);
1773 dprint_status(task);
1774 switch (task->tk_status) {
1775 case 0:
1776 /* Success */
1777 break;
1778 case -EHOSTDOWN:
1779 case -EHOSTUNREACH:
1780 case -ENETUNREACH:
1781 case -ETIMEDOUT:
1782 /*
1783 * Problem reaching the server. Disconnect and let the
1784 * forechannel reestablish the connection. The server will
1785 * have to retransmit the backchannel request and we'll
1786 * reprocess it. Since these ops are idempotent, there's no
1787 * need to cache our reply at this time.
1788 */
1789 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1790 "error: %d\n", task->tk_status);
1791 xprt_conditional_disconnect(task->tk_xprt,
1792 req->rq_connect_cookie);
1793 break;
1794 default:
1795 /*
1796 * We were unable to reply and will have to drop the
1797 * request. The server should reconnect and retransmit.
1798 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001799 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001800 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1801 "error: %d\n", task->tk_status);
1802 break;
1803 }
1804 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1805}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001806#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001807
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808/*
1809 * 6. Sort out the RPC call status
1810 */
1811static void
1812call_status(struct rpc_task *task)
1813{
1814 struct rpc_clnt *clnt = task->tk_client;
1815 struct rpc_rqst *req = task->tk_rqstp;
1816 int status;
1817
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001818 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1819 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820
Chuck Lever46121cf2007-01-31 12:14:08 -05001821 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823 status = task->tk_status;
1824 if (status >= 0) {
1825 task->tk_action = call_decode;
1826 return;
1827 }
1828
Steve Dickson5753cba2012-02-06 10:08:08 -05001829 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 task->tk_status = 0;
1831 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001832 case -EHOSTDOWN:
1833 case -EHOSTUNREACH:
1834 case -ENETUNREACH:
1835 /*
1836 * Delay any retries for 3 seconds, then handle as if it
1837 * were a timeout.
1838 */
1839 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 case -ETIMEDOUT:
1841 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001842 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001843 xprt_conditional_disconnect(task->tk_xprt,
1844 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001846 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001848 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001849 rpc_delay(task, 3*HZ);
1850 case -EPIPE:
1851 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 task->tk_action = call_bind;
1853 break;
1854 case -EAGAIN:
1855 task->tk_action = call_transmit;
1856 break;
1857 case -EIO:
1858 /* shutdown or soft timeout */
1859 rpc_exit(task, status);
1860 break;
1861 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001862 if (clnt->cl_chatty)
1863 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 clnt->cl_protname, -status);
1865 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 }
1867}
1868
1869/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001870 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 * We do not release the request slot, so we keep using the
1872 * same XID for all retransmits.
1873 */
1874static void
1875call_timeout(struct rpc_task *task)
1876{
1877 struct rpc_clnt *clnt = task->tk_client;
1878
1879 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001880 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 goto retry;
1882 }
1883
Chuck Lever46121cf2007-01-31 12:14:08 -05001884 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001885 task->tk_timeouts++;
1886
Chuck Lever3a28bec2009-12-03 15:58:56 -05001887 if (RPC_IS_SOFTCONN(task)) {
1888 rpc_exit(task, -ETIMEDOUT);
1889 return;
1890 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001892 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001893 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001894 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001895 clnt->cl_protname,
1896 rcu_dereference(clnt->cl_xprt)->servername);
1897 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001898 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001899 if (task->tk_flags & RPC_TASK_TIMEOUT)
1900 rpc_exit(task, -ETIMEDOUT);
1901 else
1902 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 return;
1904 }
1905
Chuck Leverf518e35a2006-01-03 09:55:52 +01001906 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001908 if (clnt->cl_chatty) {
1909 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001910 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001911 clnt->cl_protname,
1912 rcu_dereference(clnt->cl_xprt)->servername);
1913 rcu_read_unlock();
1914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001916 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001917 /*
1918 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1919 * event? RFC2203 requires the server to drop all such requests.
1920 */
1921 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
1923retry:
1924 clnt->cl_stats->rpcretrans++;
1925 task->tk_action = call_bind;
1926 task->tk_status = 0;
1927}
1928
1929/*
1930 * 7. Decode the RPC reply
1931 */
1932static void
1933call_decode(struct rpc_task *task)
1934{
1935 struct rpc_clnt *clnt = task->tk_client;
1936 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001937 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001938 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
Vasily Averin726fd6a2011-06-01 16:23:59 +04001940 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
Chuck Leverf518e35a2006-01-03 09:55:52 +01001942 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001943 if (clnt->cl_chatty) {
1944 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001945 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001946 clnt->cl_protname,
1947 rcu_dereference(clnt->cl_xprt)->servername);
1948 rcu_read_unlock();
1949 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1951 }
1952
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001953 /*
1954 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001955 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001956 */
1957 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 req->rq_rcv_buf.len = req->rq_private_buf.len;
1959
1960 /* Check that the softirq receive buffer is valid */
1961 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1962 sizeof(req->rq_rcv_buf)) != 0);
1963
Trond Myklebust1e799b62008-03-21 16:19:41 -04001964 if (req->rq_rcv_buf.len < 12) {
1965 if (!RPC_IS_SOFT(task)) {
1966 task->tk_action = call_bind;
1967 clnt->cl_stats->rpcretrans++;
1968 goto out_retry;
1969 }
1970 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1971 clnt->cl_protname, task->tk_status);
1972 task->tk_action = call_timeout;
1973 goto out_retry;
1974 }
1975
Chuck Leverb0e1c572008-05-21 17:09:19 -04001976 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001977 if (IS_ERR(p)) {
1978 if (p == ERR_PTR(-EAGAIN))
1979 goto out_retry;
1980 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 }
1982
Trond Myklebustabbcf282006-01-03 09:55:03 +01001983 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001985 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1987 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001988 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001989 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1990 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 return;
1992out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001994 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001995 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001996 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001997 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001998 xprt_conditional_disconnect(task->tk_xprt,
1999 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001}
2002
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002003static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002004rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005{
2006 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002008 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
2010 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002011
2012 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 *p++ = req->rq_xid; /* XID */
2014 *p++ = htonl(RPC_CALL); /* CALL */
2015 *p++ = htonl(RPC_VERSION); /* RPC version */
2016 *p++ = htonl(clnt->cl_prog); /* program number */
2017 *p++ = htonl(clnt->cl_vers); /* program version */
2018 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002019 p = rpcauth_marshcred(task, p);
2020 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2021 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022}
2023
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002024static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002025rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002027 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2029 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002030 __be32 *p = iov->iov_base;
2031 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 int error = -EACCES;
2033
David Howellse8896492006-08-24 15:44:19 -04002034 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2035 /* RFC-1014 says that the representation of XDR data must be a
2036 * multiple of four bytes
2037 * - if it isn't pointer subtraction in the NFS client may give
2038 * undefined results
2039 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002040 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002041 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002042 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002043 goto out_eio;
2044 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 if ((len -= 3) < 0)
2046 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002048 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002050 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002051 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002052 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2056 if (--len < 0)
2057 goto out_overflow;
2058 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002059 case RPC_AUTH_ERROR:
2060 break;
2061 case RPC_MISMATCH:
2062 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2063 task->tk_pid, __func__);
2064 error = -EPROTONOSUPPORT;
2065 goto out_err;
2066 default:
2067 dprintk("RPC: %5u %s: RPC call rejected, "
2068 "unknown error: %x\n",
2069 task->tk_pid, __func__, n);
2070 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 }
2072 if (--len < 0)
2073 goto out_overflow;
2074 switch ((n = ntohl(*p++))) {
2075 case RPC_AUTH_REJECTEDCRED:
2076 case RPC_AUTH_REJECTEDVERF:
2077 case RPCSEC_GSS_CREDPROBLEM:
2078 case RPCSEC_GSS_CTXPROBLEM:
2079 if (!task->tk_cred_retry)
2080 break;
2081 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002082 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002083 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002085 /* Ensure we obtain a new XID! */
2086 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002087 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002088 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 case RPC_AUTH_BADCRED:
2090 case RPC_AUTH_BADVERF:
2091 /* possibly garbled cred/verf? */
2092 if (!task->tk_garb_retry)
2093 break;
2094 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002095 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002096 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002098 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002100 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002101 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002102 "authentication.\n",
2103 rcu_dereference(clnt->cl_xprt)->servername);
2104 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 break;
2106 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002107 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002108 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 error = -EIO;
2110 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002111 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002112 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 goto out_err;
2114 }
2115 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002116 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002117 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002118 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002120 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 if (len < 0)
2122 goto out_overflow;
2123 switch ((n = ntohl(*p++))) {
2124 case RPC_SUCCESS:
2125 return p;
2126 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002127 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2128 "by server %s\n", task->tk_pid, __func__,
2129 (unsigned int)clnt->cl_prog,
2130 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002131 error = -EPFNOSUPPORT;
2132 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002134 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2135 "by server %s\n", task->tk_pid, __func__,
2136 (unsigned int)clnt->cl_prog,
2137 (unsigned int)clnt->cl_vers,
2138 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002139 error = -EPROTONOSUPPORT;
2140 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002142 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002143 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002144 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002145 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002146 clnt->cl_prog, clnt->cl_vers,
2147 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002148 error = -EOPNOTSUPP;
2149 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002151 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002152 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 break; /* retry */
2154 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002155 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002156 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 /* Also retry */
2158 }
2159
Trond Myklebustabbcf282006-01-03 09:55:03 +01002160out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002161 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 if (task->tk_garb_retry) {
2163 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002164 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002165 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002167out_retry:
2168 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170out_eio:
2171 error = -EIO;
2172out_err:
2173 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002174 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002175 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002176 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002178 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002179 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002180 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002182
Chuck Lever9f06c712010-12-14 14:59:18 +00002183static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002184{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002185}
2186
Chuck Leverbf269552010-12-14 14:59:29 +00002187static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002188{
2189 return 0;
2190}
2191
2192static struct rpc_procinfo rpcproc_null = {
2193 .p_encode = rpcproc_encode_null,
2194 .p_decode = rpcproc_decode_null,
2195};
2196
Chuck Levercaabea82009-12-03 15:58:56 -05002197static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002198{
2199 struct rpc_message msg = {
2200 .rpc_proc = &rpcproc_null,
2201 };
2202 int err;
2203 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002204 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002205 put_rpccred(msg.rpc_cred);
2206 return err;
2207}
Trond Myklebust188fef12007-06-16 14:18:40 -04002208
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002209struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2210{
2211 struct rpc_message msg = {
2212 .rpc_proc = &rpcproc_null,
2213 .rpc_cred = cred,
2214 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002215 struct rpc_task_setup task_setup_data = {
2216 .rpc_client = clnt,
2217 .rpc_message = &msg,
2218 .callback_ops = &rpc_default_ops,
2219 .flags = flags,
2220 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002221 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002222}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002223EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002224
Trond Myklebust188fef12007-06-16 14:18:40 -04002225#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002226static void rpc_show_header(void)
2227{
Chuck Levercb3997b2008-05-21 17:09:41 -04002228 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2229 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002230}
2231
Chuck Lever38e886e2008-05-21 17:09:33 -04002232static void rpc_show_task(const struct rpc_clnt *clnt,
2233 const struct rpc_task *task)
2234{
2235 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002236
2237 if (RPC_IS_QUEUED(task))
2238 rpc_waitq = rpc_qname(task->tk_waitqueue);
2239
Joe Perchesb3bceda2010-12-21 10:52:24 -05002240 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 -04002241 task->tk_pid, task->tk_flags, task->tk_status,
2242 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2243 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002244 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002245}
2246
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002247void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002248{
2249 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002250 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002251 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002252 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002253
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002254 spin_lock(&sn->rpc_client_lock);
2255 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002256 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002257 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002258 if (!header) {
2259 rpc_show_header();
2260 header++;
2261 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002262 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002263 }
2264 spin_unlock(&clnt->cl_lock);
2265 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002266 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002267}
2268#endif