blob: a80ee9b80dcfe64f72d29361e2122c90005b6956 [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 Kinsburskyeee173252012-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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 err = -EINVAL;
308 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800309 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500310
311 if (args->version >= program->nrvers)
312 goto out_err;
313 version = program->version[args->version];
314 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 goto out_err;
316
317 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700318 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 if (!clnt)
320 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 clnt->cl_parent = clnt;
322
Trond Myklebust2446ab62012-03-01 17:00:56 -0500323 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 clnt->cl_procinfo = version->procs;
325 clnt->cl_maxproc = version->nrprocs;
326 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300327 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500330 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500331 err = -ENOMEM;
332 if (clnt->cl_metrics == NULL)
333 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500334 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400335 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400336 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Trond Myklebust2446ab62012-03-01 17:00:56 -0500338 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 clnt->cl_autobind = 1;
340
Trond Myklebustba7392b2007-12-20 16:03:55 -0500341 clnt->cl_timeout = xprt->timeout;
342 if (args->timeout != NULL) {
343 memcpy(&clnt->cl_timeout_default, args->timeout,
344 sizeof(clnt->cl_timeout_default));
345 clnt->cl_timeout = &clnt->cl_timeout_default;
346 }
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500349 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500350 clnt->cl_principal = NULL;
351 if (args->client_name) {
352 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
353 if (!clnt->cl_principal)
354 goto out_no_principal;
355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
Trond Myklebust006abe82010-09-12 19:55:25 -0400357 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
360 if (err < 0)
361 goto out_no_path;
362
Trond Myklebust698b6d02007-12-20 16:03:53 -0500363 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000364 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500366 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000367 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 goto out_no_auth;
369 }
370
371 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400372 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400373 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 return clnt;
375
376out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400377 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500379 kfree(clnt->cl_principal);
380out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500381 rpc_free_iostats(clnt->cl_metrics);
382out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 kfree(clnt);
384out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400385 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800386out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400387 rpciod_down();
388out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 return ERR_PTR(err);
390}
391
Ben Hutchings2c530402012-07-10 10:55:09 +0000392/**
Chuck Leverc2866762006-08-22 20:06:20 -0400393 * rpc_create - create an RPC client and transport with one call
394 * @args: rpc_clnt create argument structure
395 *
396 * Creates and initializes an RPC transport and an RPC client.
397 *
398 * It can ping the server in order to determine if it is up, and to see if
399 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
400 * this behavior so asynchronous tasks can also use rpc_create.
401 */
402struct rpc_clnt *rpc_create(struct rpc_create_args *args)
403{
404 struct rpc_xprt *xprt;
405 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400406 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400407 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400408 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200409 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200410 .dstaddr = args->address,
411 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500412 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300413 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200414 };
Chuck Lever510deb02007-12-10 14:56:24 -0500415 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400416
Chuck Leverc2866762006-08-22 20:06:20 -0400417 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400418 * If the caller chooses not to specify a hostname, whip
419 * up a string representation of the passed-in address.
420 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500421 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400422 struct sockaddr_un *sun =
423 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400424 struct sockaddr_in *sin =
425 (struct sockaddr_in *)args->address;
426 struct sockaddr_in6 *sin6 =
427 (struct sockaddr_in6 *)args->address;
428
Chuck Lever510deb02007-12-10 14:56:24 -0500429 servername[0] = '\0';
430 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400431 case AF_LOCAL:
432 snprintf(servername, sizeof(servername), "%s",
433 sun->sun_path);
434 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400435 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700436 snprintf(servername, sizeof(servername), "%pI4",
437 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500438 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400439 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700440 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400441 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500442 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500443 default:
444 /* caller wants default server name, but
445 * address family isn't recognized. */
446 return ERR_PTR(-EINVAL);
447 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500448 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400449 }
450
Chuck Lever510deb02007-12-10 14:56:24 -0500451 xprt = xprt_create_transport(&xprtargs);
452 if (IS_ERR(xprt))
453 return (struct rpc_clnt *)xprt;
454
Chuck Lever43780b82007-07-01 12:13:22 -0400455 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400456 * By default, kernel RPC client connects from a reserved port.
457 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
458 * but it is always enabled for rpciod, which handles the connect
459 * operation.
460 */
461 xprt->resvport = 1;
462 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
463 xprt->resvport = 0;
464
Trond Myklebust698b6d02007-12-20 16:03:53 -0500465 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400466 if (IS_ERR(clnt))
467 return clnt;
468
469 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500470 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400471 if (err != 0) {
472 rpc_shutdown_client(clnt);
473 return ERR_PTR(err);
474 }
475 }
476
477 clnt->cl_softrtry = 1;
478 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
479 clnt->cl_softrtry = 0;
480
Chuck Leverc2866762006-08-22 20:06:20 -0400481 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
482 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500483 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
484 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400485 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
486 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400487
488 return clnt;
489}
Chuck Leverb86acd52006-08-22 20:06:22 -0400490EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492/*
493 * This function clones the RPC client structure. It allows us to share the
494 * same transport while varying parameters such as the authentication
495 * flavour.
496 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400497static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
498 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500500 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400501 struct rpc_clnt *new;
502 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Chuck Lever1b63a752012-09-14 17:23:52 -0400504 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500505 rcu_read_lock();
506 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
507 rcu_read_unlock();
508 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400509 goto out_err;
510 args->servername = xprt->servername;
511
512 new = rpc_new_client(args, xprt);
513 if (IS_ERR(new)) {
514 err = PTR_ERR(new);
515 goto out_put;
516 }
517
Trond Myklebust006abe82010-09-12 19:55:25 -0400518 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400519 new->cl_parent = clnt;
520
521 /* Turn off autobind on clones */
522 new->cl_autobind = 0;
523 new->cl_softrtry = clnt->cl_softrtry;
524 new->cl_discrtry = clnt->cl_discrtry;
525 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400527
528out_put:
Trond Myklebust2446ab62012-03-01 17:00:56 -0500529 xprt_put(xprt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400530out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800531 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500532 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
Chuck Lever1b63a752012-09-14 17:23:52 -0400534
535/**
536 * rpc_clone_client - Clone an RPC client structure
537 *
538 * @clnt: RPC client whose parameters are copied
539 *
540 * Returns a fresh RPC client or an ERR_PTR.
541 */
542struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
543{
544 struct rpc_create_args args = {
545 .program = clnt->cl_program,
546 .prognumber = clnt->cl_prog,
547 .version = clnt->cl_vers,
548 .authflavor = clnt->cl_auth->au_flavor,
549 .client_name = clnt->cl_principal,
550 };
551 return __rpc_clone_client(&args, clnt);
552}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400553EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Chuck Leverba9b5842012-09-14 17:24:02 -0400555/**
556 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
557 *
558 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800559 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400560 *
561 * Returns a fresh RPC client or an ERR_PTR.
562 */
563struct rpc_clnt *
564rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
565{
566 struct rpc_create_args args = {
567 .program = clnt->cl_program,
568 .prognumber = clnt->cl_prog,
569 .version = clnt->cl_vers,
570 .authflavor = flavor,
571 .client_name = clnt->cl_principal,
572 };
573 return __rpc_clone_client(&args, clnt);
574}
575EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400578 * Kill all tasks for the given client.
579 * XXX: kill their descendants as well?
580 */
581void rpc_killall_tasks(struct rpc_clnt *clnt)
582{
583 struct rpc_task *rovr;
584
585
586 if (list_empty(&clnt->cl_tasks))
587 return;
588 dprintk("RPC: killing all tasks for client %p\n", clnt);
589 /*
590 * Spin lock all_tasks to prevent changes...
591 */
592 spin_lock(&clnt->cl_lock);
593 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
594 if (!RPC_IS_ACTIVATED(rovr))
595 continue;
596 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
597 rovr->tk_flags |= RPC_TASK_KILLED;
598 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300599 if (RPC_IS_QUEUED(rovr))
600 rpc_wake_up_queued_task(rovr->tk_waitqueue,
601 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400602 }
603 }
604 spin_unlock(&clnt->cl_lock);
605}
606EXPORT_SYMBOL_GPL(rpc_killall_tasks);
607
608/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400610 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400612void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400614 might_sleep();
615
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500616 dprintk_rcu("RPC: shutting down %s client for %s\n",
617 clnt->cl_protname,
618 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Trond Myklebust34f52e32007-06-14 16:40:31 -0400620 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800622 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400623 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 }
625
Trond Myklebust4c402b42007-06-14 16:40:32 -0400626 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400628EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400631 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400633static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400634rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500636 dprintk_rcu("RPC: destroying %s client for %s\n",
637 clnt->cl_protname,
638 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500639 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400640 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400641 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400642 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500643 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500644 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500645 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500646 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400647 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
651/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400652 * Free an RPC client
653 */
654static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400655rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400656{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400657 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400658 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400659 return;
660 }
661
662 /*
663 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
664 * release remaining GSS contexts. This mechanism ensures
665 * that it can do so safely.
666 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400667 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400668 rpcauth_release(clnt->cl_auth);
669 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400670 if (atomic_dec_and_test(&clnt->cl_count))
671 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400672}
673
674/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400675 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 */
677void
678rpc_release_client(struct rpc_clnt *clnt)
679{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400680 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Trond Myklebust34f52e32007-06-14 16:40:31 -0400682 if (list_empty(&clnt->cl_tasks))
683 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400684 if (atomic_dec_and_test(&clnt->cl_count))
685 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400686}
687
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000688/**
689 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800690 * @old: old rpc_client
691 * @program: rpc program to set
692 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000693 *
694 * Clones the rpc client and sets up a new RPC program. This is mainly
695 * of use for enabling different RPC programs to share the same transport.
696 * The Sun NFSv2/v3 ACL protocol can do this.
697 */
698struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500699 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400700 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000701{
Trond Myklebustf994c432012-11-01 12:14:14 -0400702 struct rpc_create_args args = {
703 .program = program,
704 .prognumber = program->number,
705 .version = vers,
706 .authflavor = old->cl_auth->au_flavor,
707 .client_name = old->cl_principal,
708 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000709 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000710 int err;
711
Trond Myklebustf994c432012-11-01 12:14:14 -0400712 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000713 if (IS_ERR(clnt))
714 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500715 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000716 if (err != 0) {
717 rpc_shutdown_client(clnt);
718 clnt = ERR_PTR(err);
719 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800720out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000721 return clnt;
722}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400723EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000724
Trond Myklebust58f96122010-07-31 14:29:08 -0400725void rpc_task_release_client(struct rpc_task *task)
726{
727 struct rpc_clnt *clnt = task->tk_client;
728
729 if (clnt != NULL) {
730 /* Remove from client task list */
731 spin_lock(&clnt->cl_lock);
732 list_del(&task->tk_task);
733 spin_unlock(&clnt->cl_lock);
734 task->tk_client = NULL;
735
736 rpc_release_client(clnt);
737 }
738}
739
740static
741void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
742{
743 if (clnt != NULL) {
744 rpc_task_release_client(task);
745 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400746 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400747 if (clnt->cl_softrtry)
748 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700749 if (sk_memalloc_socks()) {
750 struct rpc_xprt *xprt;
751
752 rcu_read_lock();
753 xprt = rcu_dereference(clnt->cl_xprt);
754 if (xprt->swapper)
755 task->tk_flags |= RPC_TASK_SWAPPER;
756 rcu_read_unlock();
757 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400758 /* Add to the client's list of all tasks */
759 spin_lock(&clnt->cl_lock);
760 list_add_tail(&task->tk_task, &clnt->cl_tasks);
761 spin_unlock(&clnt->cl_lock);
762 }
763}
764
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000765void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
766{
767 rpc_task_release_client(task);
768 rpc_task_set_client(task, clnt);
769}
770EXPORT_SYMBOL_GPL(rpc_task_reset_client);
771
772
Trond Myklebust58f96122010-07-31 14:29:08 -0400773static void
774rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
775{
776 if (msg != NULL) {
777 task->tk_msg.rpc_proc = msg->rpc_proc;
778 task->tk_msg.rpc_argp = msg->rpc_argp;
779 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400780 if (msg->rpc_cred != NULL)
781 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400782 }
783}
784
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785/*
786 * Default callback for async RPC calls
787 */
788static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100789rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
791}
792
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100793static const struct rpc_call_ops rpc_default_ops = {
794 .rpc_call_done = rpc_default_callback,
795};
796
Trond Myklebustc970aa82007-07-14 15:39:59 -0400797/**
798 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
799 * @task_setup_data: pointer to task initialisation data
800 */
801struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400802{
Trond Myklebust19445b92010-04-16 16:41:10 -0400803 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400804
Trond Myklebust84115e12007-07-14 15:39:59 -0400805 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400806 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400807 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400808
Trond Myklebust58f96122010-07-31 14:29:08 -0400809 rpc_task_set_client(task, task_setup_data->rpc_client);
810 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
811
Trond Myklebust58f96122010-07-31 14:29:08 -0400812 if (task->tk_action == NULL)
813 rpc_call_start(task);
814
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400815 atomic_inc(&task->tk_count);
816 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400817out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400818 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400819}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400820EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400821
822/**
823 * rpc_call_sync - Perform a synchronous RPC call
824 * @clnt: pointer to RPC client
825 * @msg: RPC call parameters
826 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500828int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829{
830 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400831 struct rpc_task_setup task_setup_data = {
832 .rpc_client = clnt,
833 .rpc_message = msg,
834 .callback_ops = &rpc_default_ops,
835 .flags = flags,
836 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400837 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400839 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
840 if (flags & RPC_TASK_ASYNC) {
841 rpc_release_calldata(task_setup_data.callback_ops,
842 task_setup_data.callback_data);
843 return -EINVAL;
844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Trond Myklebustc970aa82007-07-14 15:39:59 -0400846 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400847 if (IS_ERR(task))
848 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100849 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800850 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 return status;
852}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400853EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400855/**
856 * rpc_call_async - Perform an asynchronous RPC call
857 * @clnt: pointer to RPC client
858 * @msg: RPC call parameters
859 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800860 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400861 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 */
863int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500864rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100865 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
867 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400868 struct rpc_task_setup task_setup_data = {
869 .rpc_client = clnt,
870 .rpc_message = msg,
871 .callback_ops = tk_ops,
872 .callback_data = data,
873 .flags = flags|RPC_TASK_ASYNC,
874 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
Trond Myklebustc970aa82007-07-14 15:39:59 -0400876 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400877 if (IS_ERR(task))
878 return PTR_ERR(task);
879 rpc_put_task(task);
880 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400882EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400884#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400885/**
886 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
887 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400888 * @req: RPC request
889 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400890 */
891struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400892 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400893{
894 struct rpc_task *task;
895 struct xdr_buf *xbufp = &req->rq_snd_buf;
896 struct rpc_task_setup task_setup_data = {
897 .callback_ops = tk_ops,
898 };
899
900 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
901 /*
902 * Create an rpc_task to send the data
903 */
904 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400905 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400906 xprt_free_bc_request(req);
907 goto out;
908 }
909 task->tk_rqstp = req;
910
911 /*
912 * Set up the xdr_buf length.
913 * This also indicates that the buffer is XDR encoded already.
914 */
915 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
916 xbufp->tail[0].iov_len;
917
918 task->tk_action = call_bc_transmit;
919 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400920 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400921 rpc_execute(task);
922
923out:
924 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
925 return task;
926}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400927#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400928
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400930rpc_call_start(struct rpc_task *task)
931{
932 task->tk_action = call_start;
933}
934EXPORT_SYMBOL_GPL(rpc_call_start);
935
Chuck Levered394402006-08-22 20:06:17 -0400936/**
937 * rpc_peeraddr - extract remote peer address from clnt's xprt
938 * @clnt: RPC client structure
939 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800940 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400941 *
942 * Returns the number of bytes that are actually in the stored address.
943 */
944size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
945{
946 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500947 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400948
Trond Myklebust2446ab62012-03-01 17:00:56 -0500949 rcu_read_lock();
950 xprt = rcu_dereference(clnt->cl_xprt);
951
952 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400953 if (bytes > bufsize)
954 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500955 memcpy(buf, &xprt->addr, bytes);
956 rcu_read_unlock();
957
958 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400959}
Chuck Leverb86acd52006-08-22 20:06:22 -0400960EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400961
Chuck Leverf425eba2006-08-22 20:06:18 -0400962/**
963 * rpc_peeraddr2str - return remote peer address in printable format
964 * @clnt: RPC client structure
965 * @format: address format
966 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500967 * NB: the lifetime of the memory referenced by the returned pointer is
968 * the same as the rpc_xprt itself. As long as the caller uses this
969 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400970 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500971const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
972 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400973{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500974 struct rpc_xprt *xprt;
975
976 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500977
978 if (xprt->address_strings[format] != NULL)
979 return xprt->address_strings[format];
980 else
981 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400982}
Chuck Leverb86acd52006-08-22 20:06:22 -0400983EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400984
Chuck Lever2e738fd2012-03-01 17:01:14 -0500985static const struct sockaddr_in rpc_inaddr_loopback = {
986 .sin_family = AF_INET,
987 .sin_addr.s_addr = htonl(INADDR_ANY),
988};
989
990static const struct sockaddr_in6 rpc_in6addr_loopback = {
991 .sin6_family = AF_INET6,
992 .sin6_addr = IN6ADDR_ANY_INIT,
993};
994
995/*
996 * Try a getsockname() on a connected datagram socket. Using a
997 * connected datagram socket prevents leaving a socket in TIME_WAIT.
998 * This conserves the ephemeral port number space.
999 *
1000 * Returns zero and fills in "buf" if successful; otherwise, a
1001 * negative errno is returned.
1002 */
1003static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1004 struct sockaddr *buf, int buflen)
1005{
1006 struct socket *sock;
1007 int err;
1008
1009 err = __sock_create(net, sap->sa_family,
1010 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1011 if (err < 0) {
1012 dprintk("RPC: can't create UDP socket (%d)\n", err);
1013 goto out;
1014 }
1015
1016 switch (sap->sa_family) {
1017 case AF_INET:
1018 err = kernel_bind(sock,
1019 (struct sockaddr *)&rpc_inaddr_loopback,
1020 sizeof(rpc_inaddr_loopback));
1021 break;
1022 case AF_INET6:
1023 err = kernel_bind(sock,
1024 (struct sockaddr *)&rpc_in6addr_loopback,
1025 sizeof(rpc_in6addr_loopback));
1026 break;
1027 default:
1028 err = -EAFNOSUPPORT;
1029 goto out;
1030 }
1031 if (err < 0) {
1032 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1033 goto out_release;
1034 }
1035
1036 err = kernel_connect(sock, sap, salen, 0);
1037 if (err < 0) {
1038 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1039 goto out_release;
1040 }
1041
1042 err = kernel_getsockname(sock, buf, &buflen);
1043 if (err < 0) {
1044 dprintk("RPC: getsockname failed (%d)\n", err);
1045 goto out_release;
1046 }
1047
1048 err = 0;
1049 if (buf->sa_family == AF_INET6) {
1050 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1051 sin6->sin6_scope_id = 0;
1052 }
1053 dprintk("RPC: %s succeeded\n", __func__);
1054
1055out_release:
1056 sock_release(sock);
1057out:
1058 return err;
1059}
1060
1061/*
1062 * Scraping a connected socket failed, so we don't have a useable
1063 * local address. Fallback: generate an address that will prevent
1064 * the server from calling us back.
1065 *
1066 * Returns zero and fills in "buf" if successful; otherwise, a
1067 * negative errno is returned.
1068 */
1069static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1070{
1071 switch (family) {
1072 case AF_INET:
1073 if (buflen < sizeof(rpc_inaddr_loopback))
1074 return -EINVAL;
1075 memcpy(buf, &rpc_inaddr_loopback,
1076 sizeof(rpc_inaddr_loopback));
1077 break;
1078 case AF_INET6:
1079 if (buflen < sizeof(rpc_in6addr_loopback))
1080 return -EINVAL;
1081 memcpy(buf, &rpc_in6addr_loopback,
1082 sizeof(rpc_in6addr_loopback));
1083 default:
1084 dprintk("RPC: %s: address family not supported\n",
1085 __func__);
1086 return -EAFNOSUPPORT;
1087 }
1088 dprintk("RPC: %s: succeeded\n", __func__);
1089 return 0;
1090}
1091
1092/**
1093 * rpc_localaddr - discover local endpoint address for an RPC client
1094 * @clnt: RPC client structure
1095 * @buf: target buffer
1096 * @buflen: size of target buffer, in bytes
1097 *
1098 * Returns zero and fills in "buf" and "buflen" if successful;
1099 * otherwise, a negative errno is returned.
1100 *
1101 * This works even if the underlying transport is not currently connected,
1102 * or if the upper layer never previously provided a source address.
1103 *
1104 * The result of this function call is transient: multiple calls in
1105 * succession may give different results, depending on how local
1106 * networking configuration changes over time.
1107 */
1108int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1109{
1110 struct sockaddr_storage address;
1111 struct sockaddr *sap = (struct sockaddr *)&address;
1112 struct rpc_xprt *xprt;
1113 struct net *net;
1114 size_t salen;
1115 int err;
1116
1117 rcu_read_lock();
1118 xprt = rcu_dereference(clnt->cl_xprt);
1119 salen = xprt->addrlen;
1120 memcpy(sap, &xprt->addr, salen);
1121 net = get_net(xprt->xprt_net);
1122 rcu_read_unlock();
1123
1124 rpc_set_port(sap, 0);
1125 err = rpc_sockname(net, sap, salen, buf, buflen);
1126 put_net(net);
1127 if (err != 0)
1128 /* Couldn't discover local address, return ANYADDR */
1129 return rpc_anyaddr(sap->sa_family, buf, buflen);
1130 return 0;
1131}
1132EXPORT_SYMBOL_GPL(rpc_localaddr);
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134void
1135rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1136{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001137 struct rpc_xprt *xprt;
1138
1139 rcu_read_lock();
1140 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001141 if (xprt->ops->set_buffer_size)
1142 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001143 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001145EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146
Trond Myklebust2446ab62012-03-01 17:00:56 -05001147/**
1148 * rpc_protocol - Get transport protocol number for an RPC client
1149 * @clnt: RPC client to query
1150 *
1151 */
1152int rpc_protocol(struct rpc_clnt *clnt)
1153{
1154 int protocol;
1155
1156 rcu_read_lock();
1157 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1158 rcu_read_unlock();
1159 return protocol;
1160}
1161EXPORT_SYMBOL_GPL(rpc_protocol);
1162
1163/**
1164 * rpc_net_ns - Get the network namespace for this RPC client
1165 * @clnt: RPC client to query
1166 *
1167 */
1168struct net *rpc_net_ns(struct rpc_clnt *clnt)
1169{
1170 struct net *ret;
1171
1172 rcu_read_lock();
1173 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1174 rcu_read_unlock();
1175 return ret;
1176}
1177EXPORT_SYMBOL_GPL(rpc_net_ns);
1178
1179/**
1180 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1181 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 *
1183 * For stream transports, this is one RPC record fragment (see RFC
1184 * 1831), as we don't support multi-record requests yet. For datagram
1185 * transports, this is the size of an IP packet minus the IP, UDP, and
1186 * RPC header sizes.
1187 */
1188size_t rpc_max_payload(struct rpc_clnt *clnt)
1189{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001190 size_t ret;
1191
1192 rcu_read_lock();
1193 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1194 rcu_read_unlock();
1195 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196}
Chuck Leverb86acd52006-08-22 20:06:22 -04001197EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Chuck Lever35f5a422006-01-03 09:55:50 +01001199/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001200 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001201 * @clnt: RPC client to query
1202 */
1203unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1204{
1205 unsigned long ret;
1206
1207 rcu_read_lock();
1208 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1209 rcu_read_unlock();
1210 return ret;
1211}
1212EXPORT_SYMBOL_GPL(rpc_get_timeout);
1213
1214/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001215 * rpc_force_rebind - force transport to check that remote port is unchanged
1216 * @clnt: client to rebind
1217 *
1218 */
1219void rpc_force_rebind(struct rpc_clnt *clnt)
1220{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001221 if (clnt->cl_autobind) {
1222 rcu_read_lock();
1223 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1224 rcu_read_unlock();
1225 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001226}
Chuck Leverb86acd52006-08-22 20:06:22 -04001227EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001228
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001230 * Restart an (async) RPC call from the call_prepare state.
1231 * Usually called from within the exit handler.
1232 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001233int
Andy Adamsonaae20062009-04-01 09:22:40 -04001234rpc_restart_call_prepare(struct rpc_task *task)
1235{
1236 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001237 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001238 task->tk_action = call_start;
1239 if (task->tk_ops->rpc_call_prepare != NULL)
1240 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001241 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001242}
1243EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1244
1245/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 * Restart an (async) RPC call. Usually called from within the
1247 * exit handler.
1248 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001249int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250rpc_restart_call(struct rpc_task *task)
1251{
1252 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001253 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001255 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001257EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Chuck Lever3748f1e2008-05-21 17:09:12 -04001259#ifdef RPC_DEBUG
1260static const char *rpc_proc_name(const struct rpc_task *task)
1261{
1262 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1263
1264 if (proc) {
1265 if (proc->p_name)
1266 return proc->p_name;
1267 else
1268 return "NULL";
1269 } else
1270 return "no proc";
1271}
1272#endif
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274/*
1275 * 0. Initial state
1276 *
1277 * Other FSM states can be visited zero or more times, but
1278 * this state is visited exactly once for each RPC.
1279 */
1280static void
1281call_start(struct rpc_task *task)
1282{
1283 struct rpc_clnt *clnt = task->tk_client;
1284
Chuck Lever3748f1e2008-05-21 17:09:12 -04001285 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001286 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001287 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001288 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290 /* Increment call count */
1291 task->tk_msg.rpc_proc->p_count++;
1292 clnt->cl_stats->rpccnt++;
1293 task->tk_action = call_reserve;
1294}
1295
1296/*
1297 * 1. Reserve an RPC call slot
1298 */
1299static void
1300call_reserve(struct rpc_task *task)
1301{
Chuck Lever46121cf2007-01-31 12:14:08 -05001302 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 task->tk_status = 0;
1305 task->tk_action = call_reserveresult;
1306 xprt_reserve(task);
1307}
1308
Trond Myklebustba60eb22013-04-14 10:49:37 -04001309static void call_retry_reserve(struct rpc_task *task);
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311/*
1312 * 1b. Grok the result of xprt_reserve()
1313 */
1314static void
1315call_reserveresult(struct rpc_task *task)
1316{
1317 int status = task->tk_status;
1318
Chuck Lever46121cf2007-01-31 12:14:08 -05001319 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
1321 /*
1322 * After a call to xprt_reserve(), we must have either
1323 * a request slot or else an error status.
1324 */
1325 task->tk_status = 0;
1326 if (status >= 0) {
1327 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001328 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 return;
1330 }
1331
1332 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001333 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 rpc_exit(task, -EIO);
1335 return;
1336 }
1337
1338 /*
1339 * Even though there was an error, we may have acquired
1340 * a request slot somehow. Make sure not to leak it.
1341 */
1342 if (task->tk_rqstp) {
1343 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001344 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 xprt_release(task);
1346 }
1347
1348 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001349 case -ENOMEM:
1350 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001352 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 return;
1354 case -EIO: /* probably a shutdown */
1355 break;
1356 default:
1357 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001358 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 break;
1360 }
1361 rpc_exit(task, status);
1362}
1363
1364/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001365 * 1c. Retry reserving an RPC call slot
1366 */
1367static void
1368call_retry_reserve(struct rpc_task *task)
1369{
1370 dprint_status(task);
1371
1372 task->tk_status = 0;
1373 task->tk_action = call_reserveresult;
1374 xprt_retry_reserve(task);
1375}
1376
1377/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001378 * 2. Bind and/or refresh the credentials
1379 */
1380static void
1381call_refresh(struct rpc_task *task)
1382{
1383 dprint_status(task);
1384
1385 task->tk_action = call_refreshresult;
1386 task->tk_status = 0;
1387 task->tk_client->cl_stats->rpcauthrefresh++;
1388 rpcauth_refreshcred(task);
1389}
1390
1391/*
1392 * 2a. Process the results of a credential refresh
1393 */
1394static void
1395call_refreshresult(struct rpc_task *task)
1396{
1397 int status = task->tk_status;
1398
1399 dprint_status(task);
1400
1401 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001402 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001403 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001404 case 0:
1405 if (rpcauth_uptodatecred(task))
1406 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001407 return;
1408 case -ETIMEDOUT:
1409 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001410 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001411 case -EAGAIN:
1412 status = -EACCES;
1413 if (!task->tk_cred_retry)
1414 break;
1415 task->tk_cred_retry--;
1416 dprintk("RPC: %5u %s: retry refresh creds\n",
1417 task->tk_pid, __func__);
1418 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001419 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001420 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1421 task->tk_pid, __func__, status);
1422 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001423}
1424
1425/*
1426 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001427 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 */
1429static void
1430call_allocate(struct rpc_task *task)
1431{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001432 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001433 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001434 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001435 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Chuck Lever46121cf2007-01-31 12:14:08 -05001437 dprint_status(task);
1438
Chuck Lever2bea90d2007-03-29 16:47:53 -04001439 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001440 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001441
Chuck Lever02107142006-01-03 09:55:49 +01001442 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 return;
1444
Chuck Lever2bea90d2007-03-29 16:47:53 -04001445 if (proc->p_proc != 0) {
1446 BUG_ON(proc->p_arglen == 0);
1447 if (proc->p_decode != NULL)
1448 BUG_ON(proc->p_replen == 0);
1449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Chuck Lever2bea90d2007-03-29 16:47:53 -04001451 /*
1452 * Calculate the size (in quads) of the RPC call
1453 * and reply headers, and convert both values
1454 * to byte sizes.
1455 */
1456 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1457 req->rq_callsize <<= 2;
1458 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1459 req->rq_rcvsize <<= 2;
1460
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001461 req->rq_buffer = xprt->ops->buf_alloc(task,
1462 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001463 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001465
1466 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
Trond Myklebust5afa91332011-06-17 10:14:59 -04001468 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001469 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 rpc_delay(task, HZ>>4);
1471 return;
1472 }
1473
1474 rpc_exit(task, -ERESTARTSYS);
1475}
1476
Trond Myklebust940e3312005-11-09 21:45:24 -05001477static inline int
1478rpc_task_need_encode(struct rpc_task *task)
1479{
1480 return task->tk_rqstp->rq_snd_buf.len == 0;
1481}
1482
1483static inline void
1484rpc_task_force_reencode(struct rpc_task *task)
1485{
1486 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001487 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001488}
1489
Chuck Lever2bea90d2007-03-29 16:47:53 -04001490static inline void
1491rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1492{
1493 buf->head[0].iov_base = start;
1494 buf->head[0].iov_len = len;
1495 buf->tail[0].iov_len = 0;
1496 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001497 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001498 buf->len = 0;
1499 buf->buflen = len;
1500}
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502/*
1503 * 3. Encode arguments of an RPC call
1504 */
1505static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001506rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001509 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001510 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Chuck Lever46121cf2007-01-31 12:14:08 -05001512 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Chuck Lever2bea90d2007-03-29 16:47:53 -04001514 rpc_xdr_buf_init(&req->rq_snd_buf,
1515 req->rq_buffer,
1516 req->rq_callsize);
1517 rpc_xdr_buf_init(&req->rq_rcv_buf,
1518 (char *)req->rq_buffer + req->rq_callsize,
1519 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Chuck Leverb0e1c572008-05-21 17:09:19 -04001521 p = rpc_encode_header(task);
1522 if (p == NULL) {
1523 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 rpc_exit(task, -EIO);
1525 return;
1526 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001527
1528 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001529 if (encode == NULL)
1530 return;
1531
1532 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1533 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
1535
1536/*
1537 * 4. Get the server port number if not yet set
1538 */
1539static void
1540call_bind(struct rpc_task *task)
1541{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001542 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543
Chuck Lever46121cf2007-01-31 12:14:08 -05001544 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Chuck Leverda351872005-08-11 16:25:11 -04001546 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001547 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001548 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001549 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001550 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 }
1552}
1553
1554/*
Chuck Leverda351872005-08-11 16:25:11 -04001555 * 4a. Sort out bind result
1556 */
1557static void
1558call_bind_status(struct rpc_task *task)
1559{
Chuck Lever906462a2007-09-11 18:00:47 -04001560 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001561
1562 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001563 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001564 task->tk_status = 0;
1565 task->tk_action = call_connect;
1566 return;
1567 }
1568
Steve Dickson5753cba2012-02-06 10:08:08 -05001569 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001570 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001571 case -ENOMEM:
1572 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1573 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001574 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001575 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001576 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1577 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001578 /* fail immediately if this is an RPC ping */
1579 if (task->tk_msg.rpc_proc->p_proc == 0) {
1580 status = -EOPNOTSUPP;
1581 break;
1582 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001583 if (task->tk_rebind_retry == 0)
1584 break;
1585 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001586 rpc_delay(task, 3*HZ);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001587 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001588 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001589 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001590 task->tk_pid);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001591 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001592 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001593 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001594 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001595 task->tk_pid);
1596 break;
1597 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001598 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001599 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001600 task->tk_status = 0;
1601 task->tk_action = call_bind;
1602 return;
Chuck Lever012da152009-12-03 15:58:56 -05001603 case -ECONNREFUSED: /* connection problems */
1604 case -ECONNRESET:
1605 case -ENOTCONN:
1606 case -EHOSTDOWN:
1607 case -EHOSTUNREACH:
1608 case -ENETUNREACH:
1609 case -EPIPE:
1610 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1611 task->tk_pid, task->tk_status);
1612 if (!RPC_IS_SOFTCONN(task)) {
1613 rpc_delay(task, 5*HZ);
1614 goto retry_timeout;
1615 }
1616 status = task->tk_status;
1617 break;
Chuck Leverda351872005-08-11 16:25:11 -04001618 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001619 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001620 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001621 }
1622
1623 rpc_exit(task, status);
1624 return;
1625
Trond Myklebustda45828e2006-08-31 15:44:52 -04001626retry_timeout:
1627 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001628}
1629
1630/*
1631 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 */
1633static void
1634call_connect(struct rpc_task *task)
1635{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001636 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Chuck Lever46121cf2007-01-31 12:14:08 -05001638 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001639 task->tk_pid, xprt,
1640 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
Chuck Leverda351872005-08-11 16:25:11 -04001642 task->tk_action = call_transmit;
1643 if (!xprt_connected(xprt)) {
1644 task->tk_action = call_connect_status;
1645 if (task->tk_status < 0)
1646 return;
1647 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649}
1650
1651/*
Chuck Leverda351872005-08-11 16:25:11 -04001652 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 */
1654static void
1655call_connect_status(struct rpc_task *task)
1656{
1657 struct rpc_clnt *clnt = task->tk_client;
1658 int status = task->tk_status;
1659
Chuck Lever46121cf2007-01-31 12:14:08 -05001660 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001661
Steve Dickson5753cba2012-02-06 10:08:08 -05001662 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 switch (status) {
Trond Myklebustda45828e2006-08-31 15:44:52 -04001664 /* if soft mounted, test if we've timed out */
1665 case -ETIMEDOUT:
1666 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001667 return;
1668 case -ECONNREFUSED:
1669 case -ECONNRESET:
1670 case -ENETUNREACH:
1671 if (RPC_IS_SOFTCONN(task))
1672 break;
1673 /* retry with existing socket, after a delay */
1674 case 0:
1675 case -EAGAIN:
1676 task->tk_status = 0;
1677 clnt->cl_stats->netreconn++;
1678 task->tk_action = call_transmit;
1679 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001681 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682}
1683
1684/*
1685 * 5. Transmit the RPC request, and wait for reply
1686 */
1687static void
1688call_transmit(struct rpc_task *task)
1689{
Chuck Lever46121cf2007-01-31 12:14:08 -05001690 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692 task->tk_action = call_status;
1693 if (task->tk_status < 0)
1694 return;
1695 task->tk_status = xprt_prepare_transmit(task);
1696 if (task->tk_status != 0)
1697 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001698 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001700 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001701 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001702 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001703 if (task->tk_status != 0) {
1704 /* Was the error nonfatal? */
1705 if (task->tk_status == -EAGAIN)
1706 rpc_delay(task, HZ >> 4);
1707 else
1708 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001709 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001710 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001711 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 xprt_transmit(task);
1713 if (task->tk_status < 0)
1714 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001715 /*
1716 * On success, ensure that we call xprt_end_transmit() before sleeping
1717 * in order to allow access to the socket to other RPC requests.
1718 */
1719 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001720 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001721 return;
1722 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001723 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001724}
1725
1726/*
1727 * 5a. Handle cleanup after a transmission
1728 */
1729static void
1730call_transmit_status(struct rpc_task *task)
1731{
1732 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001733
1734 /*
1735 * Common case: success. Force the compiler to put this
1736 * test first.
1737 */
1738 if (task->tk_status == 0) {
1739 xprt_end_transmit(task);
1740 rpc_task_force_reencode(task);
1741 return;
1742 }
1743
Trond Myklebust15f081c2009-03-11 14:37:57 -04001744 switch (task->tk_status) {
1745 case -EAGAIN:
1746 break;
1747 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001748 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001749 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001750 rpc_task_force_reencode(task);
1751 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001752 /*
1753 * Special cases: if we've been waiting on the
1754 * socket's write_space() callback, or if the
1755 * socket just returned a connection error,
1756 * then hold onto the transport lock.
1757 */
1758 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001759 case -EHOSTDOWN:
1760 case -EHOSTUNREACH:
1761 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001762 if (RPC_IS_SOFTCONN(task)) {
1763 xprt_end_transmit(task);
1764 rpc_exit(task, task->tk_status);
1765 break;
1766 }
1767 case -ECONNRESET:
1768 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001769 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001770 rpc_task_force_reencode(task);
1771 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772}
1773
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001774#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001775/*
1776 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1777 * addition, disconnect on connectivity errors.
1778 */
1779static void
1780call_bc_transmit(struct rpc_task *task)
1781{
1782 struct rpc_rqst *req = task->tk_rqstp;
1783
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001784 task->tk_status = xprt_prepare_transmit(task);
1785 if (task->tk_status == -EAGAIN) {
1786 /*
1787 * Could not reserve the transport. Try again after the
1788 * transport is released.
1789 */
1790 task->tk_status = 0;
1791 task->tk_action = call_bc_transmit;
1792 return;
1793 }
1794
1795 task->tk_action = rpc_exit_task;
1796 if (task->tk_status < 0) {
1797 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1798 "error: %d\n", task->tk_status);
1799 return;
1800 }
1801
1802 xprt_transmit(task);
1803 xprt_end_transmit(task);
1804 dprint_status(task);
1805 switch (task->tk_status) {
1806 case 0:
1807 /* Success */
1808 break;
1809 case -EHOSTDOWN:
1810 case -EHOSTUNREACH:
1811 case -ENETUNREACH:
1812 case -ETIMEDOUT:
1813 /*
1814 * Problem reaching the server. Disconnect and let the
1815 * forechannel reestablish the connection. The server will
1816 * have to retransmit the backchannel request and we'll
1817 * reprocess it. Since these ops are idempotent, there's no
1818 * need to cache our reply at this time.
1819 */
1820 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1821 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001822 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001823 req->rq_connect_cookie);
1824 break;
1825 default:
1826 /*
1827 * We were unable to reply and will have to drop the
1828 * request. The server should reconnect and retransmit.
1829 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001830 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001831 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1832 "error: %d\n", task->tk_status);
1833 break;
1834 }
1835 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1836}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001837#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001838
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839/*
1840 * 6. Sort out the RPC call status
1841 */
1842static void
1843call_status(struct rpc_task *task)
1844{
1845 struct rpc_clnt *clnt = task->tk_client;
1846 struct rpc_rqst *req = task->tk_rqstp;
1847 int status;
1848
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001849 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1850 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851
Chuck Lever46121cf2007-01-31 12:14:08 -05001852 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
1854 status = task->tk_status;
1855 if (status >= 0) {
1856 task->tk_action = call_decode;
1857 return;
1858 }
1859
Steve Dickson5753cba2012-02-06 10:08:08 -05001860 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 task->tk_status = 0;
1862 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001863 case -EHOSTDOWN:
1864 case -EHOSTUNREACH:
1865 case -ENETUNREACH:
1866 /*
1867 * Delay any retries for 3 seconds, then handle as if it
1868 * were a timeout.
1869 */
1870 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 case -ETIMEDOUT:
1872 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001873 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001874 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001875 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001877 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001879 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001880 rpc_delay(task, 3*HZ);
1881 case -EPIPE:
1882 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 task->tk_action = call_bind;
1884 break;
1885 case -EAGAIN:
1886 task->tk_action = call_transmit;
1887 break;
1888 case -EIO:
1889 /* shutdown or soft timeout */
1890 rpc_exit(task, status);
1891 break;
1892 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001893 if (clnt->cl_chatty)
1894 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 clnt->cl_protname, -status);
1896 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 }
1898}
1899
1900/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001901 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 * We do not release the request slot, so we keep using the
1903 * same XID for all retransmits.
1904 */
1905static void
1906call_timeout(struct rpc_task *task)
1907{
1908 struct rpc_clnt *clnt = task->tk_client;
1909
1910 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001911 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 goto retry;
1913 }
1914
Chuck Lever46121cf2007-01-31 12:14:08 -05001915 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001916 task->tk_timeouts++;
1917
Chuck Lever3a28bec2009-12-03 15:58:56 -05001918 if (RPC_IS_SOFTCONN(task)) {
1919 rpc_exit(task, -ETIMEDOUT);
1920 return;
1921 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001923 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001924 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001925 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001926 clnt->cl_protname,
1927 rcu_dereference(clnt->cl_xprt)->servername);
1928 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001929 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001930 if (task->tk_flags & RPC_TASK_TIMEOUT)
1931 rpc_exit(task, -ETIMEDOUT);
1932 else
1933 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 return;
1935 }
1936
Chuck Leverf518e35a2006-01-03 09:55:52 +01001937 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001939 if (clnt->cl_chatty) {
1940 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001941 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001942 clnt->cl_protname,
1943 rcu_dereference(clnt->cl_xprt)->servername);
1944 rcu_read_unlock();
1945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001947 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001948 /*
1949 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1950 * event? RFC2203 requires the server to drop all such requests.
1951 */
1952 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
1954retry:
1955 clnt->cl_stats->rpcretrans++;
1956 task->tk_action = call_bind;
1957 task->tk_status = 0;
1958}
1959
1960/*
1961 * 7. Decode the RPC reply
1962 */
1963static void
1964call_decode(struct rpc_task *task)
1965{
1966 struct rpc_clnt *clnt = task->tk_client;
1967 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001968 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001969 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Vasily Averin726fd6a2011-06-01 16:23:59 +04001971 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Chuck Leverf518e35a2006-01-03 09:55:52 +01001973 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001974 if (clnt->cl_chatty) {
1975 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001976 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001977 clnt->cl_protname,
1978 rcu_dereference(clnt->cl_xprt)->servername);
1979 rcu_read_unlock();
1980 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1982 }
1983
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001984 /*
1985 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001986 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001987 */
1988 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 req->rq_rcv_buf.len = req->rq_private_buf.len;
1990
1991 /* Check that the softirq receive buffer is valid */
1992 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1993 sizeof(req->rq_rcv_buf)) != 0);
1994
Trond Myklebust1e799b62008-03-21 16:19:41 -04001995 if (req->rq_rcv_buf.len < 12) {
1996 if (!RPC_IS_SOFT(task)) {
1997 task->tk_action = call_bind;
1998 clnt->cl_stats->rpcretrans++;
1999 goto out_retry;
2000 }
2001 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2002 clnt->cl_protname, task->tk_status);
2003 task->tk_action = call_timeout;
2004 goto out_retry;
2005 }
2006
Chuck Leverb0e1c572008-05-21 17:09:19 -04002007 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002008 if (IS_ERR(p)) {
2009 if (p == ERR_PTR(-EAGAIN))
2010 goto out_retry;
2011 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 }
2013
Trond Myklebustabbcf282006-01-03 09:55:03 +01002014 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002016 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2018 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002019 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002020 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2021 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 return;
2023out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002025 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002026 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002027 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002028 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002029 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002030 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002031 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032}
2033
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002034static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002035rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036{
2037 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002039 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
2041 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002042
Trond Myklebusta4f08352013-01-08 09:10:21 -05002043 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 *p++ = req->rq_xid; /* XID */
2045 *p++ = htonl(RPC_CALL); /* CALL */
2046 *p++ = htonl(RPC_VERSION); /* RPC version */
2047 *p++ = htonl(clnt->cl_prog); /* program number */
2048 *p++ = htonl(clnt->cl_vers); /* program version */
2049 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002050 p = rpcauth_marshcred(task, p);
2051 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2052 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053}
2054
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002055static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002056rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002058 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2060 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002061 __be32 *p = iov->iov_base;
2062 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 int error = -EACCES;
2064
David Howellse8896492006-08-24 15:44:19 -04002065 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2066 /* RFC-1014 says that the representation of XDR data must be a
2067 * multiple of four bytes
2068 * - if it isn't pointer subtraction in the NFS client may give
2069 * undefined results
2070 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002071 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002072 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002073 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002074 goto out_eio;
2075 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 if ((len -= 3) < 0)
2077 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002079 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002081 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002082 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002083 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002085
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2087 if (--len < 0)
2088 goto out_overflow;
2089 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002090 case RPC_AUTH_ERROR:
2091 break;
2092 case RPC_MISMATCH:
2093 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2094 task->tk_pid, __func__);
2095 error = -EPROTONOSUPPORT;
2096 goto out_err;
2097 default:
2098 dprintk("RPC: %5u %s: RPC call rejected, "
2099 "unknown error: %x\n",
2100 task->tk_pid, __func__, n);
2101 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 }
2103 if (--len < 0)
2104 goto out_overflow;
2105 switch ((n = ntohl(*p++))) {
2106 case RPC_AUTH_REJECTEDCRED:
2107 case RPC_AUTH_REJECTEDVERF:
2108 case RPCSEC_GSS_CREDPROBLEM:
2109 case RPCSEC_GSS_CTXPROBLEM:
2110 if (!task->tk_cred_retry)
2111 break;
2112 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002113 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002114 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002116 /* Ensure we obtain a new XID! */
2117 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002118 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002119 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 case RPC_AUTH_BADCRED:
2121 case RPC_AUTH_BADVERF:
2122 /* possibly garbled cred/verf? */
2123 if (!task->tk_garb_retry)
2124 break;
2125 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002126 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002127 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002129 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002131 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002132 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002133 "authentication.\n",
2134 rcu_dereference(clnt->cl_xprt)->servername);
2135 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 break;
2137 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002138 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002139 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 error = -EIO;
2141 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002142 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002143 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 goto out_err;
2145 }
2146 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002147 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002148 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002149 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002151 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 if (len < 0)
2153 goto out_overflow;
2154 switch ((n = ntohl(*p++))) {
2155 case RPC_SUCCESS:
2156 return p;
2157 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002158 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2159 "by server %s\n", task->tk_pid, __func__,
2160 (unsigned int)clnt->cl_prog,
2161 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002162 error = -EPFNOSUPPORT;
2163 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002165 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2166 "by server %s\n", task->tk_pid, __func__,
2167 (unsigned int)clnt->cl_prog,
2168 (unsigned int)clnt->cl_vers,
2169 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002170 error = -EPROTONOSUPPORT;
2171 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002173 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002174 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002175 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002176 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002177 clnt->cl_prog, clnt->cl_vers,
2178 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002179 error = -EOPNOTSUPP;
2180 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002182 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002183 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 break; /* retry */
2185 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002186 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002187 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 /* Also retry */
2189 }
2190
Trond Myklebustabbcf282006-01-03 09:55:03 +01002191out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002192 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 if (task->tk_garb_retry) {
2194 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002195 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002196 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002198out_retry:
2199 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201out_eio:
2202 error = -EIO;
2203out_err:
2204 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002205 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002206 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002207 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002209 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002210 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002211 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002213
Chuck Lever9f06c712010-12-14 14:59:18 +00002214static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002215{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002216}
2217
Chuck Leverbf269552010-12-14 14:59:29 +00002218static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002219{
2220 return 0;
2221}
2222
2223static struct rpc_procinfo rpcproc_null = {
2224 .p_encode = rpcproc_encode_null,
2225 .p_decode = rpcproc_decode_null,
2226};
2227
Chuck Levercaabea82009-12-03 15:58:56 -05002228static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002229{
2230 struct rpc_message msg = {
2231 .rpc_proc = &rpcproc_null,
2232 };
2233 int err;
2234 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002235 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002236 put_rpccred(msg.rpc_cred);
2237 return err;
2238}
Trond Myklebust188fef12007-06-16 14:18:40 -04002239
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002240struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2241{
2242 struct rpc_message msg = {
2243 .rpc_proc = &rpcproc_null,
2244 .rpc_cred = cred,
2245 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002246 struct rpc_task_setup task_setup_data = {
2247 .rpc_client = clnt,
2248 .rpc_message = &msg,
2249 .callback_ops = &rpc_default_ops,
2250 .flags = flags,
2251 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002252 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002253}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002254EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002255
Trond Myklebust188fef12007-06-16 14:18:40 -04002256#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002257static void rpc_show_header(void)
2258{
Chuck Levercb3997b2008-05-21 17:09:41 -04002259 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2260 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002261}
2262
Chuck Lever38e886e2008-05-21 17:09:33 -04002263static void rpc_show_task(const struct rpc_clnt *clnt,
2264 const struct rpc_task *task)
2265{
2266 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002267
2268 if (RPC_IS_QUEUED(task))
2269 rpc_waitq = rpc_qname(task->tk_waitqueue);
2270
Joe Perchesb3bceda2010-12-21 10:52:24 -05002271 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 -04002272 task->tk_pid, task->tk_flags, task->tk_status,
2273 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2274 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002275 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002276}
2277
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002278void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002279{
2280 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002281 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002282 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002283 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002284
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002285 spin_lock(&sn->rpc_client_lock);
2286 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002287 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002288 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002289 if (!header) {
2290 rpc_show_header();
2291 header++;
2292 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002293 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002294 }
2295 spin_unlock(&clnt->cl_lock);
2296 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002297 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002298}
2299#endif