blob: 13a3718e7cc9026dcc0c6e52e0a15cd9732b07ba [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>
Chuck Lever510deb02007-12-10 14:56:24 -050033#include <linux/in6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050037#include <linux/sunrpc/metrics.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#ifdef RPC_DEBUG
41# define RPCDBG_FACILITY RPCDBG_CALL
42#endif
43
Chuck Lever46121cf2007-01-31 12:14:08 -050044#define dprint_status(t) \
45 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080046 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050047
Trond Myklebust188fef12007-06-16 14:18:40 -040048/*
49 * All RPC clients are linked into this list
50 */
51static LIST_HEAD(all_clients);
52static DEFINE_SPINLOCK(rpc_client_lock);
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
55
56
57static void call_start(struct rpc_task *task);
58static void call_reserve(struct rpc_task *task);
59static void call_reserveresult(struct rpc_task *task);
60static void call_allocate(struct rpc_task *task);
61static void call_encode(struct rpc_task *task);
62static void call_decode(struct rpc_task *task);
63static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040064static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065static void call_transmit(struct rpc_task *task);
66static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050067static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068static void call_refresh(struct rpc_task *task);
69static void call_refreshresult(struct rpc_task *task);
70static void call_timeout(struct rpc_task *task);
71static void call_connect(struct rpc_task *task);
72static void call_connect_status(struct rpc_task *task);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070073static __be32 * call_header(struct rpc_task *task);
74static __be32 * call_verify(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Trond Myklebust64c91a12007-06-23 10:17:16 -040076static int rpc_ping(struct rpc_clnt *clnt, int flags);
77
Trond Myklebust188fef12007-06-16 14:18:40 -040078static void rpc_register_client(struct rpc_clnt *clnt)
79{
80 spin_lock(&rpc_client_lock);
81 list_add(&clnt->cl_clients, &all_clients);
82 spin_unlock(&rpc_client_lock);
83}
84
85static void rpc_unregister_client(struct rpc_clnt *clnt)
86{
87 spin_lock(&rpc_client_lock);
88 list_del(&clnt->cl_clients);
89 spin_unlock(&rpc_client_lock);
90}
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92static int
93rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
94{
Trond Myklebustf1345852005-09-23 11:08:25 -040095 static uint32_t clntid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 int error;
97
Trond Myklebust54281542006-03-20 13:44:49 -050098 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
99 clnt->cl_dentry = ERR_PTR(-ENOENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 if (dir_name == NULL)
101 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500102
103 clnt->cl_vfsmnt = rpc_get_mount();
104 if (IS_ERR(clnt->cl_vfsmnt))
105 return PTR_ERR(clnt->cl_vfsmnt);
106
Trond Myklebustf1345852005-09-23 11:08:25 -0400107 for (;;) {
108 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
109 "%s/clnt%x", dir_name,
110 (unsigned int)clntid++);
111 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
112 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
113 if (!IS_ERR(clnt->cl_dentry))
114 return 0;
Christoph Hellwig278c9952005-07-24 23:53:01 +0100115 error = PTR_ERR(clnt->cl_dentry);
Trond Myklebustf1345852005-09-23 11:08:25 -0400116 if (error != -EEXIST) {
117 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
118 clnt->cl_pathname, error);
Trond Myklebust54281542006-03-20 13:44:49 -0500119 rpc_put_mount();
Trond Myklebustf1345852005-09-23 11:08:25 -0400120 return error;
121 }
Christoph Hellwig278c9952005-07-24 23:53:01 +0100122 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123}
124
Trond Myklebust698b6d02007-12-20 16:03:53 -0500125static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500127 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 struct rpc_version *version;
129 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000130 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400132 size_t len;
133
134 /* sanity check the name before trying to print it */
135 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500136 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400137 if (len > RPC_MAXNETNAMELEN)
138 goto out_no_rpciod;
139 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Chuck Lever46121cf2007-01-31 12:14:08 -0500141 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500142 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Trond Myklebust4ada5392007-06-14 17:26:17 -0400144 err = rpciod_up();
145 if (err)
146 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 err = -EINVAL;
148 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800149 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500150
151 if (args->version >= program->nrvers)
152 goto out_err;
153 version = program->version[args->version];
154 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 goto out_err;
156
157 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700158 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 if (!clnt)
160 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 clnt->cl_parent = clnt;
162
163 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 if (len > sizeof(clnt->cl_inline_name)) {
165 char *buf = kmalloc(len, GFP_KERNEL);
Trond Myklebust698b6d02007-12-20 16:03:53 -0500166 if (buf != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 clnt->cl_server = buf;
168 else
169 len = sizeof(clnt->cl_inline_name);
170 }
Trond Myklebust698b6d02007-12-20 16:03:53 -0500171 strlcpy(clnt->cl_server, args->servername, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173 clnt->cl_xprt = xprt;
174 clnt->cl_procinfo = version->procs;
175 clnt->cl_maxproc = version->nrprocs;
176 clnt->cl_protname = program->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 clnt->cl_prog = program->number;
178 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500180 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500181 err = -ENOMEM;
182 if (clnt->cl_metrics == NULL)
183 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500184 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400185 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400186 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Chuck Leverec739ef2006-08-22 20:06:15 -0400188 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 clnt->cl_autobind = 1;
190
Trond Myklebustba7392b2007-12-20 16:03:55 -0500191 clnt->cl_timeout = xprt->timeout;
192 if (args->timeout != NULL) {
193 memcpy(&clnt->cl_timeout_default, args->timeout,
194 sizeof(clnt->cl_timeout_default));
195 clnt->cl_timeout = &clnt->cl_timeout_default;
196 }
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500199 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Trond Myklebust34f52e32007-06-14 16:40:31 -0400201 kref_init(&clnt->cl_kref);
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
204 if (err < 0)
205 goto out_no_path;
206
Trond Myklebust698b6d02007-12-20 16:03:53 -0500207 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000208 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500210 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000211 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 goto out_no_auth;
213 }
214
215 /* save the nodename */
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700216 clnt->cl_nodelen = strlen(utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 if (clnt->cl_nodelen > UNX_MAXNODENAME)
218 clnt->cl_nodelen = UNX_MAXNODENAME;
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700219 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400220 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 return clnt;
222
223out_no_auth:
Trond Myklebust54281542006-03-20 13:44:49 -0500224 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700225 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust54281542006-03-20 13:44:49 -0500226 rpc_put_mount();
227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500229 rpc_free_iostats(clnt->cl_metrics);
230out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 if (clnt->cl_server != clnt->cl_inline_name)
232 kfree(clnt->cl_server);
233 kfree(clnt);
234out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400235 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800236out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400237 rpciod_down();
238out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 return ERR_PTR(err);
240}
241
Chuck Leverc2866762006-08-22 20:06:20 -0400242/*
243 * rpc_create - create an RPC client and transport with one call
244 * @args: rpc_clnt create argument structure
245 *
246 * Creates and initializes an RPC transport and an RPC client.
247 *
248 * It can ping the server in order to determine if it is up, and to see if
249 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
250 * this behavior so asynchronous tasks can also use rpc_create.
251 */
252struct rpc_clnt *rpc_create(struct rpc_create_args *args)
253{
254 struct rpc_xprt *xprt;
255 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400256 struct xprt_create xprtargs = {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400257 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200258 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200259 .dstaddr = args->address,
260 .addrlen = args->addrsize,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200261 };
Chuck Lever510deb02007-12-10 14:56:24 -0500262 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400263
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200264 xprt = xprt_create_transport(&xprtargs);
Chuck Leverc2866762006-08-22 20:06:20 -0400265 if (IS_ERR(xprt))
266 return (struct rpc_clnt *)xprt;
267
268 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400269 * If the caller chooses not to specify a hostname, whip
270 * up a string representation of the passed-in address.
271 */
272 if (args->servername == NULL) {
Chuck Lever510deb02007-12-10 14:56:24 -0500273 servername[0] = '\0';
274 switch (args->address->sa_family) {
275 case AF_INET: {
276 struct sockaddr_in *sin =
277 (struct sockaddr_in *)args->address;
278 snprintf(servername, sizeof(servername), NIPQUAD_FMT,
279 NIPQUAD(sin->sin_addr.s_addr));
280 break;
281 }
282 case AF_INET6: {
283 struct sockaddr_in6 *sin =
284 (struct sockaddr_in6 *)args->address;
285 snprintf(servername, sizeof(servername), NIP6_FMT,
286 NIP6(sin->sin6_addr));
287 break;
288 }
289 default:
290 /* caller wants default server name, but
291 * address family isn't recognized. */
292 return ERR_PTR(-EINVAL);
293 }
Chuck Lever43780b82007-07-01 12:13:22 -0400294 args->servername = servername;
295 }
296
Chuck Lever510deb02007-12-10 14:56:24 -0500297 xprt = xprt_create_transport(&xprtargs);
298 if (IS_ERR(xprt))
299 return (struct rpc_clnt *)xprt;
300
Chuck Lever43780b82007-07-01 12:13:22 -0400301 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400302 * By default, kernel RPC client connects from a reserved port.
303 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
304 * but it is always enabled for rpciod, which handles the connect
305 * operation.
306 */
307 xprt->resvport = 1;
308 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
309 xprt->resvport = 0;
310
Trond Myklebust698b6d02007-12-20 16:03:53 -0500311 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400312 if (IS_ERR(clnt))
313 return clnt;
314
315 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Matthew Wilcox150030b2007-12-06 16:24:39 -0500316 int err = rpc_ping(clnt, RPC_TASK_SOFT);
Chuck Leverc2866762006-08-22 20:06:20 -0400317 if (err != 0) {
318 rpc_shutdown_client(clnt);
319 return ERR_PTR(err);
320 }
321 }
322
323 clnt->cl_softrtry = 1;
324 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
325 clnt->cl_softrtry = 0;
326
Chuck Leverc2866762006-08-22 20:06:20 -0400327 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
328 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500329 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
330 clnt->cl_discrtry = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400331
332 return clnt;
333}
Chuck Leverb86acd52006-08-22 20:06:22 -0400334EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336/*
337 * This function clones the RPC client structure. It allows us to share the
338 * same transport while varying parameters such as the authentication
339 * flavour.
340 */
341struct rpc_clnt *
342rpc_clone_client(struct rpc_clnt *clnt)
343{
344 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500345 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200347 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 if (!new)
349 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400350 new->cl_parent = clnt;
351 /* Turn off autobind on clones */
352 new->cl_autobind = 0;
353 INIT_LIST_HEAD(&new->cl_tasks);
354 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500355 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500356 new->cl_metrics = rpc_alloc_iostats(clnt);
357 if (new->cl_metrics == NULL)
358 goto out_no_stats;
Trond Myklebust34f52e32007-06-14 16:40:31 -0400359 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500360 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
361 if (err != 0)
362 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 if (new->cl_auth)
364 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400365 xprt_get(clnt->cl_xprt);
366 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400367 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400368 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500370out_no_path:
371 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500372out_no_stats:
373 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800375 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500376 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400378EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380/*
381 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400382 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400384void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400386 dprintk("RPC: shutting down %s client for %s\n",
387 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Trond Myklebust34f52e32007-06-14 16:40:31 -0400389 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800391 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400392 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 }
394
Trond Myklebust4c402b42007-06-14 16:40:32 -0400395 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400397EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400400 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400402static void
403rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400405 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Chuck Lever46121cf2007-01-31 12:14:08 -0500407 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 clnt->cl_protname, clnt->cl_server);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400409 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700410 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400411 rpc_put_mount();
412 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500413 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400414 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500415 goto out_free;
416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 if (clnt->cl_server != clnt->cl_inline_name)
418 kfree(clnt->cl_server);
419out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400420 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500421 rpc_free_iostats(clnt->cl_metrics);
422 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400423 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400424 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426}
427
428/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400429 * Free an RPC client
430 */
431static void
432rpc_free_auth(struct kref *kref)
433{
434 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
435
436 if (clnt->cl_auth == NULL) {
437 rpc_free_client(kref);
438 return;
439 }
440
441 /*
442 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
443 * release remaining GSS contexts. This mechanism ensures
444 * that it can do so safely.
445 */
446 kref_init(kref);
447 rpcauth_release(clnt->cl_auth);
448 clnt->cl_auth = NULL;
449 kref_put(kref, rpc_free_client);
450}
451
452/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400453 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 */
455void
456rpc_release_client(struct rpc_clnt *clnt)
457{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400458 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Trond Myklebust34f52e32007-06-14 16:40:31 -0400460 if (list_empty(&clnt->cl_tasks))
461 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400462 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400463}
464
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000465/**
466 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800467 * @old: old rpc_client
468 * @program: rpc program to set
469 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000470 *
471 * Clones the rpc client and sets up a new RPC program. This is mainly
472 * of use for enabling different RPC programs to share the same transport.
473 * The Sun NFSv2/v3 ACL protocol can do this.
474 */
475struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
476 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400477 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000478{
479 struct rpc_clnt *clnt;
480 struct rpc_version *version;
481 int err;
482
483 BUG_ON(vers >= program->nrvers || !program->version[vers]);
484 version = program->version[vers];
485 clnt = rpc_clone_client(old);
486 if (IS_ERR(clnt))
487 goto out;
488 clnt->cl_procinfo = version->procs;
489 clnt->cl_maxproc = version->nrprocs;
490 clnt->cl_protname = program->name;
491 clnt->cl_prog = program->number;
492 clnt->cl_vers = version->number;
493 clnt->cl_stats = program->stats;
Matthew Wilcox150030b2007-12-06 16:24:39 -0500494 err = rpc_ping(clnt, RPC_TASK_SOFT);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000495 if (err != 0) {
496 rpc_shutdown_client(clnt);
497 clnt = ERR_PTR(err);
498 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800499out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000500 return clnt;
501}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400502EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504/*
505 * Default callback for async RPC calls
506 */
507static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100508rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
510}
511
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100512static const struct rpc_call_ops rpc_default_ops = {
513 .rpc_call_done = rpc_default_callback,
514};
515
Trond Myklebustc970aa82007-07-14 15:39:59 -0400516/**
517 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
518 * @task_setup_data: pointer to task initialisation data
519 */
520struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400521{
522 struct rpc_task *task, *ret;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400523
Trond Myklebust84115e12007-07-14 15:39:59 -0400524 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400525 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400526 rpc_release_calldata(task_setup_data->callback_ops,
527 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400528 ret = ERR_PTR(-ENOMEM);
529 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400530 }
531
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400532 if (task->tk_status != 0) {
533 ret = ERR_PTR(task->tk_status);
534 rpc_put_task(task);
535 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400536 }
537 atomic_inc(&task->tk_count);
538 rpc_execute(task);
539 ret = task;
540out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400541 return ret;
542}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400543EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400544
545/**
546 * rpc_call_sync - Perform a synchronous RPC call
547 * @clnt: pointer to RPC client
548 * @msg: RPC call parameters
549 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 */
551int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
552{
553 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400554 struct rpc_task_setup task_setup_data = {
555 .rpc_client = clnt,
556 .rpc_message = msg,
557 .callback_ops = &rpc_default_ops,
558 .flags = flags,
559 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400560 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 BUG_ON(flags & RPC_TASK_ASYNC);
563
Trond Myklebustc970aa82007-07-14 15:39:59 -0400564 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400565 if (IS_ERR(task))
566 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100567 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800568 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return status;
570}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400571EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400573/**
574 * rpc_call_async - Perform an asynchronous RPC call
575 * @clnt: pointer to RPC client
576 * @msg: RPC call parameters
577 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800578 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400579 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 */
581int
582rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100583 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
585 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400586 struct rpc_task_setup task_setup_data = {
587 .rpc_client = clnt,
588 .rpc_message = msg,
589 .callback_ops = tk_ops,
590 .callback_data = data,
591 .flags = flags|RPC_TASK_ASYNC,
592 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Trond Myklebustc970aa82007-07-14 15:39:59 -0400594 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400595 if (IS_ERR(task))
596 return PTR_ERR(task);
597 rpc_put_task(task);
598 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400600EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400603rpc_call_start(struct rpc_task *task)
604{
605 task->tk_action = call_start;
606}
607EXPORT_SYMBOL_GPL(rpc_call_start);
608
Chuck Levered394402006-08-22 20:06:17 -0400609/**
610 * rpc_peeraddr - extract remote peer address from clnt's xprt
611 * @clnt: RPC client structure
612 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800613 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400614 *
615 * Returns the number of bytes that are actually in the stored address.
616 */
617size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
618{
619 size_t bytes;
620 struct rpc_xprt *xprt = clnt->cl_xprt;
621
622 bytes = sizeof(xprt->addr);
623 if (bytes > bufsize)
624 bytes = bufsize;
625 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400626 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400627}
Chuck Leverb86acd52006-08-22 20:06:22 -0400628EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400629
Chuck Leverf425eba2006-08-22 20:06:18 -0400630/**
631 * rpc_peeraddr2str - return remote peer address in printable format
632 * @clnt: RPC client structure
633 * @format: address format
634 *
635 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500636const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
637 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400638{
639 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500640
641 if (xprt->address_strings[format] != NULL)
642 return xprt->address_strings[format];
643 else
644 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400645}
Chuck Leverb86acd52006-08-22 20:06:22 -0400646EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648void
649rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
650{
651 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700652 if (xprt->ops->set_buffer_size)
653 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400655EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657/*
658 * Return size of largest payload RPC client can support, in bytes
659 *
660 * For stream transports, this is one RPC record fragment (see RFC
661 * 1831), as we don't support multi-record requests yet. For datagram
662 * transports, this is the size of an IP packet minus the IP, UDP, and
663 * RPC header sizes.
664 */
665size_t rpc_max_payload(struct rpc_clnt *clnt)
666{
667 return clnt->cl_xprt->max_payload;
668}
Chuck Leverb86acd52006-08-22 20:06:22 -0400669EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
Chuck Lever35f5a422006-01-03 09:55:50 +0100671/**
672 * rpc_force_rebind - force transport to check that remote port is unchanged
673 * @clnt: client to rebind
674 *
675 */
676void rpc_force_rebind(struct rpc_clnt *clnt)
677{
678 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400679 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100680}
Chuck Leverb86acd52006-08-22 20:06:22 -0400681EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683/*
684 * Restart an (async) RPC call. Usually called from within the
685 * exit handler.
686 */
687void
688rpc_restart_call(struct rpc_task *task)
689{
690 if (RPC_ASSASSINATED(task))
691 return;
692
693 task->tk_action = call_start;
694}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400695EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697/*
698 * 0. Initial state
699 *
700 * Other FSM states can be visited zero or more times, but
701 * this state is visited exactly once for each RPC.
702 */
703static void
704call_start(struct rpc_task *task)
705{
706 struct rpc_clnt *clnt = task->tk_client;
707
Chuck Lever46121cf2007-01-31 12:14:08 -0500708 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
709 clnt->cl_protname, clnt->cl_vers,
710 task->tk_msg.rpc_proc->p_proc,
711 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
713 /* Increment call count */
714 task->tk_msg.rpc_proc->p_count++;
715 clnt->cl_stats->rpccnt++;
716 task->tk_action = call_reserve;
717}
718
719/*
720 * 1. Reserve an RPC call slot
721 */
722static void
723call_reserve(struct rpc_task *task)
724{
Chuck Lever46121cf2007-01-31 12:14:08 -0500725 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 if (!rpcauth_uptodatecred(task)) {
728 task->tk_action = call_refresh;
729 return;
730 }
731
732 task->tk_status = 0;
733 task->tk_action = call_reserveresult;
734 xprt_reserve(task);
735}
736
737/*
738 * 1b. Grok the result of xprt_reserve()
739 */
740static void
741call_reserveresult(struct rpc_task *task)
742{
743 int status = task->tk_status;
744
Chuck Lever46121cf2007-01-31 12:14:08 -0500745 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
747 /*
748 * After a call to xprt_reserve(), we must have either
749 * a request slot or else an error status.
750 */
751 task->tk_status = 0;
752 if (status >= 0) {
753 if (task->tk_rqstp) {
754 task->tk_action = call_allocate;
755 return;
756 }
757
758 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800759 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 rpc_exit(task, -EIO);
761 return;
762 }
763
764 /*
765 * Even though there was an error, we may have acquired
766 * a request slot somehow. Make sure not to leak it.
767 */
768 if (task->tk_rqstp) {
769 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800770 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 xprt_release(task);
772 }
773
774 switch (status) {
775 case -EAGAIN: /* woken up; retry */
776 task->tk_action = call_reserve;
777 return;
778 case -EIO: /* probably a shutdown */
779 break;
780 default:
781 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800782 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 break;
784 }
785 rpc_exit(task, status);
786}
787
788/*
789 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100790 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 */
792static void
793call_allocate(struct rpc_task *task)
794{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400795 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100796 struct rpc_rqst *req = task->tk_rqstp;
797 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400798 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Chuck Lever46121cf2007-01-31 12:14:08 -0500800 dprint_status(task);
801
Chuck Lever2bea90d2007-03-29 16:47:53 -0400802 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400804
Chuck Lever02107142006-01-03 09:55:49 +0100805 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 return;
807
Chuck Lever2bea90d2007-03-29 16:47:53 -0400808 if (proc->p_proc != 0) {
809 BUG_ON(proc->p_arglen == 0);
810 if (proc->p_decode != NULL)
811 BUG_ON(proc->p_replen == 0);
812 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Chuck Lever2bea90d2007-03-29 16:47:53 -0400814 /*
815 * Calculate the size (in quads) of the RPC call
816 * and reply headers, and convert both values
817 * to byte sizes.
818 */
819 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
820 req->rq_callsize <<= 2;
821 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
822 req->rq_rcvsize <<= 2;
823
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400824 req->rq_buffer = xprt->ops->buf_alloc(task,
825 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400826 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500828
829 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Trond Myklebust14b218a2005-06-22 17:16:28 +0000831 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400832 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 rpc_delay(task, HZ>>4);
834 return;
835 }
836
837 rpc_exit(task, -ERESTARTSYS);
838}
839
Trond Myklebust940e3312005-11-09 21:45:24 -0500840static inline int
841rpc_task_need_encode(struct rpc_task *task)
842{
843 return task->tk_rqstp->rq_snd_buf.len == 0;
844}
845
846static inline void
847rpc_task_force_reencode(struct rpc_task *task)
848{
849 task->tk_rqstp->rq_snd_buf.len = 0;
850}
851
Chuck Lever2bea90d2007-03-29 16:47:53 -0400852static inline void
853rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
854{
855 buf->head[0].iov_base = start;
856 buf->head[0].iov_len = len;
857 buf->tail[0].iov_len = 0;
858 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400859 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400860 buf->len = 0;
861 buf->buflen = len;
862}
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864/*
865 * 3. Encode arguments of an RPC call
866 */
867static void
868call_encode(struct rpc_task *task)
869{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700872 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Chuck Lever46121cf2007-01-31 12:14:08 -0500874 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
Chuck Lever2bea90d2007-03-29 16:47:53 -0400876 rpc_xdr_buf_init(&req->rq_snd_buf,
877 req->rq_buffer,
878 req->rq_callsize);
879 rpc_xdr_buf_init(&req->rq_rcv_buf,
880 (char *)req->rq_buffer + req->rq_callsize,
881 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
883 /* Encode header and provided arguments */
884 encode = task->tk_msg.rpc_proc->p_encode;
885 if (!(p = call_header(task))) {
886 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
887 rpc_exit(task, -EIO);
888 return;
889 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400890 if (encode == NULL)
891 return;
892
893 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
894 task->tk_msg.rpc_argp);
895 if (task->tk_status == -ENOMEM) {
896 /* XXX: Is this sane? */
897 rpc_delay(task, 3*HZ);
898 task->tk_status = -EAGAIN;
899 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900}
901
902/*
903 * 4. Get the server port number if not yet set
904 */
905static void
906call_bind(struct rpc_task *task)
907{
Chuck Leverec739ef2006-08-22 20:06:15 -0400908 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Chuck Lever46121cf2007-01-31 12:14:08 -0500910 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Chuck Leverda351872005-08-11 16:25:11 -0400912 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400913 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400914 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400915 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400916 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 }
918}
919
920/*
Chuck Leverda351872005-08-11 16:25:11 -0400921 * 4a. Sort out bind result
922 */
923static void
924call_bind_status(struct rpc_task *task)
925{
Chuck Lever906462a2007-09-11 18:00:47 -0400926 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400927
928 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500929 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400930 task->tk_status = 0;
931 task->tk_action = call_connect;
932 return;
933 }
934
935 switch (task->tk_status) {
Chuck Lever2429cbf2007-09-11 18:00:41 -0400936 case -EAGAIN:
937 dprintk("RPC: %5u rpcbind waiting for another request "
938 "to finish\n", task->tk_pid);
939 /* avoid busy-waiting here -- could be a network outage. */
940 rpc_delay(task, 5*HZ);
941 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400942 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500943 dprintk("RPC: %5u remote rpcbind: RPC program/version "
944 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400945 /* fail immediately if this is an RPC ping */
946 if (task->tk_msg.rpc_proc->p_proc == 0) {
947 status = -EOPNOTSUPP;
948 break;
949 }
Chuck Leverea635a52005-10-06 23:12:58 -0400950 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400951 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400952 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500953 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400954 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400955 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400956 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -0400957 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -0500958 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400959 task->tk_pid);
960 break;
961 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400962 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400963 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400964 task->tk_status = 0;
965 task->tk_action = call_bind;
966 return;
Chuck Leverda351872005-08-11 16:25:11 -0400967 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500968 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -0400969 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -0400970 }
971
972 rpc_exit(task, status);
973 return;
974
Trond Myklebustda458282006-08-31 15:44:52 -0400975retry_timeout:
976 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400977}
978
979/*
980 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 */
982static void
983call_connect(struct rpc_task *task)
984{
Chuck Leverda351872005-08-11 16:25:11 -0400985 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Chuck Lever46121cf2007-01-31 12:14:08 -0500987 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -0400988 task->tk_pid, xprt,
989 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Chuck Leverda351872005-08-11 16:25:11 -0400991 task->tk_action = call_transmit;
992 if (!xprt_connected(xprt)) {
993 task->tk_action = call_connect_status;
994 if (task->tk_status < 0)
995 return;
996 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998}
999
1000/*
Chuck Leverda351872005-08-11 16:25:11 -04001001 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 */
1003static void
1004call_connect_status(struct rpc_task *task)
1005{
1006 struct rpc_clnt *clnt = task->tk_client;
1007 int status = task->tk_status;
1008
Chuck Lever46121cf2007-01-31 12:14:08 -05001009 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 task->tk_status = 0;
1012 if (status >= 0) {
1013 clnt->cl_stats->netreconn++;
1014 task->tk_action = call_transmit;
1015 return;
1016 }
1017
Chuck Leverda351872005-08-11 16:25:11 -04001018 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001019 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 switch (status) {
1022 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001024 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001025 if (!RPC_IS_SOFT(task))
1026 return;
1027 /* if soft mounted, test if we've timed out */
1028 case -ETIMEDOUT:
1029 task->tk_action = call_timeout;
1030 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 }
Trond Myklebustda458282006-08-31 15:44:52 -04001032 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033}
1034
1035/*
1036 * 5. Transmit the RPC request, and wait for reply
1037 */
1038static void
1039call_transmit(struct rpc_task *task)
1040{
Chuck Lever46121cf2007-01-31 12:14:08 -05001041 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
1043 task->tk_action = call_status;
1044 if (task->tk_status < 0)
1045 return;
1046 task->tk_status = xprt_prepare_transmit(task);
1047 if (task->tk_status != 0)
1048 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001049 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001051 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001052 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001054 /* Did the encode result in an error condition? */
1055 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001056 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001057 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 xprt_transmit(task);
1059 if (task->tk_status < 0)
1060 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001061 /*
1062 * On success, ensure that we call xprt_end_transmit() before sleeping
1063 * in order to allow access to the socket to other RPC requests.
1064 */
1065 call_transmit_status(task);
1066 if (task->tk_msg.rpc_proc->p_decode != NULL)
1067 return;
1068 task->tk_action = rpc_exit_task;
1069 rpc_wake_up_task(task);
1070}
1071
1072/*
1073 * 5a. Handle cleanup after a transmission
1074 */
1075static void
1076call_transmit_status(struct rpc_task *task)
1077{
1078 task->tk_action = call_status;
1079 /*
1080 * Special case: if we've been waiting on the socket's write_space()
1081 * callback, then don't call xprt_end_transmit().
1082 */
1083 if (task->tk_status == -EAGAIN)
1084 return;
1085 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001086 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087}
1088
1089/*
1090 * 6. Sort out the RPC call status
1091 */
1092static void
1093call_status(struct rpc_task *task)
1094{
1095 struct rpc_clnt *clnt = task->tk_client;
1096 struct rpc_rqst *req = task->tk_rqstp;
1097 int status;
1098
1099 if (req->rq_received > 0 && !req->rq_bytes_sent)
1100 task->tk_status = req->rq_received;
1101
Chuck Lever46121cf2007-01-31 12:14:08 -05001102 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
1104 status = task->tk_status;
1105 if (status >= 0) {
1106 task->tk_action = call_decode;
1107 return;
1108 }
1109
1110 task->tk_status = 0;
1111 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001112 case -EHOSTDOWN:
1113 case -EHOSTUNREACH:
1114 case -ENETUNREACH:
1115 /*
1116 * Delay any retries for 3 seconds, then handle as if it
1117 * were a timeout.
1118 */
1119 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 case -ETIMEDOUT:
1121 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001122 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001123 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 break;
1125 case -ECONNREFUSED:
1126 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001127 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 task->tk_action = call_bind;
1129 break;
1130 case -EAGAIN:
1131 task->tk_action = call_transmit;
1132 break;
1133 case -EIO:
1134 /* shutdown or soft timeout */
1135 rpc_exit(task, status);
1136 break;
1137 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001138 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 clnt->cl_protname, -status);
1140 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 }
1142}
1143
1144/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001145 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 * We do not release the request slot, so we keep using the
1147 * same XID for all retransmits.
1148 */
1149static void
1150call_timeout(struct rpc_task *task)
1151{
1152 struct rpc_clnt *clnt = task->tk_client;
1153
1154 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001155 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 goto retry;
1157 }
1158
Chuck Lever46121cf2007-01-31 12:14:08 -05001159 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001160 task->tk_timeouts++;
1161
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001163 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 clnt->cl_protname, clnt->cl_server);
1165 rpc_exit(task, -EIO);
1166 return;
1167 }
1168
Chuck Leverf518e35a2006-01-03 09:55:52 +01001169 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 task->tk_flags |= RPC_CALL_MAJORSEEN;
1171 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1172 clnt->cl_protname, clnt->cl_server);
1173 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001174 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
1176retry:
1177 clnt->cl_stats->rpcretrans++;
1178 task->tk_action = call_bind;
1179 task->tk_status = 0;
1180}
1181
1182/*
1183 * 7. Decode the RPC reply
1184 */
1185static void
1186call_decode(struct rpc_task *task)
1187{
1188 struct rpc_clnt *clnt = task->tk_client;
1189 struct rpc_rqst *req = task->tk_rqstp;
1190 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001191 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Chuck Lever46121cf2007-01-31 12:14:08 -05001193 dprintk("RPC: %5u call_decode (status %d)\n",
1194 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Chuck Leverf518e35a2006-01-03 09:55:52 +01001196 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 printk(KERN_NOTICE "%s: server %s OK\n",
1198 clnt->cl_protname, clnt->cl_server);
1199 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1200 }
1201
1202 if (task->tk_status < 12) {
1203 if (!RPC_IS_SOFT(task)) {
1204 task->tk_action = call_bind;
1205 clnt->cl_stats->rpcretrans++;
1206 goto out_retry;
1207 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001208 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1209 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001210 task->tk_action = call_timeout;
1211 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 }
1213
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001214 /*
1215 * Ensure that we see all writes made by xprt_complete_rqst()
1216 * before it changed req->rq_received.
1217 */
1218 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 req->rq_rcv_buf.len = req->rq_private_buf.len;
1220
1221 /* Check that the softirq receive buffer is valid */
1222 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1223 sizeof(req->rq_rcv_buf)) != 0);
1224
1225 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001226 p = call_verify(task);
1227 if (IS_ERR(p)) {
1228 if (p == ERR_PTR(-EAGAIN))
1229 goto out_retry;
1230 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 }
1232
Trond Myklebustabbcf282006-01-03 09:55:03 +01001233 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001235 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1237 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001238 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001239 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1240 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return;
1242out_retry:
1243 req->rq_received = req->rq_private_buf.len = 0;
1244 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001245 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001246 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247}
1248
1249/*
1250 * 8. Refresh the credentials if rejected by the server
1251 */
1252static void
1253call_refresh(struct rpc_task *task)
1254{
Chuck Lever46121cf2007-01-31 12:14:08 -05001255 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 task->tk_action = call_refreshresult;
1258 task->tk_status = 0;
1259 task->tk_client->cl_stats->rpcauthrefresh++;
1260 rpcauth_refreshcred(task);
1261}
1262
1263/*
1264 * 8a. Process the results of a credential refresh
1265 */
1266static void
1267call_refreshresult(struct rpc_task *task)
1268{
1269 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001270
1271 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
1273 task->tk_status = 0;
1274 task->tk_action = call_reserve;
1275 if (status >= 0 && rpcauth_uptodatecred(task))
1276 return;
1277 if (status == -EACCES) {
1278 rpc_exit(task, -EACCES);
1279 return;
1280 }
1281 task->tk_action = call_refresh;
1282 if (status != -ETIMEDOUT)
1283 rpc_delay(task, 3*HZ);
1284 return;
1285}
1286
1287/*
1288 * Call header serialization
1289 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001290static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291call_header(struct rpc_task *task)
1292{
1293 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001295 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
1297 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001298
1299 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 *p++ = req->rq_xid; /* XID */
1301 *p++ = htonl(RPC_CALL); /* CALL */
1302 *p++ = htonl(RPC_VERSION); /* RPC version */
1303 *p++ = htonl(clnt->cl_prog); /* program number */
1304 *p++ = htonl(clnt->cl_vers); /* program version */
1305 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001306 p = rpcauth_marshcred(task, p);
1307 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1308 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309}
1310
1311/*
1312 * Reply header verification
1313 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001314static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315call_verify(struct rpc_task *task)
1316{
1317 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1318 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001319 __be32 *p = iov->iov_base;
1320 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 int error = -EACCES;
1322
David Howellse8896492006-08-24 15:44:19 -04001323 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1324 /* RFC-1014 says that the representation of XDR data must be a
1325 * multiple of four bytes
1326 * - if it isn't pointer subtraction in the NFS client may give
1327 * undefined results
1328 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001329 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001330 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001331 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001332 goto out_eio;
1333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 if ((len -= 3) < 0)
1335 goto out_overflow;
1336 p += 1; /* skip XID */
1337
1338 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001339 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001340 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001341 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 }
1343 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1344 if (--len < 0)
1345 goto out_overflow;
1346 switch ((n = ntohl(*p++))) {
1347 case RPC_AUTH_ERROR:
1348 break;
1349 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001350 dprintk("RPC: %5u %s: RPC call version "
1351 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001352 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001353 error = -EPROTONOSUPPORT;
1354 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001356 dprintk("RPC: %5u %s: RPC call rejected, "
1357 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001358 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 goto out_eio;
1360 }
1361 if (--len < 0)
1362 goto out_overflow;
1363 switch ((n = ntohl(*p++))) {
1364 case RPC_AUTH_REJECTEDCRED:
1365 case RPC_AUTH_REJECTEDVERF:
1366 case RPCSEC_GSS_CREDPROBLEM:
1367 case RPCSEC_GSS_CTXPROBLEM:
1368 if (!task->tk_cred_retry)
1369 break;
1370 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001371 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001372 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001374 /* Ensure we obtain a new XID! */
1375 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001377 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 case RPC_AUTH_BADCRED:
1379 case RPC_AUTH_BADVERF:
1380 /* possibly garbled cred/verf? */
1381 if (!task->tk_garb_retry)
1382 break;
1383 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001384 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001385 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001387 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001389 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1390 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 break;
1392 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001393 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001394 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 error = -EIO;
1396 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001397 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001398 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 goto out_err;
1400 }
1401 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001402 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001403 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001404 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001406 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 if (len < 0)
1408 goto out_overflow;
1409 switch ((n = ntohl(*p++))) {
1410 case RPC_SUCCESS:
1411 return p;
1412 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001413 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001414 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 (unsigned int)task->tk_client->cl_prog,
1416 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001417 error = -EPFNOSUPPORT;
1418 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001420 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001421 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 (unsigned int)task->tk_client->cl_prog,
1423 (unsigned int)task->tk_client->cl_vers,
1424 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001425 error = -EPROTONOSUPPORT;
1426 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001428 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1429 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001430 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 task->tk_msg.rpc_proc,
1432 task->tk_client->cl_prog,
1433 task->tk_client->cl_vers,
1434 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001435 error = -EOPNOTSUPP;
1436 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001438 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001439 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 break; /* retry */
1441 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001442 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001443 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 /* Also retry */
1445 }
1446
Trond Myklebustabbcf282006-01-03 09:55:03 +01001447out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 task->tk_client->cl_stats->rpcgarbage++;
1449 if (task->tk_garb_retry) {
1450 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001451 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001452 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001454out_retry:
1455 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457out_eio:
1458 error = -EIO;
1459out_err:
1460 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001461 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001462 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001463 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001465 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001466 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001467 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001469
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001470static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001471{
1472 return 0;
1473}
1474
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001475static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001476{
1477 return 0;
1478}
1479
1480static struct rpc_procinfo rpcproc_null = {
1481 .p_encode = rpcproc_encode_null,
1482 .p_decode = rpcproc_decode_null,
1483};
1484
Trond Myklebust64c91a12007-06-23 10:17:16 -04001485static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001486{
1487 struct rpc_message msg = {
1488 .rpc_proc = &rpcproc_null,
1489 };
1490 int err;
1491 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1492 err = rpc_call_sync(clnt, &msg, flags);
1493 put_rpccred(msg.rpc_cred);
1494 return err;
1495}
Trond Myklebust188fef12007-06-16 14:18:40 -04001496
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001497struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1498{
1499 struct rpc_message msg = {
1500 .rpc_proc = &rpcproc_null,
1501 .rpc_cred = cred,
1502 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001503 struct rpc_task_setup task_setup_data = {
1504 .rpc_client = clnt,
1505 .rpc_message = &msg,
1506 .callback_ops = &rpc_default_ops,
1507 .flags = flags,
1508 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001509 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001510}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001511EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001512
Trond Myklebust188fef12007-06-16 14:18:40 -04001513#ifdef RPC_DEBUG
1514void rpc_show_tasks(void)
1515{
1516 struct rpc_clnt *clnt;
1517 struct rpc_task *t;
1518
1519 spin_lock(&rpc_client_lock);
1520 if (list_empty(&all_clients))
1521 goto out;
1522 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1523 "-rpcwait -action- ---ops--\n");
1524 list_for_each_entry(clnt, &all_clients, cl_clients) {
1525 if (list_empty(&clnt->cl_tasks))
1526 continue;
1527 spin_lock(&clnt->cl_lock);
1528 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1529 const char *rpc_waitq = "none";
Chuck Leverd66968f2007-09-11 18:00:25 -04001530 int proc;
1531
1532 if (t->tk_msg.rpc_proc)
1533 proc = t->tk_msg.rpc_proc->p_proc;
1534 else
1535 proc = -1;
Trond Myklebust188fef12007-06-16 14:18:40 -04001536
1537 if (RPC_IS_QUEUED(t))
1538 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1539
1540 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
Chuck Leverd66968f2007-09-11 18:00:25 -04001541 t->tk_pid, proc,
Trond Myklebust188fef12007-06-16 14:18:40 -04001542 t->tk_flags, t->tk_status,
1543 t->tk_client,
1544 (t->tk_client ? t->tk_client->cl_prog : 0),
1545 t->tk_rqstp, t->tk_timeout,
1546 rpc_waitq,
1547 t->tk_action, t->tk_ops);
1548 }
1549 spin_unlock(&clnt->cl_lock);
1550 }
1551out:
1552 spin_unlock(&rpc_client_lock);
1553}
1554#endif