blob: 52429b1ffcc1d8d33bf7cf116bab5bfa0ceb052c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
19 *
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
22 */
23
24#include <asm/system.h>
25
26#include <linux/module.h>
27#include <linux/types.h>
28#include <linux/mm.h>
29#include <linux/slab.h>
Trond Myklebust6d5fcb52006-10-18 16:01:06 -040030#include <linux/smp_lock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050032#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050036#include <linux/sunrpc/metrics.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#ifdef RPC_DEBUG
40# define RPCDBG_FACILITY RPCDBG_CALL
41#endif
42
Chuck Lever46121cf2007-01-31 12:14:08 -050043#define dprint_status(t) \
44 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
45 __FUNCTION__, t->tk_status)
46
Trond Myklebust188fef12007-06-16 14:18:40 -040047/*
48 * All RPC clients are linked into this list
49 */
50static LIST_HEAD(all_clients);
51static DEFINE_SPINLOCK(rpc_client_lock);
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
54
55
56static void call_start(struct rpc_task *task);
57static void call_reserve(struct rpc_task *task);
58static void call_reserveresult(struct rpc_task *task);
59static void call_allocate(struct rpc_task *task);
60static void call_encode(struct rpc_task *task);
61static void call_decode(struct rpc_task *task);
62static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040063static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_transmit(struct rpc_task *task);
65static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050066static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_refresh(struct rpc_task *task);
68static void call_refreshresult(struct rpc_task *task);
69static void call_timeout(struct rpc_task *task);
70static void call_connect(struct rpc_task *task);
71static void call_connect_status(struct rpc_task *task);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070072static __be32 * call_header(struct rpc_task *task);
73static __be32 * call_verify(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Trond Myklebust64c91a12007-06-23 10:17:16 -040075static int rpc_ping(struct rpc_clnt *clnt, int flags);
76
Trond Myklebust188fef12007-06-16 14:18:40 -040077static void rpc_register_client(struct rpc_clnt *clnt)
78{
79 spin_lock(&rpc_client_lock);
80 list_add(&clnt->cl_clients, &all_clients);
81 spin_unlock(&rpc_client_lock);
82}
83
84static void rpc_unregister_client(struct rpc_clnt *clnt)
85{
86 spin_lock(&rpc_client_lock);
87 list_del(&clnt->cl_clients);
88 spin_unlock(&rpc_client_lock);
89}
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
91static int
92rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
93{
Trond Myklebustf1345852005-09-23 11:08:25 -040094 static uint32_t clntid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 int error;
96
Trond Myklebust54281542006-03-20 13:44:49 -050097 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
98 clnt->cl_dentry = ERR_PTR(-ENOENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 if (dir_name == NULL)
100 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500101
102 clnt->cl_vfsmnt = rpc_get_mount();
103 if (IS_ERR(clnt->cl_vfsmnt))
104 return PTR_ERR(clnt->cl_vfsmnt);
105
Trond Myklebustf1345852005-09-23 11:08:25 -0400106 for (;;) {
107 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
108 "%s/clnt%x", dir_name,
109 (unsigned int)clntid++);
110 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
111 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
112 if (!IS_ERR(clnt->cl_dentry))
113 return 0;
Christoph Hellwig278c9952005-07-24 23:53:01 +0100114 error = PTR_ERR(clnt->cl_dentry);
Trond Myklebustf1345852005-09-23 11:08:25 -0400115 if (error != -EEXIST) {
116 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
117 clnt->cl_pathname, error);
Trond Myklebust54281542006-03-20 13:44:49 -0500118 rpc_put_mount();
Trond Myklebustf1345852005-09-23 11:08:25 -0400119 return error;
120 }
Christoph Hellwig278c9952005-07-24 23:53:01 +0100121 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122}
123
Chuck Leverff9aa5e2006-08-22 20:06:21 -0400124static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
126 struct rpc_version *version;
127 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000128 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 int err;
130 int len;
131
Chuck Lever46121cf2007-01-31 12:14:08 -0500132 dprintk("RPC: creating %s client for %s (xprt %p)\n",
133 program->name, servname, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Trond Myklebust4ada5392007-06-14 17:26:17 -0400135 err = rpciod_up();
136 if (err)
137 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 err = -EINVAL;
139 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800140 goto out_no_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 if (vers >= program->nrvers || !(version = program->version[vers]))
142 goto out_err;
143
144 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700145 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 if (!clnt)
147 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 clnt->cl_parent = clnt;
149
150 clnt->cl_server = clnt->cl_inline_name;
151 len = strlen(servname) + 1;
152 if (len > sizeof(clnt->cl_inline_name)) {
153 char *buf = kmalloc(len, GFP_KERNEL);
154 if (buf != 0)
155 clnt->cl_server = buf;
156 else
157 len = sizeof(clnt->cl_inline_name);
158 }
159 strlcpy(clnt->cl_server, servname, len);
160
161 clnt->cl_xprt = xprt;
162 clnt->cl_procinfo = version->procs;
163 clnt->cl_maxproc = version->nrprocs;
164 clnt->cl_protname = program->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 clnt->cl_prog = program->number;
166 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500168 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500169 err = -ENOMEM;
170 if (clnt->cl_metrics == NULL)
171 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500172 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400173 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400174 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Chuck Leverec739ef2006-08-22 20:06:15 -0400176 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 clnt->cl_autobind = 1;
178
179 clnt->cl_rtt = &clnt->cl_rtt_default;
180 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
181
Trond Myklebust34f52e32007-06-14 16:40:31 -0400182 kref_init(&clnt->cl_kref);
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
185 if (err < 0)
186 goto out_no_path;
187
J. Bruce Fields6a192752005-06-22 17:16:23 +0000188 auth = rpcauth_create(flavor, clnt);
189 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
191 flavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000192 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 goto out_no_auth;
194 }
195
196 /* save the nodename */
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700197 clnt->cl_nodelen = strlen(utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 if (clnt->cl_nodelen > UNX_MAXNODENAME)
199 clnt->cl_nodelen = UNX_MAXNODENAME;
Serge E. Hallyne9ff3992006-10-02 02:18:11 -0700200 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400201 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 return clnt;
203
204out_no_auth:
Trond Myklebust54281542006-03-20 13:44:49 -0500205 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700206 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust54281542006-03-20 13:44:49 -0500207 rpc_put_mount();
208 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500210 rpc_free_iostats(clnt->cl_metrics);
211out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 if (clnt->cl_server != clnt->cl_inline_name)
213 kfree(clnt->cl_server);
214 kfree(clnt);
215out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400216 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800217out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400218 rpciod_down();
219out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 return ERR_PTR(err);
221}
222
Chuck Leverc2866762006-08-22 20:06:20 -0400223/*
224 * rpc_create - create an RPC client and transport with one call
225 * @args: rpc_clnt create argument structure
226 *
227 * Creates and initializes an RPC transport and an RPC client.
228 *
229 * It can ping the server in order to determine if it is up, and to see if
230 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
231 * this behavior so asynchronous tasks can also use rpc_create.
232 */
233struct rpc_clnt *rpc_create(struct rpc_create_args *args)
234{
235 struct rpc_xprt *xprt;
236 struct rpc_clnt *clnt;
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200237 struct rpc_xprtsock_create xprtargs = {
238 .proto = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200239 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200240 .dstaddr = args->address,
241 .addrlen = args->addrsize,
242 .timeout = args->timeout
243 };
Chuck Lever43780b82007-07-01 12:13:22 -0400244 char servername[20];
Chuck Leverc2866762006-08-22 20:06:20 -0400245
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200246 xprt = xprt_create_transport(&xprtargs);
Chuck Leverc2866762006-08-22 20:06:20 -0400247 if (IS_ERR(xprt))
248 return (struct rpc_clnt *)xprt;
249
250 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400251 * If the caller chooses not to specify a hostname, whip
252 * up a string representation of the passed-in address.
253 */
254 if (args->servername == NULL) {
255 struct sockaddr_in *addr =
256 (struct sockaddr_in *) &args->address;
257 snprintf(servername, sizeof(servername), NIPQUAD_FMT,
258 NIPQUAD(addr->sin_addr.s_addr));
259 args->servername = servername;
260 }
261
262 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400263 * By default, kernel RPC client connects from a reserved port.
264 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
265 * but it is always enabled for rpciod, which handles the connect
266 * operation.
267 */
268 xprt->resvport = 1;
269 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
270 xprt->resvport = 0;
271
272 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Chuck Lever46121cf2007-01-31 12:14:08 -0500273 args->program->name, args->servername, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400274
275 clnt = rpc_new_client(xprt, args->servername, args->program,
276 args->version, args->authflavor);
277 if (IS_ERR(clnt))
278 return clnt;
279
280 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
281 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
282 if (err != 0) {
283 rpc_shutdown_client(clnt);
284 return ERR_PTR(err);
285 }
286 }
287
288 clnt->cl_softrtry = 1;
289 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
290 clnt->cl_softrtry = 0;
291
292 if (args->flags & RPC_CLNT_CREATE_INTR)
293 clnt->cl_intr = 1;
294 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
295 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500296 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
297 clnt->cl_discrtry = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400298
299 return clnt;
300}
Chuck Leverb86acd52006-08-22 20:06:22 -0400301EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/*
304 * This function clones the RPC client structure. It allows us to share the
305 * same transport while varying parameters such as the authentication
306 * flavour.
307 */
308struct rpc_clnt *
309rpc_clone_client(struct rpc_clnt *clnt)
310{
311 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500312 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200314 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 if (!new)
316 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400317 new->cl_parent = clnt;
318 /* Turn off autobind on clones */
319 new->cl_autobind = 0;
320 INIT_LIST_HEAD(&new->cl_tasks);
321 spin_lock_init(&new->cl_lock);
322 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500323 new->cl_metrics = rpc_alloc_iostats(clnt);
324 if (new->cl_metrics == NULL)
325 goto out_no_stats;
Trond Myklebust34f52e32007-06-14 16:40:31 -0400326 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500327 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
328 if (err != 0)
329 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 if (new->cl_auth)
331 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400332 xprt_get(clnt->cl_xprt);
333 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400334 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400335 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500337out_no_path:
338 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500339out_no_stats:
340 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341out_no_clnt:
Chuck Lever46121cf2007-01-31 12:14:08 -0500342 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500343 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344}
345
346/*
347 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400348 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400350void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400352 dprintk("RPC: shutting down %s client for %s\n",
353 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Trond Myklebust34f52e32007-06-14 16:40:31 -0400355 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800357 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400358 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 }
360
Trond Myklebust4c402b42007-06-14 16:40:32 -0400361 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362}
363
364/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400365 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400367static void
368rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400370 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Chuck Lever46121cf2007-01-31 12:14:08 -0500372 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 clnt->cl_protname, clnt->cl_server);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400374 if (!IS_ERR(clnt->cl_dentry)) {
Trond Myklebustdff02cc2006-07-31 14:17:18 -0700375 rpc_rmdir(clnt->cl_dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400376 rpc_put_mount();
377 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500378 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400379 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500380 goto out_free;
381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 if (clnt->cl_server != clnt->cl_inline_name)
383 kfree(clnt->cl_server);
384out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400385 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500386 rpc_free_iostats(clnt->cl_metrics);
387 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400388 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400389 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391}
392
393/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400394 * Free an RPC client
395 */
396static void
397rpc_free_auth(struct kref *kref)
398{
399 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
400
401 if (clnt->cl_auth == NULL) {
402 rpc_free_client(kref);
403 return;
404 }
405
406 /*
407 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
408 * release remaining GSS contexts. This mechanism ensures
409 * that it can do so safely.
410 */
411 kref_init(kref);
412 rpcauth_release(clnt->cl_auth);
413 clnt->cl_auth = NULL;
414 kref_put(kref, rpc_free_client);
415}
416
417/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400418 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 */
420void
421rpc_release_client(struct rpc_clnt *clnt)
422{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400423 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Trond Myklebust34f52e32007-06-14 16:40:31 -0400425 if (list_empty(&clnt->cl_tasks))
426 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400427 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400428}
429
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000430/**
431 * rpc_bind_new_program - bind a new RPC program to an existing client
432 * @old - old rpc_client
433 * @program - rpc program to set
434 * @vers - rpc program version
435 *
436 * Clones the rpc client and sets up a new RPC program. This is mainly
437 * of use for enabling different RPC programs to share the same transport.
438 * The Sun NFSv2/v3 ACL protocol can do this.
439 */
440struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
441 struct rpc_program *program,
442 int vers)
443{
444 struct rpc_clnt *clnt;
445 struct rpc_version *version;
446 int err;
447
448 BUG_ON(vers >= program->nrvers || !program->version[vers]);
449 version = program->version[vers];
450 clnt = rpc_clone_client(old);
451 if (IS_ERR(clnt))
452 goto out;
453 clnt->cl_procinfo = version->procs;
454 clnt->cl_maxproc = version->nrprocs;
455 clnt->cl_protname = program->name;
456 clnt->cl_prog = program->number;
457 clnt->cl_vers = version->number;
458 clnt->cl_stats = program->stats;
459 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
460 if (err != 0) {
461 rpc_shutdown_client(clnt);
462 clnt = ERR_PTR(err);
463 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800464out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000465 return clnt;
466}
467
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468/*
469 * Default callback for async RPC calls
470 */
471static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100472rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473{
474}
475
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100476static const struct rpc_call_ops rpc_default_ops = {
477 .rpc_call_done = rpc_default_callback,
478};
479
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480/*
Trond Myklebust14b218a2005-06-22 17:16:28 +0000481 * Export the signal mask handling for synchronous code that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 * sleeps on RPC calls
483 */
Trond Myklebust2bd61572006-01-03 09:55:19 +0100484#define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800485
Trond Myklebust14b218a2005-06-22 17:16:28 +0000486static void rpc_save_sigmask(sigset_t *oldset, int intr)
487{
Trond Myklebust2bd61572006-01-03 09:55:19 +0100488 unsigned long sigallow = sigmask(SIGKILL);
Trond Myklebust14b218a2005-06-22 17:16:28 +0000489 sigset_t sigmask;
490
491 /* Block all signals except those listed in sigallow */
492 if (intr)
493 sigallow |= RPC_INTR_SIGNALS;
494 siginitsetinv(&sigmask, sigallow);
495 sigprocmask(SIG_BLOCK, &sigmask, oldset);
496}
497
498static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
499{
500 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
501}
502
503static inline void rpc_restore_sigmask(sigset_t *oldset)
504{
505 sigprocmask(SIG_SETMASK, oldset, NULL);
506}
507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
509{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000510 rpc_save_sigmask(oldset, clnt->cl_intr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511}
512
513void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
514{
Trond Myklebust14b218a2005-06-22 17:16:28 +0000515 rpc_restore_sigmask(oldset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
517
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400518static
519struct rpc_task *rpc_do_run_task(struct rpc_clnt *clnt,
520 struct rpc_message *msg,
521 int flags,
522 const struct rpc_call_ops *ops,
523 void *data)
524{
525 struct rpc_task *task, *ret;
526 sigset_t oldset;
527
528 task = rpc_new_task(clnt, flags, ops, data);
529 if (task == NULL) {
530 rpc_release_calldata(ops, data);
531 return ERR_PTR(-ENOMEM);
532 }
533
534 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
535 rpc_task_sigmask(task, &oldset);
536 if (msg != NULL) {
537 rpc_call_setup(task, msg, 0);
538 if (task->tk_status != 0) {
539 ret = ERR_PTR(task->tk_status);
540 rpc_put_task(task);
541 goto out;
542 }
543 }
544 atomic_inc(&task->tk_count);
545 rpc_execute(task);
546 ret = task;
547out:
548 rpc_restore_sigmask(&oldset);
549 return ret;
550}
551
552/**
553 * rpc_call_sync - Perform a synchronous RPC call
554 * @clnt: pointer to RPC client
555 * @msg: RPC call parameters
556 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 */
558int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
559{
560 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400561 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 BUG_ON(flags & RPC_TASK_ASYNC);
564
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400565 task = rpc_do_run_task(clnt, msg, flags, &rpc_default_ops, NULL);
566 if (IS_ERR(task))
567 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100568 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800569 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 return status;
571}
572
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400573/**
574 * rpc_call_async - Perform an asynchronous RPC call
575 * @clnt: pointer to RPC client
576 * @msg: RPC call parameters
577 * @flags: RPC call flags
578 * @ops: RPC call ops
579 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 */
581int
582rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100583 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
585 struct rpc_task *task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400587 task = rpc_do_run_task(clnt, msg, flags|RPC_TASK_ASYNC, tk_ops, data);
588 if (IS_ERR(task))
589 return PTR_ERR(task);
590 rpc_put_task(task);
591 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592}
593
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400594/**
595 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
596 * @clnt: pointer to RPC client
597 * @flags: RPC flags
598 * @ops: RPC call ops
599 * @data: user call data
600 */
601struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
602 const struct rpc_call_ops *tk_ops,
603 void *data)
604{
605 return rpc_do_run_task(clnt, NULL, flags, tk_ops, data);
606}
607EXPORT_SYMBOL(rpc_run_task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
609void
610rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
611{
612 task->tk_msg = *msg;
613 task->tk_flags |= flags;
614 /* Bind the user cred */
615 if (task->tk_msg.rpc_cred != NULL)
616 rpcauth_holdcred(task);
617 else
618 rpcauth_bindcred(task);
619
620 if (task->tk_status == 0)
621 task->tk_action = call_start;
622 else
Trond Myklebustabbcf282006-01-03 09:55:03 +0100623 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624}
625
Chuck Levered394402006-08-22 20:06:17 -0400626/**
627 * rpc_peeraddr - extract remote peer address from clnt's xprt
628 * @clnt: RPC client structure
629 * @buf: target buffer
630 * @size: length of target buffer
631 *
632 * Returns the number of bytes that are actually in the stored address.
633 */
634size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
635{
636 size_t bytes;
637 struct rpc_xprt *xprt = clnt->cl_xprt;
638
639 bytes = sizeof(xprt->addr);
640 if (bytes > bufsize)
641 bytes = bufsize;
642 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400643 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400644}
Chuck Leverb86acd52006-08-22 20:06:22 -0400645EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400646
Chuck Leverf425eba2006-08-22 20:06:18 -0400647/**
648 * rpc_peeraddr2str - return remote peer address in printable format
649 * @clnt: RPC client structure
650 * @format: address format
651 *
652 */
653char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
654{
655 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500656
657 if (xprt->address_strings[format] != NULL)
658 return xprt->address_strings[format];
659 else
660 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400661}
Chuck Leverb86acd52006-08-22 20:06:22 -0400662EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664void
665rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
666{
667 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700668 if (xprt->ops->set_buffer_size)
669 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
672/*
673 * Return size of largest payload RPC client can support, in bytes
674 *
675 * For stream transports, this is one RPC record fragment (see RFC
676 * 1831), as we don't support multi-record requests yet. For datagram
677 * transports, this is the size of an IP packet minus the IP, UDP, and
678 * RPC header sizes.
679 */
680size_t rpc_max_payload(struct rpc_clnt *clnt)
681{
682 return clnt->cl_xprt->max_payload;
683}
Chuck Leverb86acd52006-08-22 20:06:22 -0400684EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Chuck Lever35f5a422006-01-03 09:55:50 +0100686/**
687 * rpc_force_rebind - force transport to check that remote port is unchanged
688 * @clnt: client to rebind
689 *
690 */
691void rpc_force_rebind(struct rpc_clnt *clnt)
692{
693 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400694 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100695}
Chuck Leverb86acd52006-08-22 20:06:22 -0400696EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100697
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698/*
699 * Restart an (async) RPC call. Usually called from within the
700 * exit handler.
701 */
702void
703rpc_restart_call(struct rpc_task *task)
704{
705 if (RPC_ASSASSINATED(task))
706 return;
707
708 task->tk_action = call_start;
709}
710
711/*
712 * 0. Initial state
713 *
714 * Other FSM states can be visited zero or more times, but
715 * this state is visited exactly once for each RPC.
716 */
717static void
718call_start(struct rpc_task *task)
719{
720 struct rpc_clnt *clnt = task->tk_client;
721
Chuck Lever46121cf2007-01-31 12:14:08 -0500722 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
723 clnt->cl_protname, clnt->cl_vers,
724 task->tk_msg.rpc_proc->p_proc,
725 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 /* Increment call count */
728 task->tk_msg.rpc_proc->p_count++;
729 clnt->cl_stats->rpccnt++;
730 task->tk_action = call_reserve;
731}
732
733/*
734 * 1. Reserve an RPC call slot
735 */
736static void
737call_reserve(struct rpc_task *task)
738{
Chuck Lever46121cf2007-01-31 12:14:08 -0500739 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
741 if (!rpcauth_uptodatecred(task)) {
742 task->tk_action = call_refresh;
743 return;
744 }
745
746 task->tk_status = 0;
747 task->tk_action = call_reserveresult;
748 xprt_reserve(task);
749}
750
751/*
752 * 1b. Grok the result of xprt_reserve()
753 */
754static void
755call_reserveresult(struct rpc_task *task)
756{
757 int status = task->tk_status;
758
Chuck Lever46121cf2007-01-31 12:14:08 -0500759 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
761 /*
762 * After a call to xprt_reserve(), we must have either
763 * a request slot or else an error status.
764 */
765 task->tk_status = 0;
766 if (status >= 0) {
767 if (task->tk_rqstp) {
768 task->tk_action = call_allocate;
769 return;
770 }
771
772 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
773 __FUNCTION__, status);
774 rpc_exit(task, -EIO);
775 return;
776 }
777
778 /*
779 * Even though there was an error, we may have acquired
780 * a request slot somehow. Make sure not to leak it.
781 */
782 if (task->tk_rqstp) {
783 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
784 __FUNCTION__, status);
785 xprt_release(task);
786 }
787
788 switch (status) {
789 case -EAGAIN: /* woken up; retry */
790 task->tk_action = call_reserve;
791 return;
792 case -EIO: /* probably a shutdown */
793 break;
794 default:
795 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
796 __FUNCTION__, status);
797 break;
798 }
799 rpc_exit(task, status);
800}
801
802/*
803 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100804 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 */
806static void
807call_allocate(struct rpc_task *task)
808{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400809 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100810 struct rpc_rqst *req = task->tk_rqstp;
811 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400812 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Chuck Lever46121cf2007-01-31 12:14:08 -0500814 dprint_status(task);
815
Chuck Lever2bea90d2007-03-29 16:47:53 -0400816 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400818
Chuck Lever02107142006-01-03 09:55:49 +0100819 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 return;
821
Chuck Lever2bea90d2007-03-29 16:47:53 -0400822 if (proc->p_proc != 0) {
823 BUG_ON(proc->p_arglen == 0);
824 if (proc->p_decode != NULL)
825 BUG_ON(proc->p_replen == 0);
826 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827
Chuck Lever2bea90d2007-03-29 16:47:53 -0400828 /*
829 * Calculate the size (in quads) of the RPC call
830 * and reply headers, and convert both values
831 * to byte sizes.
832 */
833 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
834 req->rq_callsize <<= 2;
835 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
836 req->rq_rcvsize <<= 2;
837
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400838 req->rq_buffer = xprt->ops->buf_alloc(task,
839 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400840 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500842
843 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Trond Myklebust14b218a2005-06-22 17:16:28 +0000845 if (RPC_IS_ASYNC(task) || !signalled()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 xprt_release(task);
847 task->tk_action = call_reserve;
848 rpc_delay(task, HZ>>4);
849 return;
850 }
851
852 rpc_exit(task, -ERESTARTSYS);
853}
854
Trond Myklebust940e3312005-11-09 21:45:24 -0500855static inline int
856rpc_task_need_encode(struct rpc_task *task)
857{
858 return task->tk_rqstp->rq_snd_buf.len == 0;
859}
860
861static inline void
862rpc_task_force_reencode(struct rpc_task *task)
863{
864 task->tk_rqstp->rq_snd_buf.len = 0;
865}
866
Chuck Lever2bea90d2007-03-29 16:47:53 -0400867static inline void
868rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
869{
870 buf->head[0].iov_base = start;
871 buf->head[0].iov_len = len;
872 buf->tail[0].iov_len = 0;
873 buf->page_len = 0;
874 buf->len = 0;
875 buf->buflen = len;
876}
877
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878/*
879 * 3. Encode arguments of an RPC call
880 */
881static void
882call_encode(struct rpc_task *task)
883{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700886 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Chuck Lever46121cf2007-01-31 12:14:08 -0500888 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Chuck Lever2bea90d2007-03-29 16:47:53 -0400890 rpc_xdr_buf_init(&req->rq_snd_buf,
891 req->rq_buffer,
892 req->rq_callsize);
893 rpc_xdr_buf_init(&req->rq_rcv_buf,
894 (char *)req->rq_buffer + req->rq_callsize,
895 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
897 /* Encode header and provided arguments */
898 encode = task->tk_msg.rpc_proc->p_encode;
899 if (!(p = call_header(task))) {
900 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
901 rpc_exit(task, -EIO);
902 return;
903 }
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400904 if (encode == NULL)
905 return;
906
907 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
908 task->tk_msg.rpc_argp);
909 if (task->tk_status == -ENOMEM) {
910 /* XXX: Is this sane? */
911 rpc_delay(task, 3*HZ);
912 task->tk_status = -EAGAIN;
913 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
915
916/*
917 * 4. Get the server port number if not yet set
918 */
919static void
920call_bind(struct rpc_task *task)
921{
Chuck Leverec739ef2006-08-22 20:06:15 -0400922 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Chuck Lever46121cf2007-01-31 12:14:08 -0500924 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Chuck Leverda351872005-08-11 16:25:11 -0400926 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -0400927 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -0400928 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -0400929 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400930 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 }
932}
933
934/*
Chuck Leverda351872005-08-11 16:25:11 -0400935 * 4a. Sort out bind result
936 */
937static void
938call_bind_status(struct rpc_task *task)
939{
940 int status = -EACCES;
941
942 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -0500943 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -0400944 task->tk_status = 0;
945 task->tk_action = call_connect;
946 return;
947 }
948
949 switch (task->tk_status) {
950 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -0500951 dprintk("RPC: %5u remote rpcbind: RPC program/version "
952 "unavailable\n", task->tk_pid);
Chuck Leverea635a52005-10-06 23:12:58 -0400953 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -0400954 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400955 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500956 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -0400957 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -0400958 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400959 case -EPFNOSUPPORT:
Chuck Lever46121cf2007-01-31 12:14:08 -0500960 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -0400961 task->tk_pid);
962 break;
963 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400964 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -0400965 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -0400966 task->tk_status = 0;
967 task->tk_action = call_bind;
968 return;
Chuck Leverda351872005-08-11 16:25:11 -0400969 default:
Chuck Lever46121cf2007-01-31 12:14:08 -0500970 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -0400971 task->tk_pid, -task->tk_status);
972 status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -0400973 }
974
975 rpc_exit(task, status);
976 return;
977
Trond Myklebustda458282006-08-31 15:44:52 -0400978retry_timeout:
979 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -0400980}
981
982/*
983 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 */
985static void
986call_connect(struct rpc_task *task)
987{
Chuck Leverda351872005-08-11 16:25:11 -0400988 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Chuck Lever46121cf2007-01-31 12:14:08 -0500990 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -0400991 task->tk_pid, xprt,
992 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Chuck Leverda351872005-08-11 16:25:11 -0400994 task->tk_action = call_transmit;
995 if (!xprt_connected(xprt)) {
996 task->tk_action = call_connect_status;
997 if (task->tk_status < 0)
998 return;
999 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001}
1002
1003/*
Chuck Leverda351872005-08-11 16:25:11 -04001004 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 */
1006static void
1007call_connect_status(struct rpc_task *task)
1008{
1009 struct rpc_clnt *clnt = task->tk_client;
1010 int status = task->tk_status;
1011
Chuck Lever46121cf2007-01-31 12:14:08 -05001012 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001013
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 task->tk_status = 0;
1015 if (status >= 0) {
1016 clnt->cl_stats->netreconn++;
1017 task->tk_action = call_transmit;
1018 return;
1019 }
1020
Chuck Leverda351872005-08-11 16:25:11 -04001021 /* Something failed: remote service port may have changed */
Chuck Lever35f5a422006-01-03 09:55:50 +01001022 rpc_force_rebind(clnt);
Chuck Leverda351872005-08-11 16:25:11 -04001023
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 switch (status) {
1025 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 case -EAGAIN:
Chuck Leverda351872005-08-11 16:25:11 -04001027 task->tk_action = call_bind;
Trond Myklebustda458282006-08-31 15:44:52 -04001028 if (!RPC_IS_SOFT(task))
1029 return;
1030 /* if soft mounted, test if we've timed out */
1031 case -ETIMEDOUT:
1032 task->tk_action = call_timeout;
1033 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 }
Trond Myklebustda458282006-08-31 15:44:52 -04001035 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036}
1037
1038/*
1039 * 5. Transmit the RPC request, and wait for reply
1040 */
1041static void
1042call_transmit(struct rpc_task *task)
1043{
Chuck Lever46121cf2007-01-31 12:14:08 -05001044 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
1046 task->tk_action = call_status;
1047 if (task->tk_status < 0)
1048 return;
1049 task->tk_status = xprt_prepare_transmit(task);
1050 if (task->tk_status != 0)
1051 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001052 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001054 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001055 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 call_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001057 /* Did the encode result in an error condition? */
1058 if (task->tk_status != 0)
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001059 return;
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001060 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 xprt_transmit(task);
1062 if (task->tk_status < 0)
1063 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001064 /*
1065 * On success, ensure that we call xprt_end_transmit() before sleeping
1066 * in order to allow access to the socket to other RPC requests.
1067 */
1068 call_transmit_status(task);
1069 if (task->tk_msg.rpc_proc->p_decode != NULL)
1070 return;
1071 task->tk_action = rpc_exit_task;
1072 rpc_wake_up_task(task);
1073}
1074
1075/*
1076 * 5a. Handle cleanup after a transmission
1077 */
1078static void
1079call_transmit_status(struct rpc_task *task)
1080{
1081 task->tk_action = call_status;
1082 /*
1083 * Special case: if we've been waiting on the socket's write_space()
1084 * callback, then don't call xprt_end_transmit().
1085 */
1086 if (task->tk_status == -EAGAIN)
1087 return;
1088 xprt_end_transmit(task);
Trond Myklebust940e3312005-11-09 21:45:24 -05001089 rpc_task_force_reencode(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090}
1091
1092/*
1093 * 6. Sort out the RPC call status
1094 */
1095static void
1096call_status(struct rpc_task *task)
1097{
1098 struct rpc_clnt *clnt = task->tk_client;
1099 struct rpc_rqst *req = task->tk_rqstp;
1100 int status;
1101
1102 if (req->rq_received > 0 && !req->rq_bytes_sent)
1103 task->tk_status = req->rq_received;
1104
Chuck Lever46121cf2007-01-31 12:14:08 -05001105 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
1107 status = task->tk_status;
1108 if (status >= 0) {
1109 task->tk_action = call_decode;
1110 return;
1111 }
1112
1113 task->tk_status = 0;
1114 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001115 case -EHOSTDOWN:
1116 case -EHOSTUNREACH:
1117 case -ENETUNREACH:
1118 /*
1119 * Delay any retries for 3 seconds, then handle as if it
1120 * were a timeout.
1121 */
1122 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 case -ETIMEDOUT:
1124 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001125 if (task->tk_client->cl_discrtry)
1126 xprt_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 break;
1128 case -ECONNREFUSED:
1129 case -ENOTCONN:
Chuck Lever35f5a422006-01-03 09:55:50 +01001130 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 task->tk_action = call_bind;
1132 break;
1133 case -EAGAIN:
1134 task->tk_action = call_transmit;
1135 break;
1136 case -EIO:
1137 /* shutdown or soft timeout */
1138 rpc_exit(task, status);
1139 break;
1140 default:
Chuck Leverf518e35a2006-01-03 09:55:52 +01001141 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 clnt->cl_protname, -status);
1143 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 }
1145}
1146
1147/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001148 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 * We do not release the request slot, so we keep using the
1150 * same XID for all retransmits.
1151 */
1152static void
1153call_timeout(struct rpc_task *task)
1154{
1155 struct rpc_clnt *clnt = task->tk_client;
1156
1157 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001158 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 goto retry;
1160 }
1161
Chuck Lever46121cf2007-01-31 12:14:08 -05001162 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001163 task->tk_timeouts++;
1164
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 if (RPC_IS_SOFT(task)) {
Chuck Leverf518e35a2006-01-03 09:55:52 +01001166 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 clnt->cl_protname, clnt->cl_server);
1168 rpc_exit(task, -EIO);
1169 return;
1170 }
1171
Chuck Leverf518e35a2006-01-03 09:55:52 +01001172 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 task->tk_flags |= RPC_CALL_MAJORSEEN;
1174 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1175 clnt->cl_protname, clnt->cl_server);
1176 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001177 rpc_force_rebind(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
1179retry:
1180 clnt->cl_stats->rpcretrans++;
1181 task->tk_action = call_bind;
1182 task->tk_status = 0;
1183}
1184
1185/*
1186 * 7. Decode the RPC reply
1187 */
1188static void
1189call_decode(struct rpc_task *task)
1190{
1191 struct rpc_clnt *clnt = task->tk_client;
1192 struct rpc_rqst *req = task->tk_rqstp;
1193 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001194 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Chuck Lever46121cf2007-01-31 12:14:08 -05001196 dprintk("RPC: %5u call_decode (status %d)\n",
1197 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Chuck Leverf518e35a2006-01-03 09:55:52 +01001199 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 printk(KERN_NOTICE "%s: server %s OK\n",
1201 clnt->cl_protname, clnt->cl_server);
1202 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1203 }
1204
1205 if (task->tk_status < 12) {
1206 if (!RPC_IS_SOFT(task)) {
1207 task->tk_action = call_bind;
1208 clnt->cl_stats->rpcretrans++;
1209 goto out_retry;
1210 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001211 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1212 clnt->cl_protname, task->tk_status);
Trond Myklebustda458282006-08-31 15:44:52 -04001213 task->tk_action = call_timeout;
1214 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 }
1216
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001217 /*
1218 * Ensure that we see all writes made by xprt_complete_rqst()
1219 * before it changed req->rq_received.
1220 */
1221 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 req->rq_rcv_buf.len = req->rq_private_buf.len;
1223
1224 /* Check that the softirq receive buffer is valid */
1225 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1226 sizeof(req->rq_rcv_buf)) != 0);
1227
1228 /* Verify the RPC header */
Trond Myklebustabbcf282006-01-03 09:55:03 +01001229 p = call_verify(task);
1230 if (IS_ERR(p)) {
1231 if (p == ERR_PTR(-EAGAIN))
1232 goto out_retry;
1233 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 }
1235
Trond Myklebustabbcf282006-01-03 09:55:03 +01001236 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001238 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1240 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001241 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001242 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1243 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 return;
1245out_retry:
1246 req->rq_received = req->rq_private_buf.len = 0;
1247 task->tk_status = 0;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001248 if (task->tk_client->cl_discrtry)
1249 xprt_disconnect(task->tk_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250}
1251
1252/*
1253 * 8. Refresh the credentials if rejected by the server
1254 */
1255static void
1256call_refresh(struct rpc_task *task)
1257{
Chuck Lever46121cf2007-01-31 12:14:08 -05001258 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
1260 xprt_release(task); /* Must do to obtain new XID */
1261 task->tk_action = call_refreshresult;
1262 task->tk_status = 0;
1263 task->tk_client->cl_stats->rpcauthrefresh++;
1264 rpcauth_refreshcred(task);
1265}
1266
1267/*
1268 * 8a. Process the results of a credential refresh
1269 */
1270static void
1271call_refreshresult(struct rpc_task *task)
1272{
1273 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001274
1275 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276
1277 task->tk_status = 0;
1278 task->tk_action = call_reserve;
1279 if (status >= 0 && rpcauth_uptodatecred(task))
1280 return;
1281 if (status == -EACCES) {
1282 rpc_exit(task, -EACCES);
1283 return;
1284 }
1285 task->tk_action = call_refresh;
1286 if (status != -ETIMEDOUT)
1287 rpc_delay(task, 3*HZ);
1288 return;
1289}
1290
1291/*
1292 * Call header serialization
1293 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001294static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295call_header(struct rpc_task *task)
1296{
1297 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001299 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
1301 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001302
1303 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 *p++ = req->rq_xid; /* XID */
1305 *p++ = htonl(RPC_CALL); /* CALL */
1306 *p++ = htonl(RPC_VERSION); /* RPC version */
1307 *p++ = htonl(clnt->cl_prog); /* program number */
1308 *p++ = htonl(clnt->cl_vers); /* program version */
1309 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001310 p = rpcauth_marshcred(task, p);
1311 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1312 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313}
1314
1315/*
1316 * Reply header verification
1317 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001318static __be32 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319call_verify(struct rpc_task *task)
1320{
1321 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1322 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001323 __be32 *p = iov->iov_base;
1324 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 int error = -EACCES;
1326
David Howellse8896492006-08-24 15:44:19 -04001327 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1328 /* RFC-1014 says that the representation of XDR data must be a
1329 * multiple of four bytes
1330 * - if it isn't pointer subtraction in the NFS client may give
1331 * undefined results
1332 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001333 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1334 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1335 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001336 goto out_eio;
1337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 if ((len -= 3) < 0)
1339 goto out_overflow;
1340 p += 1; /* skip XID */
1341
1342 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001343 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1344 task->tk_pid, __FUNCTION__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001345 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 }
1347 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1348 if (--len < 0)
1349 goto out_overflow;
1350 switch ((n = ntohl(*p++))) {
1351 case RPC_AUTH_ERROR:
1352 break;
1353 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001354 dprintk("RPC: %5u %s: RPC call version "
1355 "mismatch!\n",
1356 task->tk_pid, __FUNCTION__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001357 error = -EPROTONOSUPPORT;
1358 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001360 dprintk("RPC: %5u %s: RPC call rejected, "
1361 "unknown error: %x\n",
1362 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 goto out_eio;
1364 }
1365 if (--len < 0)
1366 goto out_overflow;
1367 switch ((n = ntohl(*p++))) {
1368 case RPC_AUTH_REJECTEDCRED:
1369 case RPC_AUTH_REJECTEDVERF:
1370 case RPCSEC_GSS_CREDPROBLEM:
1371 case RPCSEC_GSS_CTXPROBLEM:
1372 if (!task->tk_cred_retry)
1373 break;
1374 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001375 dprintk("RPC: %5u %s: retry stale creds\n",
1376 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 rpcauth_invalcred(task);
1378 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001379 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 case RPC_AUTH_BADCRED:
1381 case RPC_AUTH_BADVERF:
1382 /* possibly garbled cred/verf? */
1383 if (!task->tk_garb_retry)
1384 break;
1385 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001386 dprintk("RPC: %5u %s: retry garbled creds\n",
1387 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001389 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 case RPC_AUTH_TOOWEAK:
Levent Serinol1356b8c2006-03-20 13:44:11 -05001391 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1392 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 break;
1394 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001395 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1396 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 error = -EIO;
1398 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001399 dprintk("RPC: %5u %s: call rejected %d\n",
1400 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 goto out_err;
1402 }
1403 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001404 dprintk("RPC: %5u %s: auth check failed\n",
1405 task->tk_pid, __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001406 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001408 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 if (len < 0)
1410 goto out_overflow;
1411 switch ((n = ntohl(*p++))) {
1412 case RPC_SUCCESS:
1413 return p;
1414 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001415 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1416 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 (unsigned int)task->tk_client->cl_prog,
1418 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001419 error = -EPFNOSUPPORT;
1420 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001422 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1423 "server %s\n", task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 (unsigned int)task->tk_client->cl_prog,
1425 (unsigned int)task->tk_client->cl_vers,
1426 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001427 error = -EPROTONOSUPPORT;
1428 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 case RPC_PROC_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001430 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1431 "version %u on server %s\n",
1432 task->tk_pid, __FUNCTION__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 task->tk_msg.rpc_proc,
1434 task->tk_client->cl_prog,
1435 task->tk_client->cl_vers,
1436 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001437 error = -EOPNOTSUPP;
1438 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001440 dprintk("RPC: %5u %s: server saw garbage\n",
1441 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 break; /* retry */
1443 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001444 dprintk("RPC: %5u %s: server accept status: %x\n",
1445 task->tk_pid, __FUNCTION__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 /* Also retry */
1447 }
1448
Trond Myklebustabbcf282006-01-03 09:55:03 +01001449out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 task->tk_client->cl_stats->rpcgarbage++;
1451 if (task->tk_garb_retry) {
1452 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001453 dprintk("RPC: %5u %s: retrying\n",
1454 task->tk_pid, __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001456out_retry:
1457 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459out_eio:
1460 error = -EIO;
1461out_err:
1462 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001463 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1464 __FUNCTION__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001465 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001467 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1468 __FUNCTION__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001469 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001471
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001472static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001473{
1474 return 0;
1475}
1476
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001477static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001478{
1479 return 0;
1480}
1481
1482static struct rpc_procinfo rpcproc_null = {
1483 .p_encode = rpcproc_encode_null,
1484 .p_decode = rpcproc_decode_null,
1485};
1486
Trond Myklebust64c91a12007-06-23 10:17:16 -04001487static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001488{
1489 struct rpc_message msg = {
1490 .rpc_proc = &rpcproc_null,
1491 };
1492 int err;
1493 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1494 err = rpc_call_sync(clnt, &msg, flags);
1495 put_rpccred(msg.rpc_cred);
1496 return err;
1497}
Trond Myklebust188fef12007-06-16 14:18:40 -04001498
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001499struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1500{
1501 struct rpc_message msg = {
1502 .rpc_proc = &rpcproc_null,
1503 .rpc_cred = cred,
1504 };
1505 return rpc_do_run_task(clnt, &msg, flags, &rpc_default_ops, NULL);
1506}
1507EXPORT_SYMBOL(rpc_call_null);
1508
Trond Myklebust188fef12007-06-16 14:18:40 -04001509#ifdef RPC_DEBUG
1510void rpc_show_tasks(void)
1511{
1512 struct rpc_clnt *clnt;
1513 struct rpc_task *t;
1514
1515 spin_lock(&rpc_client_lock);
1516 if (list_empty(&all_clients))
1517 goto out;
1518 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1519 "-rpcwait -action- ---ops--\n");
1520 list_for_each_entry(clnt, &all_clients, cl_clients) {
1521 if (list_empty(&clnt->cl_tasks))
1522 continue;
1523 spin_lock(&clnt->cl_lock);
1524 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1525 const char *rpc_waitq = "none";
1526
1527 if (RPC_IS_QUEUED(t))
1528 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1529
1530 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
1531 t->tk_pid,
1532 (t->tk_msg.rpc_proc ? t->tk_msg.rpc_proc->p_proc : -1),
1533 t->tk_flags, t->tk_status,
1534 t->tk_client,
1535 (t->tk_client ? t->tk_client->cl_prog : 0),
1536 t->tk_rqstp, t->tk_timeout,
1537 rpc_waitq,
1538 t->tk_action, t->tk_ops);
1539 }
1540 spin_unlock(&clnt->cl_lock);
1541 }
1542out:
1543 spin_unlock(&rpc_client_lock);
1544}
1545#endif