blob: a3c00da9ce2156ab57f1134c2d8f93cdb7caeb17 [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, \
46 __FUNCTION__, t->tk_status)
47
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)) {
316 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
317 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
327 if (args->flags & RPC_CLNT_CREATE_INTR)
328 clnt->cl_intr = 1;
329 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
330 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500331 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
332 clnt->cl_discrtry = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400333
334 return clnt;
335}
Chuck Leverb86acd52006-08-22 20:06:22 -0400336EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338/*
339 * This function clones the RPC client structure. It allows us to share the
340 * same transport while varying parameters such as the authentication
341 * flavour.
342 */
343struct rpc_clnt *
344rpc_clone_client(struct rpc_clnt *clnt)
345{
346 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500347 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200349 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 if (!new)
351 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400352 new->cl_parent = clnt;
353 /* Turn off autobind on clones */
354 new->cl_autobind = 0;
355 INIT_LIST_HEAD(&new->cl_tasks);
356 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500357 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500358 new->cl_metrics = rpc_alloc_iostats(clnt);
359 if (new->cl_metrics == NULL)
360 goto out_no_stats;
Trond Myklebust34f52e32007-06-14 16:40:31 -0400361 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500362 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
363 if (err != 0)
364 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 if (new->cl_auth)
366 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400367 xprt_get(clnt->cl_xprt);
368 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400369 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400370 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500372out_no_path:
373 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500374out_no_stats:
375 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376out_no_clnt:
Chuck Lever46121cf2007-01-31 12:14:08 -0500377 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500378 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400380EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382/*
383 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400384 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400386void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400388 dprintk("RPC: shutting down %s client for %s\n",
389 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Trond Myklebust34f52e32007-06-14 16:40:31 -0400391 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800393 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400394 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 }
396
Trond Myklebust4c402b42007-06-14 16:40:32 -0400397 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400399EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400402 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400404static void
405rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400407 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Chuck Lever46121cf2007-01-31 12:14:08 -0500409 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 clnt->cl_protname, clnt->cl_server);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400411 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700412 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400413 rpc_put_mount();
414 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500415 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400416 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500417 goto out_free;
418 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 if (clnt->cl_server != clnt->cl_inline_name)
420 kfree(clnt->cl_server);
421out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400422 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500423 rpc_free_iostats(clnt->cl_metrics);
424 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400425 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400426 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428}
429
430/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400431 * Free an RPC client
432 */
433static void
434rpc_free_auth(struct kref *kref)
435{
436 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
437
438 if (clnt->cl_auth == NULL) {
439 rpc_free_client(kref);
440 return;
441 }
442
443 /*
444 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
445 * release remaining GSS contexts. This mechanism ensures
446 * that it can do so safely.
447 */
448 kref_init(kref);
449 rpcauth_release(clnt->cl_auth);
450 clnt->cl_auth = NULL;
451 kref_put(kref, rpc_free_client);
452}
453
454/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400455 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 */
457void
458rpc_release_client(struct rpc_clnt *clnt)
459{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400460 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Trond Myklebust34f52e32007-06-14 16:40:31 -0400462 if (list_empty(&clnt->cl_tasks))
463 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400464 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400465}
466
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000467/**
468 * rpc_bind_new_program - bind a new RPC program to an existing client
469 * @old - old rpc_client
470 * @program - rpc program to set
471 * @vers - rpc program version
472 *
473 * Clones the rpc client and sets up a new RPC program. This is mainly
474 * of use for enabling different RPC programs to share the same transport.
475 * The Sun NFSv2/v3 ACL protocol can do this.
476 */
477struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
478 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400479 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000480{
481 struct rpc_clnt *clnt;
482 struct rpc_version *version;
483 int err;
484
485 BUG_ON(vers >= program->nrvers || !program->version[vers]);
486 version = program->version[vers];
487 clnt = rpc_clone_client(old);
488 if (IS_ERR(clnt))
489 goto out;
490 clnt->cl_procinfo = version->procs;
491 clnt->cl_maxproc = version->nrprocs;
492 clnt->cl_protname = program->name;
493 clnt->cl_prog = program->number;
494 clnt->cl_vers = version->number;
495 clnt->cl_stats = program->stats;
496 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
497 if (err != 0) {
498 rpc_shutdown_client(clnt);
499 clnt = ERR_PTR(err);
500 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800501out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000502 return clnt;
503}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400504EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506/*
507 * Default callback for async RPC calls
508 */
509static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100510rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
512}
513
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100514static const struct rpc_call_ops rpc_default_ops = {
515 .rpc_call_done = rpc_default_callback,
516};
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518/*
Trond Myklebust14b218a2005-06-22 17:16:28 +0000519 * Export the signal mask handling for synchronous code that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 * sleeps on RPC calls
521 */
Trond Myklebust2bd61572006-01-03 09:55:19 +0100522#define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800523
Trond Myklebust14b218a2005-06-22 17:16:28 +0000524static void rpc_save_sigmask(sigset_t *oldset, int intr)
525{
Trond Myklebust2bd61572006-01-03 09:55:19 +0100526 unsigned long sigallow = sigmask(SIGKILL);
Trond Myklebust14b218a2005-06-22 17:16:28 +0000527 sigset_t sigmask;
528
529 /* Block all signals except those listed in sigallow */
530 if (intr)
531 sigallow |= RPC_INTR_SIGNALS;
532 siginitsetinv(&sigmask, sigallow);
533 sigprocmask(SIG_BLOCK, &sigmask, oldset);
534}
535
Trond Myklebust50859252007-10-25 18:19:37 -0400536static void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
Trond Myklebust14b218a2005-06-22 17:16:28 +0000537{
538 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
539}
540
Trond Myklebust50859252007-10-25 18:19:37 -0400541static void rpc_restore_sigmask(sigset_t *oldset)
Trond Myklebust14b218a2005-06-22 17:16:28 +0000542{
543 sigprocmask(SIG_SETMASK, oldset, NULL);
544}
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
547{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000548 rpc_save_sigmask(oldset, clnt->cl_intr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400550EXPORT_SYMBOL_GPL(rpc_clnt_sigmask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
553{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000554 rpc_restore_sigmask(oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400556EXPORT_SYMBOL_GPL(rpc_clnt_sigunmask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Trond Myklebustc970aa82007-07-14 15:39:59 -0400558/**
559 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
560 * @task_setup_data: pointer to task initialisation data
561 */
562struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400563{
564 struct rpc_task *task, *ret;
565 sigset_t oldset;
566
Trond Myklebust84115e12007-07-14 15:39:59 -0400567 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400568 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400569 rpc_release_calldata(task_setup_data->callback_ops,
570 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400571 ret = ERR_PTR(-ENOMEM);
572 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400573 }
574
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400575 if (task->tk_status != 0) {
576 ret = ERR_PTR(task->tk_status);
577 rpc_put_task(task);
578 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400579 }
580 atomic_inc(&task->tk_count);
Trond Myklebust50859252007-10-25 18:19:37 -0400581 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
582 rpc_task_sigmask(task, &oldset);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400583 rpc_execute(task);
Trond Myklebust50859252007-10-25 18:19:37 -0400584 rpc_restore_sigmask(&oldset);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400585 ret = task;
586out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400587 return ret;
588}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400589EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400590
591/**
592 * rpc_call_sync - Perform a synchronous RPC call
593 * @clnt: pointer to RPC client
594 * @msg: RPC call parameters
595 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 */
597int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
598{
599 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400600 struct rpc_task_setup task_setup_data = {
601 .rpc_client = clnt,
602 .rpc_message = msg,
603 .callback_ops = &rpc_default_ops,
604 .flags = flags,
605 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400606 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 BUG_ON(flags & RPC_TASK_ASYNC);
609
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);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100613 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800614 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 return status;
616}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400617EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400619/**
620 * rpc_call_async - Perform an asynchronous RPC call
621 * @clnt: pointer to RPC client
622 * @msg: RPC call parameters
623 * @flags: RPC call flags
624 * @ops: RPC call ops
625 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 */
627int
628rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100629 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
631 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400632 struct rpc_task_setup task_setup_data = {
633 .rpc_client = clnt,
634 .rpc_message = msg,
635 .callback_ops = tk_ops,
636 .callback_data = data,
637 .flags = flags|RPC_TASK_ASYNC,
638 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
Trond Myklebustc970aa82007-07-14 15:39:59 -0400640 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400641 if (IS_ERR(task))
642 return PTR_ERR(task);
643 rpc_put_task(task);
644 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400646EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400649rpc_call_start(struct rpc_task *task)
650{
651 task->tk_action = call_start;
652}
653EXPORT_SYMBOL_GPL(rpc_call_start);
654
Chuck Levered394402006-08-22 20:06:17 -0400655/**
656 * rpc_peeraddr - extract remote peer address from clnt's xprt
657 * @clnt: RPC client structure
658 * @buf: target buffer
659 * @size: length of target buffer
660 *
661 * Returns the number of bytes that are actually in the stored address.
662 */
663size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
664{
665 size_t bytes;
666 struct rpc_xprt *xprt = clnt->cl_xprt;
667
668 bytes = sizeof(xprt->addr);
669 if (bytes > bufsize)
670 bytes = bufsize;
671 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400672 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400673}
Chuck Leverb86acd52006-08-22 20:06:22 -0400674EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400675
Chuck Leverf425eba2006-08-22 20:06:18 -0400676/**
677 * rpc_peeraddr2str - return remote peer address in printable format
678 * @clnt: RPC client structure
679 * @format: address format
680 *
681 */
682char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
683{
684 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500685
686 if (xprt->address_strings[format] != NULL)
687 return xprt->address_strings[format];
688 else
689 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400690}
Chuck Leverb86acd52006-08-22 20:06:22 -0400691EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400692
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693void
694rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
695{
696 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700697 if (xprt->ops->set_buffer_size)
698 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400700EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
702/*
703 * Return size of largest payload RPC client can support, in bytes
704 *
705 * For stream transports, this is one RPC record fragment (see RFC
706 * 1831), as we don't support multi-record requests yet. For datagram
707 * transports, this is the size of an IP packet minus the IP, UDP, and
708 * RPC header sizes.
709 */
710size_t rpc_max_payload(struct rpc_clnt *clnt)
711{
712 return clnt->cl_xprt->max_payload;
713}
Chuck Leverb86acd52006-08-22 20:06:22 -0400714EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Chuck Lever35f5a422006-01-03 09:55:50 +0100716/**
717 * rpc_force_rebind - force transport to check that remote port is unchanged
718 * @clnt: client to rebind
719 *
720 */
721void rpc_force_rebind(struct rpc_clnt *clnt)
722{
723 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400724 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100725}
Chuck Leverb86acd52006-08-22 20:06:22 -0400726EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728/*
729 * Restart an (async) RPC call. Usually called from within the
730 * exit handler.
731 */
732void
733rpc_restart_call(struct rpc_task *task)
734{
735 if (RPC_ASSASSINATED(task))
736 return;
737
738 task->tk_action = call_start;
739}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400740EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
742/*
743 * 0. Initial state
744 *
745 * Other FSM states can be visited zero or more times, but
746 * this state is visited exactly once for each RPC.
747 */
748static void
749call_start(struct rpc_task *task)
750{
751 struct rpc_clnt *clnt = task->tk_client;
752
Chuck Lever46121cf2007-01-31 12:14:08 -0500753 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
754 clnt->cl_protname, clnt->cl_vers,
755 task->tk_msg.rpc_proc->p_proc,
756 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
758 /* Increment call count */
759 task->tk_msg.rpc_proc->p_count++;
760 clnt->cl_stats->rpccnt++;
761 task->tk_action = call_reserve;
762}
763
764/*
765 * 1. Reserve an RPC call slot
766 */
767static void
768call_reserve(struct rpc_task *task)
769{
Chuck Lever46121cf2007-01-31 12:14:08 -0500770 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
772 if (!rpcauth_uptodatecred(task)) {
773 task->tk_action = call_refresh;
774 return;
775 }
776
777 task->tk_status = 0;
778 task->tk_action = call_reserveresult;
779 xprt_reserve(task);
780}
781
782/*
783 * 1b. Grok the result of xprt_reserve()
784 */
785static void
786call_reserveresult(struct rpc_task *task)
787{
788 int status = task->tk_status;
789
Chuck Lever46121cf2007-01-31 12:14:08 -0500790 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
792 /*
793 * After a call to xprt_reserve(), we must have either
794 * a request slot or else an error status.
795 */
796 task->tk_status = 0;
797 if (status >= 0) {
798 if (task->tk_rqstp) {
799 task->tk_action = call_allocate;
800 return;
801 }
802
803 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
804 __FUNCTION__, status);
805 rpc_exit(task, -EIO);
806 return;
807 }
808
809 /*
810 * Even though there was an error, we may have acquired
811 * a request slot somehow. Make sure not to leak it.
812 */
813 if (task->tk_rqstp) {
814 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
815 __FUNCTION__, status);
816 xprt_release(task);
817 }
818
819 switch (status) {
820 case -EAGAIN: /* woken up; retry */
821 task->tk_action = call_reserve;
822 return;
823 case -EIO: /* probably a shutdown */
824 break;
825 default:
826 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
827 __FUNCTION__, status);
828 break;
829 }
830 rpc_exit(task, status);
831}
832
833/*
834 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100835 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 */
837static void
838call_allocate(struct rpc_task *task)
839{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400840 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100841 struct rpc_rqst *req = task->tk_rqstp;
842 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400843 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Chuck Lever46121cf2007-01-31 12:14:08 -0500845 dprint_status(task);
846
Chuck Lever2bea90d2007-03-29 16:47:53 -0400847 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400849
Chuck Lever02107142006-01-03 09:55:49 +0100850 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 return;
852
Chuck Lever2bea90d2007-03-29 16:47:53 -0400853 if (proc->p_proc != 0) {
854 BUG_ON(proc->p_arglen == 0);
855 if (proc->p_decode != NULL)
856 BUG_ON(proc->p_replen == 0);
857 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Chuck Lever2bea90d2007-03-29 16:47:53 -0400859 /*
860 * Calculate the size (in quads) of the RPC call
861 * and reply headers, and convert both values
862 * to byte sizes.
863 */
864 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
865 req->rq_callsize <<= 2;
866 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
867 req->rq_rcvsize <<= 2;
868
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400869 req->rq_buffer = xprt->ops->buf_alloc(task,
870 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400871 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500873
874 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
Trond Myklebust14b218a2005-06-22 17:16:28 +0000876 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400877 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 rpc_delay(task, HZ>>4);
879 return;
880 }
881
882 rpc_exit(task, -ERESTARTSYS);
883}
884
Trond Myklebust940e3312005-11-09 21:45:24 -0500885static inline int
886rpc_task_need_encode(struct rpc_task *task)
887{
888 return task->tk_rqstp->rq_snd_buf.len == 0;
889}
890
891static inline void
892rpc_task_force_reencode(struct rpc_task *task)
893{
894 task->tk_rqstp->rq_snd_buf.len = 0;
895}
896
Chuck Lever2bea90d2007-03-29 16:47:53 -0400897static inline void
898rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
899{
900 buf->head[0].iov_base = start;
901 buf->head[0].iov_len = len;
902 buf->tail[0].iov_len = 0;
903 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400904 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400905 buf->len = 0;
906 buf->buflen = len;
907}
908
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909/*
910 * 3. Encode arguments of an RPC call
911 */
912static void
913call_encode(struct rpc_task *task)
914{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700917 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Chuck Lever46121cf2007-01-31 12:14:08 -0500919 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920
Chuck Lever2bea90d2007-03-29 16:47:53 -0400921 rpc_xdr_buf_init(&req->rq_snd_buf,
922 req->rq_buffer,
923 req->rq_callsize);
924 rpc_xdr_buf_init(&req->rq_rcv_buf,
925 (char *)req->rq_buffer + req->rq_callsize,
926 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
928 /* Encode header and provided arguments */
929 encode = task->tk_msg.rpc_proc->p_encode;
930 if (!(p = call_header(task))) {
931 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
932 rpc_exit(task, -EIO);
933 return;
934 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400935 if (encode == NULL)
936 return;
937
938 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
939 task->tk_msg.rpc_argp);
940 if (task->tk_status == -ENOMEM) {
941 /* XXX: Is this sane? */
942 rpc_delay(task, 3*HZ);
943 task->tk_status = -EAGAIN;
944 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945}
946
947/*
948 * 4. Get the server port number if not yet set
949 */
950static void
951call_bind(struct rpc_task *task)
952{
Chuck Leverec739ef2006-08-22 20:06:15 -0400953 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Chuck Lever46121cf2007-01-31 12:14:08 -0500955 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
Chuck Leverda351872005-08-11 16:25:11 -0400957 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400958 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400959 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400960 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400961 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 }
963}
964
965/*
Chuck Leverda351872005-08-11 16:25:11 -0400966 * 4a. Sort out bind result
967 */
968static void
969call_bind_status(struct rpc_task *task)
970{
Chuck Lever906462a2007-09-11 18:00:47 -0400971 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400972
973 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500974 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400975 task->tk_status = 0;
976 task->tk_action = call_connect;
977 return;
978 }
979
980 switch (task->tk_status) {
Chuck Lever2429cbf2007-09-11 18:00:41 -0400981 case -EAGAIN:
982 dprintk("RPC: %5u rpcbind waiting for another request "
983 "to finish\n", task->tk_pid);
984 /* avoid busy-waiting here -- could be a network outage. */
985 rpc_delay(task, 5*HZ);
986 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400987 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500988 dprintk("RPC: %5u remote rpcbind: RPC program/version "
989 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400990 /* fail immediately if this is an RPC ping */
991 if (task->tk_msg.rpc_proc->p_proc == 0) {
992 status = -EOPNOTSUPP;
993 break;
994 }
Chuck Leverea635a52005-10-06 23:12:58 -0400995 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400996 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400997 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500998 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400999 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001000 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001001 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001002 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -05001003 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -04001004 task->tk_pid);
1005 break;
1006 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001007 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001008 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001009 task->tk_status = 0;
1010 task->tk_action = call_bind;
1011 return;
Chuck Leverda351872005-08-11 16:25:11 -04001012 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001013 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001014 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001015 }
1016
1017 rpc_exit(task, status);
1018 return;
1019
Trond Myklebustda458282006-08-31 15:44:52 -04001020retry_timeout:
1021 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001022}
1023
1024/*
1025 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 */
1027static void
1028call_connect(struct rpc_task *task)
1029{
Chuck Leverda351872005-08-11 16:25:11 -04001030 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Chuck Lever46121cf2007-01-31 12:14:08 -05001032 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001033 task->tk_pid, xprt,
1034 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
Chuck Leverda351872005-08-11 16:25:11 -04001036 task->tk_action = call_transmit;
1037 if (!xprt_connected(xprt)) {
1038 task->tk_action = call_connect_status;
1039 if (task->tk_status < 0)
1040 return;
1041 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043}
1044
1045/*
Chuck Leverda351872005-08-11 16:25:11 -04001046 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 */
1048static void
1049call_connect_status(struct rpc_task *task)
1050{
1051 struct rpc_clnt *clnt = task->tk_client;
1052 int status = task->tk_status;
1053
Chuck Lever46121cf2007-01-31 12:14:08 -05001054 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001055
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 task->tk_status = 0;
1057 if (status >= 0) {
1058 clnt->cl_stats->netreconn++;
1059 task->tk_action = call_transmit;
1060 return;
1061 }
1062
Chuck Leverda351872005-08-11 16:25:11 -04001063 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001064 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 switch (status) {
1067 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001069 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001070 if (!RPC_IS_SOFT(task))
1071 return;
1072 /* if soft mounted, test if we've timed out */
1073 case -ETIMEDOUT:
1074 task->tk_action = call_timeout;
1075 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 }
Trond Myklebustda458282006-08-31 15:44:52 -04001077 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078}
1079
1080/*
1081 * 5. Transmit the RPC request, and wait for reply
1082 */
1083static void
1084call_transmit(struct rpc_task *task)
1085{
Chuck Lever46121cf2007-01-31 12:14:08 -05001086 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
1088 task->tk_action = call_status;
1089 if (task->tk_status < 0)
1090 return;
1091 task->tk_status = xprt_prepare_transmit(task);
1092 if (task->tk_status != 0)
1093 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001094 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001096 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001097 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001099 /* Did the encode result in an error condition? */
1100 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001101 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001102 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 xprt_transmit(task);
1104 if (task->tk_status < 0)
1105 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001106 /*
1107 * On success, ensure that we call xprt_end_transmit() before sleeping
1108 * in order to allow access to the socket to other RPC requests.
1109 */
1110 call_transmit_status(task);
1111 if (task->tk_msg.rpc_proc->p_decode != NULL)
1112 return;
1113 task->tk_action = rpc_exit_task;
1114 rpc_wake_up_task(task);
1115}
1116
1117/*
1118 * 5a. Handle cleanup after a transmission
1119 */
1120static void
1121call_transmit_status(struct rpc_task *task)
1122{
1123 task->tk_action = call_status;
1124 /*
1125 * Special case: if we've been waiting on the socket's write_space()
1126 * callback, then don't call xprt_end_transmit().
1127 */
1128 if (task->tk_status == -EAGAIN)
1129 return;
1130 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001131 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132}
1133
1134/*
1135 * 6. Sort out the RPC call status
1136 */
1137static void
1138call_status(struct rpc_task *task)
1139{
1140 struct rpc_clnt *clnt = task->tk_client;
1141 struct rpc_rqst *req = task->tk_rqstp;
1142 int status;
1143
1144 if (req->rq_received > 0 && !req->rq_bytes_sent)
1145 task->tk_status = req->rq_received;
1146
Chuck Lever46121cf2007-01-31 12:14:08 -05001147 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
1149 status = task->tk_status;
1150 if (status >= 0) {
1151 task->tk_action = call_decode;
1152 return;
1153 }
1154
1155 task->tk_status = 0;
1156 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001157 case -EHOSTDOWN:
1158 case -EHOSTUNREACH:
1159 case -ENETUNREACH:
1160 /*
1161 * Delay any retries for 3 seconds, then handle as if it
1162 * were a timeout.
1163 */
1164 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 case -ETIMEDOUT:
1166 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001167 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001168 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 break;
1170 case -ECONNREFUSED:
1171 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001172 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 task->tk_action = call_bind;
1174 break;
1175 case -EAGAIN:
1176 task->tk_action = call_transmit;
1177 break;
1178 case -EIO:
1179 /* shutdown or soft timeout */
1180 rpc_exit(task, status);
1181 break;
1182 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001183 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 clnt->cl_protname, -status);
1185 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 }
1187}
1188
1189/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001190 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 * We do not release the request slot, so we keep using the
1192 * same XID for all retransmits.
1193 */
1194static void
1195call_timeout(struct rpc_task *task)
1196{
1197 struct rpc_clnt *clnt = task->tk_client;
1198
1199 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001200 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 goto retry;
1202 }
1203
Chuck Lever46121cf2007-01-31 12:14:08 -05001204 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001205 task->tk_timeouts++;
1206
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001208 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 clnt->cl_protname, clnt->cl_server);
1210 rpc_exit(task, -EIO);
1211 return;
1212 }
1213
Chuck Leverf518e35a2006-01-03 09:55:52 +01001214 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 task->tk_flags |= RPC_CALL_MAJORSEEN;
1216 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1217 clnt->cl_protname, clnt->cl_server);
1218 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001219 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
1221retry:
1222 clnt->cl_stats->rpcretrans++;
1223 task->tk_action = call_bind;
1224 task->tk_status = 0;
1225}
1226
1227/*
1228 * 7. Decode the RPC reply
1229 */
1230static void
1231call_decode(struct rpc_task *task)
1232{
1233 struct rpc_clnt *clnt = task->tk_client;
1234 struct rpc_rqst *req = task->tk_rqstp;
1235 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001236 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
Chuck Lever46121cf2007-01-31 12:14:08 -05001238 dprintk("RPC: %5u call_decode (status %d)\n",
1239 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240
Chuck Leverf518e35a2006-01-03 09:55:52 +01001241 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 printk(KERN_NOTICE "%s: server %s OK\n",
1243 clnt->cl_protname, clnt->cl_server);
1244 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1245 }
1246
1247 if (task->tk_status < 12) {
1248 if (!RPC_IS_SOFT(task)) {
1249 task->tk_action = call_bind;
1250 clnt->cl_stats->rpcretrans++;
1251 goto out_retry;
1252 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001253 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1254 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001255 task->tk_action = call_timeout;
1256 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 }
1258
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001259 /*
1260 * Ensure that we see all writes made by xprt_complete_rqst()
1261 * before it changed req->rq_received.
1262 */
1263 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 req->rq_rcv_buf.len = req->rq_private_buf.len;
1265
1266 /* Check that the softirq receive buffer is valid */
1267 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1268 sizeof(req->rq_rcv_buf)) != 0);
1269
1270 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001271 p = call_verify(task);
1272 if (IS_ERR(p)) {
1273 if (p == ERR_PTR(-EAGAIN))
1274 goto out_retry;
1275 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 }
1277
Trond Myklebustabbcf282006-01-03 09:55:03 +01001278 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001280 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1282 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001283 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001284 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1285 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 return;
1287out_retry:
1288 req->rq_received = req->rq_private_buf.len = 0;
1289 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001290 if (task->tk_client->cl_discrtry)
Trond Myklebust3ebb0672007-11-06 18:40:12 -05001291 xprt_force_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292}
1293
1294/*
1295 * 8. Refresh the credentials if rejected by the server
1296 */
1297static void
1298call_refresh(struct rpc_task *task)
1299{
Chuck Lever46121cf2007-01-31 12:14:08 -05001300 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 task->tk_action = call_refreshresult;
1303 task->tk_status = 0;
1304 task->tk_client->cl_stats->rpcauthrefresh++;
1305 rpcauth_refreshcred(task);
1306}
1307
1308/*
1309 * 8a. Process the results of a credential refresh
1310 */
1311static void
1312call_refreshresult(struct rpc_task *task)
1313{
1314 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001315
1316 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
1318 task->tk_status = 0;
1319 task->tk_action = call_reserve;
1320 if (status >= 0 && rpcauth_uptodatecred(task))
1321 return;
1322 if (status == -EACCES) {
1323 rpc_exit(task, -EACCES);
1324 return;
1325 }
1326 task->tk_action = call_refresh;
1327 if (status != -ETIMEDOUT)
1328 rpc_delay(task, 3*HZ);
1329 return;
1330}
1331
1332/*
1333 * Call header serialization
1334 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001335static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336call_header(struct rpc_task *task)
1337{
1338 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001340 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
1342 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001343
1344 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 *p++ = req->rq_xid; /* XID */
1346 *p++ = htonl(RPC_CALL); /* CALL */
1347 *p++ = htonl(RPC_VERSION); /* RPC version */
1348 *p++ = htonl(clnt->cl_prog); /* program number */
1349 *p++ = htonl(clnt->cl_vers); /* program version */
1350 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001351 p = rpcauth_marshcred(task, p);
1352 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1353 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354}
1355
1356/*
1357 * Reply header verification
1358 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001359static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360call_verify(struct rpc_task *task)
1361{
1362 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1363 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001364 __be32 *p = iov->iov_base;
1365 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 int error = -EACCES;
1367
David Howellse8896492006-08-24 15:44:19 -04001368 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1369 /* RFC-1014 says that the representation of XDR data must be a
1370 * multiple of four bytes
1371 * - if it isn't pointer subtraction in the NFS client may give
1372 * undefined results
1373 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001374 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1375 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1376 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001377 goto out_eio;
1378 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 if ((len -= 3) < 0)
1380 goto out_overflow;
1381 p += 1; /* skip XID */
1382
1383 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001384 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1385 task->tk_pid, __FUNCTION__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001386 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 }
1388 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1389 if (--len < 0)
1390 goto out_overflow;
1391 switch ((n = ntohl(*p++))) {
1392 case RPC_AUTH_ERROR:
1393 break;
1394 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001395 dprintk("RPC: %5u %s: RPC call version "
1396 "mismatch!\n",
1397 task->tk_pid, __FUNCTION__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001398 error = -EPROTONOSUPPORT;
1399 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001401 dprintk("RPC: %5u %s: RPC call rejected, "
1402 "unknown error: %x\n",
1403 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 goto out_eio;
1405 }
1406 if (--len < 0)
1407 goto out_overflow;
1408 switch ((n = ntohl(*p++))) {
1409 case RPC_AUTH_REJECTEDCRED:
1410 case RPC_AUTH_REJECTEDVERF:
1411 case RPCSEC_GSS_CREDPROBLEM:
1412 case RPCSEC_GSS_CTXPROBLEM:
1413 if (!task->tk_cred_retry)
1414 break;
1415 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001416 dprintk("RPC: %5u %s: retry stale creds\n",
1417 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001419 /* Ensure we obtain a new XID! */
1420 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001422 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 case RPC_AUTH_BADCRED:
1424 case RPC_AUTH_BADVERF:
1425 /* possibly garbled cred/verf? */
1426 if (!task->tk_garb_retry)
1427 break;
1428 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001429 dprintk("RPC: %5u %s: retry garbled creds\n",
1430 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001432 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001434 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1435 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 break;
1437 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001438 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1439 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 error = -EIO;
1441 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001442 dprintk("RPC: %5u %s: call rejected %d\n",
1443 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 goto out_err;
1445 }
1446 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001447 dprintk("RPC: %5u %s: auth check failed\n",
1448 task->tk_pid, __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001449 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001451 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 if (len < 0)
1453 goto out_overflow;
1454 switch ((n = ntohl(*p++))) {
1455 case RPC_SUCCESS:
1456 return p;
1457 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001458 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1459 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 (unsigned int)task->tk_client->cl_prog,
1461 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001462 error = -EPFNOSUPPORT;
1463 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001465 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1466 "server %s\n", task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 (unsigned int)task->tk_client->cl_prog,
1468 (unsigned int)task->tk_client->cl_vers,
1469 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001470 error = -EPROTONOSUPPORT;
1471 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001473 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1474 "version %u on server %s\n",
1475 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 task->tk_msg.rpc_proc,
1477 task->tk_client->cl_prog,
1478 task->tk_client->cl_vers,
1479 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001480 error = -EOPNOTSUPP;
1481 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001483 dprintk("RPC: %5u %s: server saw garbage\n",
1484 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 break; /* retry */
1486 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001487 dprintk("RPC: %5u %s: server accept status: %x\n",
1488 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 /* Also retry */
1490 }
1491
Trond Myklebustabbcf282006-01-03 09:55:03 +01001492out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 task->tk_client->cl_stats->rpcgarbage++;
1494 if (task->tk_garb_retry) {
1495 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001496 dprintk("RPC: %5u %s: retrying\n",
1497 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001499out_retry:
1500 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502out_eio:
1503 error = -EIO;
1504out_err:
1505 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001506 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1507 __FUNCTION__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001508 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001510 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1511 __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001512 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001514
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001515static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001516{
1517 return 0;
1518}
1519
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001520static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001521{
1522 return 0;
1523}
1524
1525static struct rpc_procinfo rpcproc_null = {
1526 .p_encode = rpcproc_encode_null,
1527 .p_decode = rpcproc_decode_null,
1528};
1529
Trond Myklebust64c91a12007-06-23 10:17:16 -04001530static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001531{
1532 struct rpc_message msg = {
1533 .rpc_proc = &rpcproc_null,
1534 };
1535 int err;
1536 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1537 err = rpc_call_sync(clnt, &msg, flags);
1538 put_rpccred(msg.rpc_cred);
1539 return err;
1540}
Trond Myklebust188fef12007-06-16 14:18:40 -04001541
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001542struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1543{
1544 struct rpc_message msg = {
1545 .rpc_proc = &rpcproc_null,
1546 .rpc_cred = cred,
1547 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001548 struct rpc_task_setup task_setup_data = {
1549 .rpc_client = clnt,
1550 .rpc_message = &msg,
1551 .callback_ops = &rpc_default_ops,
1552 .flags = flags,
1553 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001554 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001555}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001556EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001557
Trond Myklebust188fef12007-06-16 14:18:40 -04001558#ifdef RPC_DEBUG
1559void rpc_show_tasks(void)
1560{
1561 struct rpc_clnt *clnt;
1562 struct rpc_task *t;
1563
1564 spin_lock(&rpc_client_lock);
1565 if (list_empty(&all_clients))
1566 goto out;
1567 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1568 "-rpcwait -action- ---ops--\n");
1569 list_for_each_entry(clnt, &all_clients, cl_clients) {
1570 if (list_empty(&clnt->cl_tasks))
1571 continue;
1572 spin_lock(&clnt->cl_lock);
1573 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1574 const char *rpc_waitq = "none";
Chuck Leverd66968f2007-09-11 18:00:25 -04001575 int proc;
1576
1577 if (t->tk_msg.rpc_proc)
1578 proc = t->tk_msg.rpc_proc->p_proc;
1579 else
1580 proc = -1;
Trond Myklebust188fef12007-06-16 14:18:40 -04001581
1582 if (RPC_IS_QUEUED(t))
1583 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1584
1585 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
Chuck Leverd66968f2007-09-11 18:00:25 -04001586 t->tk_pid, proc,
Trond Myklebust188fef12007-06-16 14:18:40 -04001587 t->tk_flags, t->tk_status,
1588 t->tk_client,
1589 (t->tk_client ? t->tk_client->cl_prog : 0),
1590 t->tk_rqstp, t->tk_timeout,
1591 rpc_waitq,
1592 t->tk_action, t->tk_ops);
1593 }
1594 spin_unlock(&clnt->cl_lock);
1595 }
1596out:
1597 spin_unlock(&rpc_client_lock);
1598}
1599#endif