blob: c8193ce67b230c50e375ed206ac7e4c95c43a425 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400108 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400109 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400110 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500115 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117
Trond Myklebust2446ab62012-03-01 17:00:56 -0500118 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400120 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500121 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500126 struct rpc_clnt *clnt,
127 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Trond Myklebustf1345852005-09-23 11:08:25 -0400129 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400130 char name[15];
Linus Torvalds26fe5752012-05-10 13:14:12 -0700131 struct qstr q = { .name = name };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400132 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int error;
134
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400136 if (dir == NULL) {
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400139 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 for (;;) {
141 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
142 name[sizeof(name) - 1] = '\0';
143 q.hash = full_name_hash(q.name, q.len);
144 dentry = rpc_create_client_dir(dir, &q, clnt);
145 if (!IS_ERR(dentry))
146 break;
147 error = PTR_ERR(dentry);
148 if (error != -EEXIST) {
149 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name, name, error);
152 break;
153 }
154 }
155 dput(dir);
156 return dentry;
157}
158
159static int
Trond Myklebust080b7942012-01-20 13:53:56 -0500160rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400161{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500162 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400163 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400164 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400165
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400166 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 if (dir_name == NULL)
168 return 0;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500169 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400170 if (!pipefs_sb)
171 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400172 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500173 rpc_put_sb_net(net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400174 if (IS_ERR(dentry))
175 return PTR_ERR(dentry);
176 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400177 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178}
179
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
181{
182 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
183 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
184 return 1;
185 return 0;
186}
187
188static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
189 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400190{
191 struct dentry *dentry;
192 int err = 0;
193
194 switch (event) {
195 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 dentry = rpc_setup_pipedir_sb(sb, clnt,
197 clnt->cl_program->pipe_dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400198 if (!dentry)
199 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400200 if (IS_ERR(dentry))
201 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400202 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400203 if (clnt->cl_auth->au_ops->pipes_create) {
204 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
205 if (err)
206 __rpc_clnt_remove_pipedir(clnt);
207 }
208 break;
209 case RPC_PIPEFS_UMOUNT:
210 __rpc_clnt_remove_pipedir(clnt);
211 break;
212 default:
213 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
214 return -ENOTSUPP;
215 }
216 return err;
217}
218
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400219static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
220 struct super_block *sb)
221{
222 int error = 0;
223
224 for (;; clnt = clnt->cl_parent) {
225 if (!rpc_clnt_skip_event(clnt, event))
226 error = __rpc_clnt_handle_event(clnt, event, sb);
227 if (error || clnt == clnt->cl_parent)
228 break;
229 }
230 return error;
231}
232
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400233static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
234{
235 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
236 struct rpc_clnt *clnt;
237
238 spin_lock(&sn->rpc_client_lock);
239 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400240 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300241 continue;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400242 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400243 continue;
Stanislav Kinsburskya4dff1b2012-04-20 18:11:02 +0400244 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
245 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400246 spin_unlock(&sn->rpc_client_lock);
247 return clnt;
248 }
249 spin_unlock(&sn->rpc_client_lock);
250 return NULL;
251}
252
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400253static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
254 void *ptr)
255{
256 struct super_block *sb = ptr;
257 struct rpc_clnt *clnt;
258 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400259
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400260 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400261 error = __rpc_pipefs_event(clnt, event, sb);
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400262 rpc_release_client(clnt);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400263 if (error)
264 break;
265 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400266 return error;
267}
268
269static struct notifier_block rpc_clients_block = {
270 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400271 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400272};
273
274int rpc_clients_notifier_register(void)
275{
276 return rpc_pipefs_notifier_register(&rpc_clients_block);
277}
278
279void rpc_clients_notifier_unregister(void)
280{
281 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
282}
283
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400284static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
285{
286 clnt->cl_nodelen = strlen(nodename);
287 if (clnt->cl_nodelen > UNX_MAXNODENAME)
288 clnt->cl_nodelen = UNX_MAXNODENAME;
289 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
290}
291
Trond Myklebust698b6d02007-12-20 16:03:53 -0500292static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500294 const struct rpc_program *program = args->program;
295 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000297 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400299
300 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500301 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500302 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Trond Myklebust4ada5392007-06-14 17:26:17 -0400304 err = rpciod_up();
305 if (err)
306 goto out_no_rpciod;
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
559 * @auth: security flavor for new client
560 *
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 /*
615 * To avoid deadlock, never call rpc_shutdown_client from a
616 * workqueue context!
617 */
618 WARN_ON_ONCE(current->flags & PF_WQ_WORKER);
619 might_sleep();
620
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500621 dprintk_rcu("RPC: shutting down %s client for %s\n",
622 clnt->cl_protname,
623 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Trond Myklebust34f52e32007-06-14 16:40:31 -0400625 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800627 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400628 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 }
630
Trond Myklebust4c402b42007-06-14 16:40:32 -0400631 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400633EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
635/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400636 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400638static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400639rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500641 dprintk_rcu("RPC: destroying %s client for %s\n",
642 clnt->cl_protname,
643 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500644 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400645 rpc_release_client(clnt->cl_parent);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400646 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400647 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500648 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500649 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500650 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500651 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400652 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
655
656/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400657 * Free an RPC client
658 */
659static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400660rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400661{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400662 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400663 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400664 return;
665 }
666
667 /*
668 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
669 * release remaining GSS contexts. This mechanism ensures
670 * that it can do so safely.
671 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400672 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400673 rpcauth_release(clnt->cl_auth);
674 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400675 if (atomic_dec_and_test(&clnt->cl_count))
676 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400677}
678
679/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400680 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 */
682void
683rpc_release_client(struct rpc_clnt *clnt)
684{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400685 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Trond Myklebust34f52e32007-06-14 16:40:31 -0400687 if (list_empty(&clnt->cl_tasks))
688 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400689 if (atomic_dec_and_test(&clnt->cl_count))
690 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400691}
692
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000693/**
694 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800695 * @old: old rpc_client
696 * @program: rpc program to set
697 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000698 *
699 * Clones the rpc client and sets up a new RPC program. This is mainly
700 * of use for enabling different RPC programs to share the same transport.
701 * The Sun NFSv2/v3 ACL protocol can do this.
702 */
703struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500704 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400705 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000706{
Trond Myklebustf994c432012-11-01 12:14:14 -0400707 struct rpc_create_args args = {
708 .program = program,
709 .prognumber = program->number,
710 .version = vers,
711 .authflavor = old->cl_auth->au_flavor,
712 .client_name = old->cl_principal,
713 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000714 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000715 int err;
716
Trond Myklebustf994c432012-11-01 12:14:14 -0400717 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000718 if (IS_ERR(clnt))
719 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500720 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000721 if (err != 0) {
722 rpc_shutdown_client(clnt);
723 clnt = ERR_PTR(err);
724 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800725out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000726 return clnt;
727}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400728EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000729
Trond Myklebust58f96122010-07-31 14:29:08 -0400730void rpc_task_release_client(struct rpc_task *task)
731{
732 struct rpc_clnt *clnt = task->tk_client;
733
734 if (clnt != NULL) {
735 /* Remove from client task list */
736 spin_lock(&clnt->cl_lock);
737 list_del(&task->tk_task);
738 spin_unlock(&clnt->cl_lock);
739 task->tk_client = NULL;
740
741 rpc_release_client(clnt);
742 }
743}
744
745static
746void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
747{
748 if (clnt != NULL) {
749 rpc_task_release_client(task);
750 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400751 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400752 if (clnt->cl_softrtry)
753 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700754 if (sk_memalloc_socks()) {
755 struct rpc_xprt *xprt;
756
757 rcu_read_lock();
758 xprt = rcu_dereference(clnt->cl_xprt);
759 if (xprt->swapper)
760 task->tk_flags |= RPC_TASK_SWAPPER;
761 rcu_read_unlock();
762 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400763 /* Add to the client's list of all tasks */
764 spin_lock(&clnt->cl_lock);
765 list_add_tail(&task->tk_task, &clnt->cl_tasks);
766 spin_unlock(&clnt->cl_lock);
767 }
768}
769
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000770void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
771{
772 rpc_task_release_client(task);
773 rpc_task_set_client(task, clnt);
774}
775EXPORT_SYMBOL_GPL(rpc_task_reset_client);
776
777
Trond Myklebust58f96122010-07-31 14:29:08 -0400778static void
779rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
780{
781 if (msg != NULL) {
782 task->tk_msg.rpc_proc = msg->rpc_proc;
783 task->tk_msg.rpc_argp = msg->rpc_argp;
784 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400785 if (msg->rpc_cred != NULL)
786 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400787 }
788}
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790/*
791 * Default callback for async RPC calls
792 */
793static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100794rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795{
796}
797
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100798static const struct rpc_call_ops rpc_default_ops = {
799 .rpc_call_done = rpc_default_callback,
800};
801
Trond Myklebustc970aa82007-07-14 15:39:59 -0400802/**
803 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
804 * @task_setup_data: pointer to task initialisation data
805 */
806struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400807{
Trond Myklebust19445b92010-04-16 16:41:10 -0400808 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400809
Trond Myklebust84115e12007-07-14 15:39:59 -0400810 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400811 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400812 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400813
Trond Myklebust58f96122010-07-31 14:29:08 -0400814 rpc_task_set_client(task, task_setup_data->rpc_client);
815 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
816
Trond Myklebust58f96122010-07-31 14:29:08 -0400817 if (task->tk_action == NULL)
818 rpc_call_start(task);
819
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400820 atomic_inc(&task->tk_count);
821 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400822out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400823 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400824}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400825EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400826
827/**
828 * rpc_call_sync - Perform a synchronous RPC call
829 * @clnt: pointer to RPC client
830 * @msg: RPC call parameters
831 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500833int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
835 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400836 struct rpc_task_setup task_setup_data = {
837 .rpc_client = clnt,
838 .rpc_message = msg,
839 .callback_ops = &rpc_default_ops,
840 .flags = flags,
841 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400842 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400844 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
845 if (flags & RPC_TASK_ASYNC) {
846 rpc_release_calldata(task_setup_data.callback_ops,
847 task_setup_data.callback_data);
848 return -EINVAL;
849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Trond Myklebustc970aa82007-07-14 15:39:59 -0400851 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400852 if (IS_ERR(task))
853 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100854 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800855 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 return status;
857}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400858EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400860/**
861 * rpc_call_async - Perform an asynchronous RPC call
862 * @clnt: pointer to RPC client
863 * @msg: RPC call parameters
864 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800865 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400866 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 */
868int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500869rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100870 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
872 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400873 struct rpc_task_setup task_setup_data = {
874 .rpc_client = clnt,
875 .rpc_message = msg,
876 .callback_ops = tk_ops,
877 .callback_data = data,
878 .flags = flags|RPC_TASK_ASYNC,
879 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Trond Myklebustc970aa82007-07-14 15:39:59 -0400881 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400882 if (IS_ERR(task))
883 return PTR_ERR(task);
884 rpc_put_task(task);
885 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400887EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400889#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400890/**
891 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
892 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400893 * @req: RPC request
894 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400895 */
896struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400897 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400898{
899 struct rpc_task *task;
900 struct xdr_buf *xbufp = &req->rq_snd_buf;
901 struct rpc_task_setup task_setup_data = {
902 .callback_ops = tk_ops,
903 };
904
905 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
906 /*
907 * Create an rpc_task to send the data
908 */
909 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400910 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400911 xprt_free_bc_request(req);
912 goto out;
913 }
914 task->tk_rqstp = req;
915
916 /*
917 * Set up the xdr_buf length.
918 * This also indicates that the buffer is XDR encoded already.
919 */
920 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
921 xbufp->tail[0].iov_len;
922
923 task->tk_action = call_bc_transmit;
924 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400925 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400926 rpc_execute(task);
927
928out:
929 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
930 return task;
931}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400932#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400933
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400935rpc_call_start(struct rpc_task *task)
936{
937 task->tk_action = call_start;
938}
939EXPORT_SYMBOL_GPL(rpc_call_start);
940
Chuck Levered394402006-08-22 20:06:17 -0400941/**
942 * rpc_peeraddr - extract remote peer address from clnt's xprt
943 * @clnt: RPC client structure
944 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800945 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400946 *
947 * Returns the number of bytes that are actually in the stored address.
948 */
949size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
950{
951 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500952 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400953
Trond Myklebust2446ab62012-03-01 17:00:56 -0500954 rcu_read_lock();
955 xprt = rcu_dereference(clnt->cl_xprt);
956
957 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400958 if (bytes > bufsize)
959 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500960 memcpy(buf, &xprt->addr, bytes);
961 rcu_read_unlock();
962
963 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400964}
Chuck Leverb86acd52006-08-22 20:06:22 -0400965EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400966
Chuck Leverf425eba2006-08-22 20:06:18 -0400967/**
968 * rpc_peeraddr2str - return remote peer address in printable format
969 * @clnt: RPC client structure
970 * @format: address format
971 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500972 * NB: the lifetime of the memory referenced by the returned pointer is
973 * the same as the rpc_xprt itself. As long as the caller uses this
974 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400975 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500976const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
977 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400978{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500979 struct rpc_xprt *xprt;
980
981 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500982
983 if (xprt->address_strings[format] != NULL)
984 return xprt->address_strings[format];
985 else
986 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400987}
Chuck Leverb86acd52006-08-22 20:06:22 -0400988EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400989
Chuck Lever2e738fd2012-03-01 17:01:14 -0500990static const struct sockaddr_in rpc_inaddr_loopback = {
991 .sin_family = AF_INET,
992 .sin_addr.s_addr = htonl(INADDR_ANY),
993};
994
995static const struct sockaddr_in6 rpc_in6addr_loopback = {
996 .sin6_family = AF_INET6,
997 .sin6_addr = IN6ADDR_ANY_INIT,
998};
999
1000/*
1001 * Try a getsockname() on a connected datagram socket. Using a
1002 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1003 * This conserves the ephemeral port number space.
1004 *
1005 * Returns zero and fills in "buf" if successful; otherwise, a
1006 * negative errno is returned.
1007 */
1008static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1009 struct sockaddr *buf, int buflen)
1010{
1011 struct socket *sock;
1012 int err;
1013
1014 err = __sock_create(net, sap->sa_family,
1015 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1016 if (err < 0) {
1017 dprintk("RPC: can't create UDP socket (%d)\n", err);
1018 goto out;
1019 }
1020
1021 switch (sap->sa_family) {
1022 case AF_INET:
1023 err = kernel_bind(sock,
1024 (struct sockaddr *)&rpc_inaddr_loopback,
1025 sizeof(rpc_inaddr_loopback));
1026 break;
1027 case AF_INET6:
1028 err = kernel_bind(sock,
1029 (struct sockaddr *)&rpc_in6addr_loopback,
1030 sizeof(rpc_in6addr_loopback));
1031 break;
1032 default:
1033 err = -EAFNOSUPPORT;
1034 goto out;
1035 }
1036 if (err < 0) {
1037 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1038 goto out_release;
1039 }
1040
1041 err = kernel_connect(sock, sap, salen, 0);
1042 if (err < 0) {
1043 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1044 goto out_release;
1045 }
1046
1047 err = kernel_getsockname(sock, buf, &buflen);
1048 if (err < 0) {
1049 dprintk("RPC: getsockname failed (%d)\n", err);
1050 goto out_release;
1051 }
1052
1053 err = 0;
1054 if (buf->sa_family == AF_INET6) {
1055 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1056 sin6->sin6_scope_id = 0;
1057 }
1058 dprintk("RPC: %s succeeded\n", __func__);
1059
1060out_release:
1061 sock_release(sock);
1062out:
1063 return err;
1064}
1065
1066/*
1067 * Scraping a connected socket failed, so we don't have a useable
1068 * local address. Fallback: generate an address that will prevent
1069 * the server from calling us back.
1070 *
1071 * Returns zero and fills in "buf" if successful; otherwise, a
1072 * negative errno is returned.
1073 */
1074static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1075{
1076 switch (family) {
1077 case AF_INET:
1078 if (buflen < sizeof(rpc_inaddr_loopback))
1079 return -EINVAL;
1080 memcpy(buf, &rpc_inaddr_loopback,
1081 sizeof(rpc_inaddr_loopback));
1082 break;
1083 case AF_INET6:
1084 if (buflen < sizeof(rpc_in6addr_loopback))
1085 return -EINVAL;
1086 memcpy(buf, &rpc_in6addr_loopback,
1087 sizeof(rpc_in6addr_loopback));
1088 default:
1089 dprintk("RPC: %s: address family not supported\n",
1090 __func__);
1091 return -EAFNOSUPPORT;
1092 }
1093 dprintk("RPC: %s: succeeded\n", __func__);
1094 return 0;
1095}
1096
1097/**
1098 * rpc_localaddr - discover local endpoint address for an RPC client
1099 * @clnt: RPC client structure
1100 * @buf: target buffer
1101 * @buflen: size of target buffer, in bytes
1102 *
1103 * Returns zero and fills in "buf" and "buflen" if successful;
1104 * otherwise, a negative errno is returned.
1105 *
1106 * This works even if the underlying transport is not currently connected,
1107 * or if the upper layer never previously provided a source address.
1108 *
1109 * The result of this function call is transient: multiple calls in
1110 * succession may give different results, depending on how local
1111 * networking configuration changes over time.
1112 */
1113int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1114{
1115 struct sockaddr_storage address;
1116 struct sockaddr *sap = (struct sockaddr *)&address;
1117 struct rpc_xprt *xprt;
1118 struct net *net;
1119 size_t salen;
1120 int err;
1121
1122 rcu_read_lock();
1123 xprt = rcu_dereference(clnt->cl_xprt);
1124 salen = xprt->addrlen;
1125 memcpy(sap, &xprt->addr, salen);
1126 net = get_net(xprt->xprt_net);
1127 rcu_read_unlock();
1128
1129 rpc_set_port(sap, 0);
1130 err = rpc_sockname(net, sap, salen, buf, buflen);
1131 put_net(net);
1132 if (err != 0)
1133 /* Couldn't discover local address, return ANYADDR */
1134 return rpc_anyaddr(sap->sa_family, buf, buflen);
1135 return 0;
1136}
1137EXPORT_SYMBOL_GPL(rpc_localaddr);
1138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139void
1140rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1141{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001142 struct rpc_xprt *xprt;
1143
1144 rcu_read_lock();
1145 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001146 if (xprt->ops->set_buffer_size)
1147 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001148 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001150EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Trond Myklebust2446ab62012-03-01 17:00:56 -05001152/**
1153 * rpc_protocol - Get transport protocol number for an RPC client
1154 * @clnt: RPC client to query
1155 *
1156 */
1157int rpc_protocol(struct rpc_clnt *clnt)
1158{
1159 int protocol;
1160
1161 rcu_read_lock();
1162 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1163 rcu_read_unlock();
1164 return protocol;
1165}
1166EXPORT_SYMBOL_GPL(rpc_protocol);
1167
1168/**
1169 * rpc_net_ns - Get the network namespace for this RPC client
1170 * @clnt: RPC client to query
1171 *
1172 */
1173struct net *rpc_net_ns(struct rpc_clnt *clnt)
1174{
1175 struct net *ret;
1176
1177 rcu_read_lock();
1178 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1179 rcu_read_unlock();
1180 return ret;
1181}
1182EXPORT_SYMBOL_GPL(rpc_net_ns);
1183
1184/**
1185 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1186 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 *
1188 * For stream transports, this is one RPC record fragment (see RFC
1189 * 1831), as we don't support multi-record requests yet. For datagram
1190 * transports, this is the size of an IP packet minus the IP, UDP, and
1191 * RPC header sizes.
1192 */
1193size_t rpc_max_payload(struct rpc_clnt *clnt)
1194{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001195 size_t ret;
1196
1197 rcu_read_lock();
1198 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1199 rcu_read_unlock();
1200 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201}
Chuck Leverb86acd52006-08-22 20:06:22 -04001202EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203
Chuck Lever35f5a422006-01-03 09:55:50 +01001204/**
1205 * rpc_force_rebind - force transport to check that remote port is unchanged
1206 * @clnt: client to rebind
1207 *
1208 */
1209void rpc_force_rebind(struct rpc_clnt *clnt)
1210{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001211 if (clnt->cl_autobind) {
1212 rcu_read_lock();
1213 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1214 rcu_read_unlock();
1215 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001216}
Chuck Leverb86acd52006-08-22 20:06:22 -04001217EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001220 * Restart an (async) RPC call from the call_prepare state.
1221 * Usually called from within the exit handler.
1222 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001223int
Andy Adamsonaae20062009-04-01 09:22:40 -04001224rpc_restart_call_prepare(struct rpc_task *task)
1225{
1226 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001227 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001228 task->tk_action = call_start;
1229 if (task->tk_ops->rpc_call_prepare != NULL)
1230 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001231 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001232}
1233EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1234
1235/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 * Restart an (async) RPC call. Usually called from within the
1237 * exit handler.
1238 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001239int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240rpc_restart_call(struct rpc_task *task)
1241{
1242 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001243 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001245 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001247EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248
Chuck Lever3748f1e2008-05-21 17:09:12 -04001249#ifdef RPC_DEBUG
1250static const char *rpc_proc_name(const struct rpc_task *task)
1251{
1252 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1253
1254 if (proc) {
1255 if (proc->p_name)
1256 return proc->p_name;
1257 else
1258 return "NULL";
1259 } else
1260 return "no proc";
1261}
1262#endif
1263
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264/*
1265 * 0. Initial state
1266 *
1267 * Other FSM states can be visited zero or more times, but
1268 * this state is visited exactly once for each RPC.
1269 */
1270static void
1271call_start(struct rpc_task *task)
1272{
1273 struct rpc_clnt *clnt = task->tk_client;
1274
Chuck Lever3748f1e2008-05-21 17:09:12 -04001275 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001276 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001277 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001278 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
1280 /* Increment call count */
1281 task->tk_msg.rpc_proc->p_count++;
1282 clnt->cl_stats->rpccnt++;
1283 task->tk_action = call_reserve;
1284}
1285
1286/*
1287 * 1. Reserve an RPC call slot
1288 */
1289static void
1290call_reserve(struct rpc_task *task)
1291{
Chuck Lever46121cf2007-01-31 12:14:08 -05001292 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 task->tk_status = 0;
1295 task->tk_action = call_reserveresult;
1296 xprt_reserve(task);
1297}
1298
1299/*
1300 * 1b. Grok the result of xprt_reserve()
1301 */
1302static void
1303call_reserveresult(struct rpc_task *task)
1304{
1305 int status = task->tk_status;
1306
Chuck Lever46121cf2007-01-31 12:14:08 -05001307 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
1309 /*
1310 * After a call to xprt_reserve(), we must have either
1311 * a request slot or else an error status.
1312 */
1313 task->tk_status = 0;
1314 if (status >= 0) {
1315 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001316 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 return;
1318 }
1319
1320 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001321 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 rpc_exit(task, -EIO);
1323 return;
1324 }
1325
1326 /*
1327 * Even though there was an error, we may have acquired
1328 * a request slot somehow. Make sure not to leak it.
1329 */
1330 if (task->tk_rqstp) {
1331 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001332 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 xprt_release(task);
1334 }
1335
1336 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001337 case -ENOMEM:
1338 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 case -EAGAIN: /* woken up; retry */
1340 task->tk_action = call_reserve;
1341 return;
1342 case -EIO: /* probably a shutdown */
1343 break;
1344 default:
1345 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001346 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 break;
1348 }
1349 rpc_exit(task, status);
1350}
1351
1352/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001353 * 2. Bind and/or refresh the credentials
1354 */
1355static void
1356call_refresh(struct rpc_task *task)
1357{
1358 dprint_status(task);
1359
1360 task->tk_action = call_refreshresult;
1361 task->tk_status = 0;
1362 task->tk_client->cl_stats->rpcauthrefresh++;
1363 rpcauth_refreshcred(task);
1364}
1365
1366/*
1367 * 2a. Process the results of a credential refresh
1368 */
1369static void
1370call_refreshresult(struct rpc_task *task)
1371{
1372 int status = task->tk_status;
1373
1374 dprint_status(task);
1375
1376 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001377 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001378 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001379 case 0:
1380 if (rpcauth_uptodatecred(task))
1381 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001382 return;
1383 case -ETIMEDOUT:
1384 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001385 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001386 case -EAGAIN:
1387 status = -EACCES;
1388 if (!task->tk_cred_retry)
1389 break;
1390 task->tk_cred_retry--;
1391 dprintk("RPC: %5u %s: retry refresh creds\n",
1392 task->tk_pid, __func__);
1393 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001394 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001395 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1396 task->tk_pid, __func__, status);
1397 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001398}
1399
1400/*
1401 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001402 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 */
1404static void
1405call_allocate(struct rpc_task *task)
1406{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001407 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001408 struct rpc_rqst *req = task->tk_rqstp;
1409 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001410 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
Chuck Lever46121cf2007-01-31 12:14:08 -05001412 dprint_status(task);
1413
Chuck Lever2bea90d2007-03-29 16:47:53 -04001414 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001415 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001416
Chuck Lever02107142006-01-03 09:55:49 +01001417 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 return;
1419
Chuck Lever2bea90d2007-03-29 16:47:53 -04001420 if (proc->p_proc != 0) {
1421 BUG_ON(proc->p_arglen == 0);
1422 if (proc->p_decode != NULL)
1423 BUG_ON(proc->p_replen == 0);
1424 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Chuck Lever2bea90d2007-03-29 16:47:53 -04001426 /*
1427 * Calculate the size (in quads) of the RPC call
1428 * and reply headers, and convert both values
1429 * to byte sizes.
1430 */
1431 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1432 req->rq_callsize <<= 2;
1433 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1434 req->rq_rcvsize <<= 2;
1435
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001436 req->rq_buffer = xprt->ops->buf_alloc(task,
1437 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001438 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001440
1441 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Trond Myklebust5afa9132011-06-17 10:14:59 -04001443 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001444 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 rpc_delay(task, HZ>>4);
1446 return;
1447 }
1448
1449 rpc_exit(task, -ERESTARTSYS);
1450}
1451
Trond Myklebust940e3312005-11-09 21:45:24 -05001452static inline int
1453rpc_task_need_encode(struct rpc_task *task)
1454{
1455 return task->tk_rqstp->rq_snd_buf.len == 0;
1456}
1457
1458static inline void
1459rpc_task_force_reencode(struct rpc_task *task)
1460{
1461 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001462 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001463}
1464
Chuck Lever2bea90d2007-03-29 16:47:53 -04001465static inline void
1466rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1467{
1468 buf->head[0].iov_base = start;
1469 buf->head[0].iov_len = len;
1470 buf->tail[0].iov_len = 0;
1471 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001472 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001473 buf->len = 0;
1474 buf->buflen = len;
1475}
1476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477/*
1478 * 3. Encode arguments of an RPC call
1479 */
1480static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001481rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001484 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001485 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Chuck Lever46121cf2007-01-31 12:14:08 -05001487 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
Chuck Lever2bea90d2007-03-29 16:47:53 -04001489 rpc_xdr_buf_init(&req->rq_snd_buf,
1490 req->rq_buffer,
1491 req->rq_callsize);
1492 rpc_xdr_buf_init(&req->rq_rcv_buf,
1493 (char *)req->rq_buffer + req->rq_callsize,
1494 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Chuck Leverb0e1c572008-05-21 17:09:19 -04001496 p = rpc_encode_header(task);
1497 if (p == NULL) {
1498 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 rpc_exit(task, -EIO);
1500 return;
1501 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001502
1503 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001504 if (encode == NULL)
1505 return;
1506
1507 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1508 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509}
1510
1511/*
1512 * 4. Get the server port number if not yet set
1513 */
1514static void
1515call_bind(struct rpc_task *task)
1516{
Chuck Leverec739ef2006-08-22 20:06:15 -04001517 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Chuck Lever46121cf2007-01-31 12:14:08 -05001519 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Chuck Leverda351872005-08-11 16:25:11 -04001521 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001522 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001523 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001524 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001525 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 }
1527}
1528
1529/*
Chuck Leverda351872005-08-11 16:25:11 -04001530 * 4a. Sort out bind result
1531 */
1532static void
1533call_bind_status(struct rpc_task *task)
1534{
Chuck Lever906462a2007-09-11 18:00:47 -04001535 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001536
1537 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001538 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001539 task->tk_status = 0;
1540 task->tk_action = call_connect;
1541 return;
1542 }
1543
Steve Dickson5753cba2012-02-06 10:08:08 -05001544 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001545 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001546 case -ENOMEM:
1547 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1548 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001549 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001550 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001551 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1552 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001553 /* fail immediately if this is an RPC ping */
1554 if (task->tk_msg.rpc_proc->p_proc == 0) {
1555 status = -EOPNOTSUPP;
1556 break;
1557 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001558 if (task->tk_rebind_retry == 0)
1559 break;
1560 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001561 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001562 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001563 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001564 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001565 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001566 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001567 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001568 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001569 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001570 task->tk_pid);
1571 break;
1572 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001573 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001574 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001575 task->tk_status = 0;
1576 task->tk_action = call_bind;
1577 return;
Chuck Lever012da152009-12-03 15:58:56 -05001578 case -ECONNREFUSED: /* connection problems */
1579 case -ECONNRESET:
1580 case -ENOTCONN:
1581 case -EHOSTDOWN:
1582 case -EHOSTUNREACH:
1583 case -ENETUNREACH:
1584 case -EPIPE:
1585 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1586 task->tk_pid, task->tk_status);
1587 if (!RPC_IS_SOFTCONN(task)) {
1588 rpc_delay(task, 5*HZ);
1589 goto retry_timeout;
1590 }
1591 status = task->tk_status;
1592 break;
Chuck Leverda351872005-08-11 16:25:11 -04001593 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001594 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001595 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001596 }
1597
1598 rpc_exit(task, status);
1599 return;
1600
Trond Myklebustda458282006-08-31 15:44:52 -04001601retry_timeout:
1602 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001603}
1604
1605/*
1606 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 */
1608static void
1609call_connect(struct rpc_task *task)
1610{
Chuck Leverda351872005-08-11 16:25:11 -04001611 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612
Chuck Lever46121cf2007-01-31 12:14:08 -05001613 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001614 task->tk_pid, xprt,
1615 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Chuck Leverda351872005-08-11 16:25:11 -04001617 task->tk_action = call_transmit;
1618 if (!xprt_connected(xprt)) {
1619 task->tk_action = call_connect_status;
1620 if (task->tk_status < 0)
1621 return;
1622 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624}
1625
1626/*
Chuck Leverda351872005-08-11 16:25:11 -04001627 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 */
1629static void
1630call_connect_status(struct rpc_task *task)
1631{
1632 struct rpc_clnt *clnt = task->tk_client;
1633 int status = task->tk_status;
1634
Chuck Lever46121cf2007-01-31 12:14:08 -05001635 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001636
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001638 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 clnt->cl_stats->netreconn++;
1640 task->tk_action = call_transmit;
1641 return;
1642 }
1643
Steve Dickson5753cba2012-02-06 10:08:08 -05001644 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001646 /* if soft mounted, test if we've timed out */
1647 case -ETIMEDOUT:
1648 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001649 break;
1650 default:
1651 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 }
1653}
1654
1655/*
1656 * 5. Transmit the RPC request, and wait for reply
1657 */
1658static void
1659call_transmit(struct rpc_task *task)
1660{
Chuck Lever46121cf2007-01-31 12:14:08 -05001661 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662
1663 task->tk_action = call_status;
1664 if (task->tk_status < 0)
1665 return;
1666 task->tk_status = xprt_prepare_transmit(task);
1667 if (task->tk_status != 0)
1668 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001669 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001671 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001672 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001673 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001674 if (task->tk_status != 0) {
1675 /* Was the error nonfatal? */
1676 if (task->tk_status == -EAGAIN)
1677 rpc_delay(task, HZ >> 4);
1678 else
1679 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001680 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001681 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001682 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 xprt_transmit(task);
1684 if (task->tk_status < 0)
1685 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001686 /*
1687 * On success, ensure that we call xprt_end_transmit() before sleeping
1688 * in order to allow access to the socket to other RPC requests.
1689 */
1690 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001691 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001692 return;
1693 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001694 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001695}
1696
1697/*
1698 * 5a. Handle cleanup after a transmission
1699 */
1700static void
1701call_transmit_status(struct rpc_task *task)
1702{
1703 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001704
1705 /*
1706 * Common case: success. Force the compiler to put this
1707 * test first.
1708 */
1709 if (task->tk_status == 0) {
1710 xprt_end_transmit(task);
1711 rpc_task_force_reencode(task);
1712 return;
1713 }
1714
Trond Myklebust15f081c2009-03-11 14:37:57 -04001715 switch (task->tk_status) {
1716 case -EAGAIN:
1717 break;
1718 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001719 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001720 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001721 rpc_task_force_reencode(task);
1722 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001723 /*
1724 * Special cases: if we've been waiting on the
1725 * socket's write_space() callback, or if the
1726 * socket just returned a connection error,
1727 * then hold onto the transport lock.
1728 */
1729 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001730 case -EHOSTDOWN:
1731 case -EHOSTUNREACH:
1732 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001733 if (RPC_IS_SOFTCONN(task)) {
1734 xprt_end_transmit(task);
1735 rpc_exit(task, task->tk_status);
1736 break;
1737 }
1738 case -ECONNRESET:
1739 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001740 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001741 rpc_task_force_reencode(task);
1742 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743}
1744
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001745#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001746/*
1747 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1748 * addition, disconnect on connectivity errors.
1749 */
1750static void
1751call_bc_transmit(struct rpc_task *task)
1752{
1753 struct rpc_rqst *req = task->tk_rqstp;
1754
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001755 task->tk_status = xprt_prepare_transmit(task);
1756 if (task->tk_status == -EAGAIN) {
1757 /*
1758 * Could not reserve the transport. Try again after the
1759 * transport is released.
1760 */
1761 task->tk_status = 0;
1762 task->tk_action = call_bc_transmit;
1763 return;
1764 }
1765
1766 task->tk_action = rpc_exit_task;
1767 if (task->tk_status < 0) {
1768 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1769 "error: %d\n", task->tk_status);
1770 return;
1771 }
1772
1773 xprt_transmit(task);
1774 xprt_end_transmit(task);
1775 dprint_status(task);
1776 switch (task->tk_status) {
1777 case 0:
1778 /* Success */
1779 break;
1780 case -EHOSTDOWN:
1781 case -EHOSTUNREACH:
1782 case -ENETUNREACH:
1783 case -ETIMEDOUT:
1784 /*
1785 * Problem reaching the server. Disconnect and let the
1786 * forechannel reestablish the connection. The server will
1787 * have to retransmit the backchannel request and we'll
1788 * reprocess it. Since these ops are idempotent, there's no
1789 * need to cache our reply at this time.
1790 */
1791 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1792 "error: %d\n", task->tk_status);
1793 xprt_conditional_disconnect(task->tk_xprt,
1794 req->rq_connect_cookie);
1795 break;
1796 default:
1797 /*
1798 * We were unable to reply and will have to drop the
1799 * request. The server should reconnect and retransmit.
1800 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001801 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001802 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1803 "error: %d\n", task->tk_status);
1804 break;
1805 }
1806 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1807}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001808#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001809
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810/*
1811 * 6. Sort out the RPC call status
1812 */
1813static void
1814call_status(struct rpc_task *task)
1815{
1816 struct rpc_clnt *clnt = task->tk_client;
1817 struct rpc_rqst *req = task->tk_rqstp;
1818 int status;
1819
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001820 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1821 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Chuck Lever46121cf2007-01-31 12:14:08 -05001823 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
1825 status = task->tk_status;
1826 if (status >= 0) {
1827 task->tk_action = call_decode;
1828 return;
1829 }
1830
Steve Dickson5753cba2012-02-06 10:08:08 -05001831 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 task->tk_status = 0;
1833 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001834 case -EHOSTDOWN:
1835 case -EHOSTUNREACH:
1836 case -ENETUNREACH:
1837 /*
1838 * Delay any retries for 3 seconds, then handle as if it
1839 * were a timeout.
1840 */
1841 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 case -ETIMEDOUT:
1843 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001844 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001845 xprt_conditional_disconnect(task->tk_xprt,
1846 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001848 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001850 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001851 rpc_delay(task, 3*HZ);
1852 case -EPIPE:
1853 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 task->tk_action = call_bind;
1855 break;
1856 case -EAGAIN:
1857 task->tk_action = call_transmit;
1858 break;
1859 case -EIO:
1860 /* shutdown or soft timeout */
1861 rpc_exit(task, status);
1862 break;
1863 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001864 if (clnt->cl_chatty)
1865 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 clnt->cl_protname, -status);
1867 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 }
1869}
1870
1871/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001872 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 * We do not release the request slot, so we keep using the
1874 * same XID for all retransmits.
1875 */
1876static void
1877call_timeout(struct rpc_task *task)
1878{
1879 struct rpc_clnt *clnt = task->tk_client;
1880
1881 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001882 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 goto retry;
1884 }
1885
Chuck Lever46121cf2007-01-31 12:14:08 -05001886 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001887 task->tk_timeouts++;
1888
Chuck Lever3a28bec2009-12-03 15:58:56 -05001889 if (RPC_IS_SOFTCONN(task)) {
1890 rpc_exit(task, -ETIMEDOUT);
1891 return;
1892 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001894 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001895 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001896 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001897 clnt->cl_protname,
1898 rcu_dereference(clnt->cl_xprt)->servername);
1899 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001900 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001901 if (task->tk_flags & RPC_TASK_TIMEOUT)
1902 rpc_exit(task, -ETIMEDOUT);
1903 else
1904 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 return;
1906 }
1907
Chuck Leverf518e35a2006-01-03 09:55:52 +01001908 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001910 if (clnt->cl_chatty) {
1911 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001912 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001913 clnt->cl_protname,
1914 rcu_dereference(clnt->cl_xprt)->servername);
1915 rcu_read_unlock();
1916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001918 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001919 /*
1920 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1921 * event? RFC2203 requires the server to drop all such requests.
1922 */
1923 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924
1925retry:
1926 clnt->cl_stats->rpcretrans++;
1927 task->tk_action = call_bind;
1928 task->tk_status = 0;
1929}
1930
1931/*
1932 * 7. Decode the RPC reply
1933 */
1934static void
1935call_decode(struct rpc_task *task)
1936{
1937 struct rpc_clnt *clnt = task->tk_client;
1938 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001939 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001940 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
Vasily Averin726fd6a2011-06-01 16:23:59 +04001942 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943
Chuck Leverf518e35a2006-01-03 09:55:52 +01001944 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001945 if (clnt->cl_chatty) {
1946 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001947 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001948 clnt->cl_protname,
1949 rcu_dereference(clnt->cl_xprt)->servername);
1950 rcu_read_unlock();
1951 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1953 }
1954
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001955 /*
1956 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001957 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001958 */
1959 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 req->rq_rcv_buf.len = req->rq_private_buf.len;
1961
1962 /* Check that the softirq receive buffer is valid */
1963 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1964 sizeof(req->rq_rcv_buf)) != 0);
1965
Trond Myklebust1e799b62008-03-21 16:19:41 -04001966 if (req->rq_rcv_buf.len < 12) {
1967 if (!RPC_IS_SOFT(task)) {
1968 task->tk_action = call_bind;
1969 clnt->cl_stats->rpcretrans++;
1970 goto out_retry;
1971 }
1972 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1973 clnt->cl_protname, task->tk_status);
1974 task->tk_action = call_timeout;
1975 goto out_retry;
1976 }
1977
Chuck Leverb0e1c572008-05-21 17:09:19 -04001978 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001979 if (IS_ERR(p)) {
1980 if (p == ERR_PTR(-EAGAIN))
1981 goto out_retry;
1982 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 }
1984
Trond Myklebustabbcf282006-01-03 09:55:03 +01001985 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001987 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1989 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001990 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001991 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1992 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 return;
1994out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001996 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001997 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001998 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001999 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002000 xprt_conditional_disconnect(task->tk_xprt,
2001 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002002 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003}
2004
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002005static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002006rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007{
2008 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002010 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
2012 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002013
2014 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 *p++ = req->rq_xid; /* XID */
2016 *p++ = htonl(RPC_CALL); /* CALL */
2017 *p++ = htonl(RPC_VERSION); /* RPC version */
2018 *p++ = htonl(clnt->cl_prog); /* program number */
2019 *p++ = htonl(clnt->cl_vers); /* program version */
2020 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002021 p = rpcauth_marshcred(task, p);
2022 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2023 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024}
2025
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002026static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002027rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002029 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2031 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002032 __be32 *p = iov->iov_base;
2033 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 int error = -EACCES;
2035
David Howellse8896492006-08-24 15:44:19 -04002036 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2037 /* RFC-1014 says that the representation of XDR data must be a
2038 * multiple of four bytes
2039 * - if it isn't pointer subtraction in the NFS client may give
2040 * undefined results
2041 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002042 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002043 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002044 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002045 goto out_eio;
2046 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 if ((len -= 3) < 0)
2048 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002050 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002052 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002053 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002054 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002056
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2058 if (--len < 0)
2059 goto out_overflow;
2060 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002061 case RPC_AUTH_ERROR:
2062 break;
2063 case RPC_MISMATCH:
2064 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2065 task->tk_pid, __func__);
2066 error = -EPROTONOSUPPORT;
2067 goto out_err;
2068 default:
2069 dprintk("RPC: %5u %s: RPC call rejected, "
2070 "unknown error: %x\n",
2071 task->tk_pid, __func__, n);
2072 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 }
2074 if (--len < 0)
2075 goto out_overflow;
2076 switch ((n = ntohl(*p++))) {
2077 case RPC_AUTH_REJECTEDCRED:
2078 case RPC_AUTH_REJECTEDVERF:
2079 case RPCSEC_GSS_CREDPROBLEM:
2080 case RPCSEC_GSS_CTXPROBLEM:
2081 if (!task->tk_cred_retry)
2082 break;
2083 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002084 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002085 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002087 /* Ensure we obtain a new XID! */
2088 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002089 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002090 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 case RPC_AUTH_BADCRED:
2092 case RPC_AUTH_BADVERF:
2093 /* possibly garbled cred/verf? */
2094 if (!task->tk_garb_retry)
2095 break;
2096 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002097 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002098 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002100 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002102 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002103 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002104 "authentication.\n",
2105 rcu_dereference(clnt->cl_xprt)->servername);
2106 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 break;
2108 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002109 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002110 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 error = -EIO;
2112 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002113 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002114 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 goto out_err;
2116 }
2117 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002118 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002119 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002120 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002122 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 if (len < 0)
2124 goto out_overflow;
2125 switch ((n = ntohl(*p++))) {
2126 case RPC_SUCCESS:
2127 return p;
2128 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002129 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2130 "by server %s\n", task->tk_pid, __func__,
2131 (unsigned int)clnt->cl_prog,
2132 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002133 error = -EPFNOSUPPORT;
2134 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002136 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2137 "by server %s\n", task->tk_pid, __func__,
2138 (unsigned int)clnt->cl_prog,
2139 (unsigned int)clnt->cl_vers,
2140 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002141 error = -EPROTONOSUPPORT;
2142 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002144 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002145 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002146 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002147 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002148 clnt->cl_prog, clnt->cl_vers,
2149 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002150 error = -EOPNOTSUPP;
2151 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002153 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002154 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 break; /* retry */
2156 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002157 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002158 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 /* Also retry */
2160 }
2161
Trond Myklebustabbcf282006-01-03 09:55:03 +01002162out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002163 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 if (task->tk_garb_retry) {
2165 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002166 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002167 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002169out_retry:
2170 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172out_eio:
2173 error = -EIO;
2174out_err:
2175 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002176 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002177 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002178 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002180 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002181 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002182 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002184
Chuck Lever9f06c712010-12-14 14:59:18 +00002185static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002186{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002187}
2188
Chuck Leverbf269552010-12-14 14:59:29 +00002189static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002190{
2191 return 0;
2192}
2193
2194static struct rpc_procinfo rpcproc_null = {
2195 .p_encode = rpcproc_encode_null,
2196 .p_decode = rpcproc_decode_null,
2197};
2198
Chuck Levercaabea82009-12-03 15:58:56 -05002199static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002200{
2201 struct rpc_message msg = {
2202 .rpc_proc = &rpcproc_null,
2203 };
2204 int err;
2205 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002206 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002207 put_rpccred(msg.rpc_cred);
2208 return err;
2209}
Trond Myklebust188fef12007-06-16 14:18:40 -04002210
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002211struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2212{
2213 struct rpc_message msg = {
2214 .rpc_proc = &rpcproc_null,
2215 .rpc_cred = cred,
2216 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002217 struct rpc_task_setup task_setup_data = {
2218 .rpc_client = clnt,
2219 .rpc_message = &msg,
2220 .callback_ops = &rpc_default_ops,
2221 .flags = flags,
2222 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002223 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002224}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002225EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002226
Trond Myklebust188fef12007-06-16 14:18:40 -04002227#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002228static void rpc_show_header(void)
2229{
Chuck Levercb3997b2008-05-21 17:09:41 -04002230 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2231 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002232}
2233
Chuck Lever38e886e2008-05-21 17:09:33 -04002234static void rpc_show_task(const struct rpc_clnt *clnt,
2235 const struct rpc_task *task)
2236{
2237 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002238
2239 if (RPC_IS_QUEUED(task))
2240 rpc_waitq = rpc_qname(task->tk_waitqueue);
2241
Joe Perchesb3bceda2010-12-21 10:52:24 -05002242 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 -04002243 task->tk_pid, task->tk_flags, task->tk_status,
2244 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2245 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002246 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002247}
2248
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002249void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002250{
2251 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002252 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002253 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002254 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002255
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002256 spin_lock(&sn->rpc_client_lock);
2257 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002258 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002259 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002260 if (!header) {
2261 rpc_show_header();
2262 header++;
2263 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002264 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002265 }
2266 spin_unlock(&clnt->cl_lock);
2267 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002268 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002269}
2270#endif