blob: 9aad45946d323c8f572293a3c7927d73fbfec5ec [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
504static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
505{
506 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
507}
508
509static inline void rpc_restore_sigmask(sigset_t *oldset)
510{
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 Myklebust6e5b70e2007-06-12 10:02:37 -0400539 return ERR_PTR(-ENOMEM);
540 }
541
542 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
543 rpc_task_sigmask(task, &oldset);
Trond Myklebust84115e12007-07-14 15:39:59 -0400544 if (task_setup_data->rpc_message != NULL) {
545 rpc_call_setup(task, task_setup_data->rpc_message, 0);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400546 if (task->tk_status != 0) {
547 ret = ERR_PTR(task->tk_status);
548 rpc_put_task(task);
549 goto out;
550 }
551 }
552 atomic_inc(&task->tk_count);
553 rpc_execute(task);
554 ret = task;
555out:
556 rpc_restore_sigmask(&oldset);
557 return ret;
558}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400559EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400560
561/**
562 * rpc_call_sync - Perform a synchronous RPC call
563 * @clnt: pointer to RPC client
564 * @msg: RPC call parameters
565 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 */
567int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
568{
569 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400570 struct rpc_task_setup task_setup_data = {
571 .rpc_client = clnt,
572 .rpc_message = msg,
573 .callback_ops = &rpc_default_ops,
574 .flags = flags,
575 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400576 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 BUG_ON(flags & RPC_TASK_ASYNC);
579
Trond Myklebustc970aa82007-07-14 15:39:59 -0400580 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400581 if (IS_ERR(task))
582 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100583 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800584 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 return status;
586}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400587EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400589/**
590 * rpc_call_async - Perform an asynchronous RPC call
591 * @clnt: pointer to RPC client
592 * @msg: RPC call parameters
593 * @flags: RPC call flags
594 * @ops: RPC call ops
595 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 */
597int
598rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100599 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600{
601 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400602 struct rpc_task_setup task_setup_data = {
603 .rpc_client = clnt,
604 .rpc_message = msg,
605 .callback_ops = tk_ops,
606 .callback_data = data,
607 .flags = flags|RPC_TASK_ASYNC,
608 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Trond Myklebustc970aa82007-07-14 15:39:59 -0400610 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400611 if (IS_ERR(task))
612 return PTR_ERR(task);
613 rpc_put_task(task);
614 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400616EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618void
Trond Myklebust84115e12007-07-14 15:39:59 -0400619rpc_call_setup(struct rpc_task *task, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
621 task->tk_msg = *msg;
622 task->tk_flags |= flags;
623 /* Bind the user cred */
624 if (task->tk_msg.rpc_cred != NULL)
625 rpcauth_holdcred(task);
626 else
627 rpcauth_bindcred(task);
628
629 if (task->tk_status == 0)
630 task->tk_action = call_start;
631 else
Trond Myklebustabbcf282006-01-03 09:55:03 +0100632 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400634EXPORT_SYMBOL_GPL(rpc_call_setup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Chuck Levered394402006-08-22 20:06:17 -0400636/**
637 * rpc_peeraddr - extract remote peer address from clnt's xprt
638 * @clnt: RPC client structure
639 * @buf: target buffer
640 * @size: length of target buffer
641 *
642 * Returns the number of bytes that are actually in the stored address.
643 */
644size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
645{
646 size_t bytes;
647 struct rpc_xprt *xprt = clnt->cl_xprt;
648
649 bytes = sizeof(xprt->addr);
650 if (bytes > bufsize)
651 bytes = bufsize;
652 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400653 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400654}
Chuck Leverb86acd52006-08-22 20:06:22 -0400655EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400656
Chuck Leverf425eba2006-08-22 20:06:18 -0400657/**
658 * rpc_peeraddr2str - return remote peer address in printable format
659 * @clnt: RPC client structure
660 * @format: address format
661 *
662 */
663char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
664{
665 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500666
667 if (xprt->address_strings[format] != NULL)
668 return xprt->address_strings[format];
669 else
670 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400671}
Chuck Leverb86acd52006-08-22 20:06:22 -0400672EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674void
675rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
676{
677 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700678 if (xprt->ops->set_buffer_size)
679 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400681EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
683/*
684 * Return size of largest payload RPC client can support, in bytes
685 *
686 * For stream transports, this is one RPC record fragment (see RFC
687 * 1831), as we don't support multi-record requests yet. For datagram
688 * transports, this is the size of an IP packet minus the IP, UDP, and
689 * RPC header sizes.
690 */
691size_t rpc_max_payload(struct rpc_clnt *clnt)
692{
693 return clnt->cl_xprt->max_payload;
694}
Chuck Leverb86acd52006-08-22 20:06:22 -0400695EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Chuck Lever35f5a422006-01-03 09:55:50 +0100697/**
698 * rpc_force_rebind - force transport to check that remote port is unchanged
699 * @clnt: client to rebind
700 *
701 */
702void rpc_force_rebind(struct rpc_clnt *clnt)
703{
704 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400705 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100706}
Chuck Leverb86acd52006-08-22 20:06:22 -0400707EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/*
710 * Restart an (async) RPC call. Usually called from within the
711 * exit handler.
712 */
713void
714rpc_restart_call(struct rpc_task *task)
715{
716 if (RPC_ASSASSINATED(task))
717 return;
718
719 task->tk_action = call_start;
720}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400721EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723/*
724 * 0. Initial state
725 *
726 * Other FSM states can be visited zero or more times, but
727 * this state is visited exactly once for each RPC.
728 */
729static void
730call_start(struct rpc_task *task)
731{
732 struct rpc_clnt *clnt = task->tk_client;
733
Chuck Lever46121cf2007-01-31 12:14:08 -0500734 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
735 clnt->cl_protname, clnt->cl_vers,
736 task->tk_msg.rpc_proc->p_proc,
737 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
739 /* Increment call count */
740 task->tk_msg.rpc_proc->p_count++;
741 clnt->cl_stats->rpccnt++;
742 task->tk_action = call_reserve;
743}
744
745/*
746 * 1. Reserve an RPC call slot
747 */
748static void
749call_reserve(struct rpc_task *task)
750{
Chuck Lever46121cf2007-01-31 12:14:08 -0500751 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
753 if (!rpcauth_uptodatecred(task)) {
754 task->tk_action = call_refresh;
755 return;
756 }
757
758 task->tk_status = 0;
759 task->tk_action = call_reserveresult;
760 xprt_reserve(task);
761}
762
763/*
764 * 1b. Grok the result of xprt_reserve()
765 */
766static void
767call_reserveresult(struct rpc_task *task)
768{
769 int status = task->tk_status;
770
Chuck Lever46121cf2007-01-31 12:14:08 -0500771 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773 /*
774 * After a call to xprt_reserve(), we must have either
775 * a request slot or else an error status.
776 */
777 task->tk_status = 0;
778 if (status >= 0) {
779 if (task->tk_rqstp) {
780 task->tk_action = call_allocate;
781 return;
782 }
783
784 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
785 __FUNCTION__, status);
786 rpc_exit(task, -EIO);
787 return;
788 }
789
790 /*
791 * Even though there was an error, we may have acquired
792 * a request slot somehow. Make sure not to leak it.
793 */
794 if (task->tk_rqstp) {
795 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
796 __FUNCTION__, status);
797 xprt_release(task);
798 }
799
800 switch (status) {
801 case -EAGAIN: /* woken up; retry */
802 task->tk_action = call_reserve;
803 return;
804 case -EIO: /* probably a shutdown */
805 break;
806 default:
807 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
808 __FUNCTION__, status);
809 break;
810 }
811 rpc_exit(task, status);
812}
813
814/*
815 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100816 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 */
818static void
819call_allocate(struct rpc_task *task)
820{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400821 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100822 struct rpc_rqst *req = task->tk_rqstp;
823 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400824 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Chuck Lever46121cf2007-01-31 12:14:08 -0500826 dprint_status(task);
827
Chuck Lever2bea90d2007-03-29 16:47:53 -0400828 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400830
Chuck Lever02107142006-01-03 09:55:49 +0100831 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 return;
833
Chuck Lever2bea90d2007-03-29 16:47:53 -0400834 if (proc->p_proc != 0) {
835 BUG_ON(proc->p_arglen == 0);
836 if (proc->p_decode != NULL)
837 BUG_ON(proc->p_replen == 0);
838 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Chuck Lever2bea90d2007-03-29 16:47:53 -0400840 /*
841 * Calculate the size (in quads) of the RPC call
842 * and reply headers, and convert both values
843 * to byte sizes.
844 */
845 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
846 req->rq_callsize <<= 2;
847 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
848 req->rq_rcvsize <<= 2;
849
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400850 req->rq_buffer = xprt->ops->buf_alloc(task,
851 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400852 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500854
855 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Trond Myklebust14b218a2005-06-22 17:16:28 +0000857 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400858 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 rpc_delay(task, HZ>>4);
860 return;
861 }
862
863 rpc_exit(task, -ERESTARTSYS);
864}
865
Trond Myklebust940e3312005-11-09 21:45:24 -0500866static inline int
867rpc_task_need_encode(struct rpc_task *task)
868{
869 return task->tk_rqstp->rq_snd_buf.len == 0;
870}
871
872static inline void
873rpc_task_force_reencode(struct rpc_task *task)
874{
875 task->tk_rqstp->rq_snd_buf.len = 0;
876}
877
Chuck Lever2bea90d2007-03-29 16:47:53 -0400878static inline void
879rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
880{
881 buf->head[0].iov_base = start;
882 buf->head[0].iov_len = len;
883 buf->tail[0].iov_len = 0;
884 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400885 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400886 buf->len = 0;
887 buf->buflen = len;
888}
889
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890/*
891 * 3. Encode arguments of an RPC call
892 */
893static void
894call_encode(struct rpc_task *task)
895{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700898 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Chuck Lever46121cf2007-01-31 12:14:08 -0500900 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Chuck Lever2bea90d2007-03-29 16:47:53 -0400902 rpc_xdr_buf_init(&req->rq_snd_buf,
903 req->rq_buffer,
904 req->rq_callsize);
905 rpc_xdr_buf_init(&req->rq_rcv_buf,
906 (char *)req->rq_buffer + req->rq_callsize,
907 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
909 /* Encode header and provided arguments */
910 encode = task->tk_msg.rpc_proc->p_encode;
911 if (!(p = call_header(task))) {
912 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
913 rpc_exit(task, -EIO);
914 return;
915 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400916 if (encode == NULL)
917 return;
918
919 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
920 task->tk_msg.rpc_argp);
921 if (task->tk_status == -ENOMEM) {
922 /* XXX: Is this sane? */
923 rpc_delay(task, 3*HZ);
924 task->tk_status = -EAGAIN;
925 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926}
927
928/*
929 * 4. Get the server port number if not yet set
930 */
931static void
932call_bind(struct rpc_task *task)
933{
Chuck Leverec739ef2006-08-22 20:06:15 -0400934 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Chuck Lever46121cf2007-01-31 12:14:08 -0500936 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Chuck Leverda351872005-08-11 16:25:11 -0400938 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400939 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400940 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400941 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400942 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 }
944}
945
946/*
Chuck Leverda351872005-08-11 16:25:11 -0400947 * 4a. Sort out bind result
948 */
949static void
950call_bind_status(struct rpc_task *task)
951{
Chuck Lever906462a2007-09-11 18:00:47 -0400952 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400953
954 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500955 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400956 task->tk_status = 0;
957 task->tk_action = call_connect;
958 return;
959 }
960
961 switch (task->tk_status) {
Chuck Lever2429cbf2007-09-11 18:00:41 -0400962 case -EAGAIN:
963 dprintk("RPC: %5u rpcbind waiting for another request "
964 "to finish\n", task->tk_pid);
965 /* avoid busy-waiting here -- could be a network outage. */
966 rpc_delay(task, 5*HZ);
967 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400968 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500969 dprintk("RPC: %5u remote rpcbind: RPC program/version "
970 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400971 /* fail immediately if this is an RPC ping */
972 if (task->tk_msg.rpc_proc->p_proc == 0) {
973 status = -EOPNOTSUPP;
974 break;
975 }
Chuck Leverea635a52005-10-06 23:12:58 -0400976 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400977 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400978 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500979 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400980 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400981 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400982 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -0400983 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -0500984 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400985 task->tk_pid);
986 break;
987 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400988 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400989 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400990 task->tk_status = 0;
991 task->tk_action = call_bind;
992 return;
Chuck Leverda351872005-08-11 16:25:11 -0400993 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500994 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -0400995 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -0400996 }
997
998 rpc_exit(task, status);
999 return;
1000
Trond Myklebustda458282006-08-31 15:44:52 -04001001retry_timeout:
1002 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001003}
1004
1005/*
1006 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 */
1008static void
1009call_connect(struct rpc_task *task)
1010{
Chuck Leverda351872005-08-11 16:25:11 -04001011 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
Chuck Lever46121cf2007-01-31 12:14:08 -05001013 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001014 task->tk_pid, xprt,
1015 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Chuck Leverda351872005-08-11 16:25:11 -04001017 task->tk_action = call_transmit;
1018 if (!xprt_connected(xprt)) {
1019 task->tk_action = call_connect_status;
1020 if (task->tk_status < 0)
1021 return;
1022 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
1026/*
Chuck Leverda351872005-08-11 16:25:11 -04001027 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 */
1029static void
1030call_connect_status(struct rpc_task *task)
1031{
1032 struct rpc_clnt *clnt = task->tk_client;
1033 int status = task->tk_status;
1034
Chuck Lever46121cf2007-01-31 12:14:08 -05001035 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001036
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 task->tk_status = 0;
1038 if (status >= 0) {
1039 clnt->cl_stats->netreconn++;
1040 task->tk_action = call_transmit;
1041 return;
1042 }
1043
Chuck Leverda351872005-08-11 16:25:11 -04001044 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001045 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001046
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 switch (status) {
1048 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001050 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001051 if (!RPC_IS_SOFT(task))
1052 return;
1053 /* if soft mounted, test if we've timed out */
1054 case -ETIMEDOUT:
1055 task->tk_action = call_timeout;
1056 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 }
Trond Myklebustda458282006-08-31 15:44:52 -04001058 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059}
1060
1061/*
1062 * 5. Transmit the RPC request, and wait for reply
1063 */
1064static void
1065call_transmit(struct rpc_task *task)
1066{
Chuck Lever46121cf2007-01-31 12:14:08 -05001067 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
1069 task->tk_action = call_status;
1070 if (task->tk_status < 0)
1071 return;
1072 task->tk_status = xprt_prepare_transmit(task);
1073 if (task->tk_status != 0)
1074 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001075 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001077 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001078 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001080 /* Did the encode result in an error condition? */
1081 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001082 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001083 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 xprt_transmit(task);
1085 if (task->tk_status < 0)
1086 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001087 /*
1088 * On success, ensure that we call xprt_end_transmit() before sleeping
1089 * in order to allow access to the socket to other RPC requests.
1090 */
1091 call_transmit_status(task);
1092 if (task->tk_msg.rpc_proc->p_decode != NULL)
1093 return;
1094 task->tk_action = rpc_exit_task;
1095 rpc_wake_up_task(task);
1096}
1097
1098/*
1099 * 5a. Handle cleanup after a transmission
1100 */
1101static void
1102call_transmit_status(struct rpc_task *task)
1103{
1104 task->tk_action = call_status;
1105 /*
1106 * Special case: if we've been waiting on the socket's write_space()
1107 * callback, then don't call xprt_end_transmit().
1108 */
1109 if (task->tk_status == -EAGAIN)
1110 return;
1111 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001112 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113}
1114
1115/*
1116 * 6. Sort out the RPC call status
1117 */
1118static void
1119call_status(struct rpc_task *task)
1120{
1121 struct rpc_clnt *clnt = task->tk_client;
1122 struct rpc_rqst *req = task->tk_rqstp;
1123 int status;
1124
1125 if (req->rq_received > 0 && !req->rq_bytes_sent)
1126 task->tk_status = req->rq_received;
1127
Chuck Lever46121cf2007-01-31 12:14:08 -05001128 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
1130 status = task->tk_status;
1131 if (status >= 0) {
1132 task->tk_action = call_decode;
1133 return;
1134 }
1135
1136 task->tk_status = 0;
1137 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001138 case -EHOSTDOWN:
1139 case -EHOSTUNREACH:
1140 case -ENETUNREACH:
1141 /*
1142 * Delay any retries for 3 seconds, then handle as if it
1143 * were a timeout.
1144 */
1145 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 case -ETIMEDOUT:
1147 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001148 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001149 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 break;
1151 case -ECONNREFUSED:
1152 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001153 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 task->tk_action = call_bind;
1155 break;
1156 case -EAGAIN:
1157 task->tk_action = call_transmit;
1158 break;
1159 case -EIO:
1160 /* shutdown or soft timeout */
1161 rpc_exit(task, status);
1162 break;
1163 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001164 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 clnt->cl_protname, -status);
1166 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 }
1168}
1169
1170/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001171 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 * We do not release the request slot, so we keep using the
1173 * same XID for all retransmits.
1174 */
1175static void
1176call_timeout(struct rpc_task *task)
1177{
1178 struct rpc_clnt *clnt = task->tk_client;
1179
1180 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001181 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 goto retry;
1183 }
1184
Chuck Lever46121cf2007-01-31 12:14:08 -05001185 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001186 task->tk_timeouts++;
1187
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001189 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 clnt->cl_protname, clnt->cl_server);
1191 rpc_exit(task, -EIO);
1192 return;
1193 }
1194
Chuck Leverf518e35a2006-01-03 09:55:52 +01001195 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 task->tk_flags |= RPC_CALL_MAJORSEEN;
1197 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1198 clnt->cl_protname, clnt->cl_server);
1199 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001200 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
1202retry:
1203 clnt->cl_stats->rpcretrans++;
1204 task->tk_action = call_bind;
1205 task->tk_status = 0;
1206}
1207
1208/*
1209 * 7. Decode the RPC reply
1210 */
1211static void
1212call_decode(struct rpc_task *task)
1213{
1214 struct rpc_clnt *clnt = task->tk_client;
1215 struct rpc_rqst *req = task->tk_rqstp;
1216 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001217 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Chuck Lever46121cf2007-01-31 12:14:08 -05001219 dprintk("RPC: %5u call_decode (status %d)\n",
1220 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Chuck Leverf518e35a2006-01-03 09:55:52 +01001222 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 printk(KERN_NOTICE "%s: server %s OK\n",
1224 clnt->cl_protname, clnt->cl_server);
1225 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1226 }
1227
1228 if (task->tk_status < 12) {
1229 if (!RPC_IS_SOFT(task)) {
1230 task->tk_action = call_bind;
1231 clnt->cl_stats->rpcretrans++;
1232 goto out_retry;
1233 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001234 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1235 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001236 task->tk_action = call_timeout;
1237 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 }
1239
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001240 /*
1241 * Ensure that we see all writes made by xprt_complete_rqst()
1242 * before it changed req->rq_received.
1243 */
1244 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 req->rq_rcv_buf.len = req->rq_private_buf.len;
1246
1247 /* Check that the softirq receive buffer is valid */
1248 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1249 sizeof(req->rq_rcv_buf)) != 0);
1250
1251 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001252 p = call_verify(task);
1253 if (IS_ERR(p)) {
1254 if (p == ERR_PTR(-EAGAIN))
1255 goto out_retry;
1256 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 }
1258
Trond Myklebustabbcf282006-01-03 09:55:03 +01001259 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001261 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1263 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001264 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001265 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1266 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 return;
1268out_retry:
1269 req->rq_received = req->rq_private_buf.len = 0;
1270 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001271 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001272 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273}
1274
1275/*
1276 * 8. Refresh the credentials if rejected by the server
1277 */
1278static void
1279call_refresh(struct rpc_task *task)
1280{
Chuck Lever46121cf2007-01-31 12:14:08 -05001281 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 task->tk_action = call_refreshresult;
1284 task->tk_status = 0;
1285 task->tk_client->cl_stats->rpcauthrefresh++;
1286 rpcauth_refreshcred(task);
1287}
1288
1289/*
1290 * 8a. Process the results of a credential refresh
1291 */
1292static void
1293call_refreshresult(struct rpc_task *task)
1294{
1295 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001296
1297 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
1299 task->tk_status = 0;
1300 task->tk_action = call_reserve;
1301 if (status >= 0 && rpcauth_uptodatecred(task))
1302 return;
1303 if (status == -EACCES) {
1304 rpc_exit(task, -EACCES);
1305 return;
1306 }
1307 task->tk_action = call_refresh;
1308 if (status != -ETIMEDOUT)
1309 rpc_delay(task, 3*HZ);
1310 return;
1311}
1312
1313/*
1314 * Call header serialization
1315 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001316static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317call_header(struct rpc_task *task)
1318{
1319 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001321 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
1323 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001324
1325 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 *p++ = req->rq_xid; /* XID */
1327 *p++ = htonl(RPC_CALL); /* CALL */
1328 *p++ = htonl(RPC_VERSION); /* RPC version */
1329 *p++ = htonl(clnt->cl_prog); /* program number */
1330 *p++ = htonl(clnt->cl_vers); /* program version */
1331 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001332 p = rpcauth_marshcred(task, p);
1333 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1334 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335}
1336
1337/*
1338 * Reply header verification
1339 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001340static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341call_verify(struct rpc_task *task)
1342{
1343 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1344 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001345 __be32 *p = iov->iov_base;
1346 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 int error = -EACCES;
1348
David Howellse8896492006-08-24 15:44:19 -04001349 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1350 /* RFC-1014 says that the representation of XDR data must be a
1351 * multiple of four bytes
1352 * - if it isn't pointer subtraction in the NFS client may give
1353 * undefined results
1354 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001355 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1356 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1357 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001358 goto out_eio;
1359 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 if ((len -= 3) < 0)
1361 goto out_overflow;
1362 p += 1; /* skip XID */
1363
1364 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001365 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1366 task->tk_pid, __FUNCTION__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001367 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
1369 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1370 if (--len < 0)
1371 goto out_overflow;
1372 switch ((n = ntohl(*p++))) {
1373 case RPC_AUTH_ERROR:
1374 break;
1375 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001376 dprintk("RPC: %5u %s: RPC call version "
1377 "mismatch!\n",
1378 task->tk_pid, __FUNCTION__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001379 error = -EPROTONOSUPPORT;
1380 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001382 dprintk("RPC: %5u %s: RPC call rejected, "
1383 "unknown error: %x\n",
1384 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 goto out_eio;
1386 }
1387 if (--len < 0)
1388 goto out_overflow;
1389 switch ((n = ntohl(*p++))) {
1390 case RPC_AUTH_REJECTEDCRED:
1391 case RPC_AUTH_REJECTEDVERF:
1392 case RPCSEC_GSS_CREDPROBLEM:
1393 case RPCSEC_GSS_CTXPROBLEM:
1394 if (!task->tk_cred_retry)
1395 break;
1396 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001397 dprintk("RPC: %5u %s: retry stale creds\n",
1398 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001400 /* Ensure we obtain a new XID! */
1401 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001403 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 case RPC_AUTH_BADCRED:
1405 case RPC_AUTH_BADVERF:
1406 /* possibly garbled cred/verf? */
1407 if (!task->tk_garb_retry)
1408 break;
1409 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001410 dprintk("RPC: %5u %s: retry garbled creds\n",
1411 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001413 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001415 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1416 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 break;
1418 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001419 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1420 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 error = -EIO;
1422 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001423 dprintk("RPC: %5u %s: call rejected %d\n",
1424 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 goto out_err;
1426 }
1427 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001428 dprintk("RPC: %5u %s: auth check failed\n",
1429 task->tk_pid, __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001430 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001432 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 if (len < 0)
1434 goto out_overflow;
1435 switch ((n = ntohl(*p++))) {
1436 case RPC_SUCCESS:
1437 return p;
1438 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001439 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1440 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 (unsigned int)task->tk_client->cl_prog,
1442 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001443 error = -EPFNOSUPPORT;
1444 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001446 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1447 "server %s\n", task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 (unsigned int)task->tk_client->cl_prog,
1449 (unsigned int)task->tk_client->cl_vers,
1450 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001451 error = -EPROTONOSUPPORT;
1452 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001454 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1455 "version %u on server %s\n",
1456 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 task->tk_msg.rpc_proc,
1458 task->tk_client->cl_prog,
1459 task->tk_client->cl_vers,
1460 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001461 error = -EOPNOTSUPP;
1462 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001464 dprintk("RPC: %5u %s: server saw garbage\n",
1465 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 break; /* retry */
1467 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001468 dprintk("RPC: %5u %s: server accept status: %x\n",
1469 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 /* Also retry */
1471 }
1472
Trond Myklebustabbcf282006-01-03 09:55:03 +01001473out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 task->tk_client->cl_stats->rpcgarbage++;
1475 if (task->tk_garb_retry) {
1476 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001477 dprintk("RPC: %5u %s: retrying\n",
1478 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001480out_retry:
1481 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483out_eio:
1484 error = -EIO;
1485out_err:
1486 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001487 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1488 __FUNCTION__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001489 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001491 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1492 __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001493 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001495
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001496static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001497{
1498 return 0;
1499}
1500
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001501static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001502{
1503 return 0;
1504}
1505
1506static struct rpc_procinfo rpcproc_null = {
1507 .p_encode = rpcproc_encode_null,
1508 .p_decode = rpcproc_decode_null,
1509};
1510
Trond Myklebust64c91a12007-06-23 10:17:16 -04001511static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001512{
1513 struct rpc_message msg = {
1514 .rpc_proc = &rpcproc_null,
1515 };
1516 int err;
1517 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1518 err = rpc_call_sync(clnt, &msg, flags);
1519 put_rpccred(msg.rpc_cred);
1520 return err;
1521}
Trond Myklebust188fef12007-06-16 14:18:40 -04001522
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001523struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1524{
1525 struct rpc_message msg = {
1526 .rpc_proc = &rpcproc_null,
1527 .rpc_cred = cred,
1528 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001529 struct rpc_task_setup task_setup_data = {
1530 .rpc_client = clnt,
1531 .rpc_message = &msg,
1532 .callback_ops = &rpc_default_ops,
1533 .flags = flags,
1534 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001535 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001536}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001537EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001538
Trond Myklebust188fef12007-06-16 14:18:40 -04001539#ifdef RPC_DEBUG
1540void rpc_show_tasks(void)
1541{
1542 struct rpc_clnt *clnt;
1543 struct rpc_task *t;
1544
1545 spin_lock(&rpc_client_lock);
1546 if (list_empty(&all_clients))
1547 goto out;
1548 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1549 "-rpcwait -action- ---ops--\n");
1550 list_for_each_entry(clnt, &all_clients, cl_clients) {
1551 if (list_empty(&clnt->cl_tasks))
1552 continue;
1553 spin_lock(&clnt->cl_lock);
1554 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1555 const char *rpc_waitq = "none";
Chuck Leverd66968f2007-09-11 18:00:25 -04001556 int proc;
1557
1558 if (t->tk_msg.rpc_proc)
1559 proc = t->tk_msg.rpc_proc->p_proc;
1560 else
1561 proc = -1;
Trond Myklebust188fef12007-06-16 14:18:40 -04001562
1563 if (RPC_IS_QUEUED(t))
1564 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1565
1566 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
Chuck Leverd66968f2007-09-11 18:00:25 -04001567 t->tk_pid, proc,
Trond Myklebust188fef12007-06-16 14:18:40 -04001568 t->tk_flags, t->tk_status,
1569 t->tk_client,
1570 (t->tk_client ? t->tk_client->cl_prog : 0),
1571 t->tk_rqstp, t->tk_timeout,
1572 rpc_waitq,
1573 t->tk_action, t->tk_ops);
1574 }
1575 spin_unlock(&clnt->cl_lock);
1576 }
1577out:
1578 spin_unlock(&rpc_client_lock);
1579}
1580#endif