blob: 5abab094441f97cbe8dd7f91dcd554579030b6be [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>
Chuck Levercb3997b2008-05-21 17:09:41 -040028#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/mm.h>
30#include <linux/slab.h>
Trond Myklebust6d5fcb52006-10-18 16:01:06 -040031#include <linux/smp_lock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050033#include <linux/workqueue.h>
Chuck Lever510deb02007-12-10 14:56:24 -050034#include <linux/in6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#ifdef RPC_DEBUG
42# define RPCDBG_FACILITY RPCDBG_CALL
43#endif
44
Chuck Lever46121cf2007-01-31 12:14:08 -050045#define dprint_status(t) \
46 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080047 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050048
Trond Myklebust188fef12007-06-16 14:18:40 -040049/*
50 * All RPC clients are linked into this list
51 */
52static LIST_HEAD(all_clients);
53static DEFINE_SPINLOCK(rpc_client_lock);
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
56
57
58static void call_start(struct rpc_task *task);
59static void call_reserve(struct rpc_task *task);
60static void call_reserveresult(struct rpc_task *task);
61static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Chuck Leverb0e1c572008-05-21 17:09:19 -040074static __be32 *rpc_encode_header(struct rpc_task *task);
75static __be32 *rpc_verify_header(struct rpc_task *task);
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;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300177 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 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);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500200 clnt->cl_principal = NULL;
201 if (args->client_name) {
202 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
203 if (!clnt->cl_principal)
204 goto out_no_principal;
205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Trond Myklebust34f52e32007-06-14 16:40:31 -0400207 kref_init(&clnt->cl_kref);
208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
210 if (err < 0)
211 goto out_no_path;
212
Trond Myklebust698b6d02007-12-20 16:03:53 -0500213 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000214 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500216 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000217 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 goto out_no_auth;
219 }
220
221 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400222 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 if (clnt->cl_nodelen > UNX_MAXNODENAME)
224 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400225 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400226 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 return clnt;
228
229out_no_auth:
Trond Myklebust54281542006-03-20 13:44:49 -0500230 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700231 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust54281542006-03-20 13:44:49 -0500232 rpc_put_mount();
233 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500235 kfree(clnt->cl_principal);
236out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500237 rpc_free_iostats(clnt->cl_metrics);
238out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 if (clnt->cl_server != clnt->cl_inline_name)
240 kfree(clnt->cl_server);
241 kfree(clnt);
242out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400243 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800244out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400245 rpciod_down();
246out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 return ERR_PTR(err);
248}
249
Chuck Leverc2866762006-08-22 20:06:20 -0400250/*
251 * rpc_create - create an RPC client and transport with one call
252 * @args: rpc_clnt create argument structure
253 *
254 * Creates and initializes an RPC transport and an RPC client.
255 *
256 * It can ping the server in order to determine if it is up, and to see if
257 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
258 * this behavior so asynchronous tasks can also use rpc_create.
259 */
260struct rpc_clnt *rpc_create(struct rpc_create_args *args)
261{
262 struct rpc_xprt *xprt;
263 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b02007-09-10 13:47:07 -0400264 struct xprt_create xprtargs = {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400265 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200266 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200267 .dstaddr = args->address,
268 .addrlen = args->addrsize,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200269 };
Chuck Lever510deb02007-12-10 14:56:24 -0500270 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400271
Chuck Leverc2866762006-08-22 20:06:20 -0400272 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400273 * If the caller chooses not to specify a hostname, whip
274 * up a string representation of the passed-in address.
275 */
276 if (args->servername == NULL) {
Chuck Lever510deb02007-12-10 14:56:24 -0500277 servername[0] = '\0';
278 switch (args->address->sa_family) {
279 case AF_INET: {
280 struct sockaddr_in *sin =
281 (struct sockaddr_in *)args->address;
Harvey Harrison21454aa2008-10-31 00:54:56 -0700282 snprintf(servername, sizeof(servername), "%pI4",
283 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500284 break;
285 }
286 case AF_INET6: {
287 struct sockaddr_in6 *sin =
288 (struct sockaddr_in6 *)args->address;
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700289 snprintf(servername, sizeof(servername), "%pI6",
Harvey Harrisonfdb46ee2008-10-28 16:10:17 -0700290 &sin->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500291 break;
292 }
293 default:
294 /* caller wants default server name, but
295 * address family isn't recognized. */
296 return ERR_PTR(-EINVAL);
297 }
Chuck Lever43780b82007-07-01 12:13:22 -0400298 args->servername = servername;
299 }
300
Chuck Lever510deb02007-12-10 14:56:24 -0500301 xprt = xprt_create_transport(&xprtargs);
302 if (IS_ERR(xprt))
303 return (struct rpc_clnt *)xprt;
304
Chuck Lever43780b82007-07-01 12:13:22 -0400305 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400306 * By default, kernel RPC client connects from a reserved port.
307 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
308 * but it is always enabled for rpciod, which handles the connect
309 * operation.
310 */
311 xprt->resvport = 1;
312 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
313 xprt->resvport = 0;
314
Trond Myklebust698b6d02007-12-20 16:03:53 -0500315 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400316 if (IS_ERR(clnt))
317 return clnt;
318
319 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Matthew Wilcox150030b2007-12-06 16:24:39 -0500320 int err = rpc_ping(clnt, RPC_TASK_SOFT);
Chuck Leverc2866762006-08-22 20:06:20 -0400321 if (err != 0) {
322 rpc_shutdown_client(clnt);
323 return ERR_PTR(err);
324 }
325 }
326
327 clnt->cl_softrtry = 1;
328 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
329 clnt->cl_softrtry = 0;
330
Chuck Leverc2866762006-08-22 20:06:20 -0400331 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
332 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500333 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
334 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400335 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
336 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400337
338 return clnt;
339}
Chuck Leverb86acd52006-08-22 20:06:22 -0400340EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/*
343 * This function clones the RPC client structure. It allows us to share the
344 * same transport while varying parameters such as the authentication
345 * flavour.
346 */
347struct rpc_clnt *
348rpc_clone_client(struct rpc_clnt *clnt)
349{
350 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500351 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200353 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (!new)
355 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400356 new->cl_parent = clnt;
357 /* Turn off autobind on clones */
358 new->cl_autobind = 0;
359 INIT_LIST_HEAD(&new->cl_tasks);
360 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500361 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500362 new->cl_metrics = rpc_alloc_iostats(clnt);
363 if (new->cl_metrics == NULL)
364 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500365 if (clnt->cl_principal) {
366 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
367 if (new->cl_principal == NULL)
368 goto out_no_principal;
369 }
Trond Myklebust34f52e32007-06-14 16:40:31 -0400370 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500371 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
372 if (err != 0)
373 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 if (new->cl_auth)
375 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400376 xprt_get(clnt->cl_xprt);
377 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400378 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400379 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500381out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500382 kfree(new->cl_principal);
383out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500384 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500385out_no_stats:
386 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800388 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500389 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400391EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393/*
394 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400395 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400397void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400399 dprintk("RPC: shutting down %s client for %s\n",
400 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Trond Myklebust34f52e32007-06-14 16:40:31 -0400402 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800404 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400405 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 }
407
Trond Myklebust4c402b42007-06-14 16:40:32 -0400408 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400410EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400413 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400415static void
416rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400418 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Chuck Lever46121cf2007-01-31 12:14:08 -0500420 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 clnt->cl_protname, clnt->cl_server);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400422 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700423 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400424 rpc_put_mount();
425 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500426 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400427 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500428 goto out_free;
429 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 if (clnt->cl_server != clnt->cl_inline_name)
431 kfree(clnt->cl_server);
432out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400433 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500434 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500435 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500436 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400437 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400438 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440}
441
442/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400443 * Free an RPC client
444 */
445static void
446rpc_free_auth(struct kref *kref)
447{
448 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
449
450 if (clnt->cl_auth == NULL) {
451 rpc_free_client(kref);
452 return;
453 }
454
455 /*
456 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
457 * release remaining GSS contexts. This mechanism ensures
458 * that it can do so safely.
459 */
460 kref_init(kref);
461 rpcauth_release(clnt->cl_auth);
462 clnt->cl_auth = NULL;
463 kref_put(kref, rpc_free_client);
464}
465
466/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400467 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 */
469void
470rpc_release_client(struct rpc_clnt *clnt)
471{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400472 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Trond Myklebust34f52e32007-06-14 16:40:31 -0400474 if (list_empty(&clnt->cl_tasks))
475 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400476 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400477}
478
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000479/**
480 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800481 * @old: old rpc_client
482 * @program: rpc program to set
483 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000484 *
485 * Clones the rpc client and sets up a new RPC program. This is mainly
486 * of use for enabling different RPC programs to share the same transport.
487 * The Sun NFSv2/v3 ACL protocol can do this.
488 */
489struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
490 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400491 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000492{
493 struct rpc_clnt *clnt;
494 struct rpc_version *version;
495 int err;
496
497 BUG_ON(vers >= program->nrvers || !program->version[vers]);
498 version = program->version[vers];
499 clnt = rpc_clone_client(old);
500 if (IS_ERR(clnt))
501 goto out;
502 clnt->cl_procinfo = version->procs;
503 clnt->cl_maxproc = version->nrprocs;
504 clnt->cl_protname = program->name;
505 clnt->cl_prog = program->number;
506 clnt->cl_vers = version->number;
507 clnt->cl_stats = program->stats;
Matthew Wilcox150030b2007-12-06 16:24:39 -0500508 err = rpc_ping(clnt, RPC_TASK_SOFT);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000509 if (err != 0) {
510 rpc_shutdown_client(clnt);
511 clnt = ERR_PTR(err);
512 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800513out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000514 return clnt;
515}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400516EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518/*
519 * Default callback for async RPC calls
520 */
521static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100522rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
524}
525
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100526static const struct rpc_call_ops rpc_default_ops = {
527 .rpc_call_done = rpc_default_callback,
528};
529
Trond Myklebustc970aa82007-07-14 15:39:59 -0400530/**
531 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
532 * @task_setup_data: pointer to task initialisation data
533 */
534struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400535{
536 struct rpc_task *task, *ret;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400537
Trond Myklebust84115e12007-07-14 15:39:59 -0400538 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400539 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400540 rpc_release_calldata(task_setup_data->callback_ops,
541 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400542 ret = ERR_PTR(-ENOMEM);
543 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400544 }
545
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400546 if (task->tk_status != 0) {
547 ret = ERR_PTR(task->tk_status);
548 rpc_put_task(task);
549 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400550 }
551 atomic_inc(&task->tk_count);
552 rpc_execute(task);
553 ret = task;
554out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400555 return ret;
556}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400557EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400558
559/**
560 * rpc_call_sync - Perform a synchronous RPC call
561 * @clnt: pointer to RPC client
562 * @msg: RPC call parameters
563 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500565int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
567 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400568 struct rpc_task_setup task_setup_data = {
569 .rpc_client = clnt,
570 .rpc_message = msg,
571 .callback_ops = &rpc_default_ops,
572 .flags = flags,
573 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400574 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 BUG_ON(flags & RPC_TASK_ASYNC);
577
Trond Myklebustc970aa82007-07-14 15:39:59 -0400578 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400579 if (IS_ERR(task))
580 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100581 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800582 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 return status;
584}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400585EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400587/**
588 * rpc_call_async - Perform an asynchronous RPC call
589 * @clnt: pointer to RPC client
590 * @msg: RPC call parameters
591 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800592 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400593 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
595int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500596rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100597 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
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 = tk_ops,
604 .callback_data = data,
605 .flags = flags|RPC_TASK_ASYNC,
606 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Trond Myklebustc970aa82007-07-14 15:39:59 -0400608 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400609 if (IS_ERR(task))
610 return PTR_ERR(task);
611 rpc_put_task(task);
612 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400614EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400617rpc_call_start(struct rpc_task *task)
618{
619 task->tk_action = call_start;
620}
621EXPORT_SYMBOL_GPL(rpc_call_start);
622
Chuck Levered394402006-08-22 20:06:17 -0400623/**
624 * rpc_peeraddr - extract remote peer address from clnt's xprt
625 * @clnt: RPC client structure
626 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800627 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400628 *
629 * Returns the number of bytes that are actually in the stored address.
630 */
631size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
632{
633 size_t bytes;
634 struct rpc_xprt *xprt = clnt->cl_xprt;
635
636 bytes = sizeof(xprt->addr);
637 if (bytes > bufsize)
638 bytes = bufsize;
639 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400640 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400641}
Chuck Leverb86acd52006-08-22 20:06:22 -0400642EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400643
Chuck Leverf425eba2006-08-22 20:06:18 -0400644/**
645 * rpc_peeraddr2str - return remote peer address in printable format
646 * @clnt: RPC client structure
647 * @format: address format
648 *
649 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500650const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
651 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400652{
653 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500654
655 if (xprt->address_strings[format] != NULL)
656 return xprt->address_strings[format];
657 else
658 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400659}
Chuck Leverb86acd52006-08-22 20:06:22 -0400660EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400661
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662void
663rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
664{
665 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700666 if (xprt->ops->set_buffer_size)
667 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400669EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
671/*
672 * Return size of largest payload RPC client can support, in bytes
673 *
674 * For stream transports, this is one RPC record fragment (see RFC
675 * 1831), as we don't support multi-record requests yet. For datagram
676 * transports, this is the size of an IP packet minus the IP, UDP, and
677 * RPC header sizes.
678 */
679size_t rpc_max_payload(struct rpc_clnt *clnt)
680{
681 return clnt->cl_xprt->max_payload;
682}
Chuck Leverb86acd52006-08-22 20:06:22 -0400683EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Chuck Lever35f5a422006-01-03 09:55:50 +0100685/**
686 * rpc_force_rebind - force transport to check that remote port is unchanged
687 * @clnt: client to rebind
688 *
689 */
690void rpc_force_rebind(struct rpc_clnt *clnt)
691{
692 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400693 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100694}
Chuck Leverb86acd52006-08-22 20:06:22 -0400695EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*
698 * Restart an (async) RPC call. Usually called from within the
699 * exit handler.
700 */
701void
702rpc_restart_call(struct rpc_task *task)
703{
704 if (RPC_ASSASSINATED(task))
705 return;
706
707 task->tk_action = call_start;
708}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400709EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Chuck Lever3748f1e2008-05-21 17:09:12 -0400711#ifdef RPC_DEBUG
712static const char *rpc_proc_name(const struct rpc_task *task)
713{
714 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
715
716 if (proc) {
717 if (proc->p_name)
718 return proc->p_name;
719 else
720 return "NULL";
721 } else
722 return "no proc";
723}
724#endif
725
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726/*
727 * 0. Initial state
728 *
729 * Other FSM states can be visited zero or more times, but
730 * this state is visited exactly once for each RPC.
731 */
732static void
733call_start(struct rpc_task *task)
734{
735 struct rpc_clnt *clnt = task->tk_client;
736
Chuck Lever3748f1e2008-05-21 17:09:12 -0400737 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500738 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400739 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500740 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
742 /* Increment call count */
743 task->tk_msg.rpc_proc->p_count++;
744 clnt->cl_stats->rpccnt++;
745 task->tk_action = call_reserve;
746}
747
748/*
749 * 1. Reserve an RPC call slot
750 */
751static void
752call_reserve(struct rpc_task *task)
753{
Chuck Lever46121cf2007-01-31 12:14:08 -0500754 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 if (!rpcauth_uptodatecred(task)) {
757 task->tk_action = call_refresh;
758 return;
759 }
760
761 task->tk_status = 0;
762 task->tk_action = call_reserveresult;
763 xprt_reserve(task);
764}
765
766/*
767 * 1b. Grok the result of xprt_reserve()
768 */
769static void
770call_reserveresult(struct rpc_task *task)
771{
772 int status = task->tk_status;
773
Chuck Lever46121cf2007-01-31 12:14:08 -0500774 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
776 /*
777 * After a call to xprt_reserve(), we must have either
778 * a request slot or else an error status.
779 */
780 task->tk_status = 0;
781 if (status >= 0) {
782 if (task->tk_rqstp) {
783 task->tk_action = call_allocate;
784 return;
785 }
786
787 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800788 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 rpc_exit(task, -EIO);
790 return;
791 }
792
793 /*
794 * Even though there was an error, we may have acquired
795 * a request slot somehow. Make sure not to leak it.
796 */
797 if (task->tk_rqstp) {
798 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800799 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 xprt_release(task);
801 }
802
803 switch (status) {
804 case -EAGAIN: /* woken up; retry */
805 task->tk_action = call_reserve;
806 return;
807 case -EIO: /* probably a shutdown */
808 break;
809 default:
810 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800811 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 break;
813 }
814 rpc_exit(task, status);
815}
816
817/*
818 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100819 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 */
821static void
822call_allocate(struct rpc_task *task)
823{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400824 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100825 struct rpc_rqst *req = task->tk_rqstp;
826 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400827 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Chuck Lever46121cf2007-01-31 12:14:08 -0500829 dprint_status(task);
830
Chuck Lever2bea90d2007-03-29 16:47:53 -0400831 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400833
Chuck Lever02107142006-01-03 09:55:49 +0100834 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return;
836
Chuck Lever2bea90d2007-03-29 16:47:53 -0400837 if (proc->p_proc != 0) {
838 BUG_ON(proc->p_arglen == 0);
839 if (proc->p_decode != NULL)
840 BUG_ON(proc->p_replen == 0);
841 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
Chuck Lever2bea90d2007-03-29 16:47:53 -0400843 /*
844 * Calculate the size (in quads) of the RPC call
845 * and reply headers, and convert both values
846 * to byte sizes.
847 */
848 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
849 req->rq_callsize <<= 2;
850 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
851 req->rq_rcvsize <<= 2;
852
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400853 req->rq_buffer = xprt->ops->buf_alloc(task,
854 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400855 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500857
858 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Trond Myklebust14b218a2005-06-22 17:16:28 +0000860 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400861 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 rpc_delay(task, HZ>>4);
863 return;
864 }
865
866 rpc_exit(task, -ERESTARTSYS);
867}
868
Trond Myklebust940e3312005-11-09 21:45:24 -0500869static inline int
870rpc_task_need_encode(struct rpc_task *task)
871{
872 return task->tk_rqstp->rq_snd_buf.len == 0;
873}
874
875static inline void
876rpc_task_force_reencode(struct rpc_task *task)
877{
878 task->tk_rqstp->rq_snd_buf.len = 0;
879}
880
Chuck Lever2bea90d2007-03-29 16:47:53 -0400881static inline void
882rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
883{
884 buf->head[0].iov_base = start;
885 buf->head[0].iov_len = len;
886 buf->tail[0].iov_len = 0;
887 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400888 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400889 buf->len = 0;
890 buf->buflen = len;
891}
892
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893/*
894 * 3. Encode arguments of an RPC call
895 */
896static void
Chuck Leverb0e1c572008-05-21 17:09:19 -0400897rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700901 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Chuck Lever46121cf2007-01-31 12:14:08 -0500903 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Chuck Lever2bea90d2007-03-29 16:47:53 -0400905 rpc_xdr_buf_init(&req->rq_snd_buf,
906 req->rq_buffer,
907 req->rq_callsize);
908 rpc_xdr_buf_init(&req->rq_rcv_buf,
909 (char *)req->rq_buffer + req->rq_callsize,
910 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Chuck Leverb0e1c572008-05-21 17:09:19 -0400912 p = rpc_encode_header(task);
913 if (p == NULL) {
914 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 rpc_exit(task, -EIO);
916 return;
917 }
Chuck Leverb0e1c572008-05-21 17:09:19 -0400918
919 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400920 if (encode == NULL)
921 return;
922
923 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
924 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925}
926
927/*
928 * 4. Get the server port number if not yet set
929 */
930static void
931call_bind(struct rpc_task *task)
932{
Chuck Leverec739ef2006-08-22 20:06:15 -0400933 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Chuck Lever46121cf2007-01-31 12:14:08 -0500935 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Chuck Leverda351872005-08-11 16:25:11 -0400937 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400938 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400939 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400940 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400941 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 }
943}
944
945/*
Chuck Leverda351872005-08-11 16:25:11 -0400946 * 4a. Sort out bind result
947 */
948static void
949call_bind_status(struct rpc_task *task)
950{
Chuck Lever906462a2007-09-11 18:00:47 -0400951 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400952
953 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500954 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400955 task->tk_status = 0;
956 task->tk_action = call_connect;
957 return;
958 }
959
960 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -0400961 case -ENOMEM:
962 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
963 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -0400964 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400965 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500966 dprintk("RPC: %5u remote rpcbind: RPC program/version "
967 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -0400968 /* fail immediately if this is an RPC ping */
969 if (task->tk_msg.rpc_proc->p_proc == 0) {
970 status = -EOPNOTSUPP;
971 break;
972 }
Chuck Leverea635a52005-10-06 23:12:58 -0400973 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400974 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400975 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500976 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400977 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400978 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400979 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -0400980 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -0500981 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400982 task->tk_pid);
983 break;
984 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400985 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400986 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400987 task->tk_status = 0;
988 task->tk_action = call_bind;
989 return;
Chuck Leverda351872005-08-11 16:25:11 -0400990 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500991 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -0400992 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -0400993 }
994
995 rpc_exit(task, status);
996 return;
997
Trond Myklebustda458282006-08-31 15:44:52 -0400998retry_timeout:
999 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001000}
1001
1002/*
1003 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 */
1005static void
1006call_connect(struct rpc_task *task)
1007{
Chuck Leverda351872005-08-11 16:25:11 -04001008 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Chuck Lever46121cf2007-01-31 12:14:08 -05001010 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001011 task->tk_pid, xprt,
1012 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Chuck Leverda351872005-08-11 16:25:11 -04001014 task->tk_action = call_transmit;
1015 if (!xprt_connected(xprt)) {
1016 task->tk_action = call_connect_status;
1017 if (task->tk_status < 0)
1018 return;
1019 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021}
1022
1023/*
Chuck Leverda351872005-08-11 16:25:11 -04001024 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 */
1026static void
1027call_connect_status(struct rpc_task *task)
1028{
1029 struct rpc_clnt *clnt = task->tk_client;
1030 int status = task->tk_status;
1031
Chuck Lever46121cf2007-01-31 12:14:08 -05001032 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001035 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 clnt->cl_stats->netreconn++;
1037 task->tk_action = call_transmit;
1038 return;
1039 }
1040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001042 /* if soft mounted, test if we've timed out */
1043 case -ETIMEDOUT:
1044 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001045 break;
1046 default:
1047 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 }
1049}
1050
1051/*
1052 * 5. Transmit the RPC request, and wait for reply
1053 */
1054static void
1055call_transmit(struct rpc_task *task)
1056{
Chuck Lever46121cf2007-01-31 12:14:08 -05001057 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058
1059 task->tk_action = call_status;
1060 if (task->tk_status < 0)
1061 return;
1062 task->tk_status = xprt_prepare_transmit(task);
1063 if (task->tk_status != 0)
1064 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001065 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001067 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001068 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001069 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001070 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001071 if (task->tk_status != 0) {
1072 /* Was the error nonfatal? */
1073 if (task->tk_status == -EAGAIN)
1074 rpc_delay(task, HZ >> 4);
1075 else
1076 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001077 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001078 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001079 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 xprt_transmit(task);
1081 if (task->tk_status < 0)
1082 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001083 /*
1084 * On success, ensure that we call xprt_end_transmit() before sleeping
1085 * in order to allow access to the socket to other RPC requests.
1086 */
1087 call_transmit_status(task);
1088 if (task->tk_msg.rpc_proc->p_decode != NULL)
1089 return;
1090 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001091 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001092}
1093
1094/*
1095 * 5a. Handle cleanup after a transmission
1096 */
1097static void
1098call_transmit_status(struct rpc_task *task)
1099{
1100 task->tk_action = call_status;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001101 switch (task->tk_status) {
1102 case -EAGAIN:
1103 break;
1104 default:
1105 xprt_end_transmit(task);
1106 /*
1107 * Special cases: if we've been waiting on the
1108 * socket's write_space() callback, or if the
1109 * socket just returned a connection error,
1110 * then hold onto the transport lock.
1111 */
1112 case -ECONNREFUSED:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001113 case -ECONNRESET:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001114 case -ENOTCONN:
1115 case -EHOSTDOWN:
1116 case -EHOSTUNREACH:
1117 case -ENETUNREACH:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001118 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001119 rpc_task_force_reencode(task);
1120 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121}
1122
1123/*
1124 * 6. Sort out the RPC call status
1125 */
1126static void
1127call_status(struct rpc_task *task)
1128{
1129 struct rpc_clnt *clnt = task->tk_client;
1130 struct rpc_rqst *req = task->tk_rqstp;
1131 int status;
1132
1133 if (req->rq_received > 0 && !req->rq_bytes_sent)
1134 task->tk_status = req->rq_received;
1135
Chuck Lever46121cf2007-01-31 12:14:08 -05001136 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
1138 status = task->tk_status;
1139 if (status >= 0) {
1140 task->tk_action = call_decode;
1141 return;
1142 }
1143
1144 task->tk_status = 0;
1145 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001146 case -EHOSTDOWN:
1147 case -EHOSTUNREACH:
1148 case -ENETUNREACH:
1149 /*
1150 * Delay any retries for 3 seconds, then handle as if it
1151 * were a timeout.
1152 */
1153 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 case -ETIMEDOUT:
1155 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001156 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001157 xprt_conditional_disconnect(task->tk_xprt,
1158 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001160 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001162 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001163 rpc_delay(task, 3*HZ);
1164 case -EPIPE:
1165 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 task->tk_action = call_bind;
1167 break;
1168 case -EAGAIN:
1169 task->tk_action = call_transmit;
1170 break;
1171 case -EIO:
1172 /* shutdown or soft timeout */
1173 rpc_exit(task, status);
1174 break;
1175 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001176 if (clnt->cl_chatty)
1177 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 clnt->cl_protname, -status);
1179 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 }
1181}
1182
1183/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001184 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 * We do not release the request slot, so we keep using the
1186 * same XID for all retransmits.
1187 */
1188static void
1189call_timeout(struct rpc_task *task)
1190{
1191 struct rpc_clnt *clnt = task->tk_client;
1192
1193 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001194 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 goto retry;
1196 }
1197
Chuck Lever46121cf2007-01-31 12:14:08 -05001198 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001199 task->tk_timeouts++;
1200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001202 if (clnt->cl_chatty)
1203 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 clnt->cl_protname, clnt->cl_server);
1205 rpc_exit(task, -EIO);
1206 return;
1207 }
1208
Chuck Leverf518e352006-01-03 09:55:52 +01001209 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001211 if (clnt->cl_chatty)
1212 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 clnt->cl_protname, clnt->cl_server);
1214 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001215 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001216 /*
1217 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1218 * event? RFC2203 requires the server to drop all such requests.
1219 */
1220 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
1222retry:
1223 clnt->cl_stats->rpcretrans++;
1224 task->tk_action = call_bind;
1225 task->tk_status = 0;
1226}
1227
1228/*
1229 * 7. Decode the RPC reply
1230 */
1231static void
1232call_decode(struct rpc_task *task)
1233{
1234 struct rpc_clnt *clnt = task->tk_client;
1235 struct rpc_rqst *req = task->tk_rqstp;
1236 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001237 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Chuck Lever46121cf2007-01-31 12:14:08 -05001239 dprintk("RPC: %5u call_decode (status %d)\n",
1240 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Chuck Leverf518e352006-01-03 09:55:52 +01001242 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001243 if (clnt->cl_chatty)
1244 printk(KERN_NOTICE "%s: server %s OK\n",
1245 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1247 }
1248
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001249 /*
1250 * Ensure that we see all writes made by xprt_complete_rqst()
1251 * before it changed req->rq_received.
1252 */
1253 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 req->rq_rcv_buf.len = req->rq_private_buf.len;
1255
1256 /* Check that the softirq receive buffer is valid */
1257 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1258 sizeof(req->rq_rcv_buf)) != 0);
1259
Trond Myklebust1e799b62008-03-21 16:19:41 -04001260 if (req->rq_rcv_buf.len < 12) {
1261 if (!RPC_IS_SOFT(task)) {
1262 task->tk_action = call_bind;
1263 clnt->cl_stats->rpcretrans++;
1264 goto out_retry;
1265 }
1266 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1267 clnt->cl_protname, task->tk_status);
1268 task->tk_action = call_timeout;
1269 goto out_retry;
1270 }
1271
Chuck Leverb0e1c572008-05-21 17:09:19 -04001272 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001273 if (IS_ERR(p)) {
1274 if (p == ERR_PTR(-EAGAIN))
1275 goto out_retry;
1276 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 }
1278
Trond Myklebustabbcf282006-01-03 09:55:03 +01001279 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001281 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1283 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001284 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001285 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1286 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 return;
1288out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001290 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001291 if (task->tk_rqstp == req) {
Trond Myklebust1e799b62008-03-21 16:19:41 -04001292 req->rq_received = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001293 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001294 xprt_conditional_disconnect(task->tk_xprt,
1295 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001296 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297}
1298
1299/*
1300 * 8. Refresh the credentials if rejected by the server
1301 */
1302static void
1303call_refresh(struct rpc_task *task)
1304{
Chuck Lever46121cf2007-01-31 12:14:08 -05001305 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 task->tk_action = call_refreshresult;
1308 task->tk_status = 0;
1309 task->tk_client->cl_stats->rpcauthrefresh++;
1310 rpcauth_refreshcred(task);
1311}
1312
1313/*
1314 * 8a. Process the results of a credential refresh
1315 */
1316static void
1317call_refreshresult(struct rpc_task *task)
1318{
1319 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001320
1321 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
1323 task->tk_status = 0;
1324 task->tk_action = call_reserve;
1325 if (status >= 0 && rpcauth_uptodatecred(task))
1326 return;
1327 if (status == -EACCES) {
1328 rpc_exit(task, -EACCES);
1329 return;
1330 }
1331 task->tk_action = call_refresh;
1332 if (status != -ETIMEDOUT)
1333 rpc_delay(task, 3*HZ);
1334 return;
1335}
1336
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001337static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001338rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339{
1340 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001342 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343
1344 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001345
1346 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 *p++ = req->rq_xid; /* XID */
1348 *p++ = htonl(RPC_CALL); /* CALL */
1349 *p++ = htonl(RPC_VERSION); /* RPC version */
1350 *p++ = htonl(clnt->cl_prog); /* program number */
1351 *p++ = htonl(clnt->cl_vers); /* program version */
1352 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001353 p = rpcauth_marshcred(task, p);
1354 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1355 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356}
1357
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001358static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001359rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
1361 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1362 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001363 __be32 *p = iov->iov_base;
1364 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 int error = -EACCES;
1366
David Howellse8896492006-08-24 15:44:19 -04001367 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1368 /* RFC-1014 says that the representation of XDR data must be a
1369 * multiple of four bytes
1370 * - if it isn't pointer subtraction in the NFS client may give
1371 * undefined results
1372 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001373 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001374 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001375 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001376 goto out_eio;
1377 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 if ((len -= 3) < 0)
1379 goto out_overflow;
1380 p += 1; /* skip XID */
1381
1382 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001383 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001384 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001385 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 }
1387 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1388 if (--len < 0)
1389 goto out_overflow;
1390 switch ((n = ntohl(*p++))) {
1391 case RPC_AUTH_ERROR:
1392 break;
1393 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001394 dprintk("RPC: %5u %s: RPC call version "
1395 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001396 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001397 error = -EPROTONOSUPPORT;
1398 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001400 dprintk("RPC: %5u %s: RPC call rejected, "
1401 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001402 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 goto out_eio;
1404 }
1405 if (--len < 0)
1406 goto out_overflow;
1407 switch ((n = ntohl(*p++))) {
1408 case RPC_AUTH_REJECTEDCRED:
1409 case RPC_AUTH_REJECTEDVERF:
1410 case RPCSEC_GSS_CREDPROBLEM:
1411 case RPCSEC_GSS_CTXPROBLEM:
1412 if (!task->tk_cred_retry)
1413 break;
1414 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001415 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001416 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001418 /* Ensure we obtain a new XID! */
1419 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001421 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 case RPC_AUTH_BADCRED:
1423 case RPC_AUTH_BADVERF:
1424 /* possibly garbled cred/verf? */
1425 if (!task->tk_garb_retry)
1426 break;
1427 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001428 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001429 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001431 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001433 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001434 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 break;
1436 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001437 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001438 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 error = -EIO;
1440 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001441 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001442 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443 goto out_err;
1444 }
1445 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001446 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001447 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001448 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001450 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 if (len < 0)
1452 goto out_overflow;
1453 switch ((n = ntohl(*p++))) {
1454 case RPC_SUCCESS:
1455 return p;
1456 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001457 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001458 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 (unsigned int)task->tk_client->cl_prog,
1460 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001461 error = -EPFNOSUPPORT;
1462 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001464 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001465 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 (unsigned int)task->tk_client->cl_prog,
1467 (unsigned int)task->tk_client->cl_vers,
1468 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001469 error = -EPROTONOSUPPORT;
1470 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001472 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001473 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001474 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001475 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 task->tk_client->cl_prog,
1477 task->tk_client->cl_vers,
1478 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001479 error = -EOPNOTSUPP;
1480 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001482 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001483 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 break; /* retry */
1485 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001486 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001487 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 /* Also retry */
1489 }
1490
Trond Myklebustabbcf282006-01-03 09:55:03 +01001491out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 task->tk_client->cl_stats->rpcgarbage++;
1493 if (task->tk_garb_retry) {
1494 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001495 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001496 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001498out_retry:
1499 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501out_eio:
1502 error = -EIO;
1503out_err:
1504 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001505 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001506 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001507 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001509 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001510 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001511 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001513
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001514static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001515{
1516 return 0;
1517}
1518
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001519static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001520{
1521 return 0;
1522}
1523
1524static struct rpc_procinfo rpcproc_null = {
1525 .p_encode = rpcproc_encode_null,
1526 .p_decode = rpcproc_decode_null,
1527};
1528
Trond Myklebust64c91a12007-06-23 10:17:16 -04001529static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001530{
1531 struct rpc_message msg = {
1532 .rpc_proc = &rpcproc_null,
1533 };
1534 int err;
1535 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1536 err = rpc_call_sync(clnt, &msg, flags);
1537 put_rpccred(msg.rpc_cred);
1538 return err;
1539}
Trond Myklebust188fef12007-06-16 14:18:40 -04001540
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001541struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1542{
1543 struct rpc_message msg = {
1544 .rpc_proc = &rpcproc_null,
1545 .rpc_cred = cred,
1546 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001547 struct rpc_task_setup task_setup_data = {
1548 .rpc_client = clnt,
1549 .rpc_message = &msg,
1550 .callback_ops = &rpc_default_ops,
1551 .flags = flags,
1552 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001553 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001554}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001555EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001556
Trond Myklebust188fef12007-06-16 14:18:40 -04001557#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001558static void rpc_show_header(void)
1559{
Chuck Levercb3997b2008-05-21 17:09:41 -04001560 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1561 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001562}
1563
Chuck Lever38e886e2008-05-21 17:09:33 -04001564static void rpc_show_task(const struct rpc_clnt *clnt,
1565 const struct rpc_task *task)
1566{
1567 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001568 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001569
1570 if (RPC_IS_QUEUED(task))
1571 rpc_waitq = rpc_qname(task->tk_waitqueue);
1572
Chuck Levercb3997b2008-05-21 17:09:41 -04001573 /* map tk_action pointer to a function name; then trim off
1574 * the "+0x0 [sunrpc]" */
1575 sprint_symbol(action, (unsigned long)task->tk_action);
1576 p = strchr(action, '+');
1577 if (p)
1578 *p = '\0';
1579
1580 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1581 task->tk_pid, task->tk_flags, task->tk_status,
1582 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1583 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1584 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001585}
1586
Trond Myklebust188fef12007-06-16 14:18:40 -04001587void rpc_show_tasks(void)
1588{
1589 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001590 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001591 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001592
1593 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001594 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001595 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001596 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001597 if (!header) {
1598 rpc_show_header();
1599 header++;
1600 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001601 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001602 }
1603 spin_unlock(&clnt->cl_lock);
1604 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001605 spin_unlock(&rpc_client_lock);
1606}
1607#endif