blob: db7220d87732c581ae378b0c3cf9fc18fc1f52b9 [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,
Trond Myklebust080b7942012-01-20 13:53:56 -0500121 struct rpc_clnt *clnt,
122 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
Trond Myklebustf1345852005-09-23 11:08:25 -0400124 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
126 struct qstr q = {
127 .name = name,
128 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400129 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 int error;
131
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400132 dir = rpc_d_lookup_sb(sb, dir_name);
133 if (dir == NULL)
134 return dir;
135 for (;;) {
136 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
137 name[sizeof(name) - 1] = '\0';
138 q.hash = full_name_hash(q.name, q.len);
139 dentry = rpc_create_client_dir(dir, &q, clnt);
140 if (!IS_ERR(dentry))
141 break;
142 error = PTR_ERR(dentry);
143 if (error != -EEXIST) {
144 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
145 " %s/%s, error %d\n",
146 dir_name, name, error);
147 break;
148 }
149 }
150 dput(dir);
151 return dentry;
152}
153
154static int
Trond Myklebust080b7942012-01-20 13:53:56 -0500155rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400156{
157 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400158 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400159
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400160 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 if (dir_name == NULL)
162 return 0;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400163 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400164 if (!pipefs_sb)
165 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400166 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400167 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400168 if (IS_ERR(dentry))
169 return PTR_ERR(dentry);
170 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400171 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172}
173
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400174static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
175 struct super_block *sb)
176{
177 struct dentry *dentry;
178 int err = 0;
179
180 switch (event) {
181 case RPC_PIPEFS_MOUNT:
182 if (clnt->cl_program->pipe_dir_name == NULL)
183 break;
184 dentry = rpc_setup_pipedir_sb(sb, clnt,
185 clnt->cl_program->pipe_dir_name);
186 BUG_ON(dentry == NULL);
187 if (IS_ERR(dentry))
188 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400189 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400190 if (clnt->cl_auth->au_ops->pipes_create) {
191 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
192 if (err)
193 __rpc_clnt_remove_pipedir(clnt);
194 }
195 break;
196 case RPC_PIPEFS_UMOUNT:
197 __rpc_clnt_remove_pipedir(clnt);
198 break;
199 default:
200 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
201 return -ENOTSUPP;
202 }
203 return err;
204}
205
206static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
207 void *ptr)
208{
209 struct super_block *sb = ptr;
210 struct rpc_clnt *clnt;
211 int error = 0;
212 struct sunrpc_net *sn = net_generic(sb->s_fs_info, sunrpc_net_id);
213
214 spin_lock(&sn->rpc_client_lock);
215 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
216 error = __rpc_pipefs_event(clnt, event, sb);
217 if (error)
218 break;
219 }
220 spin_unlock(&sn->rpc_client_lock);
221 return error;
222}
223
224static struct notifier_block rpc_clients_block = {
225 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400226 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400227};
228
229int rpc_clients_notifier_register(void)
230{
231 return rpc_pipefs_notifier_register(&rpc_clients_block);
232}
233
234void rpc_clients_notifier_unregister(void)
235{
236 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
237}
238
Trond Myklebust698b6d02007-12-20 16:03:53 -0500239static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500241 const struct rpc_program *program = args->program;
242 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000244 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400246 size_t len;
247
248 /* sanity check the name before trying to print it */
249 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500250 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400251 if (len > RPC_MAXNETNAMELEN)
252 goto out_no_rpciod;
253 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Chuck Lever46121cf2007-01-31 12:14:08 -0500255 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500256 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Trond Myklebust4ada5392007-06-14 17:26:17 -0400258 err = rpciod_up();
259 if (err)
260 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 err = -EINVAL;
262 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800263 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500264
265 if (args->version >= program->nrvers)
266 goto out_err;
267 version = program->version[args->version];
268 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 goto out_err;
270
271 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700272 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 if (!clnt)
274 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 clnt->cl_parent = clnt;
276
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500277 clnt->cl_server = kstrdup(args->servername, GFP_KERNEL);
278 if (clnt->cl_server == NULL)
279 goto out_no_server;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281 clnt->cl_xprt = xprt;
282 clnt->cl_procinfo = version->procs;
283 clnt->cl_maxproc = version->nrprocs;
284 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300285 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500288 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500289 err = -ENOMEM;
290 if (clnt->cl_metrics == NULL)
291 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500292 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400293 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400294 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Chuck Leverec739ef2006-08-22 20:06:15 -0400296 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 clnt->cl_autobind = 1;
298
Trond Myklebustba7392b2007-12-20 16:03:55 -0500299 clnt->cl_timeout = xprt->timeout;
300 if (args->timeout != NULL) {
301 memcpy(&clnt->cl_timeout_default, args->timeout,
302 sizeof(clnt->cl_timeout_default));
303 clnt->cl_timeout = &clnt->cl_timeout_default;
304 }
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500307 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500308 clnt->cl_principal = NULL;
309 if (args->client_name) {
310 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
311 if (!clnt->cl_principal)
312 goto out_no_principal;
313 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Trond Myklebust006abe82010-09-12 19:55:25 -0400315 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
318 if (err < 0)
319 goto out_no_path;
320
Trond Myklebust698b6d02007-12-20 16:03:53 -0500321 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000322 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500324 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000325 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 goto out_no_auth;
327 }
328
329 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400330 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 if (clnt->cl_nodelen > UNX_MAXNODENAME)
332 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400333 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400334 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 return clnt;
336
337out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400338 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500340 kfree(clnt->cl_principal);
341out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500342 rpc_free_iostats(clnt->cl_metrics);
343out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500344 kfree(clnt->cl_server);
345out_no_server:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 kfree(clnt);
347out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400348 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800349out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400350 rpciod_down();
351out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 return ERR_PTR(err);
353}
354
Chuck Leverc2866762006-08-22 20:06:20 -0400355/*
356 * rpc_create - create an RPC client and transport with one call
357 * @args: rpc_clnt create argument structure
358 *
359 * Creates and initializes an RPC transport and an RPC client.
360 *
361 * It can ping the server in order to determine if it is up, and to see if
362 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
363 * this behavior so asynchronous tasks can also use rpc_create.
364 */
365struct rpc_clnt *rpc_create(struct rpc_create_args *args)
366{
367 struct rpc_xprt *xprt;
368 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b02007-09-10 13:47:07 -0400369 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400370 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400371 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200372 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200373 .dstaddr = args->address,
374 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300375 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200376 };
Chuck Lever510deb02007-12-10 14:56:24 -0500377 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400378
Chuck Leverc2866762006-08-22 20:06:20 -0400379 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400380 * If the caller chooses not to specify a hostname, whip
381 * up a string representation of the passed-in address.
382 */
383 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400384 struct sockaddr_un *sun =
385 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400386 struct sockaddr_in *sin =
387 (struct sockaddr_in *)args->address;
388 struct sockaddr_in6 *sin6 =
389 (struct sockaddr_in6 *)args->address;
390
Chuck Lever510deb02007-12-10 14:56:24 -0500391 servername[0] = '\0';
392 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400393 case AF_LOCAL:
394 snprintf(servername, sizeof(servername), "%s",
395 sun->sun_path);
396 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400397 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700398 snprintf(servername, sizeof(servername), "%pI4",
399 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500400 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400401 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700402 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400403 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500404 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500405 default:
406 /* caller wants default server name, but
407 * address family isn't recognized. */
408 return ERR_PTR(-EINVAL);
409 }
Chuck Lever43780b82007-07-01 12:13:22 -0400410 args->servername = servername;
411 }
412
Chuck Lever510deb02007-12-10 14:56:24 -0500413 xprt = xprt_create_transport(&xprtargs);
414 if (IS_ERR(xprt))
415 return (struct rpc_clnt *)xprt;
416
Chuck Lever43780b82007-07-01 12:13:22 -0400417 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400418 * By default, kernel RPC client connects from a reserved port.
419 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
420 * but it is always enabled for rpciod, which handles the connect
421 * operation.
422 */
423 xprt->resvport = 1;
424 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
425 xprt->resvport = 0;
426
Trond Myklebust698b6d02007-12-20 16:03:53 -0500427 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400428 if (IS_ERR(clnt))
429 return clnt;
430
431 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500432 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400433 if (err != 0) {
434 rpc_shutdown_client(clnt);
435 return ERR_PTR(err);
436 }
437 }
438
439 clnt->cl_softrtry = 1;
440 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
441 clnt->cl_softrtry = 0;
442
Chuck Leverc2866762006-08-22 20:06:20 -0400443 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
444 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500445 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
446 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400447 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
448 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400449
450 return clnt;
451}
Chuck Leverb86acd52006-08-22 20:06:22 -0400452EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400453
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454/*
455 * This function clones the RPC client structure. It allows us to share the
456 * same transport while varying parameters such as the authentication
457 * flavour.
458 */
459struct rpc_clnt *
460rpc_clone_client(struct rpc_clnt *clnt)
461{
462 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500463 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200465 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 if (!new)
467 goto out_no_clnt;
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500468 new->cl_server = kstrdup(clnt->cl_server, GFP_KERNEL);
469 if (new->cl_server == NULL)
470 goto out_no_server;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400471 new->cl_parent = clnt;
472 /* Turn off autobind on clones */
473 new->cl_autobind = 0;
474 INIT_LIST_HEAD(&new->cl_tasks);
475 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500476 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500477 new->cl_metrics = rpc_alloc_iostats(clnt);
478 if (new->cl_metrics == NULL)
479 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500480 if (clnt->cl_principal) {
481 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
482 if (new->cl_principal == NULL)
483 goto out_no_principal;
484 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400485 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500486 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
487 if (err != 0)
488 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 if (new->cl_auth)
490 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400491 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400492 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400493 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400494 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500496out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500497 kfree(new->cl_principal);
498out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500499 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500500out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500501 kfree(new->cl_server);
502out_no_server:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500503 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800505 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500506 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400508EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
510/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400511 * Kill all tasks for the given client.
512 * XXX: kill their descendants as well?
513 */
514void rpc_killall_tasks(struct rpc_clnt *clnt)
515{
516 struct rpc_task *rovr;
517
518
519 if (list_empty(&clnt->cl_tasks))
520 return;
521 dprintk("RPC: killing all tasks for client %p\n", clnt);
522 /*
523 * Spin lock all_tasks to prevent changes...
524 */
525 spin_lock(&clnt->cl_lock);
526 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
527 if (!RPC_IS_ACTIVATED(rovr))
528 continue;
529 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
530 rovr->tk_flags |= RPC_TASK_KILLED;
531 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300532 if (RPC_IS_QUEUED(rovr))
533 rpc_wake_up_queued_task(rovr->tk_waitqueue,
534 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400535 }
536 }
537 spin_unlock(&clnt->cl_lock);
538}
539EXPORT_SYMBOL_GPL(rpc_killall_tasks);
540
541/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400543 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400545void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400547 dprintk("RPC: shutting down %s client for %s\n",
548 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Trond Myklebust34f52e32007-06-14 16:40:31 -0400550 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800552 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400553 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555
Trond Myklebust4c402b42007-06-14 16:40:32 -0400556 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400558EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400561 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400563static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400564rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
Chuck Lever46121cf2007-01-31 12:14:08 -0500566 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 clnt->cl_protname, clnt->cl_server);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500568 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400569 rpc_release_client(clnt->cl_parent);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500570 kfree(clnt->cl_server);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400571 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400572 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500573 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500574 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500575 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400576 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400577 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
581/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400582 * Free an RPC client
583 */
584static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400585rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400586{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400587 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400588 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400589 return;
590 }
591
592 /*
593 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
594 * release remaining GSS contexts. This mechanism ensures
595 * that it can do so safely.
596 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400597 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400598 rpcauth_release(clnt->cl_auth);
599 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400600 if (atomic_dec_and_test(&clnt->cl_count))
601 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400602}
603
604/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400605 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
607void
608rpc_release_client(struct rpc_clnt *clnt)
609{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400610 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Trond Myklebust34f52e32007-06-14 16:40:31 -0400612 if (list_empty(&clnt->cl_tasks))
613 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400614 if (atomic_dec_and_test(&clnt->cl_count))
615 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400616}
617
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000618/**
619 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800620 * @old: old rpc_client
621 * @program: rpc program to set
622 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000623 *
624 * Clones the rpc client and sets up a new RPC program. This is mainly
625 * of use for enabling different RPC programs to share the same transport.
626 * The Sun NFSv2/v3 ACL protocol can do this.
627 */
628struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500629 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400630 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000631{
632 struct rpc_clnt *clnt;
Trond Myklebusta613fa12012-01-20 13:53:56 -0500633 const struct rpc_version *version;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000634 int err;
635
636 BUG_ON(vers >= program->nrvers || !program->version[vers]);
637 version = program->version[vers];
638 clnt = rpc_clone_client(old);
639 if (IS_ERR(clnt))
640 goto out;
641 clnt->cl_procinfo = version->procs;
642 clnt->cl_maxproc = version->nrprocs;
643 clnt->cl_protname = program->name;
644 clnt->cl_prog = program->number;
645 clnt->cl_vers = version->number;
646 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500647 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000648 if (err != 0) {
649 rpc_shutdown_client(clnt);
650 clnt = ERR_PTR(err);
651 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800652out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000653 return clnt;
654}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400655EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000656
Trond Myklebust58f96122010-07-31 14:29:08 -0400657void rpc_task_release_client(struct rpc_task *task)
658{
659 struct rpc_clnt *clnt = task->tk_client;
660
661 if (clnt != NULL) {
662 /* Remove from client task list */
663 spin_lock(&clnt->cl_lock);
664 list_del(&task->tk_task);
665 spin_unlock(&clnt->cl_lock);
666 task->tk_client = NULL;
667
668 rpc_release_client(clnt);
669 }
670}
671
672static
673void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
674{
675 if (clnt != NULL) {
676 rpc_task_release_client(task);
677 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400678 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400679 if (clnt->cl_softrtry)
680 task->tk_flags |= RPC_TASK_SOFT;
681 /* Add to the client's list of all tasks */
682 spin_lock(&clnt->cl_lock);
683 list_add_tail(&task->tk_task, &clnt->cl_tasks);
684 spin_unlock(&clnt->cl_lock);
685 }
686}
687
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000688void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
689{
690 rpc_task_release_client(task);
691 rpc_task_set_client(task, clnt);
692}
693EXPORT_SYMBOL_GPL(rpc_task_reset_client);
694
695
Trond Myklebust58f96122010-07-31 14:29:08 -0400696static void
697rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
698{
699 if (msg != NULL) {
700 task->tk_msg.rpc_proc = msg->rpc_proc;
701 task->tk_msg.rpc_argp = msg->rpc_argp;
702 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400703 if (msg->rpc_cred != NULL)
704 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400705 }
706}
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708/*
709 * Default callback for async RPC calls
710 */
711static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100712rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
714}
715
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100716static const struct rpc_call_ops rpc_default_ops = {
717 .rpc_call_done = rpc_default_callback,
718};
719
Trond Myklebustc970aa82007-07-14 15:39:59 -0400720/**
721 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
722 * @task_setup_data: pointer to task initialisation data
723 */
724struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400725{
Trond Myklebust19445b92010-04-16 16:41:10 -0400726 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400727
Trond Myklebust84115e12007-07-14 15:39:59 -0400728 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400729 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400730 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400731
Trond Myklebust58f96122010-07-31 14:29:08 -0400732 rpc_task_set_client(task, task_setup_data->rpc_client);
733 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
734
Trond Myklebust58f96122010-07-31 14:29:08 -0400735 if (task->tk_action == NULL)
736 rpc_call_start(task);
737
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400738 atomic_inc(&task->tk_count);
739 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400740out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400741 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400742}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400743EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400744
745/**
746 * rpc_call_sync - Perform a synchronous RPC call
747 * @clnt: pointer to RPC client
748 * @msg: RPC call parameters
749 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500751int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752{
753 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400754 struct rpc_task_setup task_setup_data = {
755 .rpc_client = clnt,
756 .rpc_message = msg,
757 .callback_ops = &rpc_default_ops,
758 .flags = flags,
759 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400760 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 BUG_ON(flags & RPC_TASK_ASYNC);
763
Trond Myklebustc970aa82007-07-14 15:39:59 -0400764 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400765 if (IS_ERR(task))
766 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100767 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800768 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 return status;
770}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400771EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400773/**
774 * rpc_call_async - Perform an asynchronous RPC call
775 * @clnt: pointer to RPC client
776 * @msg: RPC call parameters
777 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800778 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400779 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 */
781int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500782rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100783 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784{
785 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400786 struct rpc_task_setup task_setup_data = {
787 .rpc_client = clnt,
788 .rpc_message = msg,
789 .callback_ops = tk_ops,
790 .callback_data = data,
791 .flags = flags|RPC_TASK_ASYNC,
792 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Trond Myklebustc970aa82007-07-14 15:39:59 -0400794 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400795 if (IS_ERR(task))
796 return PTR_ERR(task);
797 rpc_put_task(task);
798 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400800EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400802#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400803/**
804 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
805 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400806 * @req: RPC request
807 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400808 */
809struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400810 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400811{
812 struct rpc_task *task;
813 struct xdr_buf *xbufp = &req->rq_snd_buf;
814 struct rpc_task_setup task_setup_data = {
815 .callback_ops = tk_ops,
816 };
817
818 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
819 /*
820 * Create an rpc_task to send the data
821 */
822 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400823 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400824 xprt_free_bc_request(req);
825 goto out;
826 }
827 task->tk_rqstp = req;
828
829 /*
830 * Set up the xdr_buf length.
831 * This also indicates that the buffer is XDR encoded already.
832 */
833 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
834 xbufp->tail[0].iov_len;
835
836 task->tk_action = call_bc_transmit;
837 atomic_inc(&task->tk_count);
838 BUG_ON(atomic_read(&task->tk_count) != 2);
839 rpc_execute(task);
840
841out:
842 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
843 return task;
844}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400845#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400846
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400848rpc_call_start(struct rpc_task *task)
849{
850 task->tk_action = call_start;
851}
852EXPORT_SYMBOL_GPL(rpc_call_start);
853
Chuck Levered394402006-08-22 20:06:17 -0400854/**
855 * rpc_peeraddr - extract remote peer address from clnt's xprt
856 * @clnt: RPC client structure
857 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800858 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400859 *
860 * Returns the number of bytes that are actually in the stored address.
861 */
862size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
863{
864 size_t bytes;
865 struct rpc_xprt *xprt = clnt->cl_xprt;
866
867 bytes = sizeof(xprt->addr);
868 if (bytes > bufsize)
869 bytes = bufsize;
870 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400871 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400872}
Chuck Leverb86acd52006-08-22 20:06:22 -0400873EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400874
Chuck Leverf425eba2006-08-22 20:06:18 -0400875/**
876 * rpc_peeraddr2str - return remote peer address in printable format
877 * @clnt: RPC client structure
878 * @format: address format
879 *
880 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500881const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
882 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400883{
884 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500885
886 if (xprt->address_strings[format] != NULL)
887 return xprt->address_strings[format];
888 else
889 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400890}
Chuck Leverb86acd52006-08-22 20:06:22 -0400891EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400892
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893void
894rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
895{
896 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700897 if (xprt->ops->set_buffer_size)
898 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400900EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
902/*
903 * Return size of largest payload RPC client can support, in bytes
904 *
905 * For stream transports, this is one RPC record fragment (see RFC
906 * 1831), as we don't support multi-record requests yet. For datagram
907 * transports, this is the size of an IP packet minus the IP, UDP, and
908 * RPC header sizes.
909 */
910size_t rpc_max_payload(struct rpc_clnt *clnt)
911{
912 return clnt->cl_xprt->max_payload;
913}
Chuck Leverb86acd52006-08-22 20:06:22 -0400914EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Chuck Lever35f5a422006-01-03 09:55:50 +0100916/**
917 * rpc_force_rebind - force transport to check that remote port is unchanged
918 * @clnt: client to rebind
919 *
920 */
921void rpc_force_rebind(struct rpc_clnt *clnt)
922{
923 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400924 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100925}
Chuck Leverb86acd52006-08-22 20:06:22 -0400926EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400929 * Restart an (async) RPC call from the call_prepare state.
930 * Usually called from within the exit handler.
931 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400932int
Andy Adamsonaae20062009-04-01 09:22:40 -0400933rpc_restart_call_prepare(struct rpc_task *task)
934{
935 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400936 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700937 task->tk_action = call_start;
938 if (task->tk_ops->rpc_call_prepare != NULL)
939 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400940 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400941}
942EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
943
944/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 * Restart an (async) RPC call. Usually called from within the
946 * exit handler.
947 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400948int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949rpc_restart_call(struct rpc_task *task)
950{
951 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400952 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400954 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400956EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Chuck Lever3748f1e2008-05-21 17:09:12 -0400958#ifdef RPC_DEBUG
959static const char *rpc_proc_name(const struct rpc_task *task)
960{
961 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
962
963 if (proc) {
964 if (proc->p_name)
965 return proc->p_name;
966 else
967 return "NULL";
968 } else
969 return "no proc";
970}
971#endif
972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973/*
974 * 0. Initial state
975 *
976 * Other FSM states can be visited zero or more times, but
977 * this state is visited exactly once for each RPC.
978 */
979static void
980call_start(struct rpc_task *task)
981{
982 struct rpc_clnt *clnt = task->tk_client;
983
Chuck Lever3748f1e2008-05-21 17:09:12 -0400984 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500985 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400986 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500987 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
989 /* Increment call count */
990 task->tk_msg.rpc_proc->p_count++;
991 clnt->cl_stats->rpccnt++;
992 task->tk_action = call_reserve;
993}
994
995/*
996 * 1. Reserve an RPC call slot
997 */
998static void
999call_reserve(struct rpc_task *task)
1000{
Chuck Lever46121cf2007-01-31 12:14:08 -05001001 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 task->tk_status = 0;
1004 task->tk_action = call_reserveresult;
1005 xprt_reserve(task);
1006}
1007
1008/*
1009 * 1b. Grok the result of xprt_reserve()
1010 */
1011static void
1012call_reserveresult(struct rpc_task *task)
1013{
1014 int status = task->tk_status;
1015
Chuck Lever46121cf2007-01-31 12:14:08 -05001016 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
1018 /*
1019 * After a call to xprt_reserve(), we must have either
1020 * a request slot or else an error status.
1021 */
1022 task->tk_status = 0;
1023 if (status >= 0) {
1024 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001025 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 return;
1027 }
1028
1029 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001030 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 rpc_exit(task, -EIO);
1032 return;
1033 }
1034
1035 /*
1036 * Even though there was an error, we may have acquired
1037 * a request slot somehow. Make sure not to leak it.
1038 */
1039 if (task->tk_rqstp) {
1040 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001041 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 xprt_release(task);
1043 }
1044
1045 switch (status) {
1046 case -EAGAIN: /* woken up; retry */
1047 task->tk_action = call_reserve;
1048 return;
1049 case -EIO: /* probably a shutdown */
1050 break;
1051 default:
1052 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001053 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 break;
1055 }
1056 rpc_exit(task, status);
1057}
1058
1059/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001060 * 2. Bind and/or refresh the credentials
1061 */
1062static void
1063call_refresh(struct rpc_task *task)
1064{
1065 dprint_status(task);
1066
1067 task->tk_action = call_refreshresult;
1068 task->tk_status = 0;
1069 task->tk_client->cl_stats->rpcauthrefresh++;
1070 rpcauth_refreshcred(task);
1071}
1072
1073/*
1074 * 2a. Process the results of a credential refresh
1075 */
1076static void
1077call_refreshresult(struct rpc_task *task)
1078{
1079 int status = task->tk_status;
1080
1081 dprint_status(task);
1082
1083 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001084 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001085 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001086 case 0:
1087 if (rpcauth_uptodatecred(task))
1088 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001089 return;
1090 case -ETIMEDOUT:
1091 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001092 case -EAGAIN:
1093 status = -EACCES;
1094 if (!task->tk_cred_retry)
1095 break;
1096 task->tk_cred_retry--;
1097 dprintk("RPC: %5u %s: retry refresh creds\n",
1098 task->tk_pid, __func__);
1099 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001100 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001101 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1102 task->tk_pid, __func__, status);
1103 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001104}
1105
1106/*
1107 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001108 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 */
1110static void
1111call_allocate(struct rpc_task *task)
1112{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001113 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001114 struct rpc_rqst *req = task->tk_rqstp;
1115 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001116 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Chuck Lever46121cf2007-01-31 12:14:08 -05001118 dprint_status(task);
1119
Chuck Lever2bea90d2007-03-29 16:47:53 -04001120 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001121 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001122
Chuck Lever02107142006-01-03 09:55:49 +01001123 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 return;
1125
Chuck Lever2bea90d2007-03-29 16:47:53 -04001126 if (proc->p_proc != 0) {
1127 BUG_ON(proc->p_arglen == 0);
1128 if (proc->p_decode != NULL)
1129 BUG_ON(proc->p_replen == 0);
1130 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131
Chuck Lever2bea90d2007-03-29 16:47:53 -04001132 /*
1133 * Calculate the size (in quads) of the RPC call
1134 * and reply headers, and convert both values
1135 * to byte sizes.
1136 */
1137 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1138 req->rq_callsize <<= 2;
1139 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1140 req->rq_rcvsize <<= 2;
1141
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001142 req->rq_buffer = xprt->ops->buf_alloc(task,
1143 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001144 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001146
1147 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Trond Myklebust5afa9132011-06-17 10:14:59 -04001149 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001150 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 rpc_delay(task, HZ>>4);
1152 return;
1153 }
1154
1155 rpc_exit(task, -ERESTARTSYS);
1156}
1157
Trond Myklebust940e3312005-11-09 21:45:24 -05001158static inline int
1159rpc_task_need_encode(struct rpc_task *task)
1160{
1161 return task->tk_rqstp->rq_snd_buf.len == 0;
1162}
1163
1164static inline void
1165rpc_task_force_reencode(struct rpc_task *task)
1166{
1167 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001168 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001169}
1170
Chuck Lever2bea90d2007-03-29 16:47:53 -04001171static inline void
1172rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1173{
1174 buf->head[0].iov_base = start;
1175 buf->head[0].iov_len = len;
1176 buf->tail[0].iov_len = 0;
1177 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001178 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001179 buf->len = 0;
1180 buf->buflen = len;
1181}
1182
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183/*
1184 * 3. Encode arguments of an RPC call
1185 */
1186static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001187rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001190 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001191 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Chuck Lever46121cf2007-01-31 12:14:08 -05001193 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Chuck Lever2bea90d2007-03-29 16:47:53 -04001195 rpc_xdr_buf_init(&req->rq_snd_buf,
1196 req->rq_buffer,
1197 req->rq_callsize);
1198 rpc_xdr_buf_init(&req->rq_rcv_buf,
1199 (char *)req->rq_buffer + req->rq_callsize,
1200 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Chuck Leverb0e1c572008-05-21 17:09:19 -04001202 p = rpc_encode_header(task);
1203 if (p == NULL) {
1204 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 rpc_exit(task, -EIO);
1206 return;
1207 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001208
1209 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001210 if (encode == NULL)
1211 return;
1212
1213 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1214 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215}
1216
1217/*
1218 * 4. Get the server port number if not yet set
1219 */
1220static void
1221call_bind(struct rpc_task *task)
1222{
Chuck Leverec739ef2006-08-22 20:06:15 -04001223 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
Chuck Lever46121cf2007-01-31 12:14:08 -05001225 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Chuck Leverda351872005-08-11 16:25:11 -04001227 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001228 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001229 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001230 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001231 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 }
1233}
1234
1235/*
Chuck Leverda351872005-08-11 16:25:11 -04001236 * 4a. Sort out bind result
1237 */
1238static void
1239call_bind_status(struct rpc_task *task)
1240{
Chuck Lever906462a2007-09-11 18:00:47 -04001241 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001242
1243 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001244 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001245 task->tk_status = 0;
1246 task->tk_action = call_connect;
1247 return;
1248 }
1249
1250 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001251 case -ENOMEM:
1252 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1253 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001254 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001255 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001256 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1257 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001258 /* fail immediately if this is an RPC ping */
1259 if (task->tk_msg.rpc_proc->p_proc == 0) {
1260 status = -EOPNOTSUPP;
1261 break;
1262 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001263 if (task->tk_rebind_retry == 0)
1264 break;
1265 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001266 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001267 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001268 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001269 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001270 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001271 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001272 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001273 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001274 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001275 task->tk_pid);
1276 break;
1277 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001278 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001279 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001280 task->tk_status = 0;
1281 task->tk_action = call_bind;
1282 return;
Chuck Lever012da152009-12-03 15:58:56 -05001283 case -ECONNREFUSED: /* connection problems */
1284 case -ECONNRESET:
1285 case -ENOTCONN:
1286 case -EHOSTDOWN:
1287 case -EHOSTUNREACH:
1288 case -ENETUNREACH:
1289 case -EPIPE:
1290 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1291 task->tk_pid, task->tk_status);
1292 if (!RPC_IS_SOFTCONN(task)) {
1293 rpc_delay(task, 5*HZ);
1294 goto retry_timeout;
1295 }
1296 status = task->tk_status;
1297 break;
Chuck Leverda351872005-08-11 16:25:11 -04001298 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001299 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001300 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001301 }
1302
1303 rpc_exit(task, status);
1304 return;
1305
Trond Myklebustda458282006-08-31 15:44:52 -04001306retry_timeout:
1307 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001308}
1309
1310/*
1311 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 */
1313static void
1314call_connect(struct rpc_task *task)
1315{
Chuck Leverda351872005-08-11 16:25:11 -04001316 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
Chuck Lever46121cf2007-01-31 12:14:08 -05001318 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001319 task->tk_pid, xprt,
1320 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
Chuck Leverda351872005-08-11 16:25:11 -04001322 task->tk_action = call_transmit;
1323 if (!xprt_connected(xprt)) {
1324 task->tk_action = call_connect_status;
1325 if (task->tk_status < 0)
1326 return;
1327 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329}
1330
1331/*
Chuck Leverda351872005-08-11 16:25:11 -04001332 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 */
1334static void
1335call_connect_status(struct rpc_task *task)
1336{
1337 struct rpc_clnt *clnt = task->tk_client;
1338 int status = task->tk_status;
1339
Chuck Lever46121cf2007-01-31 12:14:08 -05001340 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001343 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 clnt->cl_stats->netreconn++;
1345 task->tk_action = call_transmit;
1346 return;
1347 }
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001350 /* if soft mounted, test if we've timed out */
1351 case -ETIMEDOUT:
1352 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001353 break;
1354 default:
1355 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 }
1357}
1358
1359/*
1360 * 5. Transmit the RPC request, and wait for reply
1361 */
1362static void
1363call_transmit(struct rpc_task *task)
1364{
Chuck Lever46121cf2007-01-31 12:14:08 -05001365 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
1367 task->tk_action = call_status;
1368 if (task->tk_status < 0)
1369 return;
1370 task->tk_status = xprt_prepare_transmit(task);
1371 if (task->tk_status != 0)
1372 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001373 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001375 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001376 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001377 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001378 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001379 if (task->tk_status != 0) {
1380 /* Was the error nonfatal? */
1381 if (task->tk_status == -EAGAIN)
1382 rpc_delay(task, HZ >> 4);
1383 else
1384 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001385 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001386 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001387 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 xprt_transmit(task);
1389 if (task->tk_status < 0)
1390 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001391 /*
1392 * On success, ensure that we call xprt_end_transmit() before sleeping
1393 * in order to allow access to the socket to other RPC requests.
1394 */
1395 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001396 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001397 return;
1398 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001399 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001400}
1401
1402/*
1403 * 5a. Handle cleanup after a transmission
1404 */
1405static void
1406call_transmit_status(struct rpc_task *task)
1407{
1408 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001409
1410 /*
1411 * Common case: success. Force the compiler to put this
1412 * test first.
1413 */
1414 if (task->tk_status == 0) {
1415 xprt_end_transmit(task);
1416 rpc_task_force_reencode(task);
1417 return;
1418 }
1419
Trond Myklebust15f081c2009-03-11 14:37:57 -04001420 switch (task->tk_status) {
1421 case -EAGAIN:
1422 break;
1423 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001424 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001425 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001426 rpc_task_force_reencode(task);
1427 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001428 /*
1429 * Special cases: if we've been waiting on the
1430 * socket's write_space() callback, or if the
1431 * socket just returned a connection error,
1432 * then hold onto the transport lock.
1433 */
1434 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001435 case -EHOSTDOWN:
1436 case -EHOSTUNREACH:
1437 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001438 if (RPC_IS_SOFTCONN(task)) {
1439 xprt_end_transmit(task);
1440 rpc_exit(task, task->tk_status);
1441 break;
1442 }
1443 case -ECONNRESET:
1444 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001445 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001446 rpc_task_force_reencode(task);
1447 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448}
1449
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001450#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001451/*
1452 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1453 * addition, disconnect on connectivity errors.
1454 */
1455static void
1456call_bc_transmit(struct rpc_task *task)
1457{
1458 struct rpc_rqst *req = task->tk_rqstp;
1459
1460 BUG_ON(task->tk_status != 0);
1461 task->tk_status = xprt_prepare_transmit(task);
1462 if (task->tk_status == -EAGAIN) {
1463 /*
1464 * Could not reserve the transport. Try again after the
1465 * transport is released.
1466 */
1467 task->tk_status = 0;
1468 task->tk_action = call_bc_transmit;
1469 return;
1470 }
1471
1472 task->tk_action = rpc_exit_task;
1473 if (task->tk_status < 0) {
1474 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1475 "error: %d\n", task->tk_status);
1476 return;
1477 }
1478
1479 xprt_transmit(task);
1480 xprt_end_transmit(task);
1481 dprint_status(task);
1482 switch (task->tk_status) {
1483 case 0:
1484 /* Success */
1485 break;
1486 case -EHOSTDOWN:
1487 case -EHOSTUNREACH:
1488 case -ENETUNREACH:
1489 case -ETIMEDOUT:
1490 /*
1491 * Problem reaching the server. Disconnect and let the
1492 * forechannel reestablish the connection. The server will
1493 * have to retransmit the backchannel request and we'll
1494 * reprocess it. Since these ops are idempotent, there's no
1495 * need to cache our reply at this time.
1496 */
1497 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1498 "error: %d\n", task->tk_status);
1499 xprt_conditional_disconnect(task->tk_xprt,
1500 req->rq_connect_cookie);
1501 break;
1502 default:
1503 /*
1504 * We were unable to reply and will have to drop the
1505 * request. The server should reconnect and retransmit.
1506 */
1507 BUG_ON(task->tk_status == -EAGAIN);
1508 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1509 "error: %d\n", task->tk_status);
1510 break;
1511 }
1512 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1513}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001514#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001515
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516/*
1517 * 6. Sort out the RPC call status
1518 */
1519static void
1520call_status(struct rpc_task *task)
1521{
1522 struct rpc_clnt *clnt = task->tk_client;
1523 struct rpc_rqst *req = task->tk_rqstp;
1524 int status;
1525
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001526 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1527 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Chuck Lever46121cf2007-01-31 12:14:08 -05001529 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
1531 status = task->tk_status;
1532 if (status >= 0) {
1533 task->tk_action = call_decode;
1534 return;
1535 }
1536
1537 task->tk_status = 0;
1538 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001539 case -EHOSTDOWN:
1540 case -EHOSTUNREACH:
1541 case -ENETUNREACH:
1542 /*
1543 * Delay any retries for 3 seconds, then handle as if it
1544 * were a timeout.
1545 */
1546 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 case -ETIMEDOUT:
1548 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001549 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001550 xprt_conditional_disconnect(task->tk_xprt,
1551 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001553 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001555 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001556 rpc_delay(task, 3*HZ);
1557 case -EPIPE:
1558 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 task->tk_action = call_bind;
1560 break;
1561 case -EAGAIN:
1562 task->tk_action = call_transmit;
1563 break;
1564 case -EIO:
1565 /* shutdown or soft timeout */
1566 rpc_exit(task, status);
1567 break;
1568 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001569 if (clnt->cl_chatty)
1570 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 clnt->cl_protname, -status);
1572 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 }
1574}
1575
1576/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001577 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 * We do not release the request slot, so we keep using the
1579 * same XID for all retransmits.
1580 */
1581static void
1582call_timeout(struct rpc_task *task)
1583{
1584 struct rpc_clnt *clnt = task->tk_client;
1585
1586 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001587 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 goto retry;
1589 }
1590
Chuck Lever46121cf2007-01-31 12:14:08 -05001591 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001592 task->tk_timeouts++;
1593
Chuck Lever3a28bec2009-12-03 15:58:56 -05001594 if (RPC_IS_SOFTCONN(task)) {
1595 rpc_exit(task, -ETIMEDOUT);
1596 return;
1597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001599 if (clnt->cl_chatty)
1600 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001602 if (task->tk_flags & RPC_TASK_TIMEOUT)
1603 rpc_exit(task, -ETIMEDOUT);
1604 else
1605 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 return;
1607 }
1608
Chuck Leverf518e352006-01-03 09:55:52 +01001609 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001611 if (clnt->cl_chatty)
1612 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 clnt->cl_protname, clnt->cl_server);
1614 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001615 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001616 /*
1617 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1618 * event? RFC2203 requires the server to drop all such requests.
1619 */
1620 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
1622retry:
1623 clnt->cl_stats->rpcretrans++;
1624 task->tk_action = call_bind;
1625 task->tk_status = 0;
1626}
1627
1628/*
1629 * 7. Decode the RPC reply
1630 */
1631static void
1632call_decode(struct rpc_task *task)
1633{
1634 struct rpc_clnt *clnt = task->tk_client;
1635 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001636 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001637 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Vasily Averin726fd6a2011-06-01 16:23:59 +04001639 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640
Chuck Leverf518e352006-01-03 09:55:52 +01001641 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001642 if (clnt->cl_chatty)
1643 printk(KERN_NOTICE "%s: server %s OK\n",
1644 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1646 }
1647
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001648 /*
1649 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001650 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001651 */
1652 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 req->rq_rcv_buf.len = req->rq_private_buf.len;
1654
1655 /* Check that the softirq receive buffer is valid */
1656 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1657 sizeof(req->rq_rcv_buf)) != 0);
1658
Trond Myklebust1e799b62008-03-21 16:19:41 -04001659 if (req->rq_rcv_buf.len < 12) {
1660 if (!RPC_IS_SOFT(task)) {
1661 task->tk_action = call_bind;
1662 clnt->cl_stats->rpcretrans++;
1663 goto out_retry;
1664 }
1665 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1666 clnt->cl_protname, task->tk_status);
1667 task->tk_action = call_timeout;
1668 goto out_retry;
1669 }
1670
Chuck Leverb0e1c572008-05-21 17:09:19 -04001671 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001672 if (IS_ERR(p)) {
1673 if (p == ERR_PTR(-EAGAIN))
1674 goto out_retry;
1675 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 }
1677
Trond Myklebustabbcf282006-01-03 09:55:03 +01001678 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001680 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1682 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001683 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001684 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1685 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 return;
1687out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001689 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001690 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001691 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001692 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001693 xprt_conditional_disconnect(task->tk_xprt,
1694 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001695 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696}
1697
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001698static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001699rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700{
1701 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001703 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704
1705 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001706
1707 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 *p++ = req->rq_xid; /* XID */
1709 *p++ = htonl(RPC_CALL); /* CALL */
1710 *p++ = htonl(RPC_VERSION); /* RPC version */
1711 *p++ = htonl(clnt->cl_prog); /* program number */
1712 *p++ = htonl(clnt->cl_vers); /* program version */
1713 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001714 p = rpcauth_marshcred(task, p);
1715 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1716 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717}
1718
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001719static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001720rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721{
1722 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1723 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001724 __be32 *p = iov->iov_base;
1725 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 int error = -EACCES;
1727
David Howellse8896492006-08-24 15:44:19 -04001728 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1729 /* RFC-1014 says that the representation of XDR data must be a
1730 * multiple of four bytes
1731 * - if it isn't pointer subtraction in the NFS client may give
1732 * undefined results
1733 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001734 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001735 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001736 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001737 goto out_eio;
1738 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 if ((len -= 3) < 0)
1740 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001742 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001744 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001745 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001746 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001748
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1750 if (--len < 0)
1751 goto out_overflow;
1752 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001753 case RPC_AUTH_ERROR:
1754 break;
1755 case RPC_MISMATCH:
1756 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1757 task->tk_pid, __func__);
1758 error = -EPROTONOSUPPORT;
1759 goto out_err;
1760 default:
1761 dprintk("RPC: %5u %s: RPC call rejected, "
1762 "unknown error: %x\n",
1763 task->tk_pid, __func__, n);
1764 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 }
1766 if (--len < 0)
1767 goto out_overflow;
1768 switch ((n = ntohl(*p++))) {
1769 case RPC_AUTH_REJECTEDCRED:
1770 case RPC_AUTH_REJECTEDVERF:
1771 case RPCSEC_GSS_CREDPROBLEM:
1772 case RPCSEC_GSS_CTXPROBLEM:
1773 if (!task->tk_cred_retry)
1774 break;
1775 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001776 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001777 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001779 /* Ensure we obtain a new XID! */
1780 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001781 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001782 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 case RPC_AUTH_BADCRED:
1784 case RPC_AUTH_BADVERF:
1785 /* possibly garbled cred/verf? */
1786 if (!task->tk_garb_retry)
1787 break;
1788 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001789 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001790 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001792 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001794 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001795 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 break;
1797 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001798 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001799 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 error = -EIO;
1801 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001802 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001803 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 goto out_err;
1805 }
1806 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001807 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001808 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001809 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001811 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 if (len < 0)
1813 goto out_overflow;
1814 switch ((n = ntohl(*p++))) {
1815 case RPC_SUCCESS:
1816 return p;
1817 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001818 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001819 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 (unsigned int)task->tk_client->cl_prog,
1821 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001822 error = -EPFNOSUPPORT;
1823 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001825 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001826 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 (unsigned int)task->tk_client->cl_prog,
1828 (unsigned int)task->tk_client->cl_vers,
1829 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001830 error = -EPROTONOSUPPORT;
1831 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001833 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001834 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001835 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001836 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 task->tk_client->cl_prog,
1838 task->tk_client->cl_vers,
1839 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001840 error = -EOPNOTSUPP;
1841 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001843 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001844 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 break; /* retry */
1846 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001847 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001848 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 /* Also retry */
1850 }
1851
Trond Myklebustabbcf282006-01-03 09:55:03 +01001852out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 task->tk_client->cl_stats->rpcgarbage++;
1854 if (task->tk_garb_retry) {
1855 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001856 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001857 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001859out_retry:
1860 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862out_eio:
1863 error = -EIO;
1864out_err:
1865 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001866 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001867 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001868 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001870 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001871 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001872 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001874
Chuck Lever9f06c712010-12-14 14:59:18 +00001875static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001876{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001877}
1878
Chuck Leverbf269552010-12-14 14:59:29 +00001879static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001880{
1881 return 0;
1882}
1883
1884static struct rpc_procinfo rpcproc_null = {
1885 .p_encode = rpcproc_encode_null,
1886 .p_decode = rpcproc_decode_null,
1887};
1888
Chuck Levercaabea82009-12-03 15:58:56 -05001889static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001890{
1891 struct rpc_message msg = {
1892 .rpc_proc = &rpcproc_null,
1893 };
1894 int err;
1895 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001896 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001897 put_rpccred(msg.rpc_cred);
1898 return err;
1899}
Trond Myklebust188fef12007-06-16 14:18:40 -04001900
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001901struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1902{
1903 struct rpc_message msg = {
1904 .rpc_proc = &rpcproc_null,
1905 .rpc_cred = cred,
1906 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001907 struct rpc_task_setup task_setup_data = {
1908 .rpc_client = clnt,
1909 .rpc_message = &msg,
1910 .callback_ops = &rpc_default_ops,
1911 .flags = flags,
1912 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001913 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001914}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001915EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001916
Trond Myklebust188fef12007-06-16 14:18:40 -04001917#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001918static void rpc_show_header(void)
1919{
Chuck Levercb3997b2008-05-21 17:09:41 -04001920 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1921 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001922}
1923
Chuck Lever38e886e2008-05-21 17:09:33 -04001924static void rpc_show_task(const struct rpc_clnt *clnt,
1925 const struct rpc_task *task)
1926{
1927 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001928
1929 if (RPC_IS_QUEUED(task))
1930 rpc_waitq = rpc_qname(task->tk_waitqueue);
1931
Joe Perchesb3bceda2010-12-21 10:52:24 -05001932 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 -04001933 task->tk_pid, task->tk_flags, task->tk_status,
1934 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1935 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001936 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001937}
1938
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001939void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04001940{
1941 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001942 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001943 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001944 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04001945
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001946 spin_lock(&sn->rpc_client_lock);
1947 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001948 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001949 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001950 if (!header) {
1951 rpc_show_header();
1952 header++;
1953 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001954 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001955 }
1956 spin_unlock(&clnt->cl_lock);
1957 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001958 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001959}
1960#endif