blob: e9b22e8e16c791ec51989132491e3ecc203dba05 [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
20#include <asm/system.h>
21
22#include <linux/module.h>
23#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040024#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040026#include <linux/namei.h>
27#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050037#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040038#include <linux/sunrpc/bc_xprt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040040#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040041#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#ifdef RPC_DEBUG
44# define RPCDBG_FACILITY RPCDBG_CALL
45#endif
46
Chuck Lever46121cf2007-01-31 12:14:08 -050047#define dprint_status(t) \
48 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080049 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050050
Trond Myklebust188fef12007-06-16 14:18:40 -040051/*
52 * All RPC clients are linked into this list
53 */
Trond Myklebust188fef12007-06-16 14:18:40 -040054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
56
57
58static void call_start(struct rpc_task *task);
59static void call_reserve(struct rpc_task *task);
60static void call_reserveresult(struct rpc_task *task);
61static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static void call_decode(struct rpc_task *task);
63static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040064static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040066#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040067static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050070static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_refresh(struct rpc_task *task);
72static void call_refreshresult(struct rpc_task *task);
73static void call_timeout(struct rpc_task *task);
74static void call_connect(struct rpc_task *task);
75static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Chuck Leverb0e1c572008-05-21 17:09:19 -040077static __be32 *rpc_encode_header(struct rpc_task *task);
78static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050079static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040080
Trond Myklebust188fef12007-06-16 14:18:40 -040081static void rpc_register_client(struct rpc_clnt *clnt)
82{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040083 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
84
85 spin_lock(&sn->rpc_client_lock);
86 list_add(&clnt->cl_clients, &sn->all_clients);
87 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040088}
89
90static void rpc_unregister_client(struct rpc_clnt *clnt)
91{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040092 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
93
94 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040095 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040096 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040097}
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +040099static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
100{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400101 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400102 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
103 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400104 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400105 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400106 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400107}
108
109static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
110{
111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
113 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
116 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
121 struct rpc_clnt *clnt, char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400124 char name[15];
125 struct qstr q = {
126 .name = name,
127 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 int error;
130
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 dir = rpc_d_lookup_sb(sb, dir_name);
132 if (dir == NULL)
133 return dir;
134 for (;;) {
135 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
136 name[sizeof(name) - 1] = '\0';
137 q.hash = full_name_hash(q.name, q.len);
138 dentry = rpc_create_client_dir(dir, &q, clnt);
139 if (!IS_ERR(dentry))
140 break;
141 error = PTR_ERR(dentry);
142 if (error != -EEXIST) {
143 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
144 " %s/%s, error %d\n",
145 dir_name, name, error);
146 break;
147 }
148 }
149 dput(dir);
150 return dentry;
151}
152
153static int
154rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
155{
156 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400157 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400158
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400159 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 if (dir_name == NULL)
161 return 0;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400162 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400163 if (!pipefs_sb)
164 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400165 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400166 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400167 if (IS_ERR(dentry))
168 return PTR_ERR(dentry);
169 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400170 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400173static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
174 struct super_block *sb)
175{
176 struct dentry *dentry;
177 int err = 0;
178
179 switch (event) {
180 case RPC_PIPEFS_MOUNT:
181 if (clnt->cl_program->pipe_dir_name == NULL)
182 break;
183 dentry = rpc_setup_pipedir_sb(sb, clnt,
184 clnt->cl_program->pipe_dir_name);
185 BUG_ON(dentry == NULL);
186 if (IS_ERR(dentry))
187 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400188 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400189 if (clnt->cl_auth->au_ops->pipes_create) {
190 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
191 if (err)
192 __rpc_clnt_remove_pipedir(clnt);
193 }
194 break;
195 case RPC_PIPEFS_UMOUNT:
196 __rpc_clnt_remove_pipedir(clnt);
197 break;
198 default:
199 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
200 return -ENOTSUPP;
201 }
202 return err;
203}
204
205static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
206 void *ptr)
207{
208 struct super_block *sb = ptr;
209 struct rpc_clnt *clnt;
210 int error = 0;
211 struct sunrpc_net *sn = net_generic(sb->s_fs_info, sunrpc_net_id);
212
213 spin_lock(&sn->rpc_client_lock);
214 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
215 error = __rpc_pipefs_event(clnt, event, sb);
216 if (error)
217 break;
218 }
219 spin_unlock(&sn->rpc_client_lock);
220 return error;
221}
222
223static struct notifier_block rpc_clients_block = {
224 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400225 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400226};
227
228int rpc_clients_notifier_register(void)
229{
230 return rpc_pipefs_notifier_register(&rpc_clients_block);
231}
232
233void rpc_clients_notifier_unregister(void)
234{
235 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
236}
237
Trond Myklebust698b6d02007-12-20 16:03:53 -0500238static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500240 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 struct rpc_version *version;
242 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000243 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400245 size_t len;
246
247 /* sanity check the name before trying to print it */
248 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500249 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400250 if (len > RPC_MAXNETNAMELEN)
251 goto out_no_rpciod;
252 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Chuck Lever46121cf2007-01-31 12:14:08 -0500254 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500255 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Trond Myklebust4ada5392007-06-14 17:26:17 -0400257 err = rpciod_up();
258 if (err)
259 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 err = -EINVAL;
261 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800262 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500263
264 if (args->version >= program->nrvers)
265 goto out_err;
266 version = program->version[args->version];
267 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 goto out_err;
269
270 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700271 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 if (!clnt)
273 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 clnt->cl_parent = clnt;
275
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500276 clnt->cl_server = kstrdup(args->servername, GFP_KERNEL);
277 if (clnt->cl_server == NULL)
278 goto out_no_server;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280 clnt->cl_xprt = xprt;
281 clnt->cl_procinfo = version->procs;
282 clnt->cl_maxproc = version->nrprocs;
283 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300284 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500287 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500288 err = -ENOMEM;
289 if (clnt->cl_metrics == NULL)
290 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500291 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400292 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400293 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Chuck Leverec739ef2006-08-22 20:06:15 -0400295 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 clnt->cl_autobind = 1;
297
Trond Myklebustba7392b2007-12-20 16:03:55 -0500298 clnt->cl_timeout = xprt->timeout;
299 if (args->timeout != NULL) {
300 memcpy(&clnt->cl_timeout_default, args->timeout,
301 sizeof(clnt->cl_timeout_default));
302 clnt->cl_timeout = &clnt->cl_timeout_default;
303 }
304
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500306 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500307 clnt->cl_principal = NULL;
308 if (args->client_name) {
309 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
310 if (!clnt->cl_principal)
311 goto out_no_principal;
312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Trond Myklebust006abe82010-09-12 19:55:25 -0400314 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
317 if (err < 0)
318 goto out_no_path;
319
Trond Myklebust698b6d02007-12-20 16:03:53 -0500320 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000321 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500323 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000324 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 goto out_no_auth;
326 }
327
328 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400329 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (clnt->cl_nodelen > UNX_MAXNODENAME)
331 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400332 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400333 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 return clnt;
335
336out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400337 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500339 kfree(clnt->cl_principal);
340out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500341 rpc_free_iostats(clnt->cl_metrics);
342out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500343 kfree(clnt->cl_server);
344out_no_server:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 kfree(clnt);
346out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400347 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800348out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400349 rpciod_down();
350out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 return ERR_PTR(err);
352}
353
Chuck Leverc2866762006-08-22 20:06:20 -0400354/*
355 * rpc_create - create an RPC client and transport with one call
356 * @args: rpc_clnt create argument structure
357 *
358 * Creates and initializes an RPC transport and an RPC client.
359 *
360 * It can ping the server in order to determine if it is up, and to see if
361 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
362 * this behavior so asynchronous tasks can also use rpc_create.
363 */
364struct rpc_clnt *rpc_create(struct rpc_create_args *args)
365{
366 struct rpc_xprt *xprt;
367 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400368 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400369 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400370 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200371 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200372 .dstaddr = args->address,
373 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300374 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200375 };
Chuck Lever510deb02007-12-10 14:56:24 -0500376 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400377
Chuck Leverc2866762006-08-22 20:06:20 -0400378 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400379 * If the caller chooses not to specify a hostname, whip
380 * up a string representation of the passed-in address.
381 */
382 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400383 struct sockaddr_un *sun =
384 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400385 struct sockaddr_in *sin =
386 (struct sockaddr_in *)args->address;
387 struct sockaddr_in6 *sin6 =
388 (struct sockaddr_in6 *)args->address;
389
Chuck Lever510deb02007-12-10 14:56:24 -0500390 servername[0] = '\0';
391 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400392 case AF_LOCAL:
393 snprintf(servername, sizeof(servername), "%s",
394 sun->sun_path);
395 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400396 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700397 snprintf(servername, sizeof(servername), "%pI4",
398 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500399 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400400 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700401 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400402 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500403 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500404 default:
405 /* caller wants default server name, but
406 * address family isn't recognized. */
407 return ERR_PTR(-EINVAL);
408 }
Chuck Lever43780b82007-07-01 12:13:22 -0400409 args->servername = servername;
410 }
411
Chuck Lever510deb02007-12-10 14:56:24 -0500412 xprt = xprt_create_transport(&xprtargs);
413 if (IS_ERR(xprt))
414 return (struct rpc_clnt *)xprt;
415
Chuck Lever43780b82007-07-01 12:13:22 -0400416 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400417 * By default, kernel RPC client connects from a reserved port.
418 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
419 * but it is always enabled for rpciod, which handles the connect
420 * operation.
421 */
422 xprt->resvport = 1;
423 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
424 xprt->resvport = 0;
425
Trond Myklebust698b6d02007-12-20 16:03:53 -0500426 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400427 if (IS_ERR(clnt))
428 return clnt;
429
430 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500431 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400432 if (err != 0) {
433 rpc_shutdown_client(clnt);
434 return ERR_PTR(err);
435 }
436 }
437
438 clnt->cl_softrtry = 1;
439 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
440 clnt->cl_softrtry = 0;
441
Chuck Leverc2866762006-08-22 20:06:20 -0400442 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
443 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500444 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
445 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400446 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
447 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400448
449 return clnt;
450}
Chuck Leverb86acd52006-08-22 20:06:22 -0400451EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453/*
454 * This function clones the RPC client structure. It allows us to share the
455 * same transport while varying parameters such as the authentication
456 * flavour.
457 */
458struct rpc_clnt *
459rpc_clone_client(struct rpc_clnt *clnt)
460{
461 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500462 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200464 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 if (!new)
466 goto out_no_clnt;
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500467 new->cl_server = kstrdup(clnt->cl_server, GFP_KERNEL);
468 if (new->cl_server == NULL)
469 goto out_no_server;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400470 new->cl_parent = clnt;
471 /* Turn off autobind on clones */
472 new->cl_autobind = 0;
473 INIT_LIST_HEAD(&new->cl_tasks);
474 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500475 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500476 new->cl_metrics = rpc_alloc_iostats(clnt);
477 if (new->cl_metrics == NULL)
478 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500479 if (clnt->cl_principal) {
480 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
481 if (new->cl_principal == NULL)
482 goto out_no_principal;
483 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400484 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500485 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
486 if (err != 0)
487 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 if (new->cl_auth)
489 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400490 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400491 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400492 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400493 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500495out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500496 kfree(new->cl_principal);
497out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500498 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500499out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500500 kfree(new->cl_server);
501out_no_server:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500502 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800504 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500505 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400507EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400510 * Kill all tasks for the given client.
511 * XXX: kill their descendants as well?
512 */
513void rpc_killall_tasks(struct rpc_clnt *clnt)
514{
515 struct rpc_task *rovr;
516
517
518 if (list_empty(&clnt->cl_tasks))
519 return;
520 dprintk("RPC: killing all tasks for client %p\n", clnt);
521 /*
522 * Spin lock all_tasks to prevent changes...
523 */
524 spin_lock(&clnt->cl_lock);
525 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
526 if (!RPC_IS_ACTIVATED(rovr))
527 continue;
528 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
529 rovr->tk_flags |= RPC_TASK_KILLED;
530 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300531 if (RPC_IS_QUEUED(rovr))
532 rpc_wake_up_queued_task(rovr->tk_waitqueue,
533 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400534 }
535 }
536 spin_unlock(&clnt->cl_lock);
537}
538EXPORT_SYMBOL_GPL(rpc_killall_tasks);
539
540/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400542 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400544void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400546 dprintk("RPC: shutting down %s client for %s\n",
547 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Trond Myklebust34f52e32007-06-14 16:40:31 -0400549 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800551 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400552 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 }
554
Trond Myklebust4c402b42007-06-14 16:40:32 -0400555 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400557EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400560 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400562static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400563rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
Chuck Lever46121cf2007-01-31 12:14:08 -0500565 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 clnt->cl_protname, clnt->cl_server);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500567 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400568 rpc_release_client(clnt->cl_parent);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500569 kfree(clnt->cl_server);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400570 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400571 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500572 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500573 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500574 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400575 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400576 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578}
579
580/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400581 * Free an RPC client
582 */
583static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400584rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400585{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400586 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400587 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400588 return;
589 }
590
591 /*
592 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
593 * release remaining GSS contexts. This mechanism ensures
594 * that it can do so safely.
595 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400596 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400597 rpcauth_release(clnt->cl_auth);
598 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400599 if (atomic_dec_and_test(&clnt->cl_count))
600 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400601}
602
603/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400604 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 */
606void
607rpc_release_client(struct rpc_clnt *clnt)
608{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400609 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Trond Myklebust34f52e32007-06-14 16:40:31 -0400611 if (list_empty(&clnt->cl_tasks))
612 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400613 if (atomic_dec_and_test(&clnt->cl_count))
614 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400615}
616
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000617/**
618 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800619 * @old: old rpc_client
620 * @program: rpc program to set
621 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000622 *
623 * Clones the rpc client and sets up a new RPC program. This is mainly
624 * of use for enabling different RPC programs to share the same transport.
625 * The Sun NFSv2/v3 ACL protocol can do this.
626 */
627struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
628 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400629 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000630{
631 struct rpc_clnt *clnt;
632 struct rpc_version *version;
633 int err;
634
635 BUG_ON(vers >= program->nrvers || !program->version[vers]);
636 version = program->version[vers];
637 clnt = rpc_clone_client(old);
638 if (IS_ERR(clnt))
639 goto out;
640 clnt->cl_procinfo = version->procs;
641 clnt->cl_maxproc = version->nrprocs;
642 clnt->cl_protname = program->name;
643 clnt->cl_prog = program->number;
644 clnt->cl_vers = version->number;
645 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500646 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000647 if (err != 0) {
648 rpc_shutdown_client(clnt);
649 clnt = ERR_PTR(err);
650 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800651out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000652 return clnt;
653}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400654EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000655
Trond Myklebust58f96122010-07-31 14:29:08 -0400656void rpc_task_release_client(struct rpc_task *task)
657{
658 struct rpc_clnt *clnt = task->tk_client;
659
660 if (clnt != NULL) {
661 /* Remove from client task list */
662 spin_lock(&clnt->cl_lock);
663 list_del(&task->tk_task);
664 spin_unlock(&clnt->cl_lock);
665 task->tk_client = NULL;
666
667 rpc_release_client(clnt);
668 }
669}
670
671static
672void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
673{
674 if (clnt != NULL) {
675 rpc_task_release_client(task);
676 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400677 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400678 if (clnt->cl_softrtry)
679 task->tk_flags |= RPC_TASK_SOFT;
680 /* Add to the client's list of all tasks */
681 spin_lock(&clnt->cl_lock);
682 list_add_tail(&task->tk_task, &clnt->cl_tasks);
683 spin_unlock(&clnt->cl_lock);
684 }
685}
686
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000687void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
688{
689 rpc_task_release_client(task);
690 rpc_task_set_client(task, clnt);
691}
692EXPORT_SYMBOL_GPL(rpc_task_reset_client);
693
694
Trond Myklebust58f96122010-07-31 14:29:08 -0400695static void
696rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
697{
698 if (msg != NULL) {
699 task->tk_msg.rpc_proc = msg->rpc_proc;
700 task->tk_msg.rpc_argp = msg->rpc_argp;
701 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400702 if (msg->rpc_cred != NULL)
703 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400704 }
705}
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707/*
708 * Default callback for async RPC calls
709 */
710static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100711rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
713}
714
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100715static const struct rpc_call_ops rpc_default_ops = {
716 .rpc_call_done = rpc_default_callback,
717};
718
Trond Myklebustc970aa82007-07-14 15:39:59 -0400719/**
720 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
721 * @task_setup_data: pointer to task initialisation data
722 */
723struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400724{
Trond Myklebust19445b92010-04-16 16:41:10 -0400725 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400726
Trond Myklebust84115e12007-07-14 15:39:59 -0400727 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400728 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400729 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400730
Trond Myklebust58f96122010-07-31 14:29:08 -0400731 rpc_task_set_client(task, task_setup_data->rpc_client);
732 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
733
Trond Myklebust58f96122010-07-31 14:29:08 -0400734 if (task->tk_action == NULL)
735 rpc_call_start(task);
736
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400737 atomic_inc(&task->tk_count);
738 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400739out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400740 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400741}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400742EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400743
744/**
745 * rpc_call_sync - Perform a synchronous RPC call
746 * @clnt: pointer to RPC client
747 * @msg: RPC call parameters
748 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500750int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751{
752 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400753 struct rpc_task_setup task_setup_data = {
754 .rpc_client = clnt,
755 .rpc_message = msg,
756 .callback_ops = &rpc_default_ops,
757 .flags = flags,
758 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400759 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 BUG_ON(flags & RPC_TASK_ASYNC);
762
Trond Myklebustc970aa82007-07-14 15:39:59 -0400763 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400764 if (IS_ERR(task))
765 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100766 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800767 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 return status;
769}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400770EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400772/**
773 * rpc_call_async - Perform an asynchronous RPC call
774 * @clnt: pointer to RPC client
775 * @msg: RPC call parameters
776 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800777 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400778 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 */
780int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500781rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100782 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783{
784 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400785 struct rpc_task_setup task_setup_data = {
786 .rpc_client = clnt,
787 .rpc_message = msg,
788 .callback_ops = tk_ops,
789 .callback_data = data,
790 .flags = flags|RPC_TASK_ASYNC,
791 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Trond Myklebustc970aa82007-07-14 15:39:59 -0400793 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400794 if (IS_ERR(task))
795 return PTR_ERR(task);
796 rpc_put_task(task);
797 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400799EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400801#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400802/**
803 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
804 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400805 * @req: RPC request
806 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400807 */
808struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400809 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400810{
811 struct rpc_task *task;
812 struct xdr_buf *xbufp = &req->rq_snd_buf;
813 struct rpc_task_setup task_setup_data = {
814 .callback_ops = tk_ops,
815 };
816
817 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
818 /*
819 * Create an rpc_task to send the data
820 */
821 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400822 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400823 xprt_free_bc_request(req);
824 goto out;
825 }
826 task->tk_rqstp = req;
827
828 /*
829 * Set up the xdr_buf length.
830 * This also indicates that the buffer is XDR encoded already.
831 */
832 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
833 xbufp->tail[0].iov_len;
834
835 task->tk_action = call_bc_transmit;
836 atomic_inc(&task->tk_count);
837 BUG_ON(atomic_read(&task->tk_count) != 2);
838 rpc_execute(task);
839
840out:
841 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
842 return task;
843}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400844#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400845
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400847rpc_call_start(struct rpc_task *task)
848{
849 task->tk_action = call_start;
850}
851EXPORT_SYMBOL_GPL(rpc_call_start);
852
Chuck Levered394402006-08-22 20:06:17 -0400853/**
854 * rpc_peeraddr - extract remote peer address from clnt's xprt
855 * @clnt: RPC client structure
856 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800857 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400858 *
859 * Returns the number of bytes that are actually in the stored address.
860 */
861size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
862{
863 size_t bytes;
864 struct rpc_xprt *xprt = clnt->cl_xprt;
865
866 bytes = sizeof(xprt->addr);
867 if (bytes > bufsize)
868 bytes = bufsize;
869 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400870 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400871}
Chuck Leverb86acd52006-08-22 20:06:22 -0400872EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400873
Chuck Leverf425eba2006-08-22 20:06:18 -0400874/**
875 * rpc_peeraddr2str - return remote peer address in printable format
876 * @clnt: RPC client structure
877 * @format: address format
878 *
879 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500880const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
881 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400882{
883 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500884
885 if (xprt->address_strings[format] != NULL)
886 return xprt->address_strings[format];
887 else
888 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400889}
Chuck Leverb86acd52006-08-22 20:06:22 -0400890EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400891
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892void
893rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
894{
895 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700896 if (xprt->ops->set_buffer_size)
897 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400899EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
901/*
902 * Return size of largest payload RPC client can support, in bytes
903 *
904 * For stream transports, this is one RPC record fragment (see RFC
905 * 1831), as we don't support multi-record requests yet. For datagram
906 * transports, this is the size of an IP packet minus the IP, UDP, and
907 * RPC header sizes.
908 */
909size_t rpc_max_payload(struct rpc_clnt *clnt)
910{
911 return clnt->cl_xprt->max_payload;
912}
Chuck Leverb86acd52006-08-22 20:06:22 -0400913EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914
Chuck Lever35f5a422006-01-03 09:55:50 +0100915/**
916 * rpc_force_rebind - force transport to check that remote port is unchanged
917 * @clnt: client to rebind
918 *
919 */
920void rpc_force_rebind(struct rpc_clnt *clnt)
921{
922 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400923 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100924}
Chuck Leverb86acd52006-08-22 20:06:22 -0400925EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100926
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400928 * Restart an (async) RPC call from the call_prepare state.
929 * Usually called from within the exit handler.
930 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400931int
Andy Adamsonaae20062009-04-01 09:22:40 -0400932rpc_restart_call_prepare(struct rpc_task *task)
933{
934 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400935 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700936 task->tk_action = call_start;
937 if (task->tk_ops->rpc_call_prepare != NULL)
938 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400939 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400940}
941EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
942
943/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 * Restart an (async) RPC call. Usually called from within the
945 * exit handler.
946 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400947int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948rpc_restart_call(struct rpc_task *task)
949{
950 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400951 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400953 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400955EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
Chuck Lever3748f1e2008-05-21 17:09:12 -0400957#ifdef RPC_DEBUG
958static const char *rpc_proc_name(const struct rpc_task *task)
959{
960 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
961
962 if (proc) {
963 if (proc->p_name)
964 return proc->p_name;
965 else
966 return "NULL";
967 } else
968 return "no proc";
969}
970#endif
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972/*
973 * 0. Initial state
974 *
975 * Other FSM states can be visited zero or more times, but
976 * this state is visited exactly once for each RPC.
977 */
978static void
979call_start(struct rpc_task *task)
980{
981 struct rpc_clnt *clnt = task->tk_client;
982
Chuck Lever3748f1e2008-05-21 17:09:12 -0400983 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500984 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400985 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500986 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
988 /* Increment call count */
989 task->tk_msg.rpc_proc->p_count++;
990 clnt->cl_stats->rpccnt++;
991 task->tk_action = call_reserve;
992}
993
994/*
995 * 1. Reserve an RPC call slot
996 */
997static void
998call_reserve(struct rpc_task *task)
999{
Chuck Lever46121cf2007-01-31 12:14:08 -05001000 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 task->tk_status = 0;
1003 task->tk_action = call_reserveresult;
1004 xprt_reserve(task);
1005}
1006
1007/*
1008 * 1b. Grok the result of xprt_reserve()
1009 */
1010static void
1011call_reserveresult(struct rpc_task *task)
1012{
1013 int status = task->tk_status;
1014
Chuck Lever46121cf2007-01-31 12:14:08 -05001015 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017 /*
1018 * After a call to xprt_reserve(), we must have either
1019 * a request slot or else an error status.
1020 */
1021 task->tk_status = 0;
1022 if (status >= 0) {
1023 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001024 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 return;
1026 }
1027
1028 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001029 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 rpc_exit(task, -EIO);
1031 return;
1032 }
1033
1034 /*
1035 * Even though there was an error, we may have acquired
1036 * a request slot somehow. Make sure not to leak it.
1037 */
1038 if (task->tk_rqstp) {
1039 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001040 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 xprt_release(task);
1042 }
1043
1044 switch (status) {
1045 case -EAGAIN: /* woken up; retry */
1046 task->tk_action = call_reserve;
1047 return;
1048 case -EIO: /* probably a shutdown */
1049 break;
1050 default:
1051 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001052 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 break;
1054 }
1055 rpc_exit(task, status);
1056}
1057
1058/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001059 * 2. Bind and/or refresh the credentials
1060 */
1061static void
1062call_refresh(struct rpc_task *task)
1063{
1064 dprint_status(task);
1065
1066 task->tk_action = call_refreshresult;
1067 task->tk_status = 0;
1068 task->tk_client->cl_stats->rpcauthrefresh++;
1069 rpcauth_refreshcred(task);
1070}
1071
1072/*
1073 * 2a. Process the results of a credential refresh
1074 */
1075static void
1076call_refreshresult(struct rpc_task *task)
1077{
1078 int status = task->tk_status;
1079
1080 dprint_status(task);
1081
1082 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001083 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001084 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001085 case 0:
1086 if (rpcauth_uptodatecred(task))
1087 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001088 return;
1089 case -ETIMEDOUT:
1090 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001091 case -EAGAIN:
1092 status = -EACCES;
1093 if (!task->tk_cred_retry)
1094 break;
1095 task->tk_cred_retry--;
1096 dprintk("RPC: %5u %s: retry refresh creds\n",
1097 task->tk_pid, __func__);
1098 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001099 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001100 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1101 task->tk_pid, __func__, status);
1102 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001103}
1104
1105/*
1106 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001107 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 */
1109static void
1110call_allocate(struct rpc_task *task)
1111{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001112 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001113 struct rpc_rqst *req = task->tk_rqstp;
1114 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001115 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Chuck Lever46121cf2007-01-31 12:14:08 -05001117 dprint_status(task);
1118
Chuck Lever2bea90d2007-03-29 16:47:53 -04001119 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001120 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001121
Chuck Lever02107142006-01-03 09:55:49 +01001122 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 return;
1124
Chuck Lever2bea90d2007-03-29 16:47:53 -04001125 if (proc->p_proc != 0) {
1126 BUG_ON(proc->p_arglen == 0);
1127 if (proc->p_decode != NULL)
1128 BUG_ON(proc->p_replen == 0);
1129 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
Chuck Lever2bea90d2007-03-29 16:47:53 -04001131 /*
1132 * Calculate the size (in quads) of the RPC call
1133 * and reply headers, and convert both values
1134 * to byte sizes.
1135 */
1136 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1137 req->rq_callsize <<= 2;
1138 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1139 req->rq_rcvsize <<= 2;
1140
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001141 req->rq_buffer = xprt->ops->buf_alloc(task,
1142 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001143 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001145
1146 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
Trond Myklebust5afa91332011-06-17 10:14:59 -04001148 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001149 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 rpc_delay(task, HZ>>4);
1151 return;
1152 }
1153
1154 rpc_exit(task, -ERESTARTSYS);
1155}
1156
Trond Myklebust940e3312005-11-09 21:45:24 -05001157static inline int
1158rpc_task_need_encode(struct rpc_task *task)
1159{
1160 return task->tk_rqstp->rq_snd_buf.len == 0;
1161}
1162
1163static inline void
1164rpc_task_force_reencode(struct rpc_task *task)
1165{
1166 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001167 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001168}
1169
Chuck Lever2bea90d2007-03-29 16:47:53 -04001170static inline void
1171rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1172{
1173 buf->head[0].iov_base = start;
1174 buf->head[0].iov_len = len;
1175 buf->tail[0].iov_len = 0;
1176 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001177 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001178 buf->len = 0;
1179 buf->buflen = len;
1180}
1181
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182/*
1183 * 3. Encode arguments of an RPC call
1184 */
1185static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001186rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001189 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001190 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
Chuck Lever46121cf2007-01-31 12:14:08 -05001192 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
Chuck Lever2bea90d2007-03-29 16:47:53 -04001194 rpc_xdr_buf_init(&req->rq_snd_buf,
1195 req->rq_buffer,
1196 req->rq_callsize);
1197 rpc_xdr_buf_init(&req->rq_rcv_buf,
1198 (char *)req->rq_buffer + req->rq_callsize,
1199 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
Chuck Leverb0e1c572008-05-21 17:09:19 -04001201 p = rpc_encode_header(task);
1202 if (p == NULL) {
1203 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 rpc_exit(task, -EIO);
1205 return;
1206 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001207
1208 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001209 if (encode == NULL)
1210 return;
1211
1212 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1213 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214}
1215
1216/*
1217 * 4. Get the server port number if not yet set
1218 */
1219static void
1220call_bind(struct rpc_task *task)
1221{
Chuck Leverec739ef2006-08-22 20:06:15 -04001222 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
Chuck Lever46121cf2007-01-31 12:14:08 -05001224 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
Chuck Leverda351872005-08-11 16:25:11 -04001226 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001227 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001228 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001229 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001230 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 }
1232}
1233
1234/*
Chuck Leverda351872005-08-11 16:25:11 -04001235 * 4a. Sort out bind result
1236 */
1237static void
1238call_bind_status(struct rpc_task *task)
1239{
Chuck Lever906462a2007-09-11 18:00:47 -04001240 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001241
1242 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001243 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001244 task->tk_status = 0;
1245 task->tk_action = call_connect;
1246 return;
1247 }
1248
1249 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001250 case -ENOMEM:
1251 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1252 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001253 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001254 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001255 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1256 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001257 /* fail immediately if this is an RPC ping */
1258 if (task->tk_msg.rpc_proc->p_proc == 0) {
1259 status = -EOPNOTSUPP;
1260 break;
1261 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001262 if (task->tk_rebind_retry == 0)
1263 break;
1264 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001265 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001266 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001267 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001268 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001269 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001270 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001271 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001272 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001273 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001274 task->tk_pid);
1275 break;
1276 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001277 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001278 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001279 task->tk_status = 0;
1280 task->tk_action = call_bind;
1281 return;
Chuck Lever012da152009-12-03 15:58:56 -05001282 case -ECONNREFUSED: /* connection problems */
1283 case -ECONNRESET:
1284 case -ENOTCONN:
1285 case -EHOSTDOWN:
1286 case -EHOSTUNREACH:
1287 case -ENETUNREACH:
1288 case -EPIPE:
1289 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1290 task->tk_pid, task->tk_status);
1291 if (!RPC_IS_SOFTCONN(task)) {
1292 rpc_delay(task, 5*HZ);
1293 goto retry_timeout;
1294 }
1295 status = task->tk_status;
1296 break;
Chuck Leverda351872005-08-11 16:25:11 -04001297 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001298 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001299 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001300 }
1301
1302 rpc_exit(task, status);
1303 return;
1304
Trond Myklebustda458282006-08-31 15:44:52 -04001305retry_timeout:
1306 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001307}
1308
1309/*
1310 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 */
1312static void
1313call_connect(struct rpc_task *task)
1314{
Chuck Leverda351872005-08-11 16:25:11 -04001315 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
Chuck Lever46121cf2007-01-31 12:14:08 -05001317 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001318 task->tk_pid, xprt,
1319 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Chuck Leverda351872005-08-11 16:25:11 -04001321 task->tk_action = call_transmit;
1322 if (!xprt_connected(xprt)) {
1323 task->tk_action = call_connect_status;
1324 if (task->tk_status < 0)
1325 return;
1326 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328}
1329
1330/*
Chuck Leverda351872005-08-11 16:25:11 -04001331 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 */
1333static void
1334call_connect_status(struct rpc_task *task)
1335{
1336 struct rpc_clnt *clnt = task->tk_client;
1337 int status = task->tk_status;
1338
Chuck Lever46121cf2007-01-31 12:14:08 -05001339 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001340
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001342 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 clnt->cl_stats->netreconn++;
1344 task->tk_action = call_transmit;
1345 return;
1346 }
1347
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001349 /* if soft mounted, test if we've timed out */
1350 case -ETIMEDOUT:
1351 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001352 break;
1353 default:
1354 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 }
1356}
1357
1358/*
1359 * 5. Transmit the RPC request, and wait for reply
1360 */
1361static void
1362call_transmit(struct rpc_task *task)
1363{
Chuck Lever46121cf2007-01-31 12:14:08 -05001364 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
1366 task->tk_action = call_status;
1367 if (task->tk_status < 0)
1368 return;
1369 task->tk_status = xprt_prepare_transmit(task);
1370 if (task->tk_status != 0)
1371 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001372 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001374 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001375 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001376 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001377 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001378 if (task->tk_status != 0) {
1379 /* Was the error nonfatal? */
1380 if (task->tk_status == -EAGAIN)
1381 rpc_delay(task, HZ >> 4);
1382 else
1383 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001384 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001385 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001386 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 xprt_transmit(task);
1388 if (task->tk_status < 0)
1389 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001390 /*
1391 * On success, ensure that we call xprt_end_transmit() before sleeping
1392 * in order to allow access to the socket to other RPC requests.
1393 */
1394 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001395 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001396 return;
1397 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001398 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001399}
1400
1401/*
1402 * 5a. Handle cleanup after a transmission
1403 */
1404static void
1405call_transmit_status(struct rpc_task *task)
1406{
1407 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001408
1409 /*
1410 * Common case: success. Force the compiler to put this
1411 * test first.
1412 */
1413 if (task->tk_status == 0) {
1414 xprt_end_transmit(task);
1415 rpc_task_force_reencode(task);
1416 return;
1417 }
1418
Trond Myklebust15f081c2009-03-11 14:37:57 -04001419 switch (task->tk_status) {
1420 case -EAGAIN:
1421 break;
1422 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001423 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001424 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001425 rpc_task_force_reencode(task);
1426 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001427 /*
1428 * Special cases: if we've been waiting on the
1429 * socket's write_space() callback, or if the
1430 * socket just returned a connection error,
1431 * then hold onto the transport lock.
1432 */
1433 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001434 case -EHOSTDOWN:
1435 case -EHOSTUNREACH:
1436 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001437 if (RPC_IS_SOFTCONN(task)) {
1438 xprt_end_transmit(task);
1439 rpc_exit(task, task->tk_status);
1440 break;
1441 }
1442 case -ECONNRESET:
1443 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001444 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001445 rpc_task_force_reencode(task);
1446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447}
1448
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001449#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001450/*
1451 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1452 * addition, disconnect on connectivity errors.
1453 */
1454static void
1455call_bc_transmit(struct rpc_task *task)
1456{
1457 struct rpc_rqst *req = task->tk_rqstp;
1458
1459 BUG_ON(task->tk_status != 0);
1460 task->tk_status = xprt_prepare_transmit(task);
1461 if (task->tk_status == -EAGAIN) {
1462 /*
1463 * Could not reserve the transport. Try again after the
1464 * transport is released.
1465 */
1466 task->tk_status = 0;
1467 task->tk_action = call_bc_transmit;
1468 return;
1469 }
1470
1471 task->tk_action = rpc_exit_task;
1472 if (task->tk_status < 0) {
1473 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1474 "error: %d\n", task->tk_status);
1475 return;
1476 }
1477
1478 xprt_transmit(task);
1479 xprt_end_transmit(task);
1480 dprint_status(task);
1481 switch (task->tk_status) {
1482 case 0:
1483 /* Success */
1484 break;
1485 case -EHOSTDOWN:
1486 case -EHOSTUNREACH:
1487 case -ENETUNREACH:
1488 case -ETIMEDOUT:
1489 /*
1490 * Problem reaching the server. Disconnect and let the
1491 * forechannel reestablish the connection. The server will
1492 * have to retransmit the backchannel request and we'll
1493 * reprocess it. Since these ops are idempotent, there's no
1494 * need to cache our reply at this time.
1495 */
1496 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1497 "error: %d\n", task->tk_status);
1498 xprt_conditional_disconnect(task->tk_xprt,
1499 req->rq_connect_cookie);
1500 break;
1501 default:
1502 /*
1503 * We were unable to reply and will have to drop the
1504 * request. The server should reconnect and retransmit.
1505 */
1506 BUG_ON(task->tk_status == -EAGAIN);
1507 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1508 "error: %d\n", task->tk_status);
1509 break;
1510 }
1511 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1512}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001513#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001514
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515/*
1516 * 6. Sort out the RPC call status
1517 */
1518static void
1519call_status(struct rpc_task *task)
1520{
1521 struct rpc_clnt *clnt = task->tk_client;
1522 struct rpc_rqst *req = task->tk_rqstp;
1523 int status;
1524
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001525 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1526 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Chuck Lever46121cf2007-01-31 12:14:08 -05001528 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
1530 status = task->tk_status;
1531 if (status >= 0) {
1532 task->tk_action = call_decode;
1533 return;
1534 }
1535
1536 task->tk_status = 0;
1537 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001538 case -EHOSTDOWN:
1539 case -EHOSTUNREACH:
1540 case -ENETUNREACH:
1541 /*
1542 * Delay any retries for 3 seconds, then handle as if it
1543 * were a timeout.
1544 */
1545 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 case -ETIMEDOUT:
1547 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001548 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001549 xprt_conditional_disconnect(task->tk_xprt,
1550 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001552 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001554 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001555 rpc_delay(task, 3*HZ);
1556 case -EPIPE:
1557 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 task->tk_action = call_bind;
1559 break;
1560 case -EAGAIN:
1561 task->tk_action = call_transmit;
1562 break;
1563 case -EIO:
1564 /* shutdown or soft timeout */
1565 rpc_exit(task, status);
1566 break;
1567 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001568 if (clnt->cl_chatty)
1569 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 clnt->cl_protname, -status);
1571 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 }
1573}
1574
1575/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001576 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 * We do not release the request slot, so we keep using the
1578 * same XID for all retransmits.
1579 */
1580static void
1581call_timeout(struct rpc_task *task)
1582{
1583 struct rpc_clnt *clnt = task->tk_client;
1584
1585 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001586 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 goto retry;
1588 }
1589
Chuck Lever46121cf2007-01-31 12:14:08 -05001590 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001591 task->tk_timeouts++;
1592
Chuck Lever3a28bec2009-12-03 15:58:56 -05001593 if (RPC_IS_SOFTCONN(task)) {
1594 rpc_exit(task, -ETIMEDOUT);
1595 return;
1596 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001598 if (clnt->cl_chatty)
1599 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001601 if (task->tk_flags & RPC_TASK_TIMEOUT)
1602 rpc_exit(task, -ETIMEDOUT);
1603 else
1604 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 return;
1606 }
1607
Chuck Leverf518e35a2006-01-03 09:55:52 +01001608 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001610 if (clnt->cl_chatty)
1611 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 clnt->cl_protname, clnt->cl_server);
1613 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001614 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001615 /*
1616 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1617 * event? RFC2203 requires the server to drop all such requests.
1618 */
1619 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
1621retry:
1622 clnt->cl_stats->rpcretrans++;
1623 task->tk_action = call_bind;
1624 task->tk_status = 0;
1625}
1626
1627/*
1628 * 7. Decode the RPC reply
1629 */
1630static void
1631call_decode(struct rpc_task *task)
1632{
1633 struct rpc_clnt *clnt = task->tk_client;
1634 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001635 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001636 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Vasily Averin726fd6a2011-06-01 16:23:59 +04001638 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639
Chuck Leverf518e35a2006-01-03 09:55:52 +01001640 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001641 if (clnt->cl_chatty)
1642 printk(KERN_NOTICE "%s: server %s OK\n",
1643 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1645 }
1646
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001647 /*
1648 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001649 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001650 */
1651 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 req->rq_rcv_buf.len = req->rq_private_buf.len;
1653
1654 /* Check that the softirq receive buffer is valid */
1655 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1656 sizeof(req->rq_rcv_buf)) != 0);
1657
Trond Myklebust1e799b62008-03-21 16:19:41 -04001658 if (req->rq_rcv_buf.len < 12) {
1659 if (!RPC_IS_SOFT(task)) {
1660 task->tk_action = call_bind;
1661 clnt->cl_stats->rpcretrans++;
1662 goto out_retry;
1663 }
1664 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1665 clnt->cl_protname, task->tk_status);
1666 task->tk_action = call_timeout;
1667 goto out_retry;
1668 }
1669
Chuck Leverb0e1c572008-05-21 17:09:19 -04001670 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001671 if (IS_ERR(p)) {
1672 if (p == ERR_PTR(-EAGAIN))
1673 goto out_retry;
1674 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 }
1676
Trond Myklebustabbcf282006-01-03 09:55:03 +01001677 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001679 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1681 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001682 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001683 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1684 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 return;
1686out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001688 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001689 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001690 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001691 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001692 xprt_conditional_disconnect(task->tk_xprt,
1693 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001694 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695}
1696
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001697static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001698rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699{
1700 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001702 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
1704 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001705
1706 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 *p++ = req->rq_xid; /* XID */
1708 *p++ = htonl(RPC_CALL); /* CALL */
1709 *p++ = htonl(RPC_VERSION); /* RPC version */
1710 *p++ = htonl(clnt->cl_prog); /* program number */
1711 *p++ = htonl(clnt->cl_vers); /* program version */
1712 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001713 p = rpcauth_marshcred(task, p);
1714 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1715 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716}
1717
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001718static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001719rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720{
1721 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1722 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001723 __be32 *p = iov->iov_base;
1724 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 int error = -EACCES;
1726
David Howellse8896492006-08-24 15:44:19 -04001727 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1728 /* RFC-1014 says that the representation of XDR data must be a
1729 * multiple of four bytes
1730 * - if it isn't pointer subtraction in the NFS client may give
1731 * undefined results
1732 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001733 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001734 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001735 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001736 goto out_eio;
1737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 if ((len -= 3) < 0)
1739 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001741 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001743 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001744 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001745 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001747
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1749 if (--len < 0)
1750 goto out_overflow;
1751 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001752 case RPC_AUTH_ERROR:
1753 break;
1754 case RPC_MISMATCH:
1755 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1756 task->tk_pid, __func__);
1757 error = -EPROTONOSUPPORT;
1758 goto out_err;
1759 default:
1760 dprintk("RPC: %5u %s: RPC call rejected, "
1761 "unknown error: %x\n",
1762 task->tk_pid, __func__, n);
1763 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 }
1765 if (--len < 0)
1766 goto out_overflow;
1767 switch ((n = ntohl(*p++))) {
1768 case RPC_AUTH_REJECTEDCRED:
1769 case RPC_AUTH_REJECTEDVERF:
1770 case RPCSEC_GSS_CREDPROBLEM:
1771 case RPCSEC_GSS_CTXPROBLEM:
1772 if (!task->tk_cred_retry)
1773 break;
1774 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001775 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001776 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001778 /* Ensure we obtain a new XID! */
1779 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001780 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001781 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 case RPC_AUTH_BADCRED:
1783 case RPC_AUTH_BADVERF:
1784 /* possibly garbled cred/verf? */
1785 if (!task->tk_garb_retry)
1786 break;
1787 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001788 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001789 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001791 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001793 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001794 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 break;
1796 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001797 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001798 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 error = -EIO;
1800 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001801 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001802 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 goto out_err;
1804 }
1805 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001806 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001807 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001808 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001810 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 if (len < 0)
1812 goto out_overflow;
1813 switch ((n = ntohl(*p++))) {
1814 case RPC_SUCCESS:
1815 return p;
1816 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001817 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001818 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 (unsigned int)task->tk_client->cl_prog,
1820 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001821 error = -EPFNOSUPPORT;
1822 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001824 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001825 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 (unsigned int)task->tk_client->cl_prog,
1827 (unsigned int)task->tk_client->cl_vers,
1828 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001829 error = -EPROTONOSUPPORT;
1830 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001832 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001833 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001834 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001835 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 task->tk_client->cl_prog,
1837 task->tk_client->cl_vers,
1838 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001839 error = -EOPNOTSUPP;
1840 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001842 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001843 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 break; /* retry */
1845 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001846 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001847 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 /* Also retry */
1849 }
1850
Trond Myklebustabbcf282006-01-03 09:55:03 +01001851out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 task->tk_client->cl_stats->rpcgarbage++;
1853 if (task->tk_garb_retry) {
1854 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001855 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001856 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001858out_retry:
1859 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861out_eio:
1862 error = -EIO;
1863out_err:
1864 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001865 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001866 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001867 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001869 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001870 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001871 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001873
Chuck Lever9f06c712010-12-14 14:59:18 +00001874static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001875{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001876}
1877
Chuck Leverbf269552010-12-14 14:59:29 +00001878static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001879{
1880 return 0;
1881}
1882
1883static struct rpc_procinfo rpcproc_null = {
1884 .p_encode = rpcproc_encode_null,
1885 .p_decode = rpcproc_decode_null,
1886};
1887
Chuck Levercaabea82009-12-03 15:58:56 -05001888static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001889{
1890 struct rpc_message msg = {
1891 .rpc_proc = &rpcproc_null,
1892 };
1893 int err;
1894 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001895 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001896 put_rpccred(msg.rpc_cred);
1897 return err;
1898}
Trond Myklebust188fef12007-06-16 14:18:40 -04001899
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001900struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1901{
1902 struct rpc_message msg = {
1903 .rpc_proc = &rpcproc_null,
1904 .rpc_cred = cred,
1905 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001906 struct rpc_task_setup task_setup_data = {
1907 .rpc_client = clnt,
1908 .rpc_message = &msg,
1909 .callback_ops = &rpc_default_ops,
1910 .flags = flags,
1911 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001912 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001913}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001914EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001915
Trond Myklebust188fef12007-06-16 14:18:40 -04001916#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001917static void rpc_show_header(void)
1918{
Chuck Levercb3997b2008-05-21 17:09:41 -04001919 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1920 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001921}
1922
Chuck Lever38e886e2008-05-21 17:09:33 -04001923static void rpc_show_task(const struct rpc_clnt *clnt,
1924 const struct rpc_task *task)
1925{
1926 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001927
1928 if (RPC_IS_QUEUED(task))
1929 rpc_waitq = rpc_qname(task->tk_waitqueue);
1930
Joe Perchesb3bceda2010-12-21 10:52:24 -05001931 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 -04001932 task->tk_pid, task->tk_flags, task->tk_status,
1933 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1934 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001935 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001936}
1937
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001938void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04001939{
1940 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001941 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001942 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001943 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04001944
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001945 spin_lock(&sn->rpc_client_lock);
1946 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001947 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001948 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001949 if (!header) {
1950 rpc_show_header();
1951 header++;
1952 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001953 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001954 }
1955 spin_unlock(&clnt->cl_lock);
1956 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001957 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001958}
1959#endif