blob: e9143edcb23b72a52f8a5833014393ca0b62e820 [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>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400108 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400109 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400110 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500115 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117
Trond Myklebust2446ab62012-03-01 17:00:56 -0500118 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400120 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500121 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500126 struct rpc_clnt *clnt,
127 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Trond Myklebustf1345852005-09-23 11:08:25 -0400129 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400130 char name[15];
Linus Torvalds26fe5752012-05-10 13:14:12 -0700131 struct qstr q = { .name = name };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400132 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int error;
134
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400136 if (dir == NULL) {
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400139 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 for (;;) {
141 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
142 name[sizeof(name) - 1] = '\0';
143 q.hash = full_name_hash(q.name, q.len);
144 dentry = rpc_create_client_dir(dir, &q, clnt);
145 if (!IS_ERR(dentry))
146 break;
147 error = PTR_ERR(dentry);
148 if (error != -EEXIST) {
149 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name, name, error);
152 break;
153 }
154 }
155 dput(dir);
156 return dentry;
157}
158
159static int
Trond Myklebust080b7942012-01-20 13:53:56 -0500160rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400161{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500162 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400163 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400164 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400165
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400166 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 if (dir_name == NULL)
168 return 0;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500169 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400170 if (!pipefs_sb)
171 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400172 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500173 rpc_put_sb_net(net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400174 if (IS_ERR(dentry))
175 return PTR_ERR(dentry);
176 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400177 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178}
179
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
181{
182 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
183 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
184 return 1;
185 return 0;
186}
187
188static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
189 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400190{
191 struct dentry *dentry;
192 int err = 0;
193
194 switch (event) {
195 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 dentry = rpc_setup_pipedir_sb(sb, clnt,
197 clnt->cl_program->pipe_dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400198 if (!dentry)
199 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400200 if (IS_ERR(dentry))
201 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400202 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400203 if (clnt->cl_auth->au_ops->pipes_create) {
204 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
205 if (err)
206 __rpc_clnt_remove_pipedir(clnt);
207 }
208 break;
209 case RPC_PIPEFS_UMOUNT:
210 __rpc_clnt_remove_pipedir(clnt);
211 break;
212 default:
213 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
214 return -ENOTSUPP;
215 }
216 return err;
217}
218
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400219static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
220 struct super_block *sb)
221{
222 int error = 0;
223
224 for (;; clnt = clnt->cl_parent) {
225 if (!rpc_clnt_skip_event(clnt, event))
226 error = __rpc_clnt_handle_event(clnt, event, sb);
227 if (error || clnt == clnt->cl_parent)
228 break;
229 }
230 return error;
231}
232
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400233static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
234{
235 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
236 struct rpc_clnt *clnt;
237
238 spin_lock(&sn->rpc_client_lock);
239 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400240 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300241 continue;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400242 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400243 continue;
Stanislav Kinsburskya4dff1b2012-04-20 18:11:02 +0400244 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
245 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400246 spin_unlock(&sn->rpc_client_lock);
247 return clnt;
248 }
249 spin_unlock(&sn->rpc_client_lock);
250 return NULL;
251}
252
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400253static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
254 void *ptr)
255{
256 struct super_block *sb = ptr;
257 struct rpc_clnt *clnt;
258 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400259
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400260 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400261 error = __rpc_pipefs_event(clnt, event, sb);
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400262 rpc_release_client(clnt);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400263 if (error)
264 break;
265 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400266 return error;
267}
268
269static struct notifier_block rpc_clients_block = {
270 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400271 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400272};
273
274int rpc_clients_notifier_register(void)
275{
276 return rpc_pipefs_notifier_register(&rpc_clients_block);
277}
278
279void rpc_clients_notifier_unregister(void)
280{
281 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
282}
283
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400284static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
285{
286 clnt->cl_nodelen = strlen(nodename);
287 if (clnt->cl_nodelen > UNX_MAXNODENAME)
288 clnt->cl_nodelen = UNX_MAXNODENAME;
289 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
290}
291
Trond Myklebust698b6d02007-12-20 16:03:53 -0500292static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500294 const struct rpc_program *program = args->program;
295 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000297 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400299
300 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500301 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500302 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Trond Myklebust4ada5392007-06-14 17:26:17 -0400304 err = rpciod_up();
305 if (err)
306 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500307
Trond Myklebustf05c1242013-04-05 14:13:21 -0400308 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500309 if (args->version >= program->nrvers)
310 goto out_err;
311 version = program->version[args->version];
312 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 goto out_err;
314
315 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700316 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 if (!clnt)
318 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 clnt->cl_parent = clnt;
320
Trond Myklebust2446ab62012-03-01 17:00:56 -0500321 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 clnt->cl_procinfo = version->procs;
323 clnt->cl_maxproc = version->nrprocs;
324 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300325 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500328 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500329 err = -ENOMEM;
330 if (clnt->cl_metrics == NULL)
331 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500332 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400333 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400334 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Trond Myklebust2446ab62012-03-01 17:00:56 -0500336 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 clnt->cl_autobind = 1;
338
Trond Myklebustba7392b2007-12-20 16:03:55 -0500339 clnt->cl_timeout = xprt->timeout;
340 if (args->timeout != NULL) {
341 memcpy(&clnt->cl_timeout_default, args->timeout,
342 sizeof(clnt->cl_timeout_default));
343 clnt->cl_timeout = &clnt->cl_timeout_default;
344 }
345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500347 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500348 clnt->cl_principal = NULL;
349 if (args->client_name) {
350 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
351 if (!clnt->cl_principal)
352 goto out_no_principal;
353 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Trond Myklebust006abe82010-09-12 19:55:25 -0400355 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
358 if (err < 0)
359 goto out_no_path;
360
Trond Myklebust698b6d02007-12-20 16:03:53 -0500361 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000362 if (IS_ERR(auth)) {
Trond Myklebust9b1d75b2013-05-01 09:17:50 -0400363 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500364 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000365 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 goto out_no_auth;
367 }
368
369 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400370 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400371 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 return clnt;
373
374out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400375 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500377 kfree(clnt->cl_principal);
378out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500379 rpc_free_iostats(clnt->cl_metrics);
380out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 kfree(clnt);
382out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400383 rpciod_down();
384out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400385 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 return ERR_PTR(err);
387}
388
Ben Hutchings2c530402012-07-10 10:55:09 +0000389/**
Chuck Leverc2866762006-08-22 20:06:20 -0400390 * rpc_create - create an RPC client and transport with one call
391 * @args: rpc_clnt create argument structure
392 *
393 * Creates and initializes an RPC transport and an RPC client.
394 *
395 * It can ping the server in order to determine if it is up, and to see if
396 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
397 * this behavior so asynchronous tasks can also use rpc_create.
398 */
399struct rpc_clnt *rpc_create(struct rpc_create_args *args)
400{
401 struct rpc_xprt *xprt;
402 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400403 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400404 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400405 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200406 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200407 .dstaddr = args->address,
408 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500409 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300410 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200411 };
Chuck Lever510deb02007-12-10 14:56:24 -0500412 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400413
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400414 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
415 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
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);
Chuck Levera58e0be2013-03-22 12:52:59 -0400514 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400515 }
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
Chuck Lever1b63a752012-09-14 17:23:52 -0400527out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800528 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500529 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530}
Chuck Lever1b63a752012-09-14 17:23:52 -0400531
532/**
533 * rpc_clone_client - Clone an RPC client structure
534 *
535 * @clnt: RPC client whose parameters are copied
536 *
537 * Returns a fresh RPC client or an ERR_PTR.
538 */
539struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
540{
541 struct rpc_create_args args = {
542 .program = clnt->cl_program,
543 .prognumber = clnt->cl_prog,
544 .version = clnt->cl_vers,
545 .authflavor = clnt->cl_auth->au_flavor,
546 .client_name = clnt->cl_principal,
547 };
548 return __rpc_clone_client(&args, clnt);
549}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400550EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Chuck Leverba9b5842012-09-14 17:24:02 -0400552/**
553 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
554 *
555 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800556 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400557 *
558 * Returns a fresh RPC client or an ERR_PTR.
559 */
560struct rpc_clnt *
561rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
562{
563 struct rpc_create_args args = {
564 .program = clnt->cl_program,
565 .prognumber = clnt->cl_prog,
566 .version = clnt->cl_vers,
567 .authflavor = flavor,
568 .client_name = clnt->cl_principal,
569 };
570 return __rpc_clone_client(&args, clnt);
571}
572EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400575 * Kill all tasks for the given client.
576 * XXX: kill their descendants as well?
577 */
578void rpc_killall_tasks(struct rpc_clnt *clnt)
579{
580 struct rpc_task *rovr;
581
582
583 if (list_empty(&clnt->cl_tasks))
584 return;
585 dprintk("RPC: killing all tasks for client %p\n", clnt);
586 /*
587 * Spin lock all_tasks to prevent changes...
588 */
589 spin_lock(&clnt->cl_lock);
590 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
591 if (!RPC_IS_ACTIVATED(rovr))
592 continue;
593 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
594 rovr->tk_flags |= RPC_TASK_KILLED;
595 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300596 if (RPC_IS_QUEUED(rovr))
597 rpc_wake_up_queued_task(rovr->tk_waitqueue,
598 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400599 }
600 }
601 spin_unlock(&clnt->cl_lock);
602}
603EXPORT_SYMBOL_GPL(rpc_killall_tasks);
604
605/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400607 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400609void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400611 might_sleep();
612
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500613 dprintk_rcu("RPC: shutting down %s client for %s\n",
614 clnt->cl_protname,
615 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Trond Myklebust34f52e32007-06-14 16:40:31 -0400617 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800619 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400620 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 }
622
Trond Myklebust4c402b42007-06-14 16:40:32 -0400623 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400625EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400628 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400630static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400631rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500633 dprintk_rcu("RPC: destroying %s client for %s\n",
634 clnt->cl_protname,
635 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500636 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400637 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400638 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400639 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500640 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500641 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500642 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500643 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400644 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646}
647
648/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400649 * Free an RPC client
650 */
651static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400652rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400653{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400654 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400655 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400656 return;
657 }
658
659 /*
660 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
661 * release remaining GSS contexts. This mechanism ensures
662 * that it can do so safely.
663 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400664 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400665 rpcauth_release(clnt->cl_auth);
666 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400667 if (atomic_dec_and_test(&clnt->cl_count))
668 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400669}
670
671/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400672 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 */
674void
675rpc_release_client(struct rpc_clnt *clnt)
676{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400677 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Trond Myklebust34f52e32007-06-14 16:40:31 -0400679 if (list_empty(&clnt->cl_tasks))
680 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400681 if (atomic_dec_and_test(&clnt->cl_count))
682 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400683}
684
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000685/**
686 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800687 * @old: old rpc_client
688 * @program: rpc program to set
689 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000690 *
691 * Clones the rpc client and sets up a new RPC program. This is mainly
692 * of use for enabling different RPC programs to share the same transport.
693 * The Sun NFSv2/v3 ACL protocol can do this.
694 */
695struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500696 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400697 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000698{
Trond Myklebustf994c432012-11-01 12:14:14 -0400699 struct rpc_create_args args = {
700 .program = program,
701 .prognumber = program->number,
702 .version = vers,
703 .authflavor = old->cl_auth->au_flavor,
704 .client_name = old->cl_principal,
705 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000706 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000707 int err;
708
Trond Myklebustf994c432012-11-01 12:14:14 -0400709 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000710 if (IS_ERR(clnt))
711 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500712 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000713 if (err != 0) {
714 rpc_shutdown_client(clnt);
715 clnt = ERR_PTR(err);
716 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800717out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000718 return clnt;
719}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400720EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000721
Trond Myklebust58f96122010-07-31 14:29:08 -0400722void rpc_task_release_client(struct rpc_task *task)
723{
724 struct rpc_clnt *clnt = task->tk_client;
725
726 if (clnt != NULL) {
727 /* Remove from client task list */
728 spin_lock(&clnt->cl_lock);
729 list_del(&task->tk_task);
730 spin_unlock(&clnt->cl_lock);
731 task->tk_client = NULL;
732
733 rpc_release_client(clnt);
734 }
735}
736
737static
738void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
739{
740 if (clnt != NULL) {
741 rpc_task_release_client(task);
742 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400743 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400744 if (clnt->cl_softrtry)
745 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700746 if (sk_memalloc_socks()) {
747 struct rpc_xprt *xprt;
748
749 rcu_read_lock();
750 xprt = rcu_dereference(clnt->cl_xprt);
751 if (xprt->swapper)
752 task->tk_flags |= RPC_TASK_SWAPPER;
753 rcu_read_unlock();
754 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400755 /* Add to the client's list of all tasks */
756 spin_lock(&clnt->cl_lock);
757 list_add_tail(&task->tk_task, &clnt->cl_tasks);
758 spin_unlock(&clnt->cl_lock);
759 }
760}
761
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000762void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
763{
764 rpc_task_release_client(task);
765 rpc_task_set_client(task, clnt);
766}
767EXPORT_SYMBOL_GPL(rpc_task_reset_client);
768
769
Trond Myklebust58f96122010-07-31 14:29:08 -0400770static void
771rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
772{
773 if (msg != NULL) {
774 task->tk_msg.rpc_proc = msg->rpc_proc;
775 task->tk_msg.rpc_argp = msg->rpc_argp;
776 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400777 if (msg->rpc_cred != NULL)
778 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400779 }
780}
781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782/*
783 * Default callback for async RPC calls
784 */
785static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100786rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787{
788}
789
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100790static const struct rpc_call_ops rpc_default_ops = {
791 .rpc_call_done = rpc_default_callback,
792};
793
Trond Myklebustc970aa82007-07-14 15:39:59 -0400794/**
795 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
796 * @task_setup_data: pointer to task initialisation data
797 */
798struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400799{
Trond Myklebust19445b92010-04-16 16:41:10 -0400800 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400801
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400802 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400803 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400804 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400805
Trond Myklebust58f96122010-07-31 14:29:08 -0400806 rpc_task_set_client(task, task_setup_data->rpc_client);
807 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
808
Trond Myklebust58f96122010-07-31 14:29:08 -0400809 if (task->tk_action == NULL)
810 rpc_call_start(task);
811
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400812 atomic_inc(&task->tk_count);
813 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400814out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400815 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400816}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400817EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400818
819/**
820 * rpc_call_sync - Perform a synchronous RPC call
821 * @clnt: pointer to RPC client
822 * @msg: RPC call parameters
823 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500825int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
827 struct rpc_task *task;
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400828 struct rpc_task_setup task_setup_data = {
829 .rpc_client = clnt,
830 .rpc_message = msg,
831 .callback_ops = &rpc_default_ops,
832 .flags = flags,
833 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400834 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400836 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
837 if (flags & RPC_TASK_ASYNC) {
838 rpc_release_calldata(task_setup_data.callback_ops,
839 task_setup_data.callback_data);
840 return -EINVAL;
841 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Trond Myklebustc970aa82007-07-14 15:39:59 -0400843 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400844 if (IS_ERR(task))
845 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100846 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800847 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 return status;
849}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400850EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400852/**
853 * rpc_call_async - Perform an asynchronous RPC call
854 * @clnt: pointer to RPC client
855 * @msg: RPC call parameters
856 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800857 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400858 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 */
860int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500861rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100862 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
864 struct rpc_task *task;
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400865 struct rpc_task_setup task_setup_data = {
866 .rpc_client = clnt,
867 .rpc_message = msg,
868 .callback_ops = tk_ops,
869 .callback_data = data,
870 .flags = flags|RPC_TASK_ASYNC,
871 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Trond Myklebustc970aa82007-07-14 15:39:59 -0400873 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400874 if (IS_ERR(task))
875 return PTR_ERR(task);
876 rpc_put_task(task);
877 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400879EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400881#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400882/**
883 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
884 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400885 * @req: RPC request
886 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400887 */
888struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400889 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400890{
891 struct rpc_task *task;
892 struct xdr_buf *xbufp = &req->rq_snd_buf;
893 struct rpc_task_setup task_setup_data = {
894 .callback_ops = tk_ops,
895 };
896
897 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
898 /*
899 * Create an rpc_task to send the data
900 */
901 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400902 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400903 xprt_free_bc_request(req);
904 goto out;
905 }
906 task->tk_rqstp = req;
907
908 /*
909 * Set up the xdr_buf length.
910 * This also indicates that the buffer is XDR encoded already.
911 */
912 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
913 xbufp->tail[0].iov_len;
914
915 task->tk_action = call_bc_transmit;
916 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400917 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400918 rpc_execute(task);
919
920out:
921 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
922 return task;
923}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400924#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400925
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400927rpc_call_start(struct rpc_task *task)
928{
929 task->tk_action = call_start;
930}
931EXPORT_SYMBOL_GPL(rpc_call_start);
932
Chuck Levered394402006-08-22 20:06:17 -0400933/**
934 * rpc_peeraddr - extract remote peer address from clnt's xprt
935 * @clnt: RPC client structure
936 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800937 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400938 *
939 * Returns the number of bytes that are actually in the stored address.
940 */
941size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
942{
943 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500944 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400945
Trond Myklebust2446ab62012-03-01 17:00:56 -0500946 rcu_read_lock();
947 xprt = rcu_dereference(clnt->cl_xprt);
948
949 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400950 if (bytes > bufsize)
951 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500952 memcpy(buf, &xprt->addr, bytes);
953 rcu_read_unlock();
954
955 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400956}
Chuck Leverb86acd52006-08-22 20:06:22 -0400957EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400958
Chuck Leverf425eba2006-08-22 20:06:18 -0400959/**
960 * rpc_peeraddr2str - return remote peer address in printable format
961 * @clnt: RPC client structure
962 * @format: address format
963 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500964 * NB: the lifetime of the memory referenced by the returned pointer is
965 * the same as the rpc_xprt itself. As long as the caller uses this
966 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400967 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500968const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
969 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400970{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500971 struct rpc_xprt *xprt;
972
973 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500974
975 if (xprt->address_strings[format] != NULL)
976 return xprt->address_strings[format];
977 else
978 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400979}
Chuck Leverb86acd52006-08-22 20:06:22 -0400980EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400981
Chuck Lever2e738fd2012-03-01 17:01:14 -0500982static const struct sockaddr_in rpc_inaddr_loopback = {
983 .sin_family = AF_INET,
984 .sin_addr.s_addr = htonl(INADDR_ANY),
985};
986
987static const struct sockaddr_in6 rpc_in6addr_loopback = {
988 .sin6_family = AF_INET6,
989 .sin6_addr = IN6ADDR_ANY_INIT,
990};
991
992/*
993 * Try a getsockname() on a connected datagram socket. Using a
994 * connected datagram socket prevents leaving a socket in TIME_WAIT.
995 * This conserves the ephemeral port number space.
996 *
997 * Returns zero and fills in "buf" if successful; otherwise, a
998 * negative errno is returned.
999 */
1000static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1001 struct sockaddr *buf, int buflen)
1002{
1003 struct socket *sock;
1004 int err;
1005
1006 err = __sock_create(net, sap->sa_family,
1007 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1008 if (err < 0) {
1009 dprintk("RPC: can't create UDP socket (%d)\n", err);
1010 goto out;
1011 }
1012
1013 switch (sap->sa_family) {
1014 case AF_INET:
1015 err = kernel_bind(sock,
1016 (struct sockaddr *)&rpc_inaddr_loopback,
1017 sizeof(rpc_inaddr_loopback));
1018 break;
1019 case AF_INET6:
1020 err = kernel_bind(sock,
1021 (struct sockaddr *)&rpc_in6addr_loopback,
1022 sizeof(rpc_in6addr_loopback));
1023 break;
1024 default:
1025 err = -EAFNOSUPPORT;
1026 goto out;
1027 }
1028 if (err < 0) {
1029 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1030 goto out_release;
1031 }
1032
1033 err = kernel_connect(sock, sap, salen, 0);
1034 if (err < 0) {
1035 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1036 goto out_release;
1037 }
1038
1039 err = kernel_getsockname(sock, buf, &buflen);
1040 if (err < 0) {
1041 dprintk("RPC: getsockname failed (%d)\n", err);
1042 goto out_release;
1043 }
1044
1045 err = 0;
1046 if (buf->sa_family == AF_INET6) {
1047 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1048 sin6->sin6_scope_id = 0;
1049 }
1050 dprintk("RPC: %s succeeded\n", __func__);
1051
1052out_release:
1053 sock_release(sock);
1054out:
1055 return err;
1056}
1057
1058/*
1059 * Scraping a connected socket failed, so we don't have a useable
1060 * local address. Fallback: generate an address that will prevent
1061 * the server from calling us back.
1062 *
1063 * Returns zero and fills in "buf" if successful; otherwise, a
1064 * negative errno is returned.
1065 */
1066static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1067{
1068 switch (family) {
1069 case AF_INET:
1070 if (buflen < sizeof(rpc_inaddr_loopback))
1071 return -EINVAL;
1072 memcpy(buf, &rpc_inaddr_loopback,
1073 sizeof(rpc_inaddr_loopback));
1074 break;
1075 case AF_INET6:
1076 if (buflen < sizeof(rpc_in6addr_loopback))
1077 return -EINVAL;
1078 memcpy(buf, &rpc_in6addr_loopback,
1079 sizeof(rpc_in6addr_loopback));
1080 default:
1081 dprintk("RPC: %s: address family not supported\n",
1082 __func__);
1083 return -EAFNOSUPPORT;
1084 }
1085 dprintk("RPC: %s: succeeded\n", __func__);
1086 return 0;
1087}
1088
1089/**
1090 * rpc_localaddr - discover local endpoint address for an RPC client
1091 * @clnt: RPC client structure
1092 * @buf: target buffer
1093 * @buflen: size of target buffer, in bytes
1094 *
1095 * Returns zero and fills in "buf" and "buflen" if successful;
1096 * otherwise, a negative errno is returned.
1097 *
1098 * This works even if the underlying transport is not currently connected,
1099 * or if the upper layer never previously provided a source address.
1100 *
1101 * The result of this function call is transient: multiple calls in
1102 * succession may give different results, depending on how local
1103 * networking configuration changes over time.
1104 */
1105int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1106{
1107 struct sockaddr_storage address;
1108 struct sockaddr *sap = (struct sockaddr *)&address;
1109 struct rpc_xprt *xprt;
1110 struct net *net;
1111 size_t salen;
1112 int err;
1113
1114 rcu_read_lock();
1115 xprt = rcu_dereference(clnt->cl_xprt);
1116 salen = xprt->addrlen;
1117 memcpy(sap, &xprt->addr, salen);
1118 net = get_net(xprt->xprt_net);
1119 rcu_read_unlock();
1120
1121 rpc_set_port(sap, 0);
1122 err = rpc_sockname(net, sap, salen, buf, buflen);
1123 put_net(net);
1124 if (err != 0)
1125 /* Couldn't discover local address, return ANYADDR */
1126 return rpc_anyaddr(sap->sa_family, buf, buflen);
1127 return 0;
1128}
1129EXPORT_SYMBOL_GPL(rpc_localaddr);
1130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131void
1132rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1133{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001134 struct rpc_xprt *xprt;
1135
1136 rcu_read_lock();
1137 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001138 if (xprt->ops->set_buffer_size)
1139 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001140 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001142EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
Trond Myklebust2446ab62012-03-01 17:00:56 -05001144/**
1145 * rpc_protocol - Get transport protocol number for an RPC client
1146 * @clnt: RPC client to query
1147 *
1148 */
1149int rpc_protocol(struct rpc_clnt *clnt)
1150{
1151 int protocol;
1152
1153 rcu_read_lock();
1154 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1155 rcu_read_unlock();
1156 return protocol;
1157}
1158EXPORT_SYMBOL_GPL(rpc_protocol);
1159
1160/**
1161 * rpc_net_ns - Get the network namespace for this RPC client
1162 * @clnt: RPC client to query
1163 *
1164 */
1165struct net *rpc_net_ns(struct rpc_clnt *clnt)
1166{
1167 struct net *ret;
1168
1169 rcu_read_lock();
1170 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1171 rcu_read_unlock();
1172 return ret;
1173}
1174EXPORT_SYMBOL_GPL(rpc_net_ns);
1175
1176/**
1177 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1178 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 *
1180 * For stream transports, this is one RPC record fragment (see RFC
1181 * 1831), as we don't support multi-record requests yet. For datagram
1182 * transports, this is the size of an IP packet minus the IP, UDP, and
1183 * RPC header sizes.
1184 */
1185size_t rpc_max_payload(struct rpc_clnt *clnt)
1186{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001187 size_t ret;
1188
1189 rcu_read_lock();
1190 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1191 rcu_read_unlock();
1192 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193}
Chuck Leverb86acd52006-08-22 20:06:22 -04001194EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Chuck Lever35f5a422006-01-03 09:55:50 +01001196/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001197 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001198 * @clnt: RPC client to query
1199 */
1200unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1201{
1202 unsigned long ret;
1203
1204 rcu_read_lock();
1205 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1206 rcu_read_unlock();
1207 return ret;
1208}
1209EXPORT_SYMBOL_GPL(rpc_get_timeout);
1210
1211/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001212 * rpc_force_rebind - force transport to check that remote port is unchanged
1213 * @clnt: client to rebind
1214 *
1215 */
1216void rpc_force_rebind(struct rpc_clnt *clnt)
1217{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001218 if (clnt->cl_autobind) {
1219 rcu_read_lock();
1220 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1221 rcu_read_unlock();
1222 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001223}
Chuck Leverb86acd52006-08-22 20:06:22 -04001224EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001225
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001227 * Restart an (async) RPC call from the call_prepare state.
1228 * Usually called from within the exit handler.
1229 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001230int
Andy Adamsonaae20062009-04-01 09:22:40 -04001231rpc_restart_call_prepare(struct rpc_task *task)
1232{
1233 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001234 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001235 task->tk_action = call_start;
1236 if (task->tk_ops->rpc_call_prepare != NULL)
1237 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001238 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001239}
1240EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1241
1242/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 * Restart an (async) RPC call. Usually called from within the
1244 * exit handler.
1245 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001246int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247rpc_restart_call(struct rpc_task *task)
1248{
1249 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001250 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001252 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001254EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Chuck Lever3748f1e2008-05-21 17:09:12 -04001256#ifdef RPC_DEBUG
1257static const char *rpc_proc_name(const struct rpc_task *task)
1258{
1259 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1260
1261 if (proc) {
1262 if (proc->p_name)
1263 return proc->p_name;
1264 else
1265 return "NULL";
1266 } else
1267 return "no proc";
1268}
1269#endif
1270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271/*
1272 * 0. Initial state
1273 *
1274 * Other FSM states can be visited zero or more times, but
1275 * this state is visited exactly once for each RPC.
1276 */
1277static void
1278call_start(struct rpc_task *task)
1279{
1280 struct rpc_clnt *clnt = task->tk_client;
1281
Chuck Lever3748f1e2008-05-21 17:09:12 -04001282 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001283 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001284 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001285 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 /* Increment call count */
1288 task->tk_msg.rpc_proc->p_count++;
1289 clnt->cl_stats->rpccnt++;
1290 task->tk_action = call_reserve;
1291}
1292
1293/*
1294 * 1. Reserve an RPC call slot
1295 */
1296static void
1297call_reserve(struct rpc_task *task)
1298{
Chuck Lever46121cf2007-01-31 12:14:08 -05001299 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 task->tk_status = 0;
1302 task->tk_action = call_reserveresult;
1303 xprt_reserve(task);
1304}
1305
Trond Myklebustba60eb22013-04-14 10:49:37 -04001306static void call_retry_reserve(struct rpc_task *task);
1307
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308/*
1309 * 1b. Grok the result of xprt_reserve()
1310 */
1311static void
1312call_reserveresult(struct rpc_task *task)
1313{
1314 int status = task->tk_status;
1315
Chuck Lever46121cf2007-01-31 12:14:08 -05001316 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
1318 /*
1319 * After a call to xprt_reserve(), we must have either
1320 * a request slot or else an error status.
1321 */
1322 task->tk_status = 0;
1323 if (status >= 0) {
1324 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001325 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 return;
1327 }
1328
1329 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001330 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 rpc_exit(task, -EIO);
1332 return;
1333 }
1334
1335 /*
1336 * Even though there was an error, we may have acquired
1337 * a request slot somehow. Make sure not to leak it.
1338 */
1339 if (task->tk_rqstp) {
1340 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001341 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 xprt_release(task);
1343 }
1344
1345 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001346 case -ENOMEM:
1347 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001349 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 return;
1351 case -EIO: /* probably a shutdown */
1352 break;
1353 default:
1354 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001355 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 break;
1357 }
1358 rpc_exit(task, status);
1359}
1360
1361/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001362 * 1c. Retry reserving an RPC call slot
1363 */
1364static void
1365call_retry_reserve(struct rpc_task *task)
1366{
1367 dprint_status(task);
1368
1369 task->tk_status = 0;
1370 task->tk_action = call_reserveresult;
1371 xprt_retry_reserve(task);
1372}
1373
1374/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001375 * 2. Bind and/or refresh the credentials
1376 */
1377static void
1378call_refresh(struct rpc_task *task)
1379{
1380 dprint_status(task);
1381
1382 task->tk_action = call_refreshresult;
1383 task->tk_status = 0;
1384 task->tk_client->cl_stats->rpcauthrefresh++;
1385 rpcauth_refreshcred(task);
1386}
1387
1388/*
1389 * 2a. Process the results of a credential refresh
1390 */
1391static void
1392call_refreshresult(struct rpc_task *task)
1393{
1394 int status = task->tk_status;
1395
1396 dprint_status(task);
1397
1398 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001399 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001400 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001401 case 0:
1402 if (rpcauth_uptodatecred(task))
1403 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001404 return;
1405 case -ETIMEDOUT:
1406 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001407 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001408 case -EAGAIN:
1409 status = -EACCES;
1410 if (!task->tk_cred_retry)
1411 break;
1412 task->tk_cred_retry--;
1413 dprintk("RPC: %5u %s: retry refresh creds\n",
1414 task->tk_pid, __func__);
1415 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001416 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001417 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1418 task->tk_pid, __func__, status);
1419 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001420}
1421
1422/*
1423 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001424 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 */
1426static void
1427call_allocate(struct rpc_task *task)
1428{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001429 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001430 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001431 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001432 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433
Chuck Lever46121cf2007-01-31 12:14:08 -05001434 dprint_status(task);
1435
Chuck Lever2bea90d2007-03-29 16:47:53 -04001436 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001437 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001438
Chuck Lever02107142006-01-03 09:55:49 +01001439 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 return;
1441
Chuck Lever2bea90d2007-03-29 16:47:53 -04001442 if (proc->p_proc != 0) {
1443 BUG_ON(proc->p_arglen == 0);
1444 if (proc->p_decode != NULL)
1445 BUG_ON(proc->p_replen == 0);
1446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
Chuck Lever2bea90d2007-03-29 16:47:53 -04001448 /*
1449 * Calculate the size (in quads) of the RPC call
1450 * and reply headers, and convert both values
1451 * to byte sizes.
1452 */
1453 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1454 req->rq_callsize <<= 2;
1455 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1456 req->rq_rcvsize <<= 2;
1457
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001458 req->rq_buffer = xprt->ops->buf_alloc(task,
1459 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001460 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001462
1463 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
Trond Myklebust5afa91332011-06-17 10:14:59 -04001465 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001466 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 rpc_delay(task, HZ>>4);
1468 return;
1469 }
1470
1471 rpc_exit(task, -ERESTARTSYS);
1472}
1473
Trond Myklebust940e3312005-11-09 21:45:24 -05001474static inline int
1475rpc_task_need_encode(struct rpc_task *task)
1476{
1477 return task->tk_rqstp->rq_snd_buf.len == 0;
1478}
1479
1480static inline void
1481rpc_task_force_reencode(struct rpc_task *task)
1482{
1483 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001484 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001485}
1486
Chuck Lever2bea90d2007-03-29 16:47:53 -04001487static inline void
1488rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1489{
1490 buf->head[0].iov_base = start;
1491 buf->head[0].iov_len = len;
1492 buf->tail[0].iov_len = 0;
1493 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001494 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001495 buf->len = 0;
1496 buf->buflen = len;
1497}
1498
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499/*
1500 * 3. Encode arguments of an RPC call
1501 */
1502static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001503rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001506 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001507 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
Chuck Lever46121cf2007-01-31 12:14:08 -05001509 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Chuck Lever2bea90d2007-03-29 16:47:53 -04001511 rpc_xdr_buf_init(&req->rq_snd_buf,
1512 req->rq_buffer,
1513 req->rq_callsize);
1514 rpc_xdr_buf_init(&req->rq_rcv_buf,
1515 (char *)req->rq_buffer + req->rq_callsize,
1516 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
Chuck Leverb0e1c572008-05-21 17:09:19 -04001518 p = rpc_encode_header(task);
1519 if (p == NULL) {
1520 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 rpc_exit(task, -EIO);
1522 return;
1523 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001524
1525 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001526 if (encode == NULL)
1527 return;
1528
1529 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1530 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531}
1532
1533/*
1534 * 4. Get the server port number if not yet set
1535 */
1536static void
1537call_bind(struct rpc_task *task)
1538{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001539 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
Chuck Lever46121cf2007-01-31 12:14:08 -05001541 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Chuck Leverda351872005-08-11 16:25:11 -04001543 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001544 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001545 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001546 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001547 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 }
1549}
1550
1551/*
Chuck Leverda351872005-08-11 16:25:11 -04001552 * 4a. Sort out bind result
1553 */
1554static void
1555call_bind_status(struct rpc_task *task)
1556{
Chuck Lever906462a2007-09-11 18:00:47 -04001557 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001558
1559 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001560 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001561 task->tk_status = 0;
1562 task->tk_action = call_connect;
1563 return;
1564 }
1565
Steve Dickson5753cba2012-02-06 10:08:08 -05001566 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001567 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001568 case -ENOMEM:
1569 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1570 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001571 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001572 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001573 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1574 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001575 /* fail immediately if this is an RPC ping */
1576 if (task->tk_msg.rpc_proc->p_proc == 0) {
1577 status = -EOPNOTSUPP;
1578 break;
1579 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001580 if (task->tk_rebind_retry == 0)
1581 break;
1582 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001583 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001584 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001585 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001586 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001587 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001588 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001589 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001590 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001591 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001592 task->tk_pid);
1593 break;
1594 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001595 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001596 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001597 task->tk_status = 0;
1598 task->tk_action = call_bind;
1599 return;
Chuck Lever012da152009-12-03 15:58:56 -05001600 case -ECONNREFUSED: /* connection problems */
1601 case -ECONNRESET:
1602 case -ENOTCONN:
1603 case -EHOSTDOWN:
1604 case -EHOSTUNREACH:
1605 case -ENETUNREACH:
1606 case -EPIPE:
1607 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1608 task->tk_pid, task->tk_status);
1609 if (!RPC_IS_SOFTCONN(task)) {
1610 rpc_delay(task, 5*HZ);
1611 goto retry_timeout;
1612 }
1613 status = task->tk_status;
1614 break;
Chuck Leverda351872005-08-11 16:25:11 -04001615 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001616 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001617 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001618 }
1619
1620 rpc_exit(task, status);
1621 return;
1622
Trond Myklebustda458282006-08-31 15:44:52 -04001623retry_timeout:
1624 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001625}
1626
1627/*
1628 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 */
1630static void
1631call_connect(struct rpc_task *task)
1632{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001633 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
Chuck Lever46121cf2007-01-31 12:14:08 -05001635 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001636 task->tk_pid, xprt,
1637 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Chuck Leverda351872005-08-11 16:25:11 -04001639 task->tk_action = call_transmit;
1640 if (!xprt_connected(xprt)) {
1641 task->tk_action = call_connect_status;
1642 if (task->tk_status < 0)
1643 return;
1644 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646}
1647
1648/*
Chuck Leverda351872005-08-11 16:25:11 -04001649 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 */
1651static void
1652call_connect_status(struct rpc_task *task)
1653{
1654 struct rpc_clnt *clnt = task->tk_client;
1655 int status = task->tk_status;
1656
Chuck Lever46121cf2007-01-31 12:14:08 -05001657 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001658
Steve Dickson5753cba2012-02-06 10:08:08 -05001659 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001661 /* if soft mounted, test if we've timed out */
1662 case -ETIMEDOUT:
1663 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001664 return;
1665 case -ECONNREFUSED:
1666 case -ECONNRESET:
1667 case -ENETUNREACH:
1668 if (RPC_IS_SOFTCONN(task))
1669 break;
1670 /* retry with existing socket, after a delay */
1671 case 0:
1672 case -EAGAIN:
1673 task->tk_status = 0;
1674 clnt->cl_stats->netreconn++;
1675 task->tk_action = call_transmit;
1676 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001678 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
1680
1681/*
1682 * 5. Transmit the RPC request, and wait for reply
1683 */
1684static void
1685call_transmit(struct rpc_task *task)
1686{
Chuck Lever46121cf2007-01-31 12:14:08 -05001687 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
1689 task->tk_action = call_status;
1690 if (task->tk_status < 0)
1691 return;
1692 task->tk_status = xprt_prepare_transmit(task);
1693 if (task->tk_status != 0)
1694 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001695 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001697 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001698 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001699 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001700 if (task->tk_status != 0) {
1701 /* Was the error nonfatal? */
1702 if (task->tk_status == -EAGAIN)
1703 rpc_delay(task, HZ >> 4);
1704 else
1705 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001706 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001707 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001708 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 xprt_transmit(task);
1710 if (task->tk_status < 0)
1711 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001712 /*
1713 * On success, ensure that we call xprt_end_transmit() before sleeping
1714 * in order to allow access to the socket to other RPC requests.
1715 */
1716 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001717 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001718 return;
1719 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001720 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001721}
1722
1723/*
1724 * 5a. Handle cleanup after a transmission
1725 */
1726static void
1727call_transmit_status(struct rpc_task *task)
1728{
1729 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001730
1731 /*
1732 * Common case: success. Force the compiler to put this
1733 * test first.
1734 */
1735 if (task->tk_status == 0) {
1736 xprt_end_transmit(task);
1737 rpc_task_force_reencode(task);
1738 return;
1739 }
1740
Trond Myklebust15f081c2009-03-11 14:37:57 -04001741 switch (task->tk_status) {
1742 case -EAGAIN:
1743 break;
1744 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001745 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001746 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001747 rpc_task_force_reencode(task);
1748 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001749 /*
1750 * Special cases: if we've been waiting on the
1751 * socket's write_space() callback, or if the
1752 * socket just returned a connection error,
1753 * then hold onto the transport lock.
1754 */
1755 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001756 case -EHOSTDOWN:
1757 case -EHOSTUNREACH:
1758 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001759 if (RPC_IS_SOFTCONN(task)) {
1760 xprt_end_transmit(task);
1761 rpc_exit(task, task->tk_status);
1762 break;
1763 }
1764 case -ECONNRESET:
1765 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001766 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001767 rpc_task_force_reencode(task);
1768 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769}
1770
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001771#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001772/*
1773 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1774 * addition, disconnect on connectivity errors.
1775 */
1776static void
1777call_bc_transmit(struct rpc_task *task)
1778{
1779 struct rpc_rqst *req = task->tk_rqstp;
1780
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001781 task->tk_status = xprt_prepare_transmit(task);
1782 if (task->tk_status == -EAGAIN) {
1783 /*
1784 * Could not reserve the transport. Try again after the
1785 * transport is released.
1786 */
1787 task->tk_status = 0;
1788 task->tk_action = call_bc_transmit;
1789 return;
1790 }
1791
1792 task->tk_action = rpc_exit_task;
1793 if (task->tk_status < 0) {
1794 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1795 "error: %d\n", task->tk_status);
1796 return;
1797 }
1798
1799 xprt_transmit(task);
1800 xprt_end_transmit(task);
1801 dprint_status(task);
1802 switch (task->tk_status) {
1803 case 0:
1804 /* Success */
1805 break;
1806 case -EHOSTDOWN:
1807 case -EHOSTUNREACH:
1808 case -ENETUNREACH:
1809 case -ETIMEDOUT:
1810 /*
1811 * Problem reaching the server. Disconnect and let the
1812 * forechannel reestablish the connection. The server will
1813 * have to retransmit the backchannel request and we'll
1814 * reprocess it. Since these ops are idempotent, there's no
1815 * need to cache our reply at this time.
1816 */
1817 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1818 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001819 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001820 req->rq_connect_cookie);
1821 break;
1822 default:
1823 /*
1824 * We were unable to reply and will have to drop the
1825 * request. The server should reconnect and retransmit.
1826 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001827 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001828 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1829 "error: %d\n", task->tk_status);
1830 break;
1831 }
1832 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1833}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001834#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001835
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836/*
1837 * 6. Sort out the RPC call status
1838 */
1839static void
1840call_status(struct rpc_task *task)
1841{
1842 struct rpc_clnt *clnt = task->tk_client;
1843 struct rpc_rqst *req = task->tk_rqstp;
1844 int status;
1845
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001846 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1847 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
Chuck Lever46121cf2007-01-31 12:14:08 -05001849 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850
1851 status = task->tk_status;
1852 if (status >= 0) {
1853 task->tk_action = call_decode;
1854 return;
1855 }
1856
Steve Dickson5753cba2012-02-06 10:08:08 -05001857 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 task->tk_status = 0;
1859 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001860 case -EHOSTDOWN:
1861 case -EHOSTUNREACH:
1862 case -ENETUNREACH:
1863 /*
1864 * Delay any retries for 3 seconds, then handle as if it
1865 * were a timeout.
1866 */
1867 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 case -ETIMEDOUT:
1869 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001870 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001871 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001872 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001874 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001876 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001877 rpc_delay(task, 3*HZ);
1878 case -EPIPE:
1879 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 task->tk_action = call_bind;
1881 break;
1882 case -EAGAIN:
1883 task->tk_action = call_transmit;
1884 break;
1885 case -EIO:
1886 /* shutdown or soft timeout */
1887 rpc_exit(task, status);
1888 break;
1889 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001890 if (clnt->cl_chatty)
1891 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 clnt->cl_protname, -status);
1893 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 }
1895}
1896
1897/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001898 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 * We do not release the request slot, so we keep using the
1900 * same XID for all retransmits.
1901 */
1902static void
1903call_timeout(struct rpc_task *task)
1904{
1905 struct rpc_clnt *clnt = task->tk_client;
1906
1907 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001908 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 goto retry;
1910 }
1911
Chuck Lever46121cf2007-01-31 12:14:08 -05001912 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001913 task->tk_timeouts++;
1914
Chuck Lever3a28bec2009-12-03 15:58:56 -05001915 if (RPC_IS_SOFTCONN(task)) {
1916 rpc_exit(task, -ETIMEDOUT);
1917 return;
1918 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001920 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001921 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001922 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001923 clnt->cl_protname,
1924 rcu_dereference(clnt->cl_xprt)->servername);
1925 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001926 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001927 if (task->tk_flags & RPC_TASK_TIMEOUT)
1928 rpc_exit(task, -ETIMEDOUT);
1929 else
1930 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 return;
1932 }
1933
Chuck Leverf518e35a2006-01-03 09:55:52 +01001934 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001936 if (clnt->cl_chatty) {
1937 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001938 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001939 clnt->cl_protname,
1940 rcu_dereference(clnt->cl_xprt)->servername);
1941 rcu_read_unlock();
1942 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001944 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001945 /*
1946 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1947 * event? RFC2203 requires the server to drop all such requests.
1948 */
1949 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950
1951retry:
1952 clnt->cl_stats->rpcretrans++;
1953 task->tk_action = call_bind;
1954 task->tk_status = 0;
1955}
1956
1957/*
1958 * 7. Decode the RPC reply
1959 */
1960static void
1961call_decode(struct rpc_task *task)
1962{
1963 struct rpc_clnt *clnt = task->tk_client;
1964 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001965 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001966 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
Vasily Averin726fd6a2011-06-01 16:23:59 +04001968 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Chuck Leverf518e35a2006-01-03 09:55:52 +01001970 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001971 if (clnt->cl_chatty) {
1972 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001973 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001974 clnt->cl_protname,
1975 rcu_dereference(clnt->cl_xprt)->servername);
1976 rcu_read_unlock();
1977 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1979 }
1980
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001981 /*
1982 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001983 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001984 */
1985 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 req->rq_rcv_buf.len = req->rq_private_buf.len;
1987
1988 /* Check that the softirq receive buffer is valid */
1989 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1990 sizeof(req->rq_rcv_buf)) != 0);
1991
Trond Myklebust1e799b62008-03-21 16:19:41 -04001992 if (req->rq_rcv_buf.len < 12) {
1993 if (!RPC_IS_SOFT(task)) {
1994 task->tk_action = call_bind;
1995 clnt->cl_stats->rpcretrans++;
1996 goto out_retry;
1997 }
1998 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1999 clnt->cl_protname, task->tk_status);
2000 task->tk_action = call_timeout;
2001 goto out_retry;
2002 }
2003
Chuck Leverb0e1c572008-05-21 17:09:19 -04002004 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002005 if (IS_ERR(p)) {
2006 if (p == ERR_PTR(-EAGAIN))
2007 goto out_retry;
2008 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 }
2010
Trond Myklebustabbcf282006-01-03 09:55:03 +01002011 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002013 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2015 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002016 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002017 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2018 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 return;
2020out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002022 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002023 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002024 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002025 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002026 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002027 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029}
2030
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002031static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002032rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033{
2034 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002036 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
2038 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002039
Trond Myklebusta4f08352013-01-08 09:10:21 -05002040 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 *p++ = req->rq_xid; /* XID */
2042 *p++ = htonl(RPC_CALL); /* CALL */
2043 *p++ = htonl(RPC_VERSION); /* RPC version */
2044 *p++ = htonl(clnt->cl_prog); /* program number */
2045 *p++ = htonl(clnt->cl_vers); /* program version */
2046 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002047 p = rpcauth_marshcred(task, p);
2048 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2049 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050}
2051
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002052static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002053rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002055 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2057 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002058 __be32 *p = iov->iov_base;
2059 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 int error = -EACCES;
2061
David Howellse8896492006-08-24 15:44:19 -04002062 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2063 /* RFC-1014 says that the representation of XDR data must be a
2064 * multiple of four bytes
2065 * - if it isn't pointer subtraction in the NFS client may give
2066 * undefined results
2067 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002068 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002069 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002070 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002071 goto out_eio;
2072 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 if ((len -= 3) < 0)
2074 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002076 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002078 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002079 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002080 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002082
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2084 if (--len < 0)
2085 goto out_overflow;
2086 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002087 case RPC_AUTH_ERROR:
2088 break;
2089 case RPC_MISMATCH:
2090 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2091 task->tk_pid, __func__);
2092 error = -EPROTONOSUPPORT;
2093 goto out_err;
2094 default:
2095 dprintk("RPC: %5u %s: RPC call rejected, "
2096 "unknown error: %x\n",
2097 task->tk_pid, __func__, n);
2098 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 }
2100 if (--len < 0)
2101 goto out_overflow;
2102 switch ((n = ntohl(*p++))) {
2103 case RPC_AUTH_REJECTEDCRED:
2104 case RPC_AUTH_REJECTEDVERF:
2105 case RPCSEC_GSS_CREDPROBLEM:
2106 case RPCSEC_GSS_CTXPROBLEM:
2107 if (!task->tk_cred_retry)
2108 break;
2109 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002110 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002111 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002113 /* Ensure we obtain a new XID! */
2114 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002115 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002116 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 case RPC_AUTH_BADCRED:
2118 case RPC_AUTH_BADVERF:
2119 /* possibly garbled cred/verf? */
2120 if (!task->tk_garb_retry)
2121 break;
2122 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002123 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002124 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002126 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002128 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002129 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002130 "authentication.\n",
2131 rcu_dereference(clnt->cl_xprt)->servername);
2132 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 break;
2134 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002135 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002136 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 error = -EIO;
2138 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002139 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002140 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 goto out_err;
2142 }
2143 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002144 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002145 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002146 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002148 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 if (len < 0)
2150 goto out_overflow;
2151 switch ((n = ntohl(*p++))) {
2152 case RPC_SUCCESS:
2153 return p;
2154 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002155 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2156 "by server %s\n", task->tk_pid, __func__,
2157 (unsigned int)clnt->cl_prog,
2158 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002159 error = -EPFNOSUPPORT;
2160 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002162 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2163 "by server %s\n", task->tk_pid, __func__,
2164 (unsigned int)clnt->cl_prog,
2165 (unsigned int)clnt->cl_vers,
2166 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002167 error = -EPROTONOSUPPORT;
2168 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002170 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002171 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002172 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002173 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002174 clnt->cl_prog, clnt->cl_vers,
2175 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002176 error = -EOPNOTSUPP;
2177 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002179 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002180 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 break; /* retry */
2182 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002183 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002184 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 /* Also retry */
2186 }
2187
Trond Myklebustabbcf282006-01-03 09:55:03 +01002188out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002189 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 if (task->tk_garb_retry) {
2191 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002192 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002193 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002195out_retry:
2196 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198out_eio:
2199 error = -EIO;
2200out_err:
2201 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002202 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002203 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002204 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002206 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002207 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002208 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002210
Chuck Lever9f06c712010-12-14 14:59:18 +00002211static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002212{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002213}
2214
Chuck Leverbf269552010-12-14 14:59:29 +00002215static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002216{
2217 return 0;
2218}
2219
2220static struct rpc_procinfo rpcproc_null = {
2221 .p_encode = rpcproc_encode_null,
2222 .p_decode = rpcproc_decode_null,
2223};
2224
Chuck Levercaabea82009-12-03 15:58:56 -05002225static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002226{
2227 struct rpc_message msg = {
2228 .rpc_proc = &rpcproc_null,
2229 };
2230 int err;
2231 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002232 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002233 put_rpccred(msg.rpc_cred);
2234 return err;
2235}
Trond Myklebust188fef12007-06-16 14:18:40 -04002236
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002237struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2238{
2239 struct rpc_message msg = {
2240 .rpc_proc = &rpcproc_null,
2241 .rpc_cred = cred,
2242 };
Trond Myklebust84115e1c2007-07-14 15:39:59 -04002243 struct rpc_task_setup task_setup_data = {
2244 .rpc_client = clnt,
2245 .rpc_message = &msg,
2246 .callback_ops = &rpc_default_ops,
2247 .flags = flags,
2248 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002249 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002250}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002251EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002252
Trond Myklebust188fef12007-06-16 14:18:40 -04002253#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002254static void rpc_show_header(void)
2255{
Chuck Levercb3997b2008-05-21 17:09:41 -04002256 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2257 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002258}
2259
Chuck Lever38e886e2008-05-21 17:09:33 -04002260static void rpc_show_task(const struct rpc_clnt *clnt,
2261 const struct rpc_task *task)
2262{
2263 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002264
2265 if (RPC_IS_QUEUED(task))
2266 rpc_waitq = rpc_qname(task->tk_waitqueue);
2267
Joe Perchesb3bceda2010-12-21 10:52:24 -05002268 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 -04002269 task->tk_pid, task->tk_flags, task->tk_status,
2270 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2271 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002272 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002273}
2274
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002275void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002276{
2277 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002278 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002279 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002280 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002281
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002282 spin_lock(&sn->rpc_client_lock);
2283 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002284 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002285 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002286 if (!header) {
2287 rpc_show_header();
2288 header++;
2289 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002290 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002291 }
2292 spin_unlock(&clnt->cl_lock);
2293 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002294 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002295}
2296#endif