blob: 6eb79c49c937828a14fbba129529d830a7ed1aa3 [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 *
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
19 *
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
22 */
23
24#include <asm/system.h>
25
26#include <linux/module.h>
27#include <linux/types.h>
28#include <linux/mm.h>
29#include <linux/slab.h>
Trond Myklebust6d5fcb52006-10-18 16:01:06 -040030#include <linux/smp_lock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050032#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050036#include <linux/sunrpc/metrics.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#ifdef RPC_DEBUG
40# define RPCDBG_FACILITY RPCDBG_CALL
41#endif
42
Chuck Lever46121cf2007-01-31 12:14:08 -050043#define dprint_status(t) \
44 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
45 __FUNCTION__, t->tk_status)
46
Trond Myklebust188fef12007-06-16 14:18:40 -040047/*
48 * All RPC clients are linked into this list
49 */
50static LIST_HEAD(all_clients);
51static DEFINE_SPINLOCK(rpc_client_lock);
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
54
55
56static void call_start(struct rpc_task *task);
57static void call_reserve(struct rpc_task *task);
58static void call_reserveresult(struct rpc_task *task);
59static void call_allocate(struct rpc_task *task);
60static void call_encode(struct rpc_task *task);
61static void call_decode(struct rpc_task *task);
62static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040063static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_transmit(struct rpc_task *task);
65static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050066static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_refresh(struct rpc_task *task);
68static void call_refreshresult(struct rpc_task *task);
69static void call_timeout(struct rpc_task *task);
70static void call_connect(struct rpc_task *task);
71static void call_connect_status(struct rpc_task *task);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070072static __be32 * call_header(struct rpc_task *task);
73static __be32 * call_verify(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Trond Myklebust64c91a12007-06-23 10:17:16 -040075static int rpc_ping(struct rpc_clnt *clnt, int flags);
76
Trond Myklebust188fef12007-06-16 14:18:40 -040077static void rpc_register_client(struct rpc_clnt *clnt)
78{
79 spin_lock(&rpc_client_lock);
80 list_add(&clnt->cl_clients, &all_clients);
81 spin_unlock(&rpc_client_lock);
82}
83
84static void rpc_unregister_client(struct rpc_clnt *clnt)
85{
86 spin_lock(&rpc_client_lock);
87 list_del(&clnt->cl_clients);
88 spin_unlock(&rpc_client_lock);
89}
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91static int
92rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
93{
Trond Myklebustf1345852005-09-23 11:08:25 -040094 static uint32_t clntid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 int error;
96
Trond Myklebust54281542006-03-20 13:44:49 -050097 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
98 clnt->cl_dentry = ERR_PTR(-ENOENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 if (dir_name == NULL)
100 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500101
102 clnt->cl_vfsmnt = rpc_get_mount();
103 if (IS_ERR(clnt->cl_vfsmnt))
104 return PTR_ERR(clnt->cl_vfsmnt);
105
Trond Myklebustf1345852005-09-23 11:08:25 -0400106 for (;;) {
107 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
108 "%s/clnt%x", dir_name,
109 (unsigned int)clntid++);
110 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
111 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
112 if (!IS_ERR(clnt->cl_dentry))
113 return 0;
Christoph Hellwig278c9952005-07-24 23:53:01 +0100114 error = PTR_ERR(clnt->cl_dentry);
Trond Myklebustf1345852005-09-23 11:08:25 -0400115 if (error != -EEXIST) {
116 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
117 clnt->cl_pathname, error);
Trond Myklebust54281542006-03-20 13:44:49 -0500118 rpc_put_mount();
Trond Myklebustf1345852005-09-23 11:08:25 -0400119 return error;
120 }
Christoph Hellwig278c9952005-07-24 23:53:01 +0100121 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122}
123
Chuck Leverff9aa5e2006-08-22 20:06:21 -0400124static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
126 struct rpc_version *version;
127 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000128 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400130 size_t len;
131
132 /* sanity check the name before trying to print it */
133 err = -EINVAL;
134 len = strlen(servname);
135 if (len > RPC_MAXNETNAMELEN)
136 goto out_no_rpciod;
137 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Chuck Lever46121cf2007-01-31 12:14:08 -0500139 dprintk("RPC: creating %s client for %s (xprt %p)\n",
140 program->name, servname, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Trond Myklebust4ada5392007-06-14 17:26:17 -0400142 err = rpciod_up();
143 if (err)
144 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 err = -EINVAL;
146 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800147 goto out_no_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 if (vers >= program->nrvers || !(version = program->version[vers]))
149 goto out_err;
150
151 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700152 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 if (!clnt)
154 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 clnt->cl_parent = clnt;
156
157 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 if (len > sizeof(clnt->cl_inline_name)) {
159 char *buf = kmalloc(len, GFP_KERNEL);
160 if (buf != 0)
161 clnt->cl_server = buf;
162 else
163 len = sizeof(clnt->cl_inline_name);
164 }
165 strlcpy(clnt->cl_server, servname, len);
166
167 clnt->cl_xprt = xprt;
168 clnt->cl_procinfo = version->procs;
169 clnt->cl_maxproc = version->nrprocs;
170 clnt->cl_protname = program->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 clnt->cl_prog = program->number;
172 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500174 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500175 err = -ENOMEM;
176 if (clnt->cl_metrics == NULL)
177 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500178 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400179 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400180 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Chuck Leverec739ef2006-08-22 20:06:15 -0400182 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 clnt->cl_autobind = 1;
184
185 clnt->cl_rtt = &clnt->cl_rtt_default;
186 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
187
Trond Myklebust34f52e32007-06-14 16:40:31 -0400188 kref_init(&clnt->cl_kref);
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
191 if (err < 0)
192 goto out_no_path;
193
J. Bruce Fields6a192752005-06-22 17:16:23 +0000194 auth = rpcauth_create(flavor, clnt);
195 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
197 flavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000198 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 goto out_no_auth;
200 }
201
202 /* save the nodename */
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700203 clnt->cl_nodelen = strlen(utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 if (clnt->cl_nodelen > UNX_MAXNODENAME)
205 clnt->cl_nodelen = UNX_MAXNODENAME;
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700206 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400207 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 return clnt;
209
210out_no_auth:
Trond Myklebust54281542006-03-20 13:44:49 -0500211 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700212 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust54281542006-03-20 13:44:49 -0500213 rpc_put_mount();
214 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500216 rpc_free_iostats(clnt->cl_metrics);
217out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 if (clnt->cl_server != clnt->cl_inline_name)
219 kfree(clnt->cl_server);
220 kfree(clnt);
221out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400222 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800223out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400224 rpciod_down();
225out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 return ERR_PTR(err);
227}
228
Chuck Leverc2866762006-08-22 20:06:20 -0400229/*
230 * rpc_create - create an RPC client and transport with one call
231 * @args: rpc_clnt create argument structure
232 *
233 * Creates and initializes an RPC transport and an RPC client.
234 *
235 * It can ping the server in order to determine if it is up, and to see if
236 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
237 * this behavior so asynchronous tasks can also use rpc_create.
238 */
239struct rpc_clnt *rpc_create(struct rpc_create_args *args)
240{
241 struct rpc_xprt *xprt;
242 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400243 struct xprt_create xprtargs = {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400244 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200245 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200246 .dstaddr = args->address,
247 .addrlen = args->addrsize,
248 .timeout = args->timeout
249 };
Chuck Lever43780b82007-07-01 12:13:22 -0400250 char servername[20];
Chuck Leverc2866762006-08-22 20:06:20 -0400251
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200252 xprt = xprt_create_transport(&xprtargs);
Chuck Leverc2866762006-08-22 20:06:20 -0400253 if (IS_ERR(xprt))
254 return (struct rpc_clnt *)xprt;
255
256 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400257 * If the caller chooses not to specify a hostname, whip
258 * up a string representation of the passed-in address.
259 */
260 if (args->servername == NULL) {
261 struct sockaddr_in *addr =
J. Bruce Fieldsafde94f2007-09-26 14:38:08 -0400262 (struct sockaddr_in *) args->address;
Chuck Lever43780b82007-07-01 12:13:22 -0400263 snprintf(servername, sizeof(servername), NIPQUAD_FMT,
264 NIPQUAD(addr->sin_addr.s_addr));
265 args->servername = servername;
266 }
267
268 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400269 * By default, kernel RPC client connects from a reserved port.
270 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
271 * but it is always enabled for rpciod, which handles the connect
272 * operation.
273 */
274 xprt->resvport = 1;
275 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
276 xprt->resvport = 0;
277
Chuck Leverc2866762006-08-22 20:06:20 -0400278 clnt = rpc_new_client(xprt, args->servername, args->program,
279 args->version, args->authflavor);
280 if (IS_ERR(clnt))
281 return clnt;
282
283 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
284 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
285 if (err != 0) {
286 rpc_shutdown_client(clnt);
287 return ERR_PTR(err);
288 }
289 }
290
291 clnt->cl_softrtry = 1;
292 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
293 clnt->cl_softrtry = 0;
294
295 if (args->flags & RPC_CLNT_CREATE_INTR)
296 clnt->cl_intr = 1;
297 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
298 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500299 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
300 clnt->cl_discrtry = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400301
302 return clnt;
303}
Chuck Leverb86acd52006-08-22 20:06:22 -0400304EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306/*
307 * This function clones the RPC client structure. It allows us to share the
308 * same transport while varying parameters such as the authentication
309 * flavour.
310 */
311struct rpc_clnt *
312rpc_clone_client(struct rpc_clnt *clnt)
313{
314 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500315 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200317 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 if (!new)
319 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400320 new->cl_parent = clnt;
321 /* Turn off autobind on clones */
322 new->cl_autobind = 0;
323 INIT_LIST_HEAD(&new->cl_tasks);
324 spin_lock_init(&new->cl_lock);
325 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500326 new->cl_metrics = rpc_alloc_iostats(clnt);
327 if (new->cl_metrics == NULL)
328 goto out_no_stats;
Trond Myklebust34f52e32007-06-14 16:40:31 -0400329 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500330 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
331 if (err != 0)
332 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 if (new->cl_auth)
334 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400335 xprt_get(clnt->cl_xprt);
336 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400337 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400338 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500340out_no_path:
341 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500342out_no_stats:
343 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344out_no_clnt:
Chuck Lever46121cf2007-01-31 12:14:08 -0500345 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500346 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400348EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350/*
351 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400352 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400354void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400356 dprintk("RPC: shutting down %s client for %s\n",
357 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Trond Myklebust34f52e32007-06-14 16:40:31 -0400359 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800361 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400362 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 }
364
Trond Myklebust4c402b42007-06-14 16:40:32 -0400365 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400367EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400370 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400372static void
373rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400375 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Chuck Lever46121cf2007-01-31 12:14:08 -0500377 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 clnt->cl_protname, clnt->cl_server);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400379 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700380 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400381 rpc_put_mount();
382 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500383 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400384 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500385 goto out_free;
386 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 if (clnt->cl_server != clnt->cl_inline_name)
388 kfree(clnt->cl_server);
389out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400390 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500391 rpc_free_iostats(clnt->cl_metrics);
392 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400393 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400394 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396}
397
398/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400399 * Free an RPC client
400 */
401static void
402rpc_free_auth(struct kref *kref)
403{
404 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
405
406 if (clnt->cl_auth == NULL) {
407 rpc_free_client(kref);
408 return;
409 }
410
411 /*
412 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
413 * release remaining GSS contexts. This mechanism ensures
414 * that it can do so safely.
415 */
416 kref_init(kref);
417 rpcauth_release(clnt->cl_auth);
418 clnt->cl_auth = NULL;
419 kref_put(kref, rpc_free_client);
420}
421
422/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400423 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 */
425void
426rpc_release_client(struct rpc_clnt *clnt)
427{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400428 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Trond Myklebust34f52e32007-06-14 16:40:31 -0400430 if (list_empty(&clnt->cl_tasks))
431 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400432 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400433}
434
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000435/**
436 * rpc_bind_new_program - bind a new RPC program to an existing client
437 * @old - old rpc_client
438 * @program - rpc program to set
439 * @vers - rpc program version
440 *
441 * Clones the rpc client and sets up a new RPC program. This is mainly
442 * of use for enabling different RPC programs to share the same transport.
443 * The Sun NFSv2/v3 ACL protocol can do this.
444 */
445struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
446 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400447 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000448{
449 struct rpc_clnt *clnt;
450 struct rpc_version *version;
451 int err;
452
453 BUG_ON(vers >= program->nrvers || !program->version[vers]);
454 version = program->version[vers];
455 clnt = rpc_clone_client(old);
456 if (IS_ERR(clnt))
457 goto out;
458 clnt->cl_procinfo = version->procs;
459 clnt->cl_maxproc = version->nrprocs;
460 clnt->cl_protname = program->name;
461 clnt->cl_prog = program->number;
462 clnt->cl_vers = version->number;
463 clnt->cl_stats = program->stats;
464 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
465 if (err != 0) {
466 rpc_shutdown_client(clnt);
467 clnt = ERR_PTR(err);
468 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800469out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000470 return clnt;
471}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400472EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474/*
475 * Default callback for async RPC calls
476 */
477static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100478rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
480}
481
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100482static const struct rpc_call_ops rpc_default_ops = {
483 .rpc_call_done = rpc_default_callback,
484};
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486/*
Trond Myklebust14b218a2005-06-22 17:16:28 +0000487 * Export the signal mask handling for synchronous code that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 * sleeps on RPC calls
489 */
Trond Myklebust2bd61572006-01-03 09:55:19 +0100490#define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800491
Trond Myklebust14b218a2005-06-22 17:16:28 +0000492static void rpc_save_sigmask(sigset_t *oldset, int intr)
493{
Trond Myklebust2bd61572006-01-03 09:55:19 +0100494 unsigned long sigallow = sigmask(SIGKILL);
Trond Myklebust14b218a2005-06-22 17:16:28 +0000495 sigset_t sigmask;
496
497 /* Block all signals except those listed in sigallow */
498 if (intr)
499 sigallow |= RPC_INTR_SIGNALS;
500 siginitsetinv(&sigmask, sigallow);
501 sigprocmask(SIG_BLOCK, &sigmask, oldset);
502}
503
Trond Myklebust50859252007-10-25 18:19:37 -0400504static void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
Trond Myklebust14b218a2005-06-22 17:16:28 +0000505{
506 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
507}
508
Trond Myklebust50859252007-10-25 18:19:37 -0400509static void rpc_restore_sigmask(sigset_t *oldset)
Trond Myklebust14b218a2005-06-22 17:16:28 +0000510{
511 sigprocmask(SIG_SETMASK, oldset, NULL);
512}
513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
515{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000516 rpc_save_sigmask(oldset, clnt->cl_intr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400518EXPORT_SYMBOL_GPL(rpc_clnt_sigmask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
520void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
521{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000522 rpc_restore_sigmask(oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400524EXPORT_SYMBOL_GPL(rpc_clnt_sigunmask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Trond Myklebustc970aa82007-07-14 15:39:59 -0400526/**
527 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
528 * @task_setup_data: pointer to task initialisation data
529 */
530struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400531{
532 struct rpc_task *task, *ret;
533 sigset_t oldset;
534
Trond Myklebust84115e12007-07-14 15:39:59 -0400535 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400536 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400537 rpc_release_calldata(task_setup_data->callback_ops,
538 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400539 ret = ERR_PTR(-ENOMEM);
540 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400541 }
542
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400543 if (task->tk_status != 0) {
544 ret = ERR_PTR(task->tk_status);
545 rpc_put_task(task);
546 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400547 }
548 atomic_inc(&task->tk_count);
Trond Myklebust50859252007-10-25 18:19:37 -0400549 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
550 rpc_task_sigmask(task, &oldset);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400551 rpc_execute(task);
Trond Myklebust50859252007-10-25 18:19:37 -0400552 rpc_restore_sigmask(&oldset);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400553 ret = task;
554out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400555 return ret;
556}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400557EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400558
559/**
560 * rpc_call_sync - Perform a synchronous RPC call
561 * @clnt: pointer to RPC client
562 * @msg: RPC call parameters
563 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
565int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
566{
567 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400568 struct rpc_task_setup task_setup_data = {
569 .rpc_client = clnt,
570 .rpc_message = msg,
571 .callback_ops = &rpc_default_ops,
572 .flags = flags,
573 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400574 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 BUG_ON(flags & RPC_TASK_ASYNC);
577
Trond Myklebustc970aa82007-07-14 15:39:59 -0400578 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400579 if (IS_ERR(task))
580 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100581 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800582 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 return status;
584}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400585EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400587/**
588 * rpc_call_async - Perform an asynchronous RPC call
589 * @clnt: pointer to RPC client
590 * @msg: RPC call parameters
591 * @flags: RPC call flags
592 * @ops: RPC call ops
593 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
595int
596rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100597 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
599 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400600 struct rpc_task_setup task_setup_data = {
601 .rpc_client = clnt,
602 .rpc_message = msg,
603 .callback_ops = tk_ops,
604 .callback_data = data,
605 .flags = flags|RPC_TASK_ASYNC,
606 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Trond Myklebustc970aa82007-07-14 15:39:59 -0400608 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400609 if (IS_ERR(task))
610 return PTR_ERR(task);
611 rpc_put_task(task);
612 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400614EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616void
Trond Myklebust84115e12007-07-14 15:39:59 -0400617rpc_call_setup(struct rpc_task *task, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
619 task->tk_msg = *msg;
620 task->tk_flags |= flags;
621 /* Bind the user cred */
622 if (task->tk_msg.rpc_cred != NULL)
623 rpcauth_holdcred(task);
624 else
625 rpcauth_bindcred(task);
626
627 if (task->tk_status == 0)
628 task->tk_action = call_start;
629 else
Trond Myklebustabbcf282006-01-03 09:55:03 +0100630 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400632EXPORT_SYMBOL_GPL(rpc_call_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Trond Myklebust77de2c52007-10-25 18:40:21 -0400634void
635rpc_call_start(struct rpc_task *task)
636{
637 task->tk_action = call_start;
638}
639EXPORT_SYMBOL_GPL(rpc_call_start);
640
Chuck Levered394402006-08-22 20:06:17 -0400641/**
642 * rpc_peeraddr - extract remote peer address from clnt's xprt
643 * @clnt: RPC client structure
644 * @buf: target buffer
645 * @size: length of target buffer
646 *
647 * Returns the number of bytes that are actually in the stored address.
648 */
649size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
650{
651 size_t bytes;
652 struct rpc_xprt *xprt = clnt->cl_xprt;
653
654 bytes = sizeof(xprt->addr);
655 if (bytes > bufsize)
656 bytes = bufsize;
657 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400658 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400659}
Chuck Leverb86acd52006-08-22 20:06:22 -0400660EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400661
Chuck Leverf425eba2006-08-22 20:06:18 -0400662/**
663 * rpc_peeraddr2str - return remote peer address in printable format
664 * @clnt: RPC client structure
665 * @format: address format
666 *
667 */
668char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
669{
670 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500671
672 if (xprt->address_strings[format] != NULL)
673 return xprt->address_strings[format];
674 else
675 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400676}
Chuck Leverb86acd52006-08-22 20:06:22 -0400677EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679void
680rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
681{
682 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700683 if (xprt->ops->set_buffer_size)
684 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400686EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
688/*
689 * Return size of largest payload RPC client can support, in bytes
690 *
691 * For stream transports, this is one RPC record fragment (see RFC
692 * 1831), as we don't support multi-record requests yet. For datagram
693 * transports, this is the size of an IP packet minus the IP, UDP, and
694 * RPC header sizes.
695 */
696size_t rpc_max_payload(struct rpc_clnt *clnt)
697{
698 return clnt->cl_xprt->max_payload;
699}
Chuck Leverb86acd52006-08-22 20:06:22 -0400700EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Chuck Lever35f5a422006-01-03 09:55:50 +0100702/**
703 * rpc_force_rebind - force transport to check that remote port is unchanged
704 * @clnt: client to rebind
705 *
706 */
707void rpc_force_rebind(struct rpc_clnt *clnt)
708{
709 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400710 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100711}
Chuck Leverb86acd52006-08-22 20:06:22 -0400712EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714/*
715 * Restart an (async) RPC call. Usually called from within the
716 * exit handler.
717 */
718void
719rpc_restart_call(struct rpc_task *task)
720{
721 if (RPC_ASSASSINATED(task))
722 return;
723
724 task->tk_action = call_start;
725}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400726EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
728/*
729 * 0. Initial state
730 *
731 * Other FSM states can be visited zero or more times, but
732 * this state is visited exactly once for each RPC.
733 */
734static void
735call_start(struct rpc_task *task)
736{
737 struct rpc_clnt *clnt = task->tk_client;
738
Chuck Lever46121cf2007-01-31 12:14:08 -0500739 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
740 clnt->cl_protname, clnt->cl_vers,
741 task->tk_msg.rpc_proc->p_proc,
742 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 /* Increment call count */
745 task->tk_msg.rpc_proc->p_count++;
746 clnt->cl_stats->rpccnt++;
747 task->tk_action = call_reserve;
748}
749
750/*
751 * 1. Reserve an RPC call slot
752 */
753static void
754call_reserve(struct rpc_task *task)
755{
Chuck Lever46121cf2007-01-31 12:14:08 -0500756 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
758 if (!rpcauth_uptodatecred(task)) {
759 task->tk_action = call_refresh;
760 return;
761 }
762
763 task->tk_status = 0;
764 task->tk_action = call_reserveresult;
765 xprt_reserve(task);
766}
767
768/*
769 * 1b. Grok the result of xprt_reserve()
770 */
771static void
772call_reserveresult(struct rpc_task *task)
773{
774 int status = task->tk_status;
775
Chuck Lever46121cf2007-01-31 12:14:08 -0500776 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778 /*
779 * After a call to xprt_reserve(), we must have either
780 * a request slot or else an error status.
781 */
782 task->tk_status = 0;
783 if (status >= 0) {
784 if (task->tk_rqstp) {
785 task->tk_action = call_allocate;
786 return;
787 }
788
789 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
790 __FUNCTION__, status);
791 rpc_exit(task, -EIO);
792 return;
793 }
794
795 /*
796 * Even though there was an error, we may have acquired
797 * a request slot somehow. Make sure not to leak it.
798 */
799 if (task->tk_rqstp) {
800 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
801 __FUNCTION__, status);
802 xprt_release(task);
803 }
804
805 switch (status) {
806 case -EAGAIN: /* woken up; retry */
807 task->tk_action = call_reserve;
808 return;
809 case -EIO: /* probably a shutdown */
810 break;
811 default:
812 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
813 __FUNCTION__, status);
814 break;
815 }
816 rpc_exit(task, status);
817}
818
819/*
820 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100821 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 */
823static void
824call_allocate(struct rpc_task *task)
825{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400826 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100827 struct rpc_rqst *req = task->tk_rqstp;
828 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400829 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Chuck Lever46121cf2007-01-31 12:14:08 -0500831 dprint_status(task);
832
Chuck Lever2bea90d2007-03-29 16:47:53 -0400833 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400835
Chuck Lever02107142006-01-03 09:55:49 +0100836 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 return;
838
Chuck Lever2bea90d2007-03-29 16:47:53 -0400839 if (proc->p_proc != 0) {
840 BUG_ON(proc->p_arglen == 0);
841 if (proc->p_decode != NULL)
842 BUG_ON(proc->p_replen == 0);
843 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Chuck Lever2bea90d2007-03-29 16:47:53 -0400845 /*
846 * Calculate the size (in quads) of the RPC call
847 * and reply headers, and convert both values
848 * to byte sizes.
849 */
850 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
851 req->rq_callsize <<= 2;
852 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
853 req->rq_rcvsize <<= 2;
854
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400855 req->rq_buffer = xprt->ops->buf_alloc(task,
856 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400857 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500859
860 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Trond Myklebust14b218a2005-06-22 17:16:28 +0000862 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400863 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 rpc_delay(task, HZ>>4);
865 return;
866 }
867
868 rpc_exit(task, -ERESTARTSYS);
869}
870
Trond Myklebust940e3312005-11-09 21:45:24 -0500871static inline int
872rpc_task_need_encode(struct rpc_task *task)
873{
874 return task->tk_rqstp->rq_snd_buf.len == 0;
875}
876
877static inline void
878rpc_task_force_reencode(struct rpc_task *task)
879{
880 task->tk_rqstp->rq_snd_buf.len = 0;
881}
882
Chuck Lever2bea90d2007-03-29 16:47:53 -0400883static inline void
884rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
885{
886 buf->head[0].iov_base = start;
887 buf->head[0].iov_len = len;
888 buf->tail[0].iov_len = 0;
889 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400890 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400891 buf->len = 0;
892 buf->buflen = len;
893}
894
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895/*
896 * 3. Encode arguments of an RPC call
897 */
898static void
899call_encode(struct rpc_task *task)
900{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700903 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Chuck Lever46121cf2007-01-31 12:14:08 -0500905 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Chuck Lever2bea90d2007-03-29 16:47:53 -0400907 rpc_xdr_buf_init(&req->rq_snd_buf,
908 req->rq_buffer,
909 req->rq_callsize);
910 rpc_xdr_buf_init(&req->rq_rcv_buf,
911 (char *)req->rq_buffer + req->rq_callsize,
912 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914 /* Encode header and provided arguments */
915 encode = task->tk_msg.rpc_proc->p_encode;
916 if (!(p = call_header(task))) {
917 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
918 rpc_exit(task, -EIO);
919 return;
920 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400921 if (encode == NULL)
922 return;
923
924 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
925 task->tk_msg.rpc_argp);
926 if (task->tk_status == -ENOMEM) {
927 /* XXX: Is this sane? */
928 rpc_delay(task, 3*HZ);
929 task->tk_status = -EAGAIN;
930 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
933/*
934 * 4. Get the server port number if not yet set
935 */
936static void
937call_bind(struct rpc_task *task)
938{
Chuck Leverec739ef2006-08-22 20:06:15 -0400939 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Chuck Lever46121cf2007-01-31 12:14:08 -0500941 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
Chuck Leverda351872005-08-11 16:25:11 -0400943 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400944 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400945 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400946 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400947 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 }
949}
950
951/*
Chuck Leverda351872005-08-11 16:25:11 -0400952 * 4a. Sort out bind result
953 */
954static void
955call_bind_status(struct rpc_task *task)
956{
Chuck Lever906462a2007-09-11 18:00:47 -0400957 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400958
959 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500960 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400961 task->tk_status = 0;
962 task->tk_action = call_connect;
963 return;
964 }
965
966 switch (task->tk_status) {
Chuck Lever2429cbf2007-09-11 18:00:41 -0400967 case -EAGAIN:
968 dprintk("RPC: %5u rpcbind waiting for another request "
969 "to finish\n", task->tk_pid);
970 /* avoid busy-waiting here -- could be a network outage. */
971 rpc_delay(task, 5*HZ);
972 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400973 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500974 dprintk("RPC: %5u remote rpcbind: RPC program/version "
975 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400976 /* fail immediately if this is an RPC ping */
977 if (task->tk_msg.rpc_proc->p_proc == 0) {
978 status = -EOPNOTSUPP;
979 break;
980 }
Chuck Leverea635a52005-10-06 23:12:58 -0400981 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400982 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400983 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500984 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400985 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400986 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400987 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -0400988 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -0500989 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400990 task->tk_pid);
991 break;
992 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400993 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400994 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400995 task->tk_status = 0;
996 task->tk_action = call_bind;
997 return;
Chuck Leverda351872005-08-11 16:25:11 -0400998 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500999 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001000 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001001 }
1002
1003 rpc_exit(task, status);
1004 return;
1005
Trond Myklebustda458282006-08-31 15:44:52 -04001006retry_timeout:
1007 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001008}
1009
1010/*
1011 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 */
1013static void
1014call_connect(struct rpc_task *task)
1015{
Chuck Leverda351872005-08-11 16:25:11 -04001016 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Chuck Lever46121cf2007-01-31 12:14:08 -05001018 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001019 task->tk_pid, xprt,
1020 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
Chuck Leverda351872005-08-11 16:25:11 -04001022 task->tk_action = call_transmit;
1023 if (!xprt_connected(xprt)) {
1024 task->tk_action = call_connect_status;
1025 if (task->tk_status < 0)
1026 return;
1027 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029}
1030
1031/*
Chuck Leverda351872005-08-11 16:25:11 -04001032 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 */
1034static void
1035call_connect_status(struct rpc_task *task)
1036{
1037 struct rpc_clnt *clnt = task->tk_client;
1038 int status = task->tk_status;
1039
Chuck Lever46121cf2007-01-31 12:14:08 -05001040 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001041
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 task->tk_status = 0;
1043 if (status >= 0) {
1044 clnt->cl_stats->netreconn++;
1045 task->tk_action = call_transmit;
1046 return;
1047 }
1048
Chuck Leverda351872005-08-11 16:25:11 -04001049 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001050 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001051
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 switch (status) {
1053 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001055 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001056 if (!RPC_IS_SOFT(task))
1057 return;
1058 /* if soft mounted, test if we've timed out */
1059 case -ETIMEDOUT:
1060 task->tk_action = call_timeout;
1061 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 }
Trond Myklebustda458282006-08-31 15:44:52 -04001063 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064}
1065
1066/*
1067 * 5. Transmit the RPC request, and wait for reply
1068 */
1069static void
1070call_transmit(struct rpc_task *task)
1071{
Chuck Lever46121cf2007-01-31 12:14:08 -05001072 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
1074 task->tk_action = call_status;
1075 if (task->tk_status < 0)
1076 return;
1077 task->tk_status = xprt_prepare_transmit(task);
1078 if (task->tk_status != 0)
1079 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001080 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001082 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001083 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001085 /* Did the encode result in an error condition? */
1086 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001087 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001088 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 xprt_transmit(task);
1090 if (task->tk_status < 0)
1091 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001092 /*
1093 * On success, ensure that we call xprt_end_transmit() before sleeping
1094 * in order to allow access to the socket to other RPC requests.
1095 */
1096 call_transmit_status(task);
1097 if (task->tk_msg.rpc_proc->p_decode != NULL)
1098 return;
1099 task->tk_action = rpc_exit_task;
1100 rpc_wake_up_task(task);
1101}
1102
1103/*
1104 * 5a. Handle cleanup after a transmission
1105 */
1106static void
1107call_transmit_status(struct rpc_task *task)
1108{
1109 task->tk_action = call_status;
1110 /*
1111 * Special case: if we've been waiting on the socket's write_space()
1112 * callback, then don't call xprt_end_transmit().
1113 */
1114 if (task->tk_status == -EAGAIN)
1115 return;
1116 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001117 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118}
1119
1120/*
1121 * 6. Sort out the RPC call status
1122 */
1123static void
1124call_status(struct rpc_task *task)
1125{
1126 struct rpc_clnt *clnt = task->tk_client;
1127 struct rpc_rqst *req = task->tk_rqstp;
1128 int status;
1129
1130 if (req->rq_received > 0 && !req->rq_bytes_sent)
1131 task->tk_status = req->rq_received;
1132
Chuck Lever46121cf2007-01-31 12:14:08 -05001133 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
1135 status = task->tk_status;
1136 if (status >= 0) {
1137 task->tk_action = call_decode;
1138 return;
1139 }
1140
1141 task->tk_status = 0;
1142 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001143 case -EHOSTDOWN:
1144 case -EHOSTUNREACH:
1145 case -ENETUNREACH:
1146 /*
1147 * Delay any retries for 3 seconds, then handle as if it
1148 * were a timeout.
1149 */
1150 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 case -ETIMEDOUT:
1152 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001153 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001154 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 break;
1156 case -ECONNREFUSED:
1157 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001158 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 task->tk_action = call_bind;
1160 break;
1161 case -EAGAIN:
1162 task->tk_action = call_transmit;
1163 break;
1164 case -EIO:
1165 /* shutdown or soft timeout */
1166 rpc_exit(task, status);
1167 break;
1168 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001169 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 clnt->cl_protname, -status);
1171 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 }
1173}
1174
1175/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001176 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 * We do not release the request slot, so we keep using the
1178 * same XID for all retransmits.
1179 */
1180static void
1181call_timeout(struct rpc_task *task)
1182{
1183 struct rpc_clnt *clnt = task->tk_client;
1184
1185 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001186 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 goto retry;
1188 }
1189
Chuck Lever46121cf2007-01-31 12:14:08 -05001190 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001191 task->tk_timeouts++;
1192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001194 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 clnt->cl_protname, clnt->cl_server);
1196 rpc_exit(task, -EIO);
1197 return;
1198 }
1199
Chuck Leverf518e35a2006-01-03 09:55:52 +01001200 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 task->tk_flags |= RPC_CALL_MAJORSEEN;
1202 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1203 clnt->cl_protname, clnt->cl_server);
1204 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001205 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
1207retry:
1208 clnt->cl_stats->rpcretrans++;
1209 task->tk_action = call_bind;
1210 task->tk_status = 0;
1211}
1212
1213/*
1214 * 7. Decode the RPC reply
1215 */
1216static void
1217call_decode(struct rpc_task *task)
1218{
1219 struct rpc_clnt *clnt = task->tk_client;
1220 struct rpc_rqst *req = task->tk_rqstp;
1221 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001222 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
Chuck Lever46121cf2007-01-31 12:14:08 -05001224 dprintk("RPC: %5u call_decode (status %d)\n",
1225 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Chuck Leverf518e35a2006-01-03 09:55:52 +01001227 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 printk(KERN_NOTICE "%s: server %s OK\n",
1229 clnt->cl_protname, clnt->cl_server);
1230 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1231 }
1232
1233 if (task->tk_status < 12) {
1234 if (!RPC_IS_SOFT(task)) {
1235 task->tk_action = call_bind;
1236 clnt->cl_stats->rpcretrans++;
1237 goto out_retry;
1238 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001239 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1240 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001241 task->tk_action = call_timeout;
1242 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 }
1244
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001245 /*
1246 * Ensure that we see all writes made by xprt_complete_rqst()
1247 * before it changed req->rq_received.
1248 */
1249 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 req->rq_rcv_buf.len = req->rq_private_buf.len;
1251
1252 /* Check that the softirq receive buffer is valid */
1253 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1254 sizeof(req->rq_rcv_buf)) != 0);
1255
1256 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001257 p = call_verify(task);
1258 if (IS_ERR(p)) {
1259 if (p == ERR_PTR(-EAGAIN))
1260 goto out_retry;
1261 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
1263
Trond Myklebustabbcf282006-01-03 09:55:03 +01001264 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001266 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1268 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001269 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001270 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1271 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 return;
1273out_retry:
1274 req->rq_received = req->rq_private_buf.len = 0;
1275 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001276 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001277 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278}
1279
1280/*
1281 * 8. Refresh the credentials if rejected by the server
1282 */
1283static void
1284call_refresh(struct rpc_task *task)
1285{
Chuck Lever46121cf2007-01-31 12:14:08 -05001286 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 task->tk_action = call_refreshresult;
1289 task->tk_status = 0;
1290 task->tk_client->cl_stats->rpcauthrefresh++;
1291 rpcauth_refreshcred(task);
1292}
1293
1294/*
1295 * 8a. Process the results of a credential refresh
1296 */
1297static void
1298call_refreshresult(struct rpc_task *task)
1299{
1300 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001301
1302 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
1304 task->tk_status = 0;
1305 task->tk_action = call_reserve;
1306 if (status >= 0 && rpcauth_uptodatecred(task))
1307 return;
1308 if (status == -EACCES) {
1309 rpc_exit(task, -EACCES);
1310 return;
1311 }
1312 task->tk_action = call_refresh;
1313 if (status != -ETIMEDOUT)
1314 rpc_delay(task, 3*HZ);
1315 return;
1316}
1317
1318/*
1319 * Call header serialization
1320 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001321static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322call_header(struct rpc_task *task)
1323{
1324 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001326 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
1328 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001329
1330 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 *p++ = req->rq_xid; /* XID */
1332 *p++ = htonl(RPC_CALL); /* CALL */
1333 *p++ = htonl(RPC_VERSION); /* RPC version */
1334 *p++ = htonl(clnt->cl_prog); /* program number */
1335 *p++ = htonl(clnt->cl_vers); /* program version */
1336 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001337 p = rpcauth_marshcred(task, p);
1338 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1339 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340}
1341
1342/*
1343 * Reply header verification
1344 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001345static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346call_verify(struct rpc_task *task)
1347{
1348 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1349 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001350 __be32 *p = iov->iov_base;
1351 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 int error = -EACCES;
1353
David Howellse8896492006-08-24 15:44:19 -04001354 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1355 /* RFC-1014 says that the representation of XDR data must be a
1356 * multiple of four bytes
1357 * - if it isn't pointer subtraction in the NFS client may give
1358 * undefined results
1359 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001360 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1361 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1362 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001363 goto out_eio;
1364 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 if ((len -= 3) < 0)
1366 goto out_overflow;
1367 p += 1; /* skip XID */
1368
1369 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001370 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1371 task->tk_pid, __FUNCTION__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001372 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
1374 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1375 if (--len < 0)
1376 goto out_overflow;
1377 switch ((n = ntohl(*p++))) {
1378 case RPC_AUTH_ERROR:
1379 break;
1380 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001381 dprintk("RPC: %5u %s: RPC call version "
1382 "mismatch!\n",
1383 task->tk_pid, __FUNCTION__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001384 error = -EPROTONOSUPPORT;
1385 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001387 dprintk("RPC: %5u %s: RPC call rejected, "
1388 "unknown error: %x\n",
1389 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 goto out_eio;
1391 }
1392 if (--len < 0)
1393 goto out_overflow;
1394 switch ((n = ntohl(*p++))) {
1395 case RPC_AUTH_REJECTEDCRED:
1396 case RPC_AUTH_REJECTEDVERF:
1397 case RPCSEC_GSS_CREDPROBLEM:
1398 case RPCSEC_GSS_CTXPROBLEM:
1399 if (!task->tk_cred_retry)
1400 break;
1401 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001402 dprintk("RPC: %5u %s: retry stale creds\n",
1403 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001405 /* Ensure we obtain a new XID! */
1406 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001408 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 case RPC_AUTH_BADCRED:
1410 case RPC_AUTH_BADVERF:
1411 /* possibly garbled cred/verf? */
1412 if (!task->tk_garb_retry)
1413 break;
1414 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001415 dprintk("RPC: %5u %s: retry garbled creds\n",
1416 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001418 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001420 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1421 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 break;
1423 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001424 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1425 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 error = -EIO;
1427 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001428 dprintk("RPC: %5u %s: call rejected %d\n",
1429 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 goto out_err;
1431 }
1432 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001433 dprintk("RPC: %5u %s: auth check failed\n",
1434 task->tk_pid, __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001435 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001437 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 if (len < 0)
1439 goto out_overflow;
1440 switch ((n = ntohl(*p++))) {
1441 case RPC_SUCCESS:
1442 return p;
1443 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001444 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1445 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 (unsigned int)task->tk_client->cl_prog,
1447 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001448 error = -EPFNOSUPPORT;
1449 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001451 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1452 "server %s\n", task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 (unsigned int)task->tk_client->cl_prog,
1454 (unsigned int)task->tk_client->cl_vers,
1455 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001456 error = -EPROTONOSUPPORT;
1457 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001459 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1460 "version %u on server %s\n",
1461 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 task->tk_msg.rpc_proc,
1463 task->tk_client->cl_prog,
1464 task->tk_client->cl_vers,
1465 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001466 error = -EOPNOTSUPP;
1467 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001469 dprintk("RPC: %5u %s: server saw garbage\n",
1470 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 break; /* retry */
1472 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001473 dprintk("RPC: %5u %s: server accept status: %x\n",
1474 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 /* Also retry */
1476 }
1477
Trond Myklebustabbcf282006-01-03 09:55:03 +01001478out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 task->tk_client->cl_stats->rpcgarbage++;
1480 if (task->tk_garb_retry) {
1481 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001482 dprintk("RPC: %5u %s: retrying\n",
1483 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001485out_retry:
1486 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488out_eio:
1489 error = -EIO;
1490out_err:
1491 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001492 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1493 __FUNCTION__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001494 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001496 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1497 __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001498 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001500
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001501static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001502{
1503 return 0;
1504}
1505
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001506static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001507{
1508 return 0;
1509}
1510
1511static struct rpc_procinfo rpcproc_null = {
1512 .p_encode = rpcproc_encode_null,
1513 .p_decode = rpcproc_decode_null,
1514};
1515
Trond Myklebust64c91a12007-06-23 10:17:16 -04001516static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001517{
1518 struct rpc_message msg = {
1519 .rpc_proc = &rpcproc_null,
1520 };
1521 int err;
1522 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1523 err = rpc_call_sync(clnt, &msg, flags);
1524 put_rpccred(msg.rpc_cred);
1525 return err;
1526}
Trond Myklebust188fef12007-06-16 14:18:40 -04001527
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001528struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1529{
1530 struct rpc_message msg = {
1531 .rpc_proc = &rpcproc_null,
1532 .rpc_cred = cred,
1533 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001534 struct rpc_task_setup task_setup_data = {
1535 .rpc_client = clnt,
1536 .rpc_message = &msg,
1537 .callback_ops = &rpc_default_ops,
1538 .flags = flags,
1539 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001540 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001541}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001542EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001543
Trond Myklebust188fef12007-06-16 14:18:40 -04001544#ifdef RPC_DEBUG
1545void rpc_show_tasks(void)
1546{
1547 struct rpc_clnt *clnt;
1548 struct rpc_task *t;
1549
1550 spin_lock(&rpc_client_lock);
1551 if (list_empty(&all_clients))
1552 goto out;
1553 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1554 "-rpcwait -action- ---ops--\n");
1555 list_for_each_entry(clnt, &all_clients, cl_clients) {
1556 if (list_empty(&clnt->cl_tasks))
1557 continue;
1558 spin_lock(&clnt->cl_lock);
1559 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1560 const char *rpc_waitq = "none";
Chuck Leverd66968f2007-09-11 18:00:25 -04001561 int proc;
1562
1563 if (t->tk_msg.rpc_proc)
1564 proc = t->tk_msg.rpc_proc->p_proc;
1565 else
1566 proc = -1;
Trond Myklebust188fef12007-06-16 14:18:40 -04001567
1568 if (RPC_IS_QUEUED(t))
1569 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1570
1571 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
Chuck Leverd66968f2007-09-11 18:00:25 -04001572 t->tk_pid, proc,
Trond Myklebust188fef12007-06-16 14:18:40 -04001573 t->tk_flags, t->tk_status,
1574 t->tk_client,
1575 (t->tk_client ? t->tk_client->cl_prog : 0),
1576 t->tk_rqstp, t->tk_timeout,
1577 rpc_waitq,
1578 t->tk_action, t->tk_ops);
1579 }
1580 spin_unlock(&clnt->cl_lock);
1581 }
1582out:
1583 spin_unlock(&rpc_client_lock);
1584}
1585#endif