blob: a9f7906c1a6ad251d4881bb731632d695449a720 [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)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300240 continue;
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
Randy Dunlap7144bca2013-01-09 17:12:35 -0800558 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400559 *
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 might_sleep();
614
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500615 dprintk_rcu("RPC: shutting down %s client for %s\n",
616 clnt->cl_protname,
617 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Trond Myklebust34f52e32007-06-14 16:40:31 -0400619 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800621 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400622 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
624
Trond Myklebust4c402b42007-06-14 16:40:32 -0400625 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400627EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
629/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400630 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400632static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400633rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500635 dprintk_rcu("RPC: destroying %s client for %s\n",
636 clnt->cl_protname,
637 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500638 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400639 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400640 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400641 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500642 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500643 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500644 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500645 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400646 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648}
649
650/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400651 * Free an RPC client
652 */
653static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400654rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400655{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400656 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400657 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400658 return;
659 }
660
661 /*
662 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
663 * release remaining GSS contexts. This mechanism ensures
664 * that it can do so safely.
665 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400666 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400667 rpcauth_release(clnt->cl_auth);
668 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400669 if (atomic_dec_and_test(&clnt->cl_count))
670 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400671}
672
673/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400674 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 */
676void
677rpc_release_client(struct rpc_clnt *clnt)
678{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400679 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Trond Myklebust34f52e32007-06-14 16:40:31 -0400681 if (list_empty(&clnt->cl_tasks))
682 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400683 if (atomic_dec_and_test(&clnt->cl_count))
684 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400685}
686
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000687/**
688 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800689 * @old: old rpc_client
690 * @program: rpc program to set
691 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000692 *
693 * Clones the rpc client and sets up a new RPC program. This is mainly
694 * of use for enabling different RPC programs to share the same transport.
695 * The Sun NFSv2/v3 ACL protocol can do this.
696 */
697struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500698 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400699 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000700{
Trond Myklebustf994c432012-11-01 12:14:14 -0400701 struct rpc_create_args args = {
702 .program = program,
703 .prognumber = program->number,
704 .version = vers,
705 .authflavor = old->cl_auth->au_flavor,
706 .client_name = old->cl_principal,
707 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000708 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000709 int err;
710
Trond Myklebustf994c432012-11-01 12:14:14 -0400711 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000712 if (IS_ERR(clnt))
713 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500714 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000715 if (err != 0) {
716 rpc_shutdown_client(clnt);
717 clnt = ERR_PTR(err);
718 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800719out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000720 return clnt;
721}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400722EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000723
Trond Myklebust58f96122010-07-31 14:29:08 -0400724void rpc_task_release_client(struct rpc_task *task)
725{
726 struct rpc_clnt *clnt = task->tk_client;
727
728 if (clnt != NULL) {
729 /* Remove from client task list */
730 spin_lock(&clnt->cl_lock);
731 list_del(&task->tk_task);
732 spin_unlock(&clnt->cl_lock);
733 task->tk_client = NULL;
734
735 rpc_release_client(clnt);
736 }
737}
738
739static
740void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
741{
742 if (clnt != NULL) {
743 rpc_task_release_client(task);
744 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400745 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400746 if (clnt->cl_softrtry)
747 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700748 if (sk_memalloc_socks()) {
749 struct rpc_xprt *xprt;
750
751 rcu_read_lock();
752 xprt = rcu_dereference(clnt->cl_xprt);
753 if (xprt->swapper)
754 task->tk_flags |= RPC_TASK_SWAPPER;
755 rcu_read_unlock();
756 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400757 /* Add to the client's list of all tasks */
758 spin_lock(&clnt->cl_lock);
759 list_add_tail(&task->tk_task, &clnt->cl_tasks);
760 spin_unlock(&clnt->cl_lock);
761 }
762}
763
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000764void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
765{
766 rpc_task_release_client(task);
767 rpc_task_set_client(task, clnt);
768}
769EXPORT_SYMBOL_GPL(rpc_task_reset_client);
770
771
Trond Myklebust58f96122010-07-31 14:29:08 -0400772static void
773rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
774{
775 if (msg != NULL) {
776 task->tk_msg.rpc_proc = msg->rpc_proc;
777 task->tk_msg.rpc_argp = msg->rpc_argp;
778 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400779 if (msg->rpc_cred != NULL)
780 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400781 }
782}
783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784/*
785 * Default callback for async RPC calls
786 */
787static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100788rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
790}
791
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100792static const struct rpc_call_ops rpc_default_ops = {
793 .rpc_call_done = rpc_default_callback,
794};
795
Trond Myklebustc970aa82007-07-14 15:39:59 -0400796/**
797 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
798 * @task_setup_data: pointer to task initialisation data
799 */
800struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400801{
Trond Myklebust19445b92010-04-16 16:41:10 -0400802 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400803
Trond Myklebust84115e12007-07-14 15:39:59 -0400804 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400805 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400806 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400807
Trond Myklebust58f96122010-07-31 14:29:08 -0400808 rpc_task_set_client(task, task_setup_data->rpc_client);
809 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
810
Trond Myklebust58f96122010-07-31 14:29:08 -0400811 if (task->tk_action == NULL)
812 rpc_call_start(task);
813
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400814 atomic_inc(&task->tk_count);
815 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400816out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400817 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400818}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400819EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400820
821/**
822 * rpc_call_sync - Perform a synchronous RPC call
823 * @clnt: pointer to RPC client
824 * @msg: RPC call parameters
825 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500827int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828{
829 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400830 struct rpc_task_setup task_setup_data = {
831 .rpc_client = clnt,
832 .rpc_message = msg,
833 .callback_ops = &rpc_default_ops,
834 .flags = flags,
835 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400836 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400838 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
839 if (flags & RPC_TASK_ASYNC) {
840 rpc_release_calldata(task_setup_data.callback_ops,
841 task_setup_data.callback_data);
842 return -EINVAL;
843 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Trond Myklebustc970aa82007-07-14 15:39:59 -0400845 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400846 if (IS_ERR(task))
847 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100848 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800849 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 return status;
851}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400852EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400854/**
855 * rpc_call_async - Perform an asynchronous RPC call
856 * @clnt: pointer to RPC client
857 * @msg: RPC call parameters
858 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800859 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400860 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 */
862int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500863rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100864 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865{
866 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400867 struct rpc_task_setup task_setup_data = {
868 .rpc_client = clnt,
869 .rpc_message = msg,
870 .callback_ops = tk_ops,
871 .callback_data = data,
872 .flags = flags|RPC_TASK_ASYNC,
873 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Trond Myklebustc970aa82007-07-14 15:39:59 -0400875 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400876 if (IS_ERR(task))
877 return PTR_ERR(task);
878 rpc_put_task(task);
879 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400881EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400883#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400884/**
885 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
886 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400887 * @req: RPC request
888 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400889 */
890struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400891 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400892{
893 struct rpc_task *task;
894 struct xdr_buf *xbufp = &req->rq_snd_buf;
895 struct rpc_task_setup task_setup_data = {
896 .callback_ops = tk_ops,
897 };
898
899 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
900 /*
901 * Create an rpc_task to send the data
902 */
903 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400904 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400905 xprt_free_bc_request(req);
906 goto out;
907 }
908 task->tk_rqstp = req;
909
910 /*
911 * Set up the xdr_buf length.
912 * This also indicates that the buffer is XDR encoded already.
913 */
914 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
915 xbufp->tail[0].iov_len;
916
917 task->tk_action = call_bc_transmit;
918 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400919 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400920 rpc_execute(task);
921
922out:
923 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
924 return task;
925}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400926#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400929rpc_call_start(struct rpc_task *task)
930{
931 task->tk_action = call_start;
932}
933EXPORT_SYMBOL_GPL(rpc_call_start);
934
Chuck Levered394402006-08-22 20:06:17 -0400935/**
936 * rpc_peeraddr - extract remote peer address from clnt's xprt
937 * @clnt: RPC client structure
938 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800939 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400940 *
941 * Returns the number of bytes that are actually in the stored address.
942 */
943size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
944{
945 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500946 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400947
Trond Myklebust2446ab62012-03-01 17:00:56 -0500948 rcu_read_lock();
949 xprt = rcu_dereference(clnt->cl_xprt);
950
951 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400952 if (bytes > bufsize)
953 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500954 memcpy(buf, &xprt->addr, bytes);
955 rcu_read_unlock();
956
957 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400958}
Chuck Leverb86acd52006-08-22 20:06:22 -0400959EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400960
Chuck Leverf425eba2006-08-22 20:06:18 -0400961/**
962 * rpc_peeraddr2str - return remote peer address in printable format
963 * @clnt: RPC client structure
964 * @format: address format
965 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500966 * NB: the lifetime of the memory referenced by the returned pointer is
967 * the same as the rpc_xprt itself. As long as the caller uses this
968 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400969 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500970const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
971 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400972{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500973 struct rpc_xprt *xprt;
974
975 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500976
977 if (xprt->address_strings[format] != NULL)
978 return xprt->address_strings[format];
979 else
980 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400981}
Chuck Leverb86acd52006-08-22 20:06:22 -0400982EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400983
Chuck Lever2e738fd2012-03-01 17:01:14 -0500984static const struct sockaddr_in rpc_inaddr_loopback = {
985 .sin_family = AF_INET,
986 .sin_addr.s_addr = htonl(INADDR_ANY),
987};
988
989static const struct sockaddr_in6 rpc_in6addr_loopback = {
990 .sin6_family = AF_INET6,
991 .sin6_addr = IN6ADDR_ANY_INIT,
992};
993
994/*
995 * Try a getsockname() on a connected datagram socket. Using a
996 * connected datagram socket prevents leaving a socket in TIME_WAIT.
997 * This conserves the ephemeral port number space.
998 *
999 * Returns zero and fills in "buf" if successful; otherwise, a
1000 * negative errno is returned.
1001 */
1002static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1003 struct sockaddr *buf, int buflen)
1004{
1005 struct socket *sock;
1006 int err;
1007
1008 err = __sock_create(net, sap->sa_family,
1009 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1010 if (err < 0) {
1011 dprintk("RPC: can't create UDP socket (%d)\n", err);
1012 goto out;
1013 }
1014
1015 switch (sap->sa_family) {
1016 case AF_INET:
1017 err = kernel_bind(sock,
1018 (struct sockaddr *)&rpc_inaddr_loopback,
1019 sizeof(rpc_inaddr_loopback));
1020 break;
1021 case AF_INET6:
1022 err = kernel_bind(sock,
1023 (struct sockaddr *)&rpc_in6addr_loopback,
1024 sizeof(rpc_in6addr_loopback));
1025 break;
1026 default:
1027 err = -EAFNOSUPPORT;
1028 goto out;
1029 }
1030 if (err < 0) {
1031 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1032 goto out_release;
1033 }
1034
1035 err = kernel_connect(sock, sap, salen, 0);
1036 if (err < 0) {
1037 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1038 goto out_release;
1039 }
1040
1041 err = kernel_getsockname(sock, buf, &buflen);
1042 if (err < 0) {
1043 dprintk("RPC: getsockname failed (%d)\n", err);
1044 goto out_release;
1045 }
1046
1047 err = 0;
1048 if (buf->sa_family == AF_INET6) {
1049 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1050 sin6->sin6_scope_id = 0;
1051 }
1052 dprintk("RPC: %s succeeded\n", __func__);
1053
1054out_release:
1055 sock_release(sock);
1056out:
1057 return err;
1058}
1059
1060/*
1061 * Scraping a connected socket failed, so we don't have a useable
1062 * local address. Fallback: generate an address that will prevent
1063 * the server from calling us back.
1064 *
1065 * Returns zero and fills in "buf" if successful; otherwise, a
1066 * negative errno is returned.
1067 */
1068static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1069{
1070 switch (family) {
1071 case AF_INET:
1072 if (buflen < sizeof(rpc_inaddr_loopback))
1073 return -EINVAL;
1074 memcpy(buf, &rpc_inaddr_loopback,
1075 sizeof(rpc_inaddr_loopback));
1076 break;
1077 case AF_INET6:
1078 if (buflen < sizeof(rpc_in6addr_loopback))
1079 return -EINVAL;
1080 memcpy(buf, &rpc_in6addr_loopback,
1081 sizeof(rpc_in6addr_loopback));
1082 default:
1083 dprintk("RPC: %s: address family not supported\n",
1084 __func__);
1085 return -EAFNOSUPPORT;
1086 }
1087 dprintk("RPC: %s: succeeded\n", __func__);
1088 return 0;
1089}
1090
1091/**
1092 * rpc_localaddr - discover local endpoint address for an RPC client
1093 * @clnt: RPC client structure
1094 * @buf: target buffer
1095 * @buflen: size of target buffer, in bytes
1096 *
1097 * Returns zero and fills in "buf" and "buflen" if successful;
1098 * otherwise, a negative errno is returned.
1099 *
1100 * This works even if the underlying transport is not currently connected,
1101 * or if the upper layer never previously provided a source address.
1102 *
1103 * The result of this function call is transient: multiple calls in
1104 * succession may give different results, depending on how local
1105 * networking configuration changes over time.
1106 */
1107int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1108{
1109 struct sockaddr_storage address;
1110 struct sockaddr *sap = (struct sockaddr *)&address;
1111 struct rpc_xprt *xprt;
1112 struct net *net;
1113 size_t salen;
1114 int err;
1115
1116 rcu_read_lock();
1117 xprt = rcu_dereference(clnt->cl_xprt);
1118 salen = xprt->addrlen;
1119 memcpy(sap, &xprt->addr, salen);
1120 net = get_net(xprt->xprt_net);
1121 rcu_read_unlock();
1122
1123 rpc_set_port(sap, 0);
1124 err = rpc_sockname(net, sap, salen, buf, buflen);
1125 put_net(net);
1126 if (err != 0)
1127 /* Couldn't discover local address, return ANYADDR */
1128 return rpc_anyaddr(sap->sa_family, buf, buflen);
1129 return 0;
1130}
1131EXPORT_SYMBOL_GPL(rpc_localaddr);
1132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133void
1134rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1135{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001136 struct rpc_xprt *xprt;
1137
1138 rcu_read_lock();
1139 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001140 if (xprt->ops->set_buffer_size)
1141 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001142 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001144EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
Trond Myklebust2446ab62012-03-01 17:00:56 -05001146/**
1147 * rpc_protocol - Get transport protocol number for an RPC client
1148 * @clnt: RPC client to query
1149 *
1150 */
1151int rpc_protocol(struct rpc_clnt *clnt)
1152{
1153 int protocol;
1154
1155 rcu_read_lock();
1156 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1157 rcu_read_unlock();
1158 return protocol;
1159}
1160EXPORT_SYMBOL_GPL(rpc_protocol);
1161
1162/**
1163 * rpc_net_ns - Get the network namespace for this RPC client
1164 * @clnt: RPC client to query
1165 *
1166 */
1167struct net *rpc_net_ns(struct rpc_clnt *clnt)
1168{
1169 struct net *ret;
1170
1171 rcu_read_lock();
1172 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1173 rcu_read_unlock();
1174 return ret;
1175}
1176EXPORT_SYMBOL_GPL(rpc_net_ns);
1177
1178/**
1179 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1180 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 *
1182 * For stream transports, this is one RPC record fragment (see RFC
1183 * 1831), as we don't support multi-record requests yet. For datagram
1184 * transports, this is the size of an IP packet minus the IP, UDP, and
1185 * RPC header sizes.
1186 */
1187size_t rpc_max_payload(struct rpc_clnt *clnt)
1188{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001189 size_t ret;
1190
1191 rcu_read_lock();
1192 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1193 rcu_read_unlock();
1194 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195}
Chuck Leverb86acd52006-08-22 20:06:22 -04001196EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
Chuck Lever35f5a422006-01-03 09:55:50 +01001198/**
1199 * rpc_force_rebind - force transport to check that remote port is unchanged
1200 * @clnt: client to rebind
1201 *
1202 */
1203void rpc_force_rebind(struct rpc_clnt *clnt)
1204{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001205 if (clnt->cl_autobind) {
1206 rcu_read_lock();
1207 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1208 rcu_read_unlock();
1209 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001210}
Chuck Leverb86acd52006-08-22 20:06:22 -04001211EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001214 * Restart an (async) RPC call from the call_prepare state.
1215 * Usually called from within the exit handler.
1216 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001217int
Andy Adamsonaae20062009-04-01 09:22:40 -04001218rpc_restart_call_prepare(struct rpc_task *task)
1219{
1220 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001221 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001222 task->tk_action = call_start;
1223 if (task->tk_ops->rpc_call_prepare != NULL)
1224 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001225 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001226}
1227EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1228
1229/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 * Restart an (async) RPC call. Usually called from within the
1231 * exit handler.
1232 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001233int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234rpc_restart_call(struct rpc_task *task)
1235{
1236 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001237 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001239 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001241EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242
Chuck Lever3748f1e2008-05-21 17:09:12 -04001243#ifdef RPC_DEBUG
1244static const char *rpc_proc_name(const struct rpc_task *task)
1245{
1246 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1247
1248 if (proc) {
1249 if (proc->p_name)
1250 return proc->p_name;
1251 else
1252 return "NULL";
1253 } else
1254 return "no proc";
1255}
1256#endif
1257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258/*
1259 * 0. Initial state
1260 *
1261 * Other FSM states can be visited zero or more times, but
1262 * this state is visited exactly once for each RPC.
1263 */
1264static void
1265call_start(struct rpc_task *task)
1266{
1267 struct rpc_clnt *clnt = task->tk_client;
1268
Chuck Lever3748f1e2008-05-21 17:09:12 -04001269 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001270 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001271 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001272 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
1274 /* Increment call count */
1275 task->tk_msg.rpc_proc->p_count++;
1276 clnt->cl_stats->rpccnt++;
1277 task->tk_action = call_reserve;
1278}
1279
1280/*
1281 * 1. Reserve an RPC call slot
1282 */
1283static void
1284call_reserve(struct rpc_task *task)
1285{
Chuck Lever46121cf2007-01-31 12:14:08 -05001286 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 task->tk_status = 0;
1289 task->tk_action = call_reserveresult;
1290 xprt_reserve(task);
1291}
1292
1293/*
1294 * 1b. Grok the result of xprt_reserve()
1295 */
1296static void
1297call_reserveresult(struct rpc_task *task)
1298{
1299 int status = task->tk_status;
1300
Chuck Lever46121cf2007-01-31 12:14:08 -05001301 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
1303 /*
1304 * After a call to xprt_reserve(), we must have either
1305 * a request slot or else an error status.
1306 */
1307 task->tk_status = 0;
1308 if (status >= 0) {
1309 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001310 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 return;
1312 }
1313
1314 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001315 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 rpc_exit(task, -EIO);
1317 return;
1318 }
1319
1320 /*
1321 * Even though there was an error, we may have acquired
1322 * a request slot somehow. Make sure not to leak it.
1323 */
1324 if (task->tk_rqstp) {
1325 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001326 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 xprt_release(task);
1328 }
1329
1330 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001331 case -ENOMEM:
1332 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 case -EAGAIN: /* woken up; retry */
1334 task->tk_action = call_reserve;
1335 return;
1336 case -EIO: /* probably a shutdown */
1337 break;
1338 default:
1339 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001340 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 break;
1342 }
1343 rpc_exit(task, status);
1344}
1345
1346/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001347 * 2. Bind and/or refresh the credentials
1348 */
1349static void
1350call_refresh(struct rpc_task *task)
1351{
1352 dprint_status(task);
1353
1354 task->tk_action = call_refreshresult;
1355 task->tk_status = 0;
1356 task->tk_client->cl_stats->rpcauthrefresh++;
1357 rpcauth_refreshcred(task);
1358}
1359
1360/*
1361 * 2a. Process the results of a credential refresh
1362 */
1363static void
1364call_refreshresult(struct rpc_task *task)
1365{
1366 int status = task->tk_status;
1367
1368 dprint_status(task);
1369
1370 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001371 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001372 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001373 case 0:
1374 if (rpcauth_uptodatecred(task))
1375 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001376 return;
1377 case -ETIMEDOUT:
1378 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001379 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001380 case -EAGAIN:
1381 status = -EACCES;
1382 if (!task->tk_cred_retry)
1383 break;
1384 task->tk_cred_retry--;
1385 dprintk("RPC: %5u %s: retry refresh creds\n",
1386 task->tk_pid, __func__);
1387 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001388 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001389 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1390 task->tk_pid, __func__, status);
1391 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001392}
1393
1394/*
1395 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001396 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 */
1398static void
1399call_allocate(struct rpc_task *task)
1400{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001401 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001402 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001403 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001404 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Chuck Lever46121cf2007-01-31 12:14:08 -05001406 dprint_status(task);
1407
Chuck Lever2bea90d2007-03-29 16:47:53 -04001408 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001409 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001410
Chuck Lever02107142006-01-03 09:55:49 +01001411 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 return;
1413
Chuck Lever2bea90d2007-03-29 16:47:53 -04001414 if (proc->p_proc != 0) {
1415 BUG_ON(proc->p_arglen == 0);
1416 if (proc->p_decode != NULL)
1417 BUG_ON(proc->p_replen == 0);
1418 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
Chuck Lever2bea90d2007-03-29 16:47:53 -04001420 /*
1421 * Calculate the size (in quads) of the RPC call
1422 * and reply headers, and convert both values
1423 * to byte sizes.
1424 */
1425 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1426 req->rq_callsize <<= 2;
1427 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1428 req->rq_rcvsize <<= 2;
1429
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001430 req->rq_buffer = xprt->ops->buf_alloc(task,
1431 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001432 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001434
1435 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Trond Myklebust5afa91332011-06-17 10:14:59 -04001437 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001438 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 rpc_delay(task, HZ>>4);
1440 return;
1441 }
1442
1443 rpc_exit(task, -ERESTARTSYS);
1444}
1445
Trond Myklebust940e3312005-11-09 21:45:24 -05001446static inline int
1447rpc_task_need_encode(struct rpc_task *task)
1448{
1449 return task->tk_rqstp->rq_snd_buf.len == 0;
1450}
1451
1452static inline void
1453rpc_task_force_reencode(struct rpc_task *task)
1454{
1455 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001456 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001457}
1458
Chuck Lever2bea90d2007-03-29 16:47:53 -04001459static inline void
1460rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1461{
1462 buf->head[0].iov_base = start;
1463 buf->head[0].iov_len = len;
1464 buf->tail[0].iov_len = 0;
1465 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001466 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001467 buf->len = 0;
1468 buf->buflen = len;
1469}
1470
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471/*
1472 * 3. Encode arguments of an RPC call
1473 */
1474static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001475rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001478 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001479 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Chuck Lever46121cf2007-01-31 12:14:08 -05001481 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
Chuck Lever2bea90d2007-03-29 16:47:53 -04001483 rpc_xdr_buf_init(&req->rq_snd_buf,
1484 req->rq_buffer,
1485 req->rq_callsize);
1486 rpc_xdr_buf_init(&req->rq_rcv_buf,
1487 (char *)req->rq_buffer + req->rq_callsize,
1488 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
Chuck Leverb0e1c572008-05-21 17:09:19 -04001490 p = rpc_encode_header(task);
1491 if (p == NULL) {
1492 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 rpc_exit(task, -EIO);
1494 return;
1495 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001496
1497 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001498 if (encode == NULL)
1499 return;
1500
1501 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1502 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503}
1504
1505/*
1506 * 4. Get the server port number if not yet set
1507 */
1508static void
1509call_bind(struct rpc_task *task)
1510{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001511 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Chuck Lever46121cf2007-01-31 12:14:08 -05001513 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Chuck Leverda351872005-08-11 16:25:11 -04001515 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001516 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001517 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001518 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001519 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 }
1521}
1522
1523/*
Chuck Leverda351872005-08-11 16:25:11 -04001524 * 4a. Sort out bind result
1525 */
1526static void
1527call_bind_status(struct rpc_task *task)
1528{
Chuck Lever906462a2007-09-11 18:00:47 -04001529 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001530
1531 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001532 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001533 task->tk_status = 0;
1534 task->tk_action = call_connect;
1535 return;
1536 }
1537
Steve Dickson5753cba2012-02-06 10:08:08 -05001538 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001539 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001540 case -ENOMEM:
1541 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1542 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001543 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001544 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001545 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1546 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001547 /* fail immediately if this is an RPC ping */
1548 if (task->tk_msg.rpc_proc->p_proc == 0) {
1549 status = -EOPNOTSUPP;
1550 break;
1551 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001552 if (task->tk_rebind_retry == 0)
1553 break;
1554 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001555 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001556 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001557 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001558 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001559 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001560 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001561 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001562 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001563 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001564 task->tk_pid);
1565 break;
1566 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001567 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001568 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001569 task->tk_status = 0;
1570 task->tk_action = call_bind;
1571 return;
Chuck Lever012da152009-12-03 15:58:56 -05001572 case -ECONNREFUSED: /* connection problems */
1573 case -ECONNRESET:
1574 case -ENOTCONN:
1575 case -EHOSTDOWN:
1576 case -EHOSTUNREACH:
1577 case -ENETUNREACH:
1578 case -EPIPE:
1579 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1580 task->tk_pid, task->tk_status);
1581 if (!RPC_IS_SOFTCONN(task)) {
1582 rpc_delay(task, 5*HZ);
1583 goto retry_timeout;
1584 }
1585 status = task->tk_status;
1586 break;
Chuck Leverda351872005-08-11 16:25:11 -04001587 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001588 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001589 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001590 }
1591
1592 rpc_exit(task, status);
1593 return;
1594
Trond Myklebustda458282006-08-31 15:44:52 -04001595retry_timeout:
1596 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001597}
1598
1599/*
1600 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 */
1602static void
1603call_connect(struct rpc_task *task)
1604{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001605 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
Chuck Lever46121cf2007-01-31 12:14:08 -05001607 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001608 task->tk_pid, xprt,
1609 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Chuck Leverda351872005-08-11 16:25:11 -04001611 task->tk_action = call_transmit;
1612 if (!xprt_connected(xprt)) {
1613 task->tk_action = call_connect_status;
1614 if (task->tk_status < 0)
1615 return;
1616 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618}
1619
1620/*
Chuck Leverda351872005-08-11 16:25:11 -04001621 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 */
1623static void
1624call_connect_status(struct rpc_task *task)
1625{
1626 struct rpc_clnt *clnt = task->tk_client;
1627 int status = task->tk_status;
1628
Chuck Lever46121cf2007-01-31 12:14:08 -05001629 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001630
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001632 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 clnt->cl_stats->netreconn++;
1634 task->tk_action = call_transmit;
1635 return;
1636 }
1637
Steve Dickson5753cba2012-02-06 10:08:08 -05001638 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001640 /* if soft mounted, test if we've timed out */
1641 case -ETIMEDOUT:
1642 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001643 break;
1644 default:
1645 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 }
1647}
1648
1649/*
1650 * 5. Transmit the RPC request, and wait for reply
1651 */
1652static void
1653call_transmit(struct rpc_task *task)
1654{
Chuck Lever46121cf2007-01-31 12:14:08 -05001655 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
1657 task->tk_action = call_status;
1658 if (task->tk_status < 0)
1659 return;
1660 task->tk_status = xprt_prepare_transmit(task);
1661 if (task->tk_status != 0)
1662 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001663 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001665 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001666 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001667 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001668 if (task->tk_status != 0) {
1669 /* Was the error nonfatal? */
1670 if (task->tk_status == -EAGAIN)
1671 rpc_delay(task, HZ >> 4);
1672 else
1673 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001674 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001675 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001676 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 xprt_transmit(task);
1678 if (task->tk_status < 0)
1679 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001680 /*
1681 * On success, ensure that we call xprt_end_transmit() before sleeping
1682 * in order to allow access to the socket to other RPC requests.
1683 */
1684 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001685 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001686 return;
1687 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001688 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001689}
1690
1691/*
1692 * 5a. Handle cleanup after a transmission
1693 */
1694static void
1695call_transmit_status(struct rpc_task *task)
1696{
1697 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001698
1699 /*
1700 * Common case: success. Force the compiler to put this
1701 * test first.
1702 */
1703 if (task->tk_status == 0) {
1704 xprt_end_transmit(task);
1705 rpc_task_force_reencode(task);
1706 return;
1707 }
1708
Trond Myklebust15f081c2009-03-11 14:37:57 -04001709 switch (task->tk_status) {
1710 case -EAGAIN:
1711 break;
1712 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001713 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001714 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001715 rpc_task_force_reencode(task);
1716 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001717 /*
1718 * Special cases: if we've been waiting on the
1719 * socket's write_space() callback, or if the
1720 * socket just returned a connection error,
1721 * then hold onto the transport lock.
1722 */
1723 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001724 case -EHOSTDOWN:
1725 case -EHOSTUNREACH:
1726 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001727 if (RPC_IS_SOFTCONN(task)) {
1728 xprt_end_transmit(task);
1729 rpc_exit(task, task->tk_status);
1730 break;
1731 }
1732 case -ECONNRESET:
1733 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001734 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001735 rpc_task_force_reencode(task);
1736 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737}
1738
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001739#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001740/*
1741 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1742 * addition, disconnect on connectivity errors.
1743 */
1744static void
1745call_bc_transmit(struct rpc_task *task)
1746{
1747 struct rpc_rqst *req = task->tk_rqstp;
1748
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001749 task->tk_status = xprt_prepare_transmit(task);
1750 if (task->tk_status == -EAGAIN) {
1751 /*
1752 * Could not reserve the transport. Try again after the
1753 * transport is released.
1754 */
1755 task->tk_status = 0;
1756 task->tk_action = call_bc_transmit;
1757 return;
1758 }
1759
1760 task->tk_action = rpc_exit_task;
1761 if (task->tk_status < 0) {
1762 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1763 "error: %d\n", task->tk_status);
1764 return;
1765 }
1766
1767 xprt_transmit(task);
1768 xprt_end_transmit(task);
1769 dprint_status(task);
1770 switch (task->tk_status) {
1771 case 0:
1772 /* Success */
1773 break;
1774 case -EHOSTDOWN:
1775 case -EHOSTUNREACH:
1776 case -ENETUNREACH:
1777 case -ETIMEDOUT:
1778 /*
1779 * Problem reaching the server. Disconnect and let the
1780 * forechannel reestablish the connection. The server will
1781 * have to retransmit the backchannel request and we'll
1782 * reprocess it. Since these ops are idempotent, there's no
1783 * need to cache our reply at this time.
1784 */
1785 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1786 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001787 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001788 req->rq_connect_cookie);
1789 break;
1790 default:
1791 /*
1792 * We were unable to reply and will have to drop the
1793 * request. The server should reconnect and retransmit.
1794 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001795 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001796 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1797 "error: %d\n", task->tk_status);
1798 break;
1799 }
1800 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1801}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001802#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001803
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804/*
1805 * 6. Sort out the RPC call status
1806 */
1807static void
1808call_status(struct rpc_task *task)
1809{
1810 struct rpc_clnt *clnt = task->tk_client;
1811 struct rpc_rqst *req = task->tk_rqstp;
1812 int status;
1813
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001814 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1815 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Chuck Lever46121cf2007-01-31 12:14:08 -05001817 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818
1819 status = task->tk_status;
1820 if (status >= 0) {
1821 task->tk_action = call_decode;
1822 return;
1823 }
1824
Steve Dickson5753cba2012-02-06 10:08:08 -05001825 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 task->tk_status = 0;
1827 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001828 case -EHOSTDOWN:
1829 case -EHOSTUNREACH:
1830 case -ENETUNREACH:
1831 /*
1832 * Delay any retries for 3 seconds, then handle as if it
1833 * were a timeout.
1834 */
1835 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 case -ETIMEDOUT:
1837 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001838 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001839 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001840 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001842 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001844 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001845 rpc_delay(task, 3*HZ);
1846 case -EPIPE:
1847 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 task->tk_action = call_bind;
1849 break;
1850 case -EAGAIN:
1851 task->tk_action = call_transmit;
1852 break;
1853 case -EIO:
1854 /* shutdown or soft timeout */
1855 rpc_exit(task, status);
1856 break;
1857 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001858 if (clnt->cl_chatty)
1859 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 clnt->cl_protname, -status);
1861 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 }
1863}
1864
1865/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001866 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 * We do not release the request slot, so we keep using the
1868 * same XID for all retransmits.
1869 */
1870static void
1871call_timeout(struct rpc_task *task)
1872{
1873 struct rpc_clnt *clnt = task->tk_client;
1874
1875 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001876 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 goto retry;
1878 }
1879
Chuck Lever46121cf2007-01-31 12:14:08 -05001880 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001881 task->tk_timeouts++;
1882
Chuck Lever3a28bec2009-12-03 15:58:56 -05001883 if (RPC_IS_SOFTCONN(task)) {
1884 rpc_exit(task, -ETIMEDOUT);
1885 return;
1886 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001888 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001889 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001890 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001891 clnt->cl_protname,
1892 rcu_dereference(clnt->cl_xprt)->servername);
1893 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001894 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001895 if (task->tk_flags & RPC_TASK_TIMEOUT)
1896 rpc_exit(task, -ETIMEDOUT);
1897 else
1898 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 return;
1900 }
1901
Chuck Leverf518e35a2006-01-03 09:55:52 +01001902 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001904 if (clnt->cl_chatty) {
1905 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001906 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001907 clnt->cl_protname,
1908 rcu_dereference(clnt->cl_xprt)->servername);
1909 rcu_read_unlock();
1910 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001912 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001913 /*
1914 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1915 * event? RFC2203 requires the server to drop all such requests.
1916 */
1917 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
1919retry:
1920 clnt->cl_stats->rpcretrans++;
1921 task->tk_action = call_bind;
1922 task->tk_status = 0;
1923}
1924
1925/*
1926 * 7. Decode the RPC reply
1927 */
1928static void
1929call_decode(struct rpc_task *task)
1930{
1931 struct rpc_clnt *clnt = task->tk_client;
1932 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001933 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001934 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
Vasily Averin726fd6a2011-06-01 16:23:59 +04001936 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937
Chuck Leverf518e35a2006-01-03 09:55:52 +01001938 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001939 if (clnt->cl_chatty) {
1940 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001941 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001942 clnt->cl_protname,
1943 rcu_dereference(clnt->cl_xprt)->servername);
1944 rcu_read_unlock();
1945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1947 }
1948
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001949 /*
1950 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001951 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001952 */
1953 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 req->rq_rcv_buf.len = req->rq_private_buf.len;
1955
1956 /* Check that the softirq receive buffer is valid */
1957 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1958 sizeof(req->rq_rcv_buf)) != 0);
1959
Trond Myklebust1e799b62008-03-21 16:19:41 -04001960 if (req->rq_rcv_buf.len < 12) {
1961 if (!RPC_IS_SOFT(task)) {
1962 task->tk_action = call_bind;
1963 clnt->cl_stats->rpcretrans++;
1964 goto out_retry;
1965 }
1966 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1967 clnt->cl_protname, task->tk_status);
1968 task->tk_action = call_timeout;
1969 goto out_retry;
1970 }
1971
Chuck Leverb0e1c572008-05-21 17:09:19 -04001972 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001973 if (IS_ERR(p)) {
1974 if (p == ERR_PTR(-EAGAIN))
1975 goto out_retry;
1976 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 }
1978
Trond Myklebustabbcf282006-01-03 09:55:03 +01001979 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001981 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1983 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001984 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001985 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1986 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 return;
1988out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001990 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001991 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001992 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001993 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001994 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001995 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001996 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997}
1998
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001999static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002000rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001{
2002 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002004 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005
2006 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002007
Trond Myklebusta4f08352013-01-08 09:10:21 -05002008 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 *p++ = req->rq_xid; /* XID */
2010 *p++ = htonl(RPC_CALL); /* CALL */
2011 *p++ = htonl(RPC_VERSION); /* RPC version */
2012 *p++ = htonl(clnt->cl_prog); /* program number */
2013 *p++ = htonl(clnt->cl_vers); /* program version */
2014 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002015 p = rpcauth_marshcred(task, p);
2016 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2017 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018}
2019
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002020static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002021rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002023 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2025 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002026 __be32 *p = iov->iov_base;
2027 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 int error = -EACCES;
2029
David Howellse8896492006-08-24 15:44:19 -04002030 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2031 /* RFC-1014 says that the representation of XDR data must be a
2032 * multiple of four bytes
2033 * - if it isn't pointer subtraction in the NFS client may give
2034 * undefined results
2035 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002036 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002037 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002038 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002039 goto out_eio;
2040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 if ((len -= 3) < 0)
2042 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002044 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002046 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002047 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002048 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002050
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2052 if (--len < 0)
2053 goto out_overflow;
2054 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002055 case RPC_AUTH_ERROR:
2056 break;
2057 case RPC_MISMATCH:
2058 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2059 task->tk_pid, __func__);
2060 error = -EPROTONOSUPPORT;
2061 goto out_err;
2062 default:
2063 dprintk("RPC: %5u %s: RPC call rejected, "
2064 "unknown error: %x\n",
2065 task->tk_pid, __func__, n);
2066 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 }
2068 if (--len < 0)
2069 goto out_overflow;
2070 switch ((n = ntohl(*p++))) {
2071 case RPC_AUTH_REJECTEDCRED:
2072 case RPC_AUTH_REJECTEDVERF:
2073 case RPCSEC_GSS_CREDPROBLEM:
2074 case RPCSEC_GSS_CTXPROBLEM:
2075 if (!task->tk_cred_retry)
2076 break;
2077 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002078 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002079 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002081 /* Ensure we obtain a new XID! */
2082 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002083 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002084 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 case RPC_AUTH_BADCRED:
2086 case RPC_AUTH_BADVERF:
2087 /* possibly garbled cred/verf? */
2088 if (!task->tk_garb_retry)
2089 break;
2090 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002091 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002092 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002094 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002096 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002097 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002098 "authentication.\n",
2099 rcu_dereference(clnt->cl_xprt)->servername);
2100 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 break;
2102 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002103 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002104 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 error = -EIO;
2106 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002107 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002108 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 goto out_err;
2110 }
2111 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002112 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002113 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002114 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002116 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 if (len < 0)
2118 goto out_overflow;
2119 switch ((n = ntohl(*p++))) {
2120 case RPC_SUCCESS:
2121 return p;
2122 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002123 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2124 "by server %s\n", task->tk_pid, __func__,
2125 (unsigned int)clnt->cl_prog,
2126 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002127 error = -EPFNOSUPPORT;
2128 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002130 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2131 "by server %s\n", task->tk_pid, __func__,
2132 (unsigned int)clnt->cl_prog,
2133 (unsigned int)clnt->cl_vers,
2134 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002135 error = -EPROTONOSUPPORT;
2136 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002138 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002139 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002140 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002141 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002142 clnt->cl_prog, clnt->cl_vers,
2143 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002144 error = -EOPNOTSUPP;
2145 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002147 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002148 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 break; /* retry */
2150 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002151 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002152 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 /* Also retry */
2154 }
2155
Trond Myklebustabbcf282006-01-03 09:55:03 +01002156out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002157 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 if (task->tk_garb_retry) {
2159 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002160 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002161 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002163out_retry:
2164 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166out_eio:
2167 error = -EIO;
2168out_err:
2169 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002170 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002171 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002172 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002174 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002175 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002176 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002178
Chuck Lever9f06c712010-12-14 14:59:18 +00002179static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002180{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002181}
2182
Chuck Leverbf269552010-12-14 14:59:29 +00002183static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002184{
2185 return 0;
2186}
2187
2188static struct rpc_procinfo rpcproc_null = {
2189 .p_encode = rpcproc_encode_null,
2190 .p_decode = rpcproc_decode_null,
2191};
2192
Chuck Levercaabea82009-12-03 15:58:56 -05002193static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002194{
2195 struct rpc_message msg = {
2196 .rpc_proc = &rpcproc_null,
2197 };
2198 int err;
2199 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002200 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002201 put_rpccred(msg.rpc_cred);
2202 return err;
2203}
Trond Myklebust188fef12007-06-16 14:18:40 -04002204
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002205struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2206{
2207 struct rpc_message msg = {
2208 .rpc_proc = &rpcproc_null,
2209 .rpc_cred = cred,
2210 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002211 struct rpc_task_setup task_setup_data = {
2212 .rpc_client = clnt,
2213 .rpc_message = &msg,
2214 .callback_ops = &rpc_default_ops,
2215 .flags = flags,
2216 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002217 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002218}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002219EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002220
Trond Myklebust188fef12007-06-16 14:18:40 -04002221#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002222static void rpc_show_header(void)
2223{
Chuck Levercb3997b2008-05-21 17:09:41 -04002224 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2225 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002226}
2227
Chuck Lever38e886e2008-05-21 17:09:33 -04002228static void rpc_show_task(const struct rpc_clnt *clnt,
2229 const struct rpc_task *task)
2230{
2231 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002232
2233 if (RPC_IS_QUEUED(task))
2234 rpc_waitq = rpc_qname(task->tk_waitqueue);
2235
Joe Perchesb3bceda2010-12-21 10:52:24 -05002236 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
Chuck Levercb3997b2008-05-21 17:09:41 -04002237 task->tk_pid, task->tk_flags, task->tk_status,
2238 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2239 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002240 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002241}
2242
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002243void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002244{
2245 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002246 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002247 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002248 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002249
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002250 spin_lock(&sn->rpc_client_lock);
2251 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002252 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002253 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002254 if (!header) {
2255 rpc_show_header();
2256 header++;
2257 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002258 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002259 }
2260 spin_unlock(&clnt->cl_lock);
2261 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002262 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002263}
2264#endif