blob: 41707450059273c55129312c0e18e20c42586a5a [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 Kinsbursky80df9d22012-01-11 19:18:17 +0400101 if (clnt->cl_path.dentry) {
102 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
103 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400104 rpc_remove_client_dir(clnt->cl_path.dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400105 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106 clnt->cl_path.dentry = NULL;
107}
108
109static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
110{
111 struct super_block *pipefs_sb;
112 int put_mnt = 0;
113
114 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
115 if (pipefs_sb) {
116 if (clnt->cl_path.dentry)
117 put_mnt = 1;
118 __rpc_clnt_remove_pipedir(clnt);
119 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
120 }
121 if (put_mnt)
122 rpc_put_mount();
123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
126 struct rpc_clnt *clnt, char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
Trond Myklebustf1345852005-09-23 11:08:25 -0400128 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400129 char name[15];
130 struct qstr q = {
131 .name = name,
132 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 int error;
135
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400136 dir = rpc_d_lookup_sb(sb, dir_name);
137 if (dir == NULL)
138 return dir;
139 for (;;) {
140 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
141 name[sizeof(name) - 1] = '\0';
142 q.hash = full_name_hash(q.name, q.len);
143 dentry = rpc_create_client_dir(dir, &q, clnt);
144 if (!IS_ERR(dentry))
145 break;
146 error = PTR_ERR(dentry);
147 if (error != -EEXIST) {
148 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
149 " %s/%s, error %d\n",
150 dir_name, name, error);
151 break;
152 }
153 }
154 dput(dir);
155 return dentry;
156}
157
158static int
159rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
160{
161 struct super_block *pipefs_sb;
162 struct path path;
163
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400164 clnt->cl_path.mnt = ERR_PTR(-ENOENT);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400165 clnt->cl_path.dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 if (dir_name == NULL)
167 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500168
Trond Myklebust23ac6582009-08-09 15:14:25 -0400169 path.mnt = rpc_get_mount();
170 if (IS_ERR(path.mnt))
171 return PTR_ERR(path.mnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400172 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
173 if (!pipefs_sb) {
174 rpc_put_mount();
175 return -ENOENT;
Christoph Hellwig278c9952005-07-24 23:53:01 +0100176 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400177 path.dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
178 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
179 if (IS_ERR(path.dentry)) {
180 rpc_put_mount();
181 return PTR_ERR(path.dentry);
182 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400183 clnt->cl_path = path;
184 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185}
186
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400187static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
188 struct super_block *sb)
189{
190 struct dentry *dentry;
191 int err = 0;
192
193 switch (event) {
194 case RPC_PIPEFS_MOUNT:
195 if (clnt->cl_program->pipe_dir_name == NULL)
196 break;
197 dentry = rpc_setup_pipedir_sb(sb, clnt,
198 clnt->cl_program->pipe_dir_name);
199 BUG_ON(dentry == NULL);
200 if (IS_ERR(dentry))
201 return PTR_ERR(dentry);
202 clnt->cl_path.dentry = dentry;
203 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
219static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
220 void *ptr)
221{
222 struct super_block *sb = ptr;
223 struct rpc_clnt *clnt;
224 int error = 0;
225 struct sunrpc_net *sn = net_generic(sb->s_fs_info, sunrpc_net_id);
226
227 spin_lock(&sn->rpc_client_lock);
228 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
229 error = __rpc_pipefs_event(clnt, event, sb);
230 if (error)
231 break;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return error;
235}
236
237static struct notifier_block rpc_clients_block = {
238 .notifier_call = rpc_pipefs_event,
239};
240
241int rpc_clients_notifier_register(void)
242{
243 return rpc_pipefs_notifier_register(&rpc_clients_block);
244}
245
246void rpc_clients_notifier_unregister(void)
247{
248 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
249}
250
Trond Myklebust698b6d02007-12-20 16:03:53 -0500251static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500253 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 struct rpc_version *version;
255 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000256 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400258 size_t len;
259
260 /* sanity check the name before trying to print it */
261 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500262 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400263 if (len > RPC_MAXNETNAMELEN)
264 goto out_no_rpciod;
265 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Chuck Lever46121cf2007-01-31 12:14:08 -0500267 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500268 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Trond Myklebust4ada5392007-06-14 17:26:17 -0400270 err = rpciod_up();
271 if (err)
272 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 err = -EINVAL;
274 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800275 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500276
277 if (args->version >= program->nrvers)
278 goto out_err;
279 version = program->version[args->version];
280 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 goto out_err;
282
283 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700284 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 if (!clnt)
286 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 clnt->cl_parent = clnt;
288
289 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 if (len > sizeof(clnt->cl_inline_name)) {
291 char *buf = kmalloc(len, GFP_KERNEL);
Trond Myklebust698b6d02007-12-20 16:03:53 -0500292 if (buf != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 clnt->cl_server = buf;
294 else
295 len = sizeof(clnt->cl_inline_name);
296 }
Trond Myklebust698b6d02007-12-20 16:03:53 -0500297 strlcpy(clnt->cl_server, args->servername, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299 clnt->cl_xprt = xprt;
300 clnt->cl_procinfo = version->procs;
301 clnt->cl_maxproc = version->nrprocs;
302 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300303 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500306 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500307 err = -ENOMEM;
308 if (clnt->cl_metrics == NULL)
309 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500310 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400311 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400312 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Chuck Leverec739ef2006-08-22 20:06:15 -0400314 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 clnt->cl_autobind = 1;
316
Trond Myklebustba7392b2007-12-20 16:03:55 -0500317 clnt->cl_timeout = xprt->timeout;
318 if (args->timeout != NULL) {
319 memcpy(&clnt->cl_timeout_default, args->timeout,
320 sizeof(clnt->cl_timeout_default));
321 clnt->cl_timeout = &clnt->cl_timeout_default;
322 }
323
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500325 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500326 clnt->cl_principal = NULL;
327 if (args->client_name) {
328 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
329 if (!clnt->cl_principal)
330 goto out_no_principal;
331 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
Trond Myklebust006abe82010-09-12 19:55:25 -0400333 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
336 if (err < 0)
337 goto out_no_path;
338
Trond Myklebust698b6d02007-12-20 16:03:53 -0500339 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000340 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500342 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000343 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 goto out_no_auth;
345 }
346
347 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400348 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 if (clnt->cl_nodelen > UNX_MAXNODENAME)
350 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400351 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400352 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return clnt;
354
355out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400356 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500358 kfree(clnt->cl_principal);
359out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500360 rpc_free_iostats(clnt->cl_metrics);
361out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 if (clnt->cl_server != clnt->cl_inline_name)
363 kfree(clnt->cl_server);
364 kfree(clnt);
365out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400366 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800367out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400368 rpciod_down();
369out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 return ERR_PTR(err);
371}
372
Chuck Leverc2866762006-08-22 20:06:20 -0400373/*
374 * rpc_create - create an RPC client and transport with one call
375 * @args: rpc_clnt create argument structure
376 *
377 * Creates and initializes an RPC transport and an RPC client.
378 *
379 * It can ping the server in order to determine if it is up, and to see if
380 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
381 * this behavior so asynchronous tasks can also use rpc_create.
382 */
383struct rpc_clnt *rpc_create(struct rpc_create_args *args)
384{
385 struct rpc_xprt *xprt;
386 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400387 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400388 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400389 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200390 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200391 .dstaddr = args->address,
392 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300393 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200394 };
Chuck Lever510deb02007-12-10 14:56:24 -0500395 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400396
Chuck Leverc2866762006-08-22 20:06:20 -0400397 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400398 * If the caller chooses not to specify a hostname, whip
399 * up a string representation of the passed-in address.
400 */
401 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400402 struct sockaddr_un *sun =
403 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400404 struct sockaddr_in *sin =
405 (struct sockaddr_in *)args->address;
406 struct sockaddr_in6 *sin6 =
407 (struct sockaddr_in6 *)args->address;
408
Chuck Lever510deb02007-12-10 14:56:24 -0500409 servername[0] = '\0';
410 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400411 case AF_LOCAL:
412 snprintf(servername, sizeof(servername), "%s",
413 sun->sun_path);
414 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400415 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700416 snprintf(servername, sizeof(servername), "%pI4",
417 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500418 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400419 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700420 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400421 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500422 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500423 default:
424 /* caller wants default server name, but
425 * address family isn't recognized. */
426 return ERR_PTR(-EINVAL);
427 }
Chuck Lever43780b82007-07-01 12:13:22 -0400428 args->servername = servername;
429 }
430
Chuck Lever510deb02007-12-10 14:56:24 -0500431 xprt = xprt_create_transport(&xprtargs);
432 if (IS_ERR(xprt))
433 return (struct rpc_clnt *)xprt;
434
Chuck Lever43780b82007-07-01 12:13:22 -0400435 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400436 * By default, kernel RPC client connects from a reserved port.
437 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
438 * but it is always enabled for rpciod, which handles the connect
439 * operation.
440 */
441 xprt->resvport = 1;
442 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
443 xprt->resvport = 0;
444
Trond Myklebust698b6d02007-12-20 16:03:53 -0500445 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400446 if (IS_ERR(clnt))
447 return clnt;
448
449 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500450 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400451 if (err != 0) {
452 rpc_shutdown_client(clnt);
453 return ERR_PTR(err);
454 }
455 }
456
457 clnt->cl_softrtry = 1;
458 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
459 clnt->cl_softrtry = 0;
460
Chuck Leverc2866762006-08-22 20:06:20 -0400461 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
462 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500463 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
464 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400465 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
466 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400467
468 return clnt;
469}
Chuck Leverb86acd52006-08-22 20:06:22 -0400470EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/*
473 * This function clones the RPC client structure. It allows us to share the
474 * same transport while varying parameters such as the authentication
475 * flavour.
476 */
477struct rpc_clnt *
478rpc_clone_client(struct rpc_clnt *clnt)
479{
480 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500481 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200483 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 if (!new)
485 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400486 new->cl_parent = clnt;
487 /* Turn off autobind on clones */
488 new->cl_autobind = 0;
489 INIT_LIST_HEAD(&new->cl_tasks);
490 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500491 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500492 new->cl_metrics = rpc_alloc_iostats(clnt);
493 if (new->cl_metrics == NULL)
494 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500495 if (clnt->cl_principal) {
496 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
497 if (new->cl_principal == NULL)
498 goto out_no_principal;
499 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400500 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500501 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
502 if (err != 0)
503 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 if (new->cl_auth)
505 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400506 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400507 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400508 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400509 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500511out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500512 kfree(new->cl_principal);
513out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500514 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500515out_no_stats:
516 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800518 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500519 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400521EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
523/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400524 * Kill all tasks for the given client.
525 * XXX: kill their descendants as well?
526 */
527void rpc_killall_tasks(struct rpc_clnt *clnt)
528{
529 struct rpc_task *rovr;
530
531
532 if (list_empty(&clnt->cl_tasks))
533 return;
534 dprintk("RPC: killing all tasks for client %p\n", clnt);
535 /*
536 * Spin lock all_tasks to prevent changes...
537 */
538 spin_lock(&clnt->cl_lock);
539 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
540 if (!RPC_IS_ACTIVATED(rovr))
541 continue;
542 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
543 rovr->tk_flags |= RPC_TASK_KILLED;
544 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300545 if (RPC_IS_QUEUED(rovr))
546 rpc_wake_up_queued_task(rovr->tk_waitqueue,
547 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400548 }
549 }
550 spin_unlock(&clnt->cl_lock);
551}
552EXPORT_SYMBOL_GPL(rpc_killall_tasks);
553
554/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400556 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400558void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400560 dprintk("RPC: shutting down %s client for %s\n",
561 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Trond Myklebust34f52e32007-06-14 16:40:31 -0400563 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800565 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400566 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 }
568
Trond Myklebust4c402b42007-06-14 16:40:32 -0400569 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400571EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
573/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400574 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400576static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400577rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Chuck Lever46121cf2007-01-31 12:14:08 -0500579 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 clnt->cl_protname, clnt->cl_server);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400581 rpc_clnt_remove_pipedir(clnt);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500582 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400583 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500584 goto out_free;
585 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 if (clnt->cl_server != clnt->cl_inline_name)
587 kfree(clnt->cl_server);
588out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400589 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500590 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500591 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500592 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400593 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400594 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596}
597
598/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400599 * Free an RPC client
600 */
601static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400602rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400603{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400604 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400605 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400606 return;
607 }
608
609 /*
610 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
611 * release remaining GSS contexts. This mechanism ensures
612 * that it can do so safely.
613 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400614 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400615 rpcauth_release(clnt->cl_auth);
616 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400617 if (atomic_dec_and_test(&clnt->cl_count))
618 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400619}
620
621/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400622 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 */
624void
625rpc_release_client(struct rpc_clnt *clnt)
626{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400627 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Trond Myklebust34f52e32007-06-14 16:40:31 -0400629 if (list_empty(&clnt->cl_tasks))
630 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400631 if (atomic_dec_and_test(&clnt->cl_count))
632 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400633}
634
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000635/**
636 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800637 * @old: old rpc_client
638 * @program: rpc program to set
639 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000640 *
641 * Clones the rpc client and sets up a new RPC program. This is mainly
642 * of use for enabling different RPC programs to share the same transport.
643 * The Sun NFSv2/v3 ACL protocol can do this.
644 */
645struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
646 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400647 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000648{
649 struct rpc_clnt *clnt;
650 struct rpc_version *version;
651 int err;
652
653 BUG_ON(vers >= program->nrvers || !program->version[vers]);
654 version = program->version[vers];
655 clnt = rpc_clone_client(old);
656 if (IS_ERR(clnt))
657 goto out;
658 clnt->cl_procinfo = version->procs;
659 clnt->cl_maxproc = version->nrprocs;
660 clnt->cl_protname = program->name;
661 clnt->cl_prog = program->number;
662 clnt->cl_vers = version->number;
663 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500664 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000665 if (err != 0) {
666 rpc_shutdown_client(clnt);
667 clnt = ERR_PTR(err);
668 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800669out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000670 return clnt;
671}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400672EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000673
Trond Myklebust58f96122010-07-31 14:29:08 -0400674void rpc_task_release_client(struct rpc_task *task)
675{
676 struct rpc_clnt *clnt = task->tk_client;
677
678 if (clnt != NULL) {
679 /* Remove from client task list */
680 spin_lock(&clnt->cl_lock);
681 list_del(&task->tk_task);
682 spin_unlock(&clnt->cl_lock);
683 task->tk_client = NULL;
684
685 rpc_release_client(clnt);
686 }
687}
688
689static
690void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
691{
692 if (clnt != NULL) {
693 rpc_task_release_client(task);
694 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400695 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400696 if (clnt->cl_softrtry)
697 task->tk_flags |= RPC_TASK_SOFT;
698 /* Add to the client's list of all tasks */
699 spin_lock(&clnt->cl_lock);
700 list_add_tail(&task->tk_task, &clnt->cl_tasks);
701 spin_unlock(&clnt->cl_lock);
702 }
703}
704
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000705void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
706{
707 rpc_task_release_client(task);
708 rpc_task_set_client(task, clnt);
709}
710EXPORT_SYMBOL_GPL(rpc_task_reset_client);
711
712
Trond Myklebust58f96122010-07-31 14:29:08 -0400713static void
714rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
715{
716 if (msg != NULL) {
717 task->tk_msg.rpc_proc = msg->rpc_proc;
718 task->tk_msg.rpc_argp = msg->rpc_argp;
719 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400720 if (msg->rpc_cred != NULL)
721 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400722 }
723}
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725/*
726 * Default callback for async RPC calls
727 */
728static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100729rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
731}
732
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100733static const struct rpc_call_ops rpc_default_ops = {
734 .rpc_call_done = rpc_default_callback,
735};
736
Trond Myklebustc970aa82007-07-14 15:39:59 -0400737/**
738 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
739 * @task_setup_data: pointer to task initialisation data
740 */
741struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400742{
Trond Myklebust19445b92010-04-16 16:41:10 -0400743 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400744
Trond Myklebust84115e12007-07-14 15:39:59 -0400745 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400746 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400747 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400748
Trond Myklebust58f96122010-07-31 14:29:08 -0400749 rpc_task_set_client(task, task_setup_data->rpc_client);
750 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
751
Trond Myklebust58f96122010-07-31 14:29:08 -0400752 if (task->tk_action == NULL)
753 rpc_call_start(task);
754
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400755 atomic_inc(&task->tk_count);
756 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400757out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400758 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400759}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400760EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400761
762/**
763 * rpc_call_sync - Perform a synchronous RPC call
764 * @clnt: pointer to RPC client
765 * @msg: RPC call parameters
766 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500768int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769{
770 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400771 struct rpc_task_setup task_setup_data = {
772 .rpc_client = clnt,
773 .rpc_message = msg,
774 .callback_ops = &rpc_default_ops,
775 .flags = flags,
776 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400777 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 BUG_ON(flags & RPC_TASK_ASYNC);
780
Trond Myklebustc970aa82007-07-14 15:39:59 -0400781 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400782 if (IS_ERR(task))
783 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100784 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800785 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 return status;
787}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400788EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400790/**
791 * rpc_call_async - Perform an asynchronous RPC call
792 * @clnt: pointer to RPC client
793 * @msg: RPC call parameters
794 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800795 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400796 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 */
798int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500799rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100800 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
802 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400803 struct rpc_task_setup task_setup_data = {
804 .rpc_client = clnt,
805 .rpc_message = msg,
806 .callback_ops = tk_ops,
807 .callback_data = data,
808 .flags = flags|RPC_TASK_ASYNC,
809 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Trond Myklebustc970aa82007-07-14 15:39:59 -0400811 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400812 if (IS_ERR(task))
813 return PTR_ERR(task);
814 rpc_put_task(task);
815 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400817EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400819#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400820/**
821 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
822 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400823 * @req: RPC request
824 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400825 */
826struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400827 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400828{
829 struct rpc_task *task;
830 struct xdr_buf *xbufp = &req->rq_snd_buf;
831 struct rpc_task_setup task_setup_data = {
832 .callback_ops = tk_ops,
833 };
834
835 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
836 /*
837 * Create an rpc_task to send the data
838 */
839 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400840 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400841 xprt_free_bc_request(req);
842 goto out;
843 }
844 task->tk_rqstp = req;
845
846 /*
847 * Set up the xdr_buf length.
848 * This also indicates that the buffer is XDR encoded already.
849 */
850 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
851 xbufp->tail[0].iov_len;
852
853 task->tk_action = call_bc_transmit;
854 atomic_inc(&task->tk_count);
855 BUG_ON(atomic_read(&task->tk_count) != 2);
856 rpc_execute(task);
857
858out:
859 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
860 return task;
861}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400862#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400865rpc_call_start(struct rpc_task *task)
866{
867 task->tk_action = call_start;
868}
869EXPORT_SYMBOL_GPL(rpc_call_start);
870
Chuck Levered394402006-08-22 20:06:17 -0400871/**
872 * rpc_peeraddr - extract remote peer address from clnt's xprt
873 * @clnt: RPC client structure
874 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800875 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400876 *
877 * Returns the number of bytes that are actually in the stored address.
878 */
879size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
880{
881 size_t bytes;
882 struct rpc_xprt *xprt = clnt->cl_xprt;
883
884 bytes = sizeof(xprt->addr);
885 if (bytes > bufsize)
886 bytes = bufsize;
887 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400888 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400889}
Chuck Leverb86acd52006-08-22 20:06:22 -0400890EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400891
Chuck Leverf425eba2006-08-22 20:06:18 -0400892/**
893 * rpc_peeraddr2str - return remote peer address in printable format
894 * @clnt: RPC client structure
895 * @format: address format
896 *
897 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500898const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
899 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400900{
901 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500902
903 if (xprt->address_strings[format] != NULL)
904 return xprt->address_strings[format];
905 else
906 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400907}
Chuck Leverb86acd52006-08-22 20:06:22 -0400908EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910void
911rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
912{
913 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700914 if (xprt->ops->set_buffer_size)
915 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400917EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919/*
920 * Return size of largest payload RPC client can support, in bytes
921 *
922 * For stream transports, this is one RPC record fragment (see RFC
923 * 1831), as we don't support multi-record requests yet. For datagram
924 * transports, this is the size of an IP packet minus the IP, UDP, and
925 * RPC header sizes.
926 */
927size_t rpc_max_payload(struct rpc_clnt *clnt)
928{
929 return clnt->cl_xprt->max_payload;
930}
Chuck Leverb86acd52006-08-22 20:06:22 -0400931EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Chuck Lever35f5a422006-01-03 09:55:50 +0100933/**
934 * rpc_force_rebind - force transport to check that remote port is unchanged
935 * @clnt: client to rebind
936 *
937 */
938void rpc_force_rebind(struct rpc_clnt *clnt)
939{
940 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400941 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100942}
Chuck Leverb86acd52006-08-22 20:06:22 -0400943EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100944
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400946 * Restart an (async) RPC call from the call_prepare state.
947 * Usually called from within the exit handler.
948 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400949int
Andy Adamsonaae20062009-04-01 09:22:40 -0400950rpc_restart_call_prepare(struct rpc_task *task)
951{
952 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400953 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700954 task->tk_action = call_start;
955 if (task->tk_ops->rpc_call_prepare != NULL)
956 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400957 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400958}
959EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
960
961/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * Restart an (async) RPC call. Usually called from within the
963 * exit handler.
964 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400965int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966rpc_restart_call(struct rpc_task *task)
967{
968 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400969 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400971 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400973EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Chuck Lever3748f1e2008-05-21 17:09:12 -0400975#ifdef RPC_DEBUG
976static const char *rpc_proc_name(const struct rpc_task *task)
977{
978 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
979
980 if (proc) {
981 if (proc->p_name)
982 return proc->p_name;
983 else
984 return "NULL";
985 } else
986 return "no proc";
987}
988#endif
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990/*
991 * 0. Initial state
992 *
993 * Other FSM states can be visited zero or more times, but
994 * this state is visited exactly once for each RPC.
995 */
996static void
997call_start(struct rpc_task *task)
998{
999 struct rpc_clnt *clnt = task->tk_client;
1000
Chuck Lever3748f1e2008-05-21 17:09:12 -04001001 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001002 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001003 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001004 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
1006 /* Increment call count */
1007 task->tk_msg.rpc_proc->p_count++;
1008 clnt->cl_stats->rpccnt++;
1009 task->tk_action = call_reserve;
1010}
1011
1012/*
1013 * 1. Reserve an RPC call slot
1014 */
1015static void
1016call_reserve(struct rpc_task *task)
1017{
Chuck Lever46121cf2007-01-31 12:14:08 -05001018 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 task->tk_status = 0;
1021 task->tk_action = call_reserveresult;
1022 xprt_reserve(task);
1023}
1024
1025/*
1026 * 1b. Grok the result of xprt_reserve()
1027 */
1028static void
1029call_reserveresult(struct rpc_task *task)
1030{
1031 int status = task->tk_status;
1032
Chuck Lever46121cf2007-01-31 12:14:08 -05001033 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
1035 /*
1036 * After a call to xprt_reserve(), we must have either
1037 * a request slot or else an error status.
1038 */
1039 task->tk_status = 0;
1040 if (status >= 0) {
1041 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001042 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 return;
1044 }
1045
1046 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001047 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 rpc_exit(task, -EIO);
1049 return;
1050 }
1051
1052 /*
1053 * Even though there was an error, we may have acquired
1054 * a request slot somehow. Make sure not to leak it.
1055 */
1056 if (task->tk_rqstp) {
1057 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001058 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 xprt_release(task);
1060 }
1061
1062 switch (status) {
1063 case -EAGAIN: /* woken up; retry */
1064 task->tk_action = call_reserve;
1065 return;
1066 case -EIO: /* probably a shutdown */
1067 break;
1068 default:
1069 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001070 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 break;
1072 }
1073 rpc_exit(task, status);
1074}
1075
1076/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001077 * 2. Bind and/or refresh the credentials
1078 */
1079static void
1080call_refresh(struct rpc_task *task)
1081{
1082 dprint_status(task);
1083
1084 task->tk_action = call_refreshresult;
1085 task->tk_status = 0;
1086 task->tk_client->cl_stats->rpcauthrefresh++;
1087 rpcauth_refreshcred(task);
1088}
1089
1090/*
1091 * 2a. Process the results of a credential refresh
1092 */
1093static void
1094call_refreshresult(struct rpc_task *task)
1095{
1096 int status = task->tk_status;
1097
1098 dprint_status(task);
1099
1100 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001101 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001102 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001103 case 0:
1104 if (rpcauth_uptodatecred(task))
1105 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001106 return;
1107 case -ETIMEDOUT:
1108 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001109 case -EAGAIN:
1110 status = -EACCES;
1111 if (!task->tk_cred_retry)
1112 break;
1113 task->tk_cred_retry--;
1114 dprintk("RPC: %5u %s: retry refresh creds\n",
1115 task->tk_pid, __func__);
1116 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001117 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001118 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1119 task->tk_pid, __func__, status);
1120 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001121}
1122
1123/*
1124 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001125 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 */
1127static void
1128call_allocate(struct rpc_task *task)
1129{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001130 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001131 struct rpc_rqst *req = task->tk_rqstp;
1132 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001133 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
Chuck Lever46121cf2007-01-31 12:14:08 -05001135 dprint_status(task);
1136
Chuck Lever2bea90d2007-03-29 16:47:53 -04001137 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001138 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001139
Chuck Lever02107142006-01-03 09:55:49 +01001140 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 return;
1142
Chuck Lever2bea90d2007-03-29 16:47:53 -04001143 if (proc->p_proc != 0) {
1144 BUG_ON(proc->p_arglen == 0);
1145 if (proc->p_decode != NULL)
1146 BUG_ON(proc->p_replen == 0);
1147 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Chuck Lever2bea90d2007-03-29 16:47:53 -04001149 /*
1150 * Calculate the size (in quads) of the RPC call
1151 * and reply headers, and convert both values
1152 * to byte sizes.
1153 */
1154 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1155 req->rq_callsize <<= 2;
1156 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1157 req->rq_rcvsize <<= 2;
1158
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001159 req->rq_buffer = xprt->ops->buf_alloc(task,
1160 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001161 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001163
1164 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Trond Myklebust5afa91332011-06-17 10:14:59 -04001166 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001167 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 rpc_delay(task, HZ>>4);
1169 return;
1170 }
1171
1172 rpc_exit(task, -ERESTARTSYS);
1173}
1174
Trond Myklebust940e3312005-11-09 21:45:24 -05001175static inline int
1176rpc_task_need_encode(struct rpc_task *task)
1177{
1178 return task->tk_rqstp->rq_snd_buf.len == 0;
1179}
1180
1181static inline void
1182rpc_task_force_reencode(struct rpc_task *task)
1183{
1184 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001185 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001186}
1187
Chuck Lever2bea90d2007-03-29 16:47:53 -04001188static inline void
1189rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1190{
1191 buf->head[0].iov_base = start;
1192 buf->head[0].iov_len = len;
1193 buf->tail[0].iov_len = 0;
1194 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001195 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001196 buf->len = 0;
1197 buf->buflen = len;
1198}
1199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200/*
1201 * 3. Encode arguments of an RPC call
1202 */
1203static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001204rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001207 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001208 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Chuck Lever46121cf2007-01-31 12:14:08 -05001210 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Chuck Lever2bea90d2007-03-29 16:47:53 -04001212 rpc_xdr_buf_init(&req->rq_snd_buf,
1213 req->rq_buffer,
1214 req->rq_callsize);
1215 rpc_xdr_buf_init(&req->rq_rcv_buf,
1216 (char *)req->rq_buffer + req->rq_callsize,
1217 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Chuck Leverb0e1c572008-05-21 17:09:19 -04001219 p = rpc_encode_header(task);
1220 if (p == NULL) {
1221 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 rpc_exit(task, -EIO);
1223 return;
1224 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001225
1226 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001227 if (encode == NULL)
1228 return;
1229
1230 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1231 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232}
1233
1234/*
1235 * 4. Get the server port number if not yet set
1236 */
1237static void
1238call_bind(struct rpc_task *task)
1239{
Chuck Leverec739ef2006-08-22 20:06:15 -04001240 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Chuck Lever46121cf2007-01-31 12:14:08 -05001242 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
Chuck Leverda351872005-08-11 16:25:11 -04001244 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001245 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001246 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001247 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001248 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 }
1250}
1251
1252/*
Chuck Leverda351872005-08-11 16:25:11 -04001253 * 4a. Sort out bind result
1254 */
1255static void
1256call_bind_status(struct rpc_task *task)
1257{
Chuck Lever906462a2007-09-11 18:00:47 -04001258 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001259
1260 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001261 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001262 task->tk_status = 0;
1263 task->tk_action = call_connect;
1264 return;
1265 }
1266
1267 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001268 case -ENOMEM:
1269 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1270 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001271 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001272 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001273 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1274 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001275 /* fail immediately if this is an RPC ping */
1276 if (task->tk_msg.rpc_proc->p_proc == 0) {
1277 status = -EOPNOTSUPP;
1278 break;
1279 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001280 if (task->tk_rebind_retry == 0)
1281 break;
1282 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001283 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001284 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001285 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001286 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001287 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001288 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001289 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001290 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001291 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001292 task->tk_pid);
1293 break;
1294 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001295 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001296 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001297 task->tk_status = 0;
1298 task->tk_action = call_bind;
1299 return;
Chuck Lever012da152009-12-03 15:58:56 -05001300 case -ECONNREFUSED: /* connection problems */
1301 case -ECONNRESET:
1302 case -ENOTCONN:
1303 case -EHOSTDOWN:
1304 case -EHOSTUNREACH:
1305 case -ENETUNREACH:
1306 case -EPIPE:
1307 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1308 task->tk_pid, task->tk_status);
1309 if (!RPC_IS_SOFTCONN(task)) {
1310 rpc_delay(task, 5*HZ);
1311 goto retry_timeout;
1312 }
1313 status = task->tk_status;
1314 break;
Chuck Leverda351872005-08-11 16:25:11 -04001315 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001316 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001317 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001318 }
1319
1320 rpc_exit(task, status);
1321 return;
1322
Trond Myklebustda458282006-08-31 15:44:52 -04001323retry_timeout:
1324 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001325}
1326
1327/*
1328 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 */
1330static void
1331call_connect(struct rpc_task *task)
1332{
Chuck Leverda351872005-08-11 16:25:11 -04001333 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
Chuck Lever46121cf2007-01-31 12:14:08 -05001335 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001336 task->tk_pid, xprt,
1337 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
Chuck Leverda351872005-08-11 16:25:11 -04001339 task->tk_action = call_transmit;
1340 if (!xprt_connected(xprt)) {
1341 task->tk_action = call_connect_status;
1342 if (task->tk_status < 0)
1343 return;
1344 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346}
1347
1348/*
Chuck Leverda351872005-08-11 16:25:11 -04001349 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 */
1351static void
1352call_connect_status(struct rpc_task *task)
1353{
1354 struct rpc_clnt *clnt = task->tk_client;
1355 int status = task->tk_status;
1356
Chuck Lever46121cf2007-01-31 12:14:08 -05001357 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001358
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001360 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 clnt->cl_stats->netreconn++;
1362 task->tk_action = call_transmit;
1363 return;
1364 }
1365
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001367 /* if soft mounted, test if we've timed out */
1368 case -ETIMEDOUT:
1369 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001370 break;
1371 default:
1372 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
1374}
1375
1376/*
1377 * 5. Transmit the RPC request, and wait for reply
1378 */
1379static void
1380call_transmit(struct rpc_task *task)
1381{
Chuck Lever46121cf2007-01-31 12:14:08 -05001382 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
1384 task->tk_action = call_status;
1385 if (task->tk_status < 0)
1386 return;
1387 task->tk_status = xprt_prepare_transmit(task);
1388 if (task->tk_status != 0)
1389 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001390 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001392 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001393 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001394 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001395 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001396 if (task->tk_status != 0) {
1397 /* Was the error nonfatal? */
1398 if (task->tk_status == -EAGAIN)
1399 rpc_delay(task, HZ >> 4);
1400 else
1401 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001402 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001403 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001404 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 xprt_transmit(task);
1406 if (task->tk_status < 0)
1407 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001408 /*
1409 * On success, ensure that we call xprt_end_transmit() before sleeping
1410 * in order to allow access to the socket to other RPC requests.
1411 */
1412 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001413 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001414 return;
1415 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001416 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001417}
1418
1419/*
1420 * 5a. Handle cleanup after a transmission
1421 */
1422static void
1423call_transmit_status(struct rpc_task *task)
1424{
1425 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001426
1427 /*
1428 * Common case: success. Force the compiler to put this
1429 * test first.
1430 */
1431 if (task->tk_status == 0) {
1432 xprt_end_transmit(task);
1433 rpc_task_force_reencode(task);
1434 return;
1435 }
1436
Trond Myklebust15f081c2009-03-11 14:37:57 -04001437 switch (task->tk_status) {
1438 case -EAGAIN:
1439 break;
1440 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001441 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001442 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001443 rpc_task_force_reencode(task);
1444 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001445 /*
1446 * Special cases: if we've been waiting on the
1447 * socket's write_space() callback, or if the
1448 * socket just returned a connection error,
1449 * then hold onto the transport lock.
1450 */
1451 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001452 case -EHOSTDOWN:
1453 case -EHOSTUNREACH:
1454 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001455 if (RPC_IS_SOFTCONN(task)) {
1456 xprt_end_transmit(task);
1457 rpc_exit(task, task->tk_status);
1458 break;
1459 }
1460 case -ECONNRESET:
1461 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001462 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001463 rpc_task_force_reencode(task);
1464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465}
1466
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001467#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001468/*
1469 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1470 * addition, disconnect on connectivity errors.
1471 */
1472static void
1473call_bc_transmit(struct rpc_task *task)
1474{
1475 struct rpc_rqst *req = task->tk_rqstp;
1476
1477 BUG_ON(task->tk_status != 0);
1478 task->tk_status = xprt_prepare_transmit(task);
1479 if (task->tk_status == -EAGAIN) {
1480 /*
1481 * Could not reserve the transport. Try again after the
1482 * transport is released.
1483 */
1484 task->tk_status = 0;
1485 task->tk_action = call_bc_transmit;
1486 return;
1487 }
1488
1489 task->tk_action = rpc_exit_task;
1490 if (task->tk_status < 0) {
1491 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1492 "error: %d\n", task->tk_status);
1493 return;
1494 }
1495
1496 xprt_transmit(task);
1497 xprt_end_transmit(task);
1498 dprint_status(task);
1499 switch (task->tk_status) {
1500 case 0:
1501 /* Success */
1502 break;
1503 case -EHOSTDOWN:
1504 case -EHOSTUNREACH:
1505 case -ENETUNREACH:
1506 case -ETIMEDOUT:
1507 /*
1508 * Problem reaching the server. Disconnect and let the
1509 * forechannel reestablish the connection. The server will
1510 * have to retransmit the backchannel request and we'll
1511 * reprocess it. Since these ops are idempotent, there's no
1512 * need to cache our reply at this time.
1513 */
1514 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1515 "error: %d\n", task->tk_status);
1516 xprt_conditional_disconnect(task->tk_xprt,
1517 req->rq_connect_cookie);
1518 break;
1519 default:
1520 /*
1521 * We were unable to reply and will have to drop the
1522 * request. The server should reconnect and retransmit.
1523 */
1524 BUG_ON(task->tk_status == -EAGAIN);
1525 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1526 "error: %d\n", task->tk_status);
1527 break;
1528 }
1529 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1530}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001531#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533/*
1534 * 6. Sort out the RPC call status
1535 */
1536static void
1537call_status(struct rpc_task *task)
1538{
1539 struct rpc_clnt *clnt = task->tk_client;
1540 struct rpc_rqst *req = task->tk_rqstp;
1541 int status;
1542
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001543 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1544 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Chuck Lever46121cf2007-01-31 12:14:08 -05001546 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
1548 status = task->tk_status;
1549 if (status >= 0) {
1550 task->tk_action = call_decode;
1551 return;
1552 }
1553
1554 task->tk_status = 0;
1555 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001556 case -EHOSTDOWN:
1557 case -EHOSTUNREACH:
1558 case -ENETUNREACH:
1559 /*
1560 * Delay any retries for 3 seconds, then handle as if it
1561 * were a timeout.
1562 */
1563 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 case -ETIMEDOUT:
1565 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001566 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001567 xprt_conditional_disconnect(task->tk_xprt,
1568 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001570 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001572 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001573 rpc_delay(task, 3*HZ);
1574 case -EPIPE:
1575 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 task->tk_action = call_bind;
1577 break;
1578 case -EAGAIN:
1579 task->tk_action = call_transmit;
1580 break;
1581 case -EIO:
1582 /* shutdown or soft timeout */
1583 rpc_exit(task, status);
1584 break;
1585 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001586 if (clnt->cl_chatty)
1587 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 clnt->cl_protname, -status);
1589 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 }
1591}
1592
1593/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001594 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 * We do not release the request slot, so we keep using the
1596 * same XID for all retransmits.
1597 */
1598static void
1599call_timeout(struct rpc_task *task)
1600{
1601 struct rpc_clnt *clnt = task->tk_client;
1602
1603 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001604 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 goto retry;
1606 }
1607
Chuck Lever46121cf2007-01-31 12:14:08 -05001608 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001609 task->tk_timeouts++;
1610
Chuck Lever3a28bec2009-12-03 15:58:56 -05001611 if (RPC_IS_SOFTCONN(task)) {
1612 rpc_exit(task, -ETIMEDOUT);
1613 return;
1614 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001616 if (clnt->cl_chatty)
1617 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001619 if (task->tk_flags & RPC_TASK_TIMEOUT)
1620 rpc_exit(task, -ETIMEDOUT);
1621 else
1622 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 return;
1624 }
1625
Chuck Leverf518e35a2006-01-03 09:55:52 +01001626 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001628 if (clnt->cl_chatty)
1629 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 clnt->cl_protname, clnt->cl_server);
1631 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001632 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001633 /*
1634 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1635 * event? RFC2203 requires the server to drop all such requests.
1636 */
1637 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
1639retry:
1640 clnt->cl_stats->rpcretrans++;
1641 task->tk_action = call_bind;
1642 task->tk_status = 0;
1643}
1644
1645/*
1646 * 7. Decode the RPC reply
1647 */
1648static void
1649call_decode(struct rpc_task *task)
1650{
1651 struct rpc_clnt *clnt = task->tk_client;
1652 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001653 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001654 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
Vasily Averin726fd6a2011-06-01 16:23:59 +04001656 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Chuck Leverf518e35a2006-01-03 09:55:52 +01001658 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001659 if (clnt->cl_chatty)
1660 printk(KERN_NOTICE "%s: server %s OK\n",
1661 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1663 }
1664
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001665 /*
1666 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001667 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001668 */
1669 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 req->rq_rcv_buf.len = req->rq_private_buf.len;
1671
1672 /* Check that the softirq receive buffer is valid */
1673 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1674 sizeof(req->rq_rcv_buf)) != 0);
1675
Trond Myklebust1e799b62008-03-21 16:19:41 -04001676 if (req->rq_rcv_buf.len < 12) {
1677 if (!RPC_IS_SOFT(task)) {
1678 task->tk_action = call_bind;
1679 clnt->cl_stats->rpcretrans++;
1680 goto out_retry;
1681 }
1682 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1683 clnt->cl_protname, task->tk_status);
1684 task->tk_action = call_timeout;
1685 goto out_retry;
1686 }
1687
Chuck Leverb0e1c572008-05-21 17:09:19 -04001688 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001689 if (IS_ERR(p)) {
1690 if (p == ERR_PTR(-EAGAIN))
1691 goto out_retry;
1692 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 }
1694
Trond Myklebustabbcf282006-01-03 09:55:03 +01001695 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001697 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1699 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001700 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001701 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1702 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 return;
1704out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001706 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001707 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001708 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001709 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001710 xprt_conditional_disconnect(task->tk_xprt,
1711 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001712 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713}
1714
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001715static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001716rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717{
1718 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001720 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
1722 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001723
1724 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 *p++ = req->rq_xid; /* XID */
1726 *p++ = htonl(RPC_CALL); /* CALL */
1727 *p++ = htonl(RPC_VERSION); /* RPC version */
1728 *p++ = htonl(clnt->cl_prog); /* program number */
1729 *p++ = htonl(clnt->cl_vers); /* program version */
1730 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001731 p = rpcauth_marshcred(task, p);
1732 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1733 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734}
1735
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001736static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001737rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738{
1739 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1740 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001741 __be32 *p = iov->iov_base;
1742 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 int error = -EACCES;
1744
David Howellse8896492006-08-24 15:44:19 -04001745 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1746 /* RFC-1014 says that the representation of XDR data must be a
1747 * multiple of four bytes
1748 * - if it isn't pointer subtraction in the NFS client may give
1749 * undefined results
1750 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001751 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001752 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001753 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001754 goto out_eio;
1755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 if ((len -= 3) < 0)
1757 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001759 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001761 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001762 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001763 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001765
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1767 if (--len < 0)
1768 goto out_overflow;
1769 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001770 case RPC_AUTH_ERROR:
1771 break;
1772 case RPC_MISMATCH:
1773 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1774 task->tk_pid, __func__);
1775 error = -EPROTONOSUPPORT;
1776 goto out_err;
1777 default:
1778 dprintk("RPC: %5u %s: RPC call rejected, "
1779 "unknown error: %x\n",
1780 task->tk_pid, __func__, n);
1781 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 }
1783 if (--len < 0)
1784 goto out_overflow;
1785 switch ((n = ntohl(*p++))) {
1786 case RPC_AUTH_REJECTEDCRED:
1787 case RPC_AUTH_REJECTEDVERF:
1788 case RPCSEC_GSS_CREDPROBLEM:
1789 case RPCSEC_GSS_CTXPROBLEM:
1790 if (!task->tk_cred_retry)
1791 break;
1792 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001793 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001794 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001796 /* Ensure we obtain a new XID! */
1797 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001798 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001799 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 case RPC_AUTH_BADCRED:
1801 case RPC_AUTH_BADVERF:
1802 /* possibly garbled cred/verf? */
1803 if (!task->tk_garb_retry)
1804 break;
1805 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001806 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001807 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001809 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001811 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001812 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 break;
1814 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001815 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001816 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 error = -EIO;
1818 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001819 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001820 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 goto out_err;
1822 }
1823 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001824 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001825 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001826 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001828 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 if (len < 0)
1830 goto out_overflow;
1831 switch ((n = ntohl(*p++))) {
1832 case RPC_SUCCESS:
1833 return p;
1834 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001835 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001836 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 (unsigned int)task->tk_client->cl_prog,
1838 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001839 error = -EPFNOSUPPORT;
1840 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001842 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001843 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 (unsigned int)task->tk_client->cl_prog,
1845 (unsigned int)task->tk_client->cl_vers,
1846 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001847 error = -EPROTONOSUPPORT;
1848 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001850 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001851 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001852 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001853 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 task->tk_client->cl_prog,
1855 task->tk_client->cl_vers,
1856 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001857 error = -EOPNOTSUPP;
1858 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001860 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001861 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 break; /* retry */
1863 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001864 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001865 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 /* Also retry */
1867 }
1868
Trond Myklebustabbcf282006-01-03 09:55:03 +01001869out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 task->tk_client->cl_stats->rpcgarbage++;
1871 if (task->tk_garb_retry) {
1872 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001873 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001874 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001876out_retry:
1877 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879out_eio:
1880 error = -EIO;
1881out_err:
1882 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001883 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001884 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001885 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001887 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001888 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001889 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001891
Chuck Lever9f06c712010-12-14 14:59:18 +00001892static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001893{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001894}
1895
Chuck Leverbf269552010-12-14 14:59:29 +00001896static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001897{
1898 return 0;
1899}
1900
1901static struct rpc_procinfo rpcproc_null = {
1902 .p_encode = rpcproc_encode_null,
1903 .p_decode = rpcproc_decode_null,
1904};
1905
Chuck Levercaabea82009-12-03 15:58:56 -05001906static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001907{
1908 struct rpc_message msg = {
1909 .rpc_proc = &rpcproc_null,
1910 };
1911 int err;
1912 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001913 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001914 put_rpccred(msg.rpc_cred);
1915 return err;
1916}
Trond Myklebust188fef12007-06-16 14:18:40 -04001917
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001918struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1919{
1920 struct rpc_message msg = {
1921 .rpc_proc = &rpcproc_null,
1922 .rpc_cred = cred,
1923 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001924 struct rpc_task_setup task_setup_data = {
1925 .rpc_client = clnt,
1926 .rpc_message = &msg,
1927 .callback_ops = &rpc_default_ops,
1928 .flags = flags,
1929 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001930 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001931}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001932EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001933
Trond Myklebust188fef12007-06-16 14:18:40 -04001934#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001935static void rpc_show_header(void)
1936{
Chuck Levercb3997b2008-05-21 17:09:41 -04001937 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1938 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001939}
1940
Chuck Lever38e886e2008-05-21 17:09:33 -04001941static void rpc_show_task(const struct rpc_clnt *clnt,
1942 const struct rpc_task *task)
1943{
1944 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001945
1946 if (RPC_IS_QUEUED(task))
1947 rpc_waitq = rpc_qname(task->tk_waitqueue);
1948
Joe Perchesb3bceda2010-12-21 10:52:24 -05001949 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 -04001950 task->tk_pid, task->tk_flags, task->tk_status,
1951 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1952 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001953 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001954}
1955
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001956void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04001957{
1958 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001959 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001960 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001961 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04001962
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001963 spin_lock(&sn->rpc_client_lock);
1964 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001965 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001966 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001967 if (!header) {
1968 rpc_show_header();
1969 header++;
1970 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001971 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001972 }
1973 spin_unlock(&clnt->cl_lock);
1974 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001975 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001976}
1977#endif