blob: 76be83ee4b04a59f90f99a3afc69ce8889a7ff39 [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}
348
349/*
350 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400351 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400353void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400355 dprintk("RPC: shutting down %s client for %s\n",
356 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Trond Myklebust34f52e32007-06-14 16:40:31 -0400358 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800360 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400361 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 }
363
Trond Myklebust4c402b42007-06-14 16:40:32 -0400364 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365}
366
367/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400368 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400370static void
371rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400373 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Chuck Lever46121cf2007-01-31 12:14:08 -0500375 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 clnt->cl_protname, clnt->cl_server);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400377 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700378 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400379 rpc_put_mount();
380 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500381 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400382 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500383 goto out_free;
384 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (clnt->cl_server != clnt->cl_inline_name)
386 kfree(clnt->cl_server);
387out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400388 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500389 rpc_free_iostats(clnt->cl_metrics);
390 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400391 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400392 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394}
395
396/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400397 * Free an RPC client
398 */
399static void
400rpc_free_auth(struct kref *kref)
401{
402 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
403
404 if (clnt->cl_auth == NULL) {
405 rpc_free_client(kref);
406 return;
407 }
408
409 /*
410 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
411 * release remaining GSS contexts. This mechanism ensures
412 * that it can do so safely.
413 */
414 kref_init(kref);
415 rpcauth_release(clnt->cl_auth);
416 clnt->cl_auth = NULL;
417 kref_put(kref, rpc_free_client);
418}
419
420/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400421 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 */
423void
424rpc_release_client(struct rpc_clnt *clnt)
425{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400426 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Trond Myklebust34f52e32007-06-14 16:40:31 -0400428 if (list_empty(&clnt->cl_tasks))
429 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400430 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400431}
432
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000433/**
434 * rpc_bind_new_program - bind a new RPC program to an existing client
435 * @old - old rpc_client
436 * @program - rpc program to set
437 * @vers - rpc program version
438 *
439 * Clones the rpc client and sets up a new RPC program. This is mainly
440 * of use for enabling different RPC programs to share the same transport.
441 * The Sun NFSv2/v3 ACL protocol can do this.
442 */
443struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
444 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400445 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000446{
447 struct rpc_clnt *clnt;
448 struct rpc_version *version;
449 int err;
450
451 BUG_ON(vers >= program->nrvers || !program->version[vers]);
452 version = program->version[vers];
453 clnt = rpc_clone_client(old);
454 if (IS_ERR(clnt))
455 goto out;
456 clnt->cl_procinfo = version->procs;
457 clnt->cl_maxproc = version->nrprocs;
458 clnt->cl_protname = program->name;
459 clnt->cl_prog = program->number;
460 clnt->cl_vers = version->number;
461 clnt->cl_stats = program->stats;
462 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
463 if (err != 0) {
464 rpc_shutdown_client(clnt);
465 clnt = ERR_PTR(err);
466 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800467out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000468 return clnt;
469}
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471/*
472 * Default callback for async RPC calls
473 */
474static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100475rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476{
477}
478
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100479static const struct rpc_call_ops rpc_default_ops = {
480 .rpc_call_done = rpc_default_callback,
481};
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483/*
Trond Myklebust14b218a2005-06-22 17:16:28 +0000484 * Export the signal mask handling for synchronous code that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 * sleeps on RPC calls
486 */
Trond Myklebust2bd61572006-01-03 09:55:19 +0100487#define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800488
Trond Myklebust14b218a2005-06-22 17:16:28 +0000489static void rpc_save_sigmask(sigset_t *oldset, int intr)
490{
Trond Myklebust2bd61572006-01-03 09:55:19 +0100491 unsigned long sigallow = sigmask(SIGKILL);
Trond Myklebust14b218a2005-06-22 17:16:28 +0000492 sigset_t sigmask;
493
494 /* Block all signals except those listed in sigallow */
495 if (intr)
496 sigallow |= RPC_INTR_SIGNALS;
497 siginitsetinv(&sigmask, sigallow);
498 sigprocmask(SIG_BLOCK, &sigmask, oldset);
499}
500
501static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
502{
503 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
504}
505
506static inline void rpc_restore_sigmask(sigset_t *oldset)
507{
508 sigprocmask(SIG_SETMASK, oldset, NULL);
509}
510
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
512{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000513 rpc_save_sigmask(oldset, clnt->cl_intr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514}
515
516void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
517{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000518 rpc_restore_sigmask(oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519}
520
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400521static
522struct rpc_task *rpc_do_run_task(struct rpc_clnt *clnt,
523 struct rpc_message *msg,
524 int flags,
525 const struct rpc_call_ops *ops,
526 void *data)
527{
528 struct rpc_task *task, *ret;
529 sigset_t oldset;
530
531 task = rpc_new_task(clnt, flags, ops, data);
532 if (task == NULL) {
533 rpc_release_calldata(ops, data);
534 return ERR_PTR(-ENOMEM);
535 }
536
537 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
538 rpc_task_sigmask(task, &oldset);
539 if (msg != NULL) {
540 rpc_call_setup(task, msg, 0);
541 if (task->tk_status != 0) {
542 ret = ERR_PTR(task->tk_status);
543 rpc_put_task(task);
544 goto out;
545 }
546 }
547 atomic_inc(&task->tk_count);
548 rpc_execute(task);
549 ret = task;
550out:
551 rpc_restore_sigmask(&oldset);
552 return ret;
553}
554
555/**
556 * rpc_call_sync - Perform a synchronous RPC call
557 * @clnt: pointer to RPC client
558 * @msg: RPC call parameters
559 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 */
561int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
562{
563 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400564 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 BUG_ON(flags & RPC_TASK_ASYNC);
567
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400568 task = rpc_do_run_task(clnt, msg, flags, &rpc_default_ops, NULL);
569 if (IS_ERR(task))
570 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100571 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800572 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 return status;
574}
575
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400576/**
577 * rpc_call_async - Perform an asynchronous RPC call
578 * @clnt: pointer to RPC client
579 * @msg: RPC call parameters
580 * @flags: RPC call flags
581 * @ops: RPC call ops
582 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 */
584int
585rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100586 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
588 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400590 task = rpc_do_run_task(clnt, msg, flags|RPC_TASK_ASYNC, tk_ops, data);
591 if (IS_ERR(task))
592 return PTR_ERR(task);
593 rpc_put_task(task);
594 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595}
596
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400597/**
598 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
599 * @clnt: pointer to RPC client
600 * @flags: RPC flags
601 * @ops: RPC call ops
602 * @data: user call data
603 */
604struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
605 const struct rpc_call_ops *tk_ops,
606 void *data)
607{
608 return rpc_do_run_task(clnt, NULL, flags, tk_ops, data);
609}
610EXPORT_SYMBOL(rpc_run_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612void
613rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
614{
615 task->tk_msg = *msg;
616 task->tk_flags |= flags;
617 /* Bind the user cred */
618 if (task->tk_msg.rpc_cred != NULL)
619 rpcauth_holdcred(task);
620 else
621 rpcauth_bindcred(task);
622
623 if (task->tk_status == 0)
624 task->tk_action = call_start;
625 else
Trond Myklebustabbcf282006-01-03 09:55:03 +0100626 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627}
628
Chuck Levered394402006-08-22 20:06:17 -0400629/**
630 * rpc_peeraddr - extract remote peer address from clnt's xprt
631 * @clnt: RPC client structure
632 * @buf: target buffer
633 * @size: length of target buffer
634 *
635 * Returns the number of bytes that are actually in the stored address.
636 */
637size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
638{
639 size_t bytes;
640 struct rpc_xprt *xprt = clnt->cl_xprt;
641
642 bytes = sizeof(xprt->addr);
643 if (bytes > bufsize)
644 bytes = bufsize;
645 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400646 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400647}
Chuck Leverb86acd52006-08-22 20:06:22 -0400648EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400649
Chuck Leverf425eba2006-08-22 20:06:18 -0400650/**
651 * rpc_peeraddr2str - return remote peer address in printable format
652 * @clnt: RPC client structure
653 * @format: address format
654 *
655 */
656char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
657{
658 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500659
660 if (xprt->address_strings[format] != NULL)
661 return xprt->address_strings[format];
662 else
663 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400664}
Chuck Leverb86acd52006-08-22 20:06:22 -0400665EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667void
668rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
669{
670 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700671 if (xprt->ops->set_buffer_size)
672 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673}
674
675/*
676 * Return size of largest payload RPC client can support, in bytes
677 *
678 * For stream transports, this is one RPC record fragment (see RFC
679 * 1831), as we don't support multi-record requests yet. For datagram
680 * transports, this is the size of an IP packet minus the IP, UDP, and
681 * RPC header sizes.
682 */
683size_t rpc_max_payload(struct rpc_clnt *clnt)
684{
685 return clnt->cl_xprt->max_payload;
686}
Chuck Leverb86acd52006-08-22 20:06:22 -0400687EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Chuck Lever35f5a422006-01-03 09:55:50 +0100689/**
690 * rpc_force_rebind - force transport to check that remote port is unchanged
691 * @clnt: client to rebind
692 *
693 */
694void rpc_force_rebind(struct rpc_clnt *clnt)
695{
696 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400697 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100698}
Chuck Leverb86acd52006-08-22 20:06:22 -0400699EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701/*
702 * Restart an (async) RPC call. Usually called from within the
703 * exit handler.
704 */
705void
706rpc_restart_call(struct rpc_task *task)
707{
708 if (RPC_ASSASSINATED(task))
709 return;
710
711 task->tk_action = call_start;
712}
713
714/*
715 * 0. Initial state
716 *
717 * Other FSM states can be visited zero or more times, but
718 * this state is visited exactly once for each RPC.
719 */
720static void
721call_start(struct rpc_task *task)
722{
723 struct rpc_clnt *clnt = task->tk_client;
724
Chuck Lever46121cf2007-01-31 12:14:08 -0500725 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
726 clnt->cl_protname, clnt->cl_vers,
727 task->tk_msg.rpc_proc->p_proc,
728 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 /* Increment call count */
731 task->tk_msg.rpc_proc->p_count++;
732 clnt->cl_stats->rpccnt++;
733 task->tk_action = call_reserve;
734}
735
736/*
737 * 1. Reserve an RPC call slot
738 */
739static void
740call_reserve(struct rpc_task *task)
741{
Chuck Lever46121cf2007-01-31 12:14:08 -0500742 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 if (!rpcauth_uptodatecred(task)) {
745 task->tk_action = call_refresh;
746 return;
747 }
748
749 task->tk_status = 0;
750 task->tk_action = call_reserveresult;
751 xprt_reserve(task);
752}
753
754/*
755 * 1b. Grok the result of xprt_reserve()
756 */
757static void
758call_reserveresult(struct rpc_task *task)
759{
760 int status = task->tk_status;
761
Chuck Lever46121cf2007-01-31 12:14:08 -0500762 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
764 /*
765 * After a call to xprt_reserve(), we must have either
766 * a request slot or else an error status.
767 */
768 task->tk_status = 0;
769 if (status >= 0) {
770 if (task->tk_rqstp) {
771 task->tk_action = call_allocate;
772 return;
773 }
774
775 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
776 __FUNCTION__, status);
777 rpc_exit(task, -EIO);
778 return;
779 }
780
781 /*
782 * Even though there was an error, we may have acquired
783 * a request slot somehow. Make sure not to leak it.
784 */
785 if (task->tk_rqstp) {
786 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
787 __FUNCTION__, status);
788 xprt_release(task);
789 }
790
791 switch (status) {
792 case -EAGAIN: /* woken up; retry */
793 task->tk_action = call_reserve;
794 return;
795 case -EIO: /* probably a shutdown */
796 break;
797 default:
798 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
799 __FUNCTION__, status);
800 break;
801 }
802 rpc_exit(task, status);
803}
804
805/*
806 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100807 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 */
809static void
810call_allocate(struct rpc_task *task)
811{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400812 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100813 struct rpc_rqst *req = task->tk_rqstp;
814 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400815 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
Chuck Lever46121cf2007-01-31 12:14:08 -0500817 dprint_status(task);
818
Chuck Lever2bea90d2007-03-29 16:47:53 -0400819 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400821
Chuck Lever02107142006-01-03 09:55:49 +0100822 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return;
824
Chuck Lever2bea90d2007-03-29 16:47:53 -0400825 if (proc->p_proc != 0) {
826 BUG_ON(proc->p_arglen == 0);
827 if (proc->p_decode != NULL)
828 BUG_ON(proc->p_replen == 0);
829 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Chuck Lever2bea90d2007-03-29 16:47:53 -0400831 /*
832 * Calculate the size (in quads) of the RPC call
833 * and reply headers, and convert both values
834 * to byte sizes.
835 */
836 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
837 req->rq_callsize <<= 2;
838 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
839 req->rq_rcvsize <<= 2;
840
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400841 req->rq_buffer = xprt->ops->buf_alloc(task,
842 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400843 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500845
846 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Trond Myklebust14b218a2005-06-22 17:16:28 +0000848 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400849 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 rpc_delay(task, HZ>>4);
851 return;
852 }
853
854 rpc_exit(task, -ERESTARTSYS);
855}
856
Trond Myklebust940e3312005-11-09 21:45:24 -0500857static inline int
858rpc_task_need_encode(struct rpc_task *task)
859{
860 return task->tk_rqstp->rq_snd_buf.len == 0;
861}
862
863static inline void
864rpc_task_force_reencode(struct rpc_task *task)
865{
866 task->tk_rqstp->rq_snd_buf.len = 0;
867}
868
Chuck Lever2bea90d2007-03-29 16:47:53 -0400869static inline void
870rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
871{
872 buf->head[0].iov_base = start;
873 buf->head[0].iov_len = len;
874 buf->tail[0].iov_len = 0;
875 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400876 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400877 buf->len = 0;
878 buf->buflen = len;
879}
880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881/*
882 * 3. Encode arguments of an RPC call
883 */
884static void
885call_encode(struct rpc_task *task)
886{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700889 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Chuck Lever46121cf2007-01-31 12:14:08 -0500891 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Chuck Lever2bea90d2007-03-29 16:47:53 -0400893 rpc_xdr_buf_init(&req->rq_snd_buf,
894 req->rq_buffer,
895 req->rq_callsize);
896 rpc_xdr_buf_init(&req->rq_rcv_buf,
897 (char *)req->rq_buffer + req->rq_callsize,
898 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
900 /* Encode header and provided arguments */
901 encode = task->tk_msg.rpc_proc->p_encode;
902 if (!(p = call_header(task))) {
903 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
904 rpc_exit(task, -EIO);
905 return;
906 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400907 if (encode == NULL)
908 return;
909
910 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
911 task->tk_msg.rpc_argp);
912 if (task->tk_status == -ENOMEM) {
913 /* XXX: Is this sane? */
914 rpc_delay(task, 3*HZ);
915 task->tk_status = -EAGAIN;
916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917}
918
919/*
920 * 4. Get the server port number if not yet set
921 */
922static void
923call_bind(struct rpc_task *task)
924{
Chuck Leverec739ef2006-08-22 20:06:15 -0400925 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Chuck Lever46121cf2007-01-31 12:14:08 -0500927 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
Chuck Leverda351872005-08-11 16:25:11 -0400929 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400930 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400931 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400932 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400933 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 }
935}
936
937/*
Chuck Leverda351872005-08-11 16:25:11 -0400938 * 4a. Sort out bind result
939 */
940static void
941call_bind_status(struct rpc_task *task)
942{
Chuck Lever906462a2007-09-11 18:00:47 -0400943 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400944
945 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500946 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400947 task->tk_status = 0;
948 task->tk_action = call_connect;
949 return;
950 }
951
952 switch (task->tk_status) {
Chuck Lever2429cbf2007-09-11 18:00:41 -0400953 case -EAGAIN:
954 dprintk("RPC: %5u rpcbind waiting for another request "
955 "to finish\n", task->tk_pid);
956 /* avoid busy-waiting here -- could be a network outage. */
957 rpc_delay(task, 5*HZ);
958 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400959 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500960 dprintk("RPC: %5u remote rpcbind: RPC program/version "
961 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400962 /* fail immediately if this is an RPC ping */
963 if (task->tk_msg.rpc_proc->p_proc == 0) {
964 status = -EOPNOTSUPP;
965 break;
966 }
Chuck Leverea635a52005-10-06 23:12:58 -0400967 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400968 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400969 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500970 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400971 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400972 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400973 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -0400974 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -0500975 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400976 task->tk_pid);
977 break;
978 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400979 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400980 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400981 task->tk_status = 0;
982 task->tk_action = call_bind;
983 return;
Chuck Leverda351872005-08-11 16:25:11 -0400984 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500985 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -0400986 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -0400987 }
988
989 rpc_exit(task, status);
990 return;
991
Trond Myklebustda458282006-08-31 15:44:52 -0400992retry_timeout:
993 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400994}
995
996/*
997 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 */
999static void
1000call_connect(struct rpc_task *task)
1001{
Chuck Leverda351872005-08-11 16:25:11 -04001002 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Chuck Lever46121cf2007-01-31 12:14:08 -05001004 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001005 task->tk_pid, xprt,
1006 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
Chuck Leverda351872005-08-11 16:25:11 -04001008 task->tk_action = call_transmit;
1009 if (!xprt_connected(xprt)) {
1010 task->tk_action = call_connect_status;
1011 if (task->tk_status < 0)
1012 return;
1013 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015}
1016
1017/*
Chuck Leverda351872005-08-11 16:25:11 -04001018 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 */
1020static void
1021call_connect_status(struct rpc_task *task)
1022{
1023 struct rpc_clnt *clnt = task->tk_client;
1024 int status = task->tk_status;
1025
Chuck Lever46121cf2007-01-31 12:14:08 -05001026 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 task->tk_status = 0;
1029 if (status >= 0) {
1030 clnt->cl_stats->netreconn++;
1031 task->tk_action = call_transmit;
1032 return;
1033 }
1034
Chuck Leverda351872005-08-11 16:25:11 -04001035 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001036 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 switch (status) {
1039 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001041 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001042 if (!RPC_IS_SOFT(task))
1043 return;
1044 /* if soft mounted, test if we've timed out */
1045 case -ETIMEDOUT:
1046 task->tk_action = call_timeout;
1047 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 }
Trond Myklebustda458282006-08-31 15:44:52 -04001049 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050}
1051
1052/*
1053 * 5. Transmit the RPC request, and wait for reply
1054 */
1055static void
1056call_transmit(struct rpc_task *task)
1057{
Chuck Lever46121cf2007-01-31 12:14:08 -05001058 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
1060 task->tk_action = call_status;
1061 if (task->tk_status < 0)
1062 return;
1063 task->tk_status = xprt_prepare_transmit(task);
1064 if (task->tk_status != 0)
1065 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001066 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001068 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001069 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001071 /* Did the encode result in an error condition? */
1072 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001073 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001074 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 xprt_transmit(task);
1076 if (task->tk_status < 0)
1077 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001078 /*
1079 * On success, ensure that we call xprt_end_transmit() before sleeping
1080 * in order to allow access to the socket to other RPC requests.
1081 */
1082 call_transmit_status(task);
1083 if (task->tk_msg.rpc_proc->p_decode != NULL)
1084 return;
1085 task->tk_action = rpc_exit_task;
1086 rpc_wake_up_task(task);
1087}
1088
1089/*
1090 * 5a. Handle cleanup after a transmission
1091 */
1092static void
1093call_transmit_status(struct rpc_task *task)
1094{
1095 task->tk_action = call_status;
1096 /*
1097 * Special case: if we've been waiting on the socket's write_space()
1098 * callback, then don't call xprt_end_transmit().
1099 */
1100 if (task->tk_status == -EAGAIN)
1101 return;
1102 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001103 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104}
1105
1106/*
1107 * 6. Sort out the RPC call status
1108 */
1109static void
1110call_status(struct rpc_task *task)
1111{
1112 struct rpc_clnt *clnt = task->tk_client;
1113 struct rpc_rqst *req = task->tk_rqstp;
1114 int status;
1115
1116 if (req->rq_received > 0 && !req->rq_bytes_sent)
1117 task->tk_status = req->rq_received;
1118
Chuck Lever46121cf2007-01-31 12:14:08 -05001119 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
1121 status = task->tk_status;
1122 if (status >= 0) {
1123 task->tk_action = call_decode;
1124 return;
1125 }
1126
1127 task->tk_status = 0;
1128 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001129 case -EHOSTDOWN:
1130 case -EHOSTUNREACH:
1131 case -ENETUNREACH:
1132 /*
1133 * Delay any retries for 3 seconds, then handle as if it
1134 * were a timeout.
1135 */
1136 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 case -ETIMEDOUT:
1138 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001139 if (task->tk_client->cl_discrtry)
1140 xprt_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 break;
1142 case -ECONNREFUSED:
1143 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001144 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 task->tk_action = call_bind;
1146 break;
1147 case -EAGAIN:
1148 task->tk_action = call_transmit;
1149 break;
1150 case -EIO:
1151 /* shutdown or soft timeout */
1152 rpc_exit(task, status);
1153 break;
1154 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001155 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 clnt->cl_protname, -status);
1157 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 }
1159}
1160
1161/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001162 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 * We do not release the request slot, so we keep using the
1164 * same XID for all retransmits.
1165 */
1166static void
1167call_timeout(struct rpc_task *task)
1168{
1169 struct rpc_clnt *clnt = task->tk_client;
1170
1171 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001172 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 goto retry;
1174 }
1175
Chuck Lever46121cf2007-01-31 12:14:08 -05001176 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001177 task->tk_timeouts++;
1178
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001180 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 clnt->cl_protname, clnt->cl_server);
1182 rpc_exit(task, -EIO);
1183 return;
1184 }
1185
Chuck Leverf518e35a2006-01-03 09:55:52 +01001186 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 task->tk_flags |= RPC_CALL_MAJORSEEN;
1188 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1189 clnt->cl_protname, clnt->cl_server);
1190 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001191 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
1193retry:
1194 clnt->cl_stats->rpcretrans++;
1195 task->tk_action = call_bind;
1196 task->tk_status = 0;
1197}
1198
1199/*
1200 * 7. Decode the RPC reply
1201 */
1202static void
1203call_decode(struct rpc_task *task)
1204{
1205 struct rpc_clnt *clnt = task->tk_client;
1206 struct rpc_rqst *req = task->tk_rqstp;
1207 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001208 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Chuck Lever46121cf2007-01-31 12:14:08 -05001210 dprintk("RPC: %5u call_decode (status %d)\n",
1211 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Chuck Leverf518e35a2006-01-03 09:55:52 +01001213 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 printk(KERN_NOTICE "%s: server %s OK\n",
1215 clnt->cl_protname, clnt->cl_server);
1216 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1217 }
1218
1219 if (task->tk_status < 12) {
1220 if (!RPC_IS_SOFT(task)) {
1221 task->tk_action = call_bind;
1222 clnt->cl_stats->rpcretrans++;
1223 goto out_retry;
1224 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001225 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1226 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001227 task->tk_action = call_timeout;
1228 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 }
1230
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001231 /*
1232 * Ensure that we see all writes made by xprt_complete_rqst()
1233 * before it changed req->rq_received.
1234 */
1235 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 req->rq_rcv_buf.len = req->rq_private_buf.len;
1237
1238 /* Check that the softirq receive buffer is valid */
1239 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1240 sizeof(req->rq_rcv_buf)) != 0);
1241
1242 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001243 p = call_verify(task);
1244 if (IS_ERR(p)) {
1245 if (p == ERR_PTR(-EAGAIN))
1246 goto out_retry;
1247 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 }
1249
Trond Myklebustabbcf282006-01-03 09:55:03 +01001250 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001252 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1254 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001255 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001256 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1257 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 return;
1259out_retry:
1260 req->rq_received = req->rq_private_buf.len = 0;
1261 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001262 if (task->tk_client->cl_discrtry)
1263 xprt_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264}
1265
1266/*
1267 * 8. Refresh the credentials if rejected by the server
1268 */
1269static void
1270call_refresh(struct rpc_task *task)
1271{
Chuck Lever46121cf2007-01-31 12:14:08 -05001272 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 task->tk_action = call_refreshresult;
1275 task->tk_status = 0;
1276 task->tk_client->cl_stats->rpcauthrefresh++;
1277 rpcauth_refreshcred(task);
1278}
1279
1280/*
1281 * 8a. Process the results of a credential refresh
1282 */
1283static void
1284call_refreshresult(struct rpc_task *task)
1285{
1286 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001287
1288 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290 task->tk_status = 0;
1291 task->tk_action = call_reserve;
1292 if (status >= 0 && rpcauth_uptodatecred(task))
1293 return;
1294 if (status == -EACCES) {
1295 rpc_exit(task, -EACCES);
1296 return;
1297 }
1298 task->tk_action = call_refresh;
1299 if (status != -ETIMEDOUT)
1300 rpc_delay(task, 3*HZ);
1301 return;
1302}
1303
1304/*
1305 * Call header serialization
1306 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001307static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308call_header(struct rpc_task *task)
1309{
1310 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001312 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
1314 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001315
1316 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 *p++ = req->rq_xid; /* XID */
1318 *p++ = htonl(RPC_CALL); /* CALL */
1319 *p++ = htonl(RPC_VERSION); /* RPC version */
1320 *p++ = htonl(clnt->cl_prog); /* program number */
1321 *p++ = htonl(clnt->cl_vers); /* program version */
1322 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001323 p = rpcauth_marshcred(task, p);
1324 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1325 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326}
1327
1328/*
1329 * Reply header verification
1330 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001331static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332call_verify(struct rpc_task *task)
1333{
1334 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1335 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001336 __be32 *p = iov->iov_base;
1337 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 int error = -EACCES;
1339
David Howellse8896492006-08-24 15:44:19 -04001340 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1341 /* RFC-1014 says that the representation of XDR data must be a
1342 * multiple of four bytes
1343 * - if it isn't pointer subtraction in the NFS client may give
1344 * undefined results
1345 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001346 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1347 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1348 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001349 goto out_eio;
1350 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 if ((len -= 3) < 0)
1352 goto out_overflow;
1353 p += 1; /* skip XID */
1354
1355 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001356 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1357 task->tk_pid, __FUNCTION__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001358 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 }
1360 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1361 if (--len < 0)
1362 goto out_overflow;
1363 switch ((n = ntohl(*p++))) {
1364 case RPC_AUTH_ERROR:
1365 break;
1366 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001367 dprintk("RPC: %5u %s: RPC call version "
1368 "mismatch!\n",
1369 task->tk_pid, __FUNCTION__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001370 error = -EPROTONOSUPPORT;
1371 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001373 dprintk("RPC: %5u %s: RPC call rejected, "
1374 "unknown error: %x\n",
1375 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 goto out_eio;
1377 }
1378 if (--len < 0)
1379 goto out_overflow;
1380 switch ((n = ntohl(*p++))) {
1381 case RPC_AUTH_REJECTEDCRED:
1382 case RPC_AUTH_REJECTEDVERF:
1383 case RPCSEC_GSS_CREDPROBLEM:
1384 case RPCSEC_GSS_CTXPROBLEM:
1385 if (!task->tk_cred_retry)
1386 break;
1387 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001388 dprintk("RPC: %5u %s: retry stale creds\n",
1389 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001391 /* Ensure we obtain a new XID! */
1392 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001394 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 case RPC_AUTH_BADCRED:
1396 case RPC_AUTH_BADVERF:
1397 /* possibly garbled cred/verf? */
1398 if (!task->tk_garb_retry)
1399 break;
1400 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001401 dprintk("RPC: %5u %s: retry garbled creds\n",
1402 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001404 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001406 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1407 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 break;
1409 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001410 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1411 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 error = -EIO;
1413 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001414 dprintk("RPC: %5u %s: call rejected %d\n",
1415 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 goto out_err;
1417 }
1418 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001419 dprintk("RPC: %5u %s: auth check failed\n",
1420 task->tk_pid, __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001421 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001423 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 if (len < 0)
1425 goto out_overflow;
1426 switch ((n = ntohl(*p++))) {
1427 case RPC_SUCCESS:
1428 return p;
1429 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001430 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1431 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 (unsigned int)task->tk_client->cl_prog,
1433 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001434 error = -EPFNOSUPPORT;
1435 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001437 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1438 "server %s\n", task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 (unsigned int)task->tk_client->cl_prog,
1440 (unsigned int)task->tk_client->cl_vers,
1441 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001442 error = -EPROTONOSUPPORT;
1443 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001445 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1446 "version %u on server %s\n",
1447 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 task->tk_msg.rpc_proc,
1449 task->tk_client->cl_prog,
1450 task->tk_client->cl_vers,
1451 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001452 error = -EOPNOTSUPP;
1453 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001455 dprintk("RPC: %5u %s: server saw garbage\n",
1456 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 break; /* retry */
1458 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001459 dprintk("RPC: %5u %s: server accept status: %x\n",
1460 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 /* Also retry */
1462 }
1463
Trond Myklebustabbcf282006-01-03 09:55:03 +01001464out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 task->tk_client->cl_stats->rpcgarbage++;
1466 if (task->tk_garb_retry) {
1467 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001468 dprintk("RPC: %5u %s: retrying\n",
1469 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001471out_retry:
1472 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474out_eio:
1475 error = -EIO;
1476out_err:
1477 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001478 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1479 __FUNCTION__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001480 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001482 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1483 __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001484 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001486
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001487static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001488{
1489 return 0;
1490}
1491
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001492static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001493{
1494 return 0;
1495}
1496
1497static struct rpc_procinfo rpcproc_null = {
1498 .p_encode = rpcproc_encode_null,
1499 .p_decode = rpcproc_decode_null,
1500};
1501
Trond Myklebust64c91a12007-06-23 10:17:16 -04001502static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001503{
1504 struct rpc_message msg = {
1505 .rpc_proc = &rpcproc_null,
1506 };
1507 int err;
1508 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1509 err = rpc_call_sync(clnt, &msg, flags);
1510 put_rpccred(msg.rpc_cred);
1511 return err;
1512}
Trond Myklebust188fef12007-06-16 14:18:40 -04001513
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001514struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1515{
1516 struct rpc_message msg = {
1517 .rpc_proc = &rpcproc_null,
1518 .rpc_cred = cred,
1519 };
1520 return rpc_do_run_task(clnt, &msg, flags, &rpc_default_ops, NULL);
1521}
1522EXPORT_SYMBOL(rpc_call_null);
1523
Trond Myklebust188fef12007-06-16 14:18:40 -04001524#ifdef RPC_DEBUG
1525void rpc_show_tasks(void)
1526{
1527 struct rpc_clnt *clnt;
1528 struct rpc_task *t;
1529
1530 spin_lock(&rpc_client_lock);
1531 if (list_empty(&all_clients))
1532 goto out;
1533 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1534 "-rpcwait -action- ---ops--\n");
1535 list_for_each_entry(clnt, &all_clients, cl_clients) {
1536 if (list_empty(&clnt->cl_tasks))
1537 continue;
1538 spin_lock(&clnt->cl_lock);
1539 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1540 const char *rpc_waitq = "none";
Chuck Leverd66968f2007-09-11 18:00:25 -04001541 int proc;
1542
1543 if (t->tk_msg.rpc_proc)
1544 proc = t->tk_msg.rpc_proc->p_proc;
1545 else
1546 proc = -1;
Trond Myklebust188fef12007-06-16 14:18:40 -04001547
1548 if (RPC_IS_QUEUED(t))
1549 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1550
1551 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
Chuck Leverd66968f2007-09-11 18:00:25 -04001552 t->tk_pid, proc,
Trond Myklebust188fef12007-06-16 14:18:40 -04001553 t->tk_flags, t->tk_status,
1554 t->tk_client,
1555 (t->tk_client ? t->tk_client->cl_prog : 0),
1556 t->tk_rqstp, t->tk_timeout,
1557 rpc_waitq,
1558 t->tk_action, t->tk_ops);
1559 }
1560 spin_unlock(&clnt->cl_lock);
1561 }
1562out:
1563 spin_unlock(&rpc_client_lock);
1564}
1565#endif