blob: aefe3ae218f772d0cd515156b5edd49fbcd73d00 [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 Myklebust84115e12007-07-14 15:39:59 -0400543 if (task_setup_data->rpc_message != NULL) {
544 rpc_call_setup(task, task_setup_data->rpc_message, 0);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400545 if (task->tk_status != 0) {
546 ret = ERR_PTR(task->tk_status);
547 rpc_put_task(task);
548 goto out;
549 }
550 }
551 atomic_inc(&task->tk_count);
Trond Myklebust50859252007-10-25 18:19:37 -0400552 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
553 rpc_task_sigmask(task, &oldset);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400554 rpc_execute(task);
Trond Myklebust50859252007-10-25 18:19:37 -0400555 rpc_restore_sigmask(&oldset);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400556 ret = task;
557out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400558 return ret;
559}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400560EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400561
562/**
563 * rpc_call_sync - Perform a synchronous RPC call
564 * @clnt: pointer to RPC client
565 * @msg: RPC call parameters
566 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 */
568int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
569{
570 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400571 struct rpc_task_setup task_setup_data = {
572 .rpc_client = clnt,
573 .rpc_message = msg,
574 .callback_ops = &rpc_default_ops,
575 .flags = flags,
576 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400577 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 BUG_ON(flags & RPC_TASK_ASYNC);
580
Trond Myklebustc970aa82007-07-14 15:39:59 -0400581 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400582 if (IS_ERR(task))
583 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100584 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800585 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 return status;
587}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400588EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400590/**
591 * rpc_call_async - Perform an asynchronous RPC call
592 * @clnt: pointer to RPC client
593 * @msg: RPC call parameters
594 * @flags: RPC call flags
595 * @ops: RPC call ops
596 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 */
598int
599rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100600 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601{
602 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400603 struct rpc_task_setup task_setup_data = {
604 .rpc_client = clnt,
605 .rpc_message = msg,
606 .callback_ops = tk_ops,
607 .callback_data = data,
608 .flags = flags|RPC_TASK_ASYNC,
609 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Trond Myklebustc970aa82007-07-14 15:39:59 -0400611 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400612 if (IS_ERR(task))
613 return PTR_ERR(task);
614 rpc_put_task(task);
615 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400617EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619void
Trond Myklebust84115e12007-07-14 15:39:59 -0400620rpc_call_setup(struct rpc_task *task, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
622 task->tk_msg = *msg;
623 task->tk_flags |= flags;
624 /* Bind the user cred */
625 if (task->tk_msg.rpc_cred != NULL)
626 rpcauth_holdcred(task);
627 else
628 rpcauth_bindcred(task);
629
630 if (task->tk_status == 0)
631 task->tk_action = call_start;
632 else
Trond Myklebustabbcf282006-01-03 09:55:03 +0100633 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400635EXPORT_SYMBOL_GPL(rpc_call_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Chuck Levered394402006-08-22 20:06:17 -0400637/**
638 * rpc_peeraddr - extract remote peer address from clnt's xprt
639 * @clnt: RPC client structure
640 * @buf: target buffer
641 * @size: length of target buffer
642 *
643 * Returns the number of bytes that are actually in the stored address.
644 */
645size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
646{
647 size_t bytes;
648 struct rpc_xprt *xprt = clnt->cl_xprt;
649
650 bytes = sizeof(xprt->addr);
651 if (bytes > bufsize)
652 bytes = bufsize;
653 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400654 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400655}
Chuck Leverb86acd52006-08-22 20:06:22 -0400656EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400657
Chuck Leverf425eba2006-08-22 20:06:18 -0400658/**
659 * rpc_peeraddr2str - return remote peer address in printable format
660 * @clnt: RPC client structure
661 * @format: address format
662 *
663 */
664char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
665{
666 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500667
668 if (xprt->address_strings[format] != NULL)
669 return xprt->address_strings[format];
670 else
671 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400672}
Chuck Leverb86acd52006-08-22 20:06:22 -0400673EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675void
676rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
677{
678 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700679 if (xprt->ops->set_buffer_size)
680 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400682EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
684/*
685 * Return size of largest payload RPC client can support, in bytes
686 *
687 * For stream transports, this is one RPC record fragment (see RFC
688 * 1831), as we don't support multi-record requests yet. For datagram
689 * transports, this is the size of an IP packet minus the IP, UDP, and
690 * RPC header sizes.
691 */
692size_t rpc_max_payload(struct rpc_clnt *clnt)
693{
694 return clnt->cl_xprt->max_payload;
695}
Chuck Leverb86acd52006-08-22 20:06:22 -0400696EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Chuck Lever35f5a422006-01-03 09:55:50 +0100698/**
699 * rpc_force_rebind - force transport to check that remote port is unchanged
700 * @clnt: client to rebind
701 *
702 */
703void rpc_force_rebind(struct rpc_clnt *clnt)
704{
705 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400706 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100707}
Chuck Leverb86acd52006-08-22 20:06:22 -0400708EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100709
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710/*
711 * Restart an (async) RPC call. Usually called from within the
712 * exit handler.
713 */
714void
715rpc_restart_call(struct rpc_task *task)
716{
717 if (RPC_ASSASSINATED(task))
718 return;
719
720 task->tk_action = call_start;
721}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400722EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724/*
725 * 0. Initial state
726 *
727 * Other FSM states can be visited zero or more times, but
728 * this state is visited exactly once for each RPC.
729 */
730static void
731call_start(struct rpc_task *task)
732{
733 struct rpc_clnt *clnt = task->tk_client;
734
Chuck Lever46121cf2007-01-31 12:14:08 -0500735 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
736 clnt->cl_protname, clnt->cl_vers,
737 task->tk_msg.rpc_proc->p_proc,
738 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
740 /* Increment call count */
741 task->tk_msg.rpc_proc->p_count++;
742 clnt->cl_stats->rpccnt++;
743 task->tk_action = call_reserve;
744}
745
746/*
747 * 1. Reserve an RPC call slot
748 */
749static void
750call_reserve(struct rpc_task *task)
751{
Chuck Lever46121cf2007-01-31 12:14:08 -0500752 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 if (!rpcauth_uptodatecred(task)) {
755 task->tk_action = call_refresh;
756 return;
757 }
758
759 task->tk_status = 0;
760 task->tk_action = call_reserveresult;
761 xprt_reserve(task);
762}
763
764/*
765 * 1b. Grok the result of xprt_reserve()
766 */
767static void
768call_reserveresult(struct rpc_task *task)
769{
770 int status = task->tk_status;
771
Chuck Lever46121cf2007-01-31 12:14:08 -0500772 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
774 /*
775 * After a call to xprt_reserve(), we must have either
776 * a request slot or else an error status.
777 */
778 task->tk_status = 0;
779 if (status >= 0) {
780 if (task->tk_rqstp) {
781 task->tk_action = call_allocate;
782 return;
783 }
784
785 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
786 __FUNCTION__, status);
787 rpc_exit(task, -EIO);
788 return;
789 }
790
791 /*
792 * Even though there was an error, we may have acquired
793 * a request slot somehow. Make sure not to leak it.
794 */
795 if (task->tk_rqstp) {
796 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
797 __FUNCTION__, status);
798 xprt_release(task);
799 }
800
801 switch (status) {
802 case -EAGAIN: /* woken up; retry */
803 task->tk_action = call_reserve;
804 return;
805 case -EIO: /* probably a shutdown */
806 break;
807 default:
808 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
809 __FUNCTION__, status);
810 break;
811 }
812 rpc_exit(task, status);
813}
814
815/*
816 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100817 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 */
819static void
820call_allocate(struct rpc_task *task)
821{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400822 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100823 struct rpc_rqst *req = task->tk_rqstp;
824 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400825 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Chuck Lever46121cf2007-01-31 12:14:08 -0500827 dprint_status(task);
828
Chuck Lever2bea90d2007-03-29 16:47:53 -0400829 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400831
Chuck Lever02107142006-01-03 09:55:49 +0100832 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 return;
834
Chuck Lever2bea90d2007-03-29 16:47:53 -0400835 if (proc->p_proc != 0) {
836 BUG_ON(proc->p_arglen == 0);
837 if (proc->p_decode != NULL)
838 BUG_ON(proc->p_replen == 0);
839 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Chuck Lever2bea90d2007-03-29 16:47:53 -0400841 /*
842 * Calculate the size (in quads) of the RPC call
843 * and reply headers, and convert both values
844 * to byte sizes.
845 */
846 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
847 req->rq_callsize <<= 2;
848 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
849 req->rq_rcvsize <<= 2;
850
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400851 req->rq_buffer = xprt->ops->buf_alloc(task,
852 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400853 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500855
856 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Trond Myklebust14b218a2005-06-22 17:16:28 +0000858 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400859 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 rpc_delay(task, HZ>>4);
861 return;
862 }
863
864 rpc_exit(task, -ERESTARTSYS);
865}
866
Trond Myklebust940e3312005-11-09 21:45:24 -0500867static inline int
868rpc_task_need_encode(struct rpc_task *task)
869{
870 return task->tk_rqstp->rq_snd_buf.len == 0;
871}
872
873static inline void
874rpc_task_force_reencode(struct rpc_task *task)
875{
876 task->tk_rqstp->rq_snd_buf.len = 0;
877}
878
Chuck Lever2bea90d2007-03-29 16:47:53 -0400879static inline void
880rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
881{
882 buf->head[0].iov_base = start;
883 buf->head[0].iov_len = len;
884 buf->tail[0].iov_len = 0;
885 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400886 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400887 buf->len = 0;
888 buf->buflen = len;
889}
890
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891/*
892 * 3. Encode arguments of an RPC call
893 */
894static void
895call_encode(struct rpc_task *task)
896{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700899 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Chuck Lever46121cf2007-01-31 12:14:08 -0500901 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Chuck Lever2bea90d2007-03-29 16:47:53 -0400903 rpc_xdr_buf_init(&req->rq_snd_buf,
904 req->rq_buffer,
905 req->rq_callsize);
906 rpc_xdr_buf_init(&req->rq_rcv_buf,
907 (char *)req->rq_buffer + req->rq_callsize,
908 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
910 /* Encode header and provided arguments */
911 encode = task->tk_msg.rpc_proc->p_encode;
912 if (!(p = call_header(task))) {
913 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
914 rpc_exit(task, -EIO);
915 return;
916 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400917 if (encode == NULL)
918 return;
919
920 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
921 task->tk_msg.rpc_argp);
922 if (task->tk_status == -ENOMEM) {
923 /* XXX: Is this sane? */
924 rpc_delay(task, 3*HZ);
925 task->tk_status = -EAGAIN;
926 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927}
928
929/*
930 * 4. Get the server port number if not yet set
931 */
932static void
933call_bind(struct rpc_task *task)
934{
Chuck Leverec739ef2006-08-22 20:06:15 -0400935 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Chuck Lever46121cf2007-01-31 12:14:08 -0500937 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Chuck Leverda351872005-08-11 16:25:11 -0400939 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400940 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400941 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400942 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400943 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 }
945}
946
947/*
Chuck Leverda351872005-08-11 16:25:11 -0400948 * 4a. Sort out bind result
949 */
950static void
951call_bind_status(struct rpc_task *task)
952{
Chuck Lever906462a2007-09-11 18:00:47 -0400953 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400954
955 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500956 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400957 task->tk_status = 0;
958 task->tk_action = call_connect;
959 return;
960 }
961
962 switch (task->tk_status) {
Chuck Lever2429cbf2007-09-11 18:00:41 -0400963 case -EAGAIN:
964 dprintk("RPC: %5u rpcbind waiting for another request "
965 "to finish\n", task->tk_pid);
966 /* avoid busy-waiting here -- could be a network outage. */
967 rpc_delay(task, 5*HZ);
968 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400969 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500970 dprintk("RPC: %5u remote rpcbind: RPC program/version "
971 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400972 /* fail immediately if this is an RPC ping */
973 if (task->tk_msg.rpc_proc->p_proc == 0) {
974 status = -EOPNOTSUPP;
975 break;
976 }
Chuck Leverea635a52005-10-06 23:12:58 -0400977 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400978 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400979 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500980 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400981 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400982 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400983 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -0400984 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -0500985 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400986 task->tk_pid);
987 break;
988 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400989 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400990 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400991 task->tk_status = 0;
992 task->tk_action = call_bind;
993 return;
Chuck Leverda351872005-08-11 16:25:11 -0400994 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500995 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -0400996 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -0400997 }
998
999 rpc_exit(task, status);
1000 return;
1001
Trond Myklebustda458282006-08-31 15:44:52 -04001002retry_timeout:
1003 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001004}
1005
1006/*
1007 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 */
1009static void
1010call_connect(struct rpc_task *task)
1011{
Chuck Leverda351872005-08-11 16:25:11 -04001012 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Chuck Lever46121cf2007-01-31 12:14:08 -05001014 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001015 task->tk_pid, xprt,
1016 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Chuck Leverda351872005-08-11 16:25:11 -04001018 task->tk_action = call_transmit;
1019 if (!xprt_connected(xprt)) {
1020 task->tk_action = call_connect_status;
1021 if (task->tk_status < 0)
1022 return;
1023 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025}
1026
1027/*
Chuck Leverda351872005-08-11 16:25:11 -04001028 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 */
1030static void
1031call_connect_status(struct rpc_task *task)
1032{
1033 struct rpc_clnt *clnt = task->tk_client;
1034 int status = task->tk_status;
1035
Chuck Lever46121cf2007-01-31 12:14:08 -05001036 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 task->tk_status = 0;
1039 if (status >= 0) {
1040 clnt->cl_stats->netreconn++;
1041 task->tk_action = call_transmit;
1042 return;
1043 }
1044
Chuck Leverda351872005-08-11 16:25:11 -04001045 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001046 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001047
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 switch (status) {
1049 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001051 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001052 if (!RPC_IS_SOFT(task))
1053 return;
1054 /* if soft mounted, test if we've timed out */
1055 case -ETIMEDOUT:
1056 task->tk_action = call_timeout;
1057 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 }
Trond Myklebustda458282006-08-31 15:44:52 -04001059 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060}
1061
1062/*
1063 * 5. Transmit the RPC request, and wait for reply
1064 */
1065static void
1066call_transmit(struct rpc_task *task)
1067{
Chuck Lever46121cf2007-01-31 12:14:08 -05001068 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
1070 task->tk_action = call_status;
1071 if (task->tk_status < 0)
1072 return;
1073 task->tk_status = xprt_prepare_transmit(task);
1074 if (task->tk_status != 0)
1075 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001076 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001078 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001079 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001081 /* Did the encode result in an error condition? */
1082 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001083 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001084 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 xprt_transmit(task);
1086 if (task->tk_status < 0)
1087 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001088 /*
1089 * On success, ensure that we call xprt_end_transmit() before sleeping
1090 * in order to allow access to the socket to other RPC requests.
1091 */
1092 call_transmit_status(task);
1093 if (task->tk_msg.rpc_proc->p_decode != NULL)
1094 return;
1095 task->tk_action = rpc_exit_task;
1096 rpc_wake_up_task(task);
1097}
1098
1099/*
1100 * 5a. Handle cleanup after a transmission
1101 */
1102static void
1103call_transmit_status(struct rpc_task *task)
1104{
1105 task->tk_action = call_status;
1106 /*
1107 * Special case: if we've been waiting on the socket's write_space()
1108 * callback, then don't call xprt_end_transmit().
1109 */
1110 if (task->tk_status == -EAGAIN)
1111 return;
1112 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001113 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114}
1115
1116/*
1117 * 6. Sort out the RPC call status
1118 */
1119static void
1120call_status(struct rpc_task *task)
1121{
1122 struct rpc_clnt *clnt = task->tk_client;
1123 struct rpc_rqst *req = task->tk_rqstp;
1124 int status;
1125
1126 if (req->rq_received > 0 && !req->rq_bytes_sent)
1127 task->tk_status = req->rq_received;
1128
Chuck Lever46121cf2007-01-31 12:14:08 -05001129 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
1131 status = task->tk_status;
1132 if (status >= 0) {
1133 task->tk_action = call_decode;
1134 return;
1135 }
1136
1137 task->tk_status = 0;
1138 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001139 case -EHOSTDOWN:
1140 case -EHOSTUNREACH:
1141 case -ENETUNREACH:
1142 /*
1143 * Delay any retries for 3 seconds, then handle as if it
1144 * were a timeout.
1145 */
1146 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 case -ETIMEDOUT:
1148 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001149 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001150 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 break;
1152 case -ECONNREFUSED:
1153 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001154 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 task->tk_action = call_bind;
1156 break;
1157 case -EAGAIN:
1158 task->tk_action = call_transmit;
1159 break;
1160 case -EIO:
1161 /* shutdown or soft timeout */
1162 rpc_exit(task, status);
1163 break;
1164 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001165 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 clnt->cl_protname, -status);
1167 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 }
1169}
1170
1171/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001172 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 * We do not release the request slot, so we keep using the
1174 * same XID for all retransmits.
1175 */
1176static void
1177call_timeout(struct rpc_task *task)
1178{
1179 struct rpc_clnt *clnt = task->tk_client;
1180
1181 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001182 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 goto retry;
1184 }
1185
Chuck Lever46121cf2007-01-31 12:14:08 -05001186 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001187 task->tk_timeouts++;
1188
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001190 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 clnt->cl_protname, clnt->cl_server);
1192 rpc_exit(task, -EIO);
1193 return;
1194 }
1195
Chuck Leverf518e35a2006-01-03 09:55:52 +01001196 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 task->tk_flags |= RPC_CALL_MAJORSEEN;
1198 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1199 clnt->cl_protname, clnt->cl_server);
1200 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001201 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
1203retry:
1204 clnt->cl_stats->rpcretrans++;
1205 task->tk_action = call_bind;
1206 task->tk_status = 0;
1207}
1208
1209/*
1210 * 7. Decode the RPC reply
1211 */
1212static void
1213call_decode(struct rpc_task *task)
1214{
1215 struct rpc_clnt *clnt = task->tk_client;
1216 struct rpc_rqst *req = task->tk_rqstp;
1217 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001218 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219
Chuck Lever46121cf2007-01-31 12:14:08 -05001220 dprintk("RPC: %5u call_decode (status %d)\n",
1221 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
Chuck Leverf518e35a2006-01-03 09:55:52 +01001223 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 printk(KERN_NOTICE "%s: server %s OK\n",
1225 clnt->cl_protname, clnt->cl_server);
1226 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1227 }
1228
1229 if (task->tk_status < 12) {
1230 if (!RPC_IS_SOFT(task)) {
1231 task->tk_action = call_bind;
1232 clnt->cl_stats->rpcretrans++;
1233 goto out_retry;
1234 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001235 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1236 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001237 task->tk_action = call_timeout;
1238 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 }
1240
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001241 /*
1242 * Ensure that we see all writes made by xprt_complete_rqst()
1243 * before it changed req->rq_received.
1244 */
1245 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 req->rq_rcv_buf.len = req->rq_private_buf.len;
1247
1248 /* Check that the softirq receive buffer is valid */
1249 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1250 sizeof(req->rq_rcv_buf)) != 0);
1251
1252 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001253 p = call_verify(task);
1254 if (IS_ERR(p)) {
1255 if (p == ERR_PTR(-EAGAIN))
1256 goto out_retry;
1257 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 }
1259
Trond Myklebustabbcf282006-01-03 09:55:03 +01001260 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001262 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1264 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001265 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001266 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1267 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 return;
1269out_retry:
1270 req->rq_received = req->rq_private_buf.len = 0;
1271 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001272 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001273 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274}
1275
1276/*
1277 * 8. Refresh the credentials if rejected by the server
1278 */
1279static void
1280call_refresh(struct rpc_task *task)
1281{
Chuck Lever46121cf2007-01-31 12:14:08 -05001282 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 task->tk_action = call_refreshresult;
1285 task->tk_status = 0;
1286 task->tk_client->cl_stats->rpcauthrefresh++;
1287 rpcauth_refreshcred(task);
1288}
1289
1290/*
1291 * 8a. Process the results of a credential refresh
1292 */
1293static void
1294call_refreshresult(struct rpc_task *task)
1295{
1296 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001297
1298 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
1300 task->tk_status = 0;
1301 task->tk_action = call_reserve;
1302 if (status >= 0 && rpcauth_uptodatecred(task))
1303 return;
1304 if (status == -EACCES) {
1305 rpc_exit(task, -EACCES);
1306 return;
1307 }
1308 task->tk_action = call_refresh;
1309 if (status != -ETIMEDOUT)
1310 rpc_delay(task, 3*HZ);
1311 return;
1312}
1313
1314/*
1315 * Call header serialization
1316 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001317static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318call_header(struct rpc_task *task)
1319{
1320 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001322 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001325
1326 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 *p++ = req->rq_xid; /* XID */
1328 *p++ = htonl(RPC_CALL); /* CALL */
1329 *p++ = htonl(RPC_VERSION); /* RPC version */
1330 *p++ = htonl(clnt->cl_prog); /* program number */
1331 *p++ = htonl(clnt->cl_vers); /* program version */
1332 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001333 p = rpcauth_marshcred(task, p);
1334 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1335 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336}
1337
1338/*
1339 * Reply header verification
1340 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001341static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342call_verify(struct rpc_task *task)
1343{
1344 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1345 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001346 __be32 *p = iov->iov_base;
1347 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 int error = -EACCES;
1349
David Howellse8896492006-08-24 15:44:19 -04001350 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1351 /* RFC-1014 says that the representation of XDR data must be a
1352 * multiple of four bytes
1353 * - if it isn't pointer subtraction in the NFS client may give
1354 * undefined results
1355 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001356 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1357 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1358 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001359 goto out_eio;
1360 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 if ((len -= 3) < 0)
1362 goto out_overflow;
1363 p += 1; /* skip XID */
1364
1365 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001366 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1367 task->tk_pid, __FUNCTION__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001368 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 }
1370 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1371 if (--len < 0)
1372 goto out_overflow;
1373 switch ((n = ntohl(*p++))) {
1374 case RPC_AUTH_ERROR:
1375 break;
1376 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001377 dprintk("RPC: %5u %s: RPC call version "
1378 "mismatch!\n",
1379 task->tk_pid, __FUNCTION__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001380 error = -EPROTONOSUPPORT;
1381 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001383 dprintk("RPC: %5u %s: RPC call rejected, "
1384 "unknown error: %x\n",
1385 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 goto out_eio;
1387 }
1388 if (--len < 0)
1389 goto out_overflow;
1390 switch ((n = ntohl(*p++))) {
1391 case RPC_AUTH_REJECTEDCRED:
1392 case RPC_AUTH_REJECTEDVERF:
1393 case RPCSEC_GSS_CREDPROBLEM:
1394 case RPCSEC_GSS_CTXPROBLEM:
1395 if (!task->tk_cred_retry)
1396 break;
1397 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001398 dprintk("RPC: %5u %s: retry stale creds\n",
1399 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001401 /* Ensure we obtain a new XID! */
1402 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001404 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 case RPC_AUTH_BADCRED:
1406 case RPC_AUTH_BADVERF:
1407 /* possibly garbled cred/verf? */
1408 if (!task->tk_garb_retry)
1409 break;
1410 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001411 dprintk("RPC: %5u %s: retry garbled creds\n",
1412 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001414 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001416 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1417 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 break;
1419 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001420 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1421 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 error = -EIO;
1423 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001424 dprintk("RPC: %5u %s: call rejected %d\n",
1425 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 goto out_err;
1427 }
1428 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001429 dprintk("RPC: %5u %s: auth check failed\n",
1430 task->tk_pid, __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001431 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001433 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 if (len < 0)
1435 goto out_overflow;
1436 switch ((n = ntohl(*p++))) {
1437 case RPC_SUCCESS:
1438 return p;
1439 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001440 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1441 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 (unsigned int)task->tk_client->cl_prog,
1443 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001444 error = -EPFNOSUPPORT;
1445 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001447 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1448 "server %s\n", task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 (unsigned int)task->tk_client->cl_prog,
1450 (unsigned int)task->tk_client->cl_vers,
1451 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001452 error = -EPROTONOSUPPORT;
1453 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001455 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1456 "version %u on server %s\n",
1457 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 task->tk_msg.rpc_proc,
1459 task->tk_client->cl_prog,
1460 task->tk_client->cl_vers,
1461 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001462 error = -EOPNOTSUPP;
1463 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001465 dprintk("RPC: %5u %s: server saw garbage\n",
1466 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 break; /* retry */
1468 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001469 dprintk("RPC: %5u %s: server accept status: %x\n",
1470 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 /* Also retry */
1472 }
1473
Trond Myklebustabbcf282006-01-03 09:55:03 +01001474out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 task->tk_client->cl_stats->rpcgarbage++;
1476 if (task->tk_garb_retry) {
1477 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001478 dprintk("RPC: %5u %s: retrying\n",
1479 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001481out_retry:
1482 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484out_eio:
1485 error = -EIO;
1486out_err:
1487 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001488 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1489 __FUNCTION__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001490 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001492 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1493 __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001494 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001496
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001497static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001498{
1499 return 0;
1500}
1501
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001502static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001503{
1504 return 0;
1505}
1506
1507static struct rpc_procinfo rpcproc_null = {
1508 .p_encode = rpcproc_encode_null,
1509 .p_decode = rpcproc_decode_null,
1510};
1511
Trond Myklebust64c91a12007-06-23 10:17:16 -04001512static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001513{
1514 struct rpc_message msg = {
1515 .rpc_proc = &rpcproc_null,
1516 };
1517 int err;
1518 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1519 err = rpc_call_sync(clnt, &msg, flags);
1520 put_rpccred(msg.rpc_cred);
1521 return err;
1522}
Trond Myklebust188fef12007-06-16 14:18:40 -04001523
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001524struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1525{
1526 struct rpc_message msg = {
1527 .rpc_proc = &rpcproc_null,
1528 .rpc_cred = cred,
1529 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001530 struct rpc_task_setup task_setup_data = {
1531 .rpc_client = clnt,
1532 .rpc_message = &msg,
1533 .callback_ops = &rpc_default_ops,
1534 .flags = flags,
1535 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001536 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001537}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001538EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001539
Trond Myklebust188fef12007-06-16 14:18:40 -04001540#ifdef RPC_DEBUG
1541void rpc_show_tasks(void)
1542{
1543 struct rpc_clnt *clnt;
1544 struct rpc_task *t;
1545
1546 spin_lock(&rpc_client_lock);
1547 if (list_empty(&all_clients))
1548 goto out;
1549 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1550 "-rpcwait -action- ---ops--\n");
1551 list_for_each_entry(clnt, &all_clients, cl_clients) {
1552 if (list_empty(&clnt->cl_tasks))
1553 continue;
1554 spin_lock(&clnt->cl_lock);
1555 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1556 const char *rpc_waitq = "none";
Chuck Leverd66968f2007-09-11 18:00:25 -04001557 int proc;
1558
1559 if (t->tk_msg.rpc_proc)
1560 proc = t->tk_msg.rpc_proc->p_proc;
1561 else
1562 proc = -1;
Trond Myklebust188fef12007-06-16 14:18:40 -04001563
1564 if (RPC_IS_QUEUED(t))
1565 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1566
1567 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
Chuck Leverd66968f2007-09-11 18:00:25 -04001568 t->tk_pid, proc,
Trond Myklebust188fef12007-06-16 14:18:40 -04001569 t->tk_flags, t->tk_status,
1570 t->tk_client,
1571 (t->tk_client ? t->tk_client->cl_prog : 0),
1572 t->tk_rqstp, t->tk_timeout,
1573 rpc_waitq,
1574 t->tk_action, t->tk_ops);
1575 }
1576 spin_unlock(&clnt->cl_lock);
1577 }
1578out:
1579 spin_unlock(&rpc_client_lock);
1580}
1581#endif