blob: 154034b675bd90de493d1438ff46a2b230178742 [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>
Trond Myklebust23ac6582009-08-09 15:14:25 -040030#include <linux/namei.h>
31#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050034#include <linux/workqueue.h>
Chuck Lever510deb02007-12-10 14:56:24 -050035#include <linux/in6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050039#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040040#include <linux/sunrpc/bc_xprt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifdef RPC_DEBUG
45# define RPCDBG_FACILITY RPCDBG_CALL
46#endif
47
Chuck Lever46121cf2007-01-31 12:14:08 -050048#define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080050 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050051
Trond Myklebust188fef12007-06-16 14:18:40 -040052/*
53 * All RPC clients are linked into this list
54 */
55static LIST_HEAD(all_clients);
56static DEFINE_SPINLOCK(rpc_client_lock);
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
59
60
61static void call_start(struct rpc_task *task);
62static void call_reserve(struct rpc_task *task);
63static void call_reserveresult(struct rpc_task *task);
64static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065static void call_decode(struct rpc_task *task);
66static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040067static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068static void call_transmit(struct rpc_task *task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069#if defined(CONFIG_NFS_V4_1)
70static void call_bc_transmit(struct rpc_task *task);
71#endif /* CONFIG_NFS_V4_1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050073static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074static void call_refresh(struct rpc_task *task);
75static void call_refreshresult(struct rpc_task *task);
76static void call_timeout(struct rpc_task *task);
77static void call_connect(struct rpc_task *task);
78static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Chuck Leverb0e1c572008-05-21 17:09:19 -040080static __be32 *rpc_encode_header(struct rpc_task *task);
81static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050082static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040083
Trond Myklebust188fef12007-06-16 14:18:40 -040084static void rpc_register_client(struct rpc_clnt *clnt)
85{
86 spin_lock(&rpc_client_lock);
87 list_add(&clnt->cl_clients, &all_clients);
88 spin_unlock(&rpc_client_lock);
89}
90
91static void rpc_unregister_client(struct rpc_clnt *clnt)
92{
93 spin_lock(&rpc_client_lock);
94 list_del(&clnt->cl_clients);
95 spin_unlock(&rpc_client_lock);
96}
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98static int
99rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
100{
Trond Myklebustf1345852005-09-23 11:08:25 -0400101 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400102 struct nameidata nd;
103 struct path path;
104 char name[15];
105 struct qstr q = {
106 .name = name,
107 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 int error;
109
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400110 clnt->cl_path.mnt = ERR_PTR(-ENOENT);
111 clnt->cl_path.dentry = ERR_PTR(-ENOENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 if (dir_name == NULL)
113 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500114
Trond Myklebust23ac6582009-08-09 15:14:25 -0400115 path.mnt = rpc_get_mount();
116 if (IS_ERR(path.mnt))
117 return PTR_ERR(path.mnt);
118 error = vfs_path_lookup(path.mnt->mnt_root, path.mnt, dir_name, 0, &nd);
119 if (error)
120 goto err;
Trond Myklebust54281542006-03-20 13:44:49 -0500121
Trond Myklebustf1345852005-09-23 11:08:25 -0400122 for (;;) {
Trond Myklebust23ac6582009-08-09 15:14:25 -0400123 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
124 name[sizeof(name) - 1] = '\0';
125 q.hash = full_name_hash(q.name, q.len);
126 path.dentry = rpc_create_client_dir(nd.path.dentry, &q, clnt);
127 if (!IS_ERR(path.dentry))
128 break;
129 error = PTR_ERR(path.dentry);
Trond Myklebustf1345852005-09-23 11:08:25 -0400130 if (error != -EEXIST) {
Trond Myklebust23ac6582009-08-09 15:14:25 -0400131 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
132 " %s/%s, error %d\n",
133 dir_name, name, error);
134 goto err_path_put;
Trond Myklebustf1345852005-09-23 11:08:25 -0400135 }
Christoph Hellwig278c9952005-07-24 23:53:01 +0100136 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400137 path_put(&nd.path);
138 clnt->cl_path = path;
139 return 0;
140err_path_put:
141 path_put(&nd.path);
142err:
143 rpc_put_mount();
144 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
Trond Myklebust698b6d02007-12-20 16:03:53 -0500147static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500149 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 struct rpc_version *version;
151 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000152 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400154 size_t len;
155
156 /* sanity check the name before trying to print it */
157 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500158 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400159 if (len > RPC_MAXNETNAMELEN)
160 goto out_no_rpciod;
161 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Chuck Lever46121cf2007-01-31 12:14:08 -0500163 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500164 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Trond Myklebust4ada5392007-06-14 17:26:17 -0400166 err = rpciod_up();
167 if (err)
168 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 err = -EINVAL;
170 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800171 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500172
173 if (args->version >= program->nrvers)
174 goto out_err;
175 version = program->version[args->version];
176 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 goto out_err;
178
179 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700180 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 if (!clnt)
182 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 clnt->cl_parent = clnt;
184
185 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 if (len > sizeof(clnt->cl_inline_name)) {
187 char *buf = kmalloc(len, GFP_KERNEL);
Trond Myklebust698b6d02007-12-20 16:03:53 -0500188 if (buf != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 clnt->cl_server = buf;
190 else
191 len = sizeof(clnt->cl_inline_name);
192 }
Trond Myklebust698b6d02007-12-20 16:03:53 -0500193 strlcpy(clnt->cl_server, args->servername, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
195 clnt->cl_xprt = xprt;
196 clnt->cl_procinfo = version->procs;
197 clnt->cl_maxproc = version->nrprocs;
198 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300199 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500202 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500203 err = -ENOMEM;
204 if (clnt->cl_metrics == NULL)
205 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500206 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400207 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400208 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Chuck Leverec739ef2006-08-22 20:06:15 -0400210 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 clnt->cl_autobind = 1;
212
Trond Myklebustba7392b2007-12-20 16:03:55 -0500213 clnt->cl_timeout = xprt->timeout;
214 if (args->timeout != NULL) {
215 memcpy(&clnt->cl_timeout_default, args->timeout,
216 sizeof(clnt->cl_timeout_default));
217 clnt->cl_timeout = &clnt->cl_timeout_default;
218 }
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500221 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500222 clnt->cl_principal = NULL;
223 if (args->client_name) {
224 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
225 if (!clnt->cl_principal)
226 goto out_no_principal;
227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Trond Myklebust34f52e32007-06-14 16:40:31 -0400229 kref_init(&clnt->cl_kref);
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
232 if (err < 0)
233 goto out_no_path;
234
Trond Myklebust698b6d02007-12-20 16:03:53 -0500235 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000236 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500238 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000239 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 goto out_no_auth;
241 }
242
243 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400244 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 if (clnt->cl_nodelen > UNX_MAXNODENAME)
246 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400247 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400248 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 return clnt;
250
251out_no_auth:
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400252 if (!IS_ERR(clnt->cl_path.dentry)) {
253 rpc_remove_client_dir(clnt->cl_path.dentry);
Trond Myklebust54281542006-03-20 13:44:49 -0500254 rpc_put_mount();
255 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500257 kfree(clnt->cl_principal);
258out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500259 rpc_free_iostats(clnt->cl_metrics);
260out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 if (clnt->cl_server != clnt->cl_inline_name)
262 kfree(clnt->cl_server);
263 kfree(clnt);
264out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400265 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800266out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400267 rpciod_down();
268out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 return ERR_PTR(err);
270}
271
Chuck Leverc2866762006-08-22 20:06:20 -0400272/*
273 * rpc_create - create an RPC client and transport with one call
274 * @args: rpc_clnt create argument structure
275 *
276 * Creates and initializes an RPC transport and an RPC client.
277 *
278 * It can ping the server in order to determine if it is up, and to see if
279 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
280 * this behavior so asynchronous tasks can also use rpc_create.
281 */
282struct rpc_clnt *rpc_create(struct rpc_create_args *args)
283{
284 struct rpc_xprt *xprt;
285 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400286 struct xprt_create xprtargs = {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400287 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200288 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200289 .dstaddr = args->address,
290 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300291 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200292 };
Chuck Lever510deb02007-12-10 14:56:24 -0500293 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400294
Chuck Leverc2866762006-08-22 20:06:20 -0400295 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400296 * If the caller chooses not to specify a hostname, whip
297 * up a string representation of the passed-in address.
298 */
299 if (args->servername == NULL) {
Chuck Lever510deb02007-12-10 14:56:24 -0500300 servername[0] = '\0';
301 switch (args->address->sa_family) {
302 case AF_INET: {
303 struct sockaddr_in *sin =
304 (struct sockaddr_in *)args->address;
Harvey Harrison21454aa2008-10-31 00:54:56 -0700305 snprintf(servername, sizeof(servername), "%pI4",
306 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500307 break;
308 }
309 case AF_INET6: {
310 struct sockaddr_in6 *sin =
311 (struct sockaddr_in6 *)args->address;
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700312 snprintf(servername, sizeof(servername), "%pI6",
Harvey Harrisonfdb46ee2008-10-28 16:10:17 -0700313 &sin->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500314 break;
315 }
316 default:
317 /* caller wants default server name, but
318 * address family isn't recognized. */
319 return ERR_PTR(-EINVAL);
320 }
Chuck Lever43780b82007-07-01 12:13:22 -0400321 args->servername = servername;
322 }
323
Chuck Lever510deb02007-12-10 14:56:24 -0500324 xprt = xprt_create_transport(&xprtargs);
325 if (IS_ERR(xprt))
326 return (struct rpc_clnt *)xprt;
327
Chuck Lever43780b82007-07-01 12:13:22 -0400328 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400329 * By default, kernel RPC client connects from a reserved port.
330 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
331 * but it is always enabled for rpciod, which handles the connect
332 * operation.
333 */
334 xprt->resvport = 1;
335 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
336 xprt->resvport = 0;
337
Trond Myklebust698b6d02007-12-20 16:03:53 -0500338 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400339 if (IS_ERR(clnt))
340 return clnt;
341
342 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500343 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400344 if (err != 0) {
345 rpc_shutdown_client(clnt);
346 return ERR_PTR(err);
347 }
348 }
349
350 clnt->cl_softrtry = 1;
351 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
352 clnt->cl_softrtry = 0;
353
Chuck Leverc2866762006-08-22 20:06:20 -0400354 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
355 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500356 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
357 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400358 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
359 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400360
361 return clnt;
362}
Chuck Leverb86acd52006-08-22 20:06:22 -0400363EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365/*
366 * This function clones the RPC client structure. It allows us to share the
367 * same transport while varying parameters such as the authentication
368 * flavour.
369 */
370struct rpc_clnt *
371rpc_clone_client(struct rpc_clnt *clnt)
372{
373 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500374 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200376 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 if (!new)
378 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400379 new->cl_parent = clnt;
380 /* Turn off autobind on clones */
381 new->cl_autobind = 0;
382 INIT_LIST_HEAD(&new->cl_tasks);
383 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500384 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500385 new->cl_metrics = rpc_alloc_iostats(clnt);
386 if (new->cl_metrics == NULL)
387 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500388 if (clnt->cl_principal) {
389 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
390 if (new->cl_principal == NULL)
391 goto out_no_principal;
392 }
Trond Myklebust34f52e32007-06-14 16:40:31 -0400393 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500394 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
395 if (err != 0)
396 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 if (new->cl_auth)
398 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400399 xprt_get(clnt->cl_xprt);
400 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400401 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400402 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500404out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500405 kfree(new->cl_principal);
406out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500407 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500408out_no_stats:
409 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800411 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500412 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400414EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416/*
417 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400418 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400420void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400422 dprintk("RPC: shutting down %s client for %s\n",
423 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Trond Myklebust34f52e32007-06-14 16:40:31 -0400425 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800427 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400428 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 }
430
Trond Myklebust4c402b42007-06-14 16:40:32 -0400431 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400433EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400436 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400438static void
439rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400441 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Chuck Lever46121cf2007-01-31 12:14:08 -0500443 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400445 if (!IS_ERR(clnt->cl_path.dentry)) {
446 rpc_remove_client_dir(clnt->cl_path.dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400447 rpc_put_mount();
448 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500449 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400450 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500451 goto out_free;
452 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 if (clnt->cl_server != clnt->cl_inline_name)
454 kfree(clnt->cl_server);
455out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400456 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500457 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500458 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500459 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400460 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400461 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463}
464
465/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400466 * Free an RPC client
467 */
468static void
469rpc_free_auth(struct kref *kref)
470{
471 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
472
473 if (clnt->cl_auth == NULL) {
474 rpc_free_client(kref);
475 return;
476 }
477
478 /*
479 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
480 * release remaining GSS contexts. This mechanism ensures
481 * that it can do so safely.
482 */
483 kref_init(kref);
484 rpcauth_release(clnt->cl_auth);
485 clnt->cl_auth = NULL;
486 kref_put(kref, rpc_free_client);
487}
488
489/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400490 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 */
492void
493rpc_release_client(struct rpc_clnt *clnt)
494{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400495 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Trond Myklebust34f52e32007-06-14 16:40:31 -0400497 if (list_empty(&clnt->cl_tasks))
498 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400499 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400500}
501
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000502/**
503 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800504 * @old: old rpc_client
505 * @program: rpc program to set
506 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000507 *
508 * Clones the rpc client and sets up a new RPC program. This is mainly
509 * of use for enabling different RPC programs to share the same transport.
510 * The Sun NFSv2/v3 ACL protocol can do this.
511 */
512struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
513 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400514 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000515{
516 struct rpc_clnt *clnt;
517 struct rpc_version *version;
518 int err;
519
520 BUG_ON(vers >= program->nrvers || !program->version[vers]);
521 version = program->version[vers];
522 clnt = rpc_clone_client(old);
523 if (IS_ERR(clnt))
524 goto out;
525 clnt->cl_procinfo = version->procs;
526 clnt->cl_maxproc = version->nrprocs;
527 clnt->cl_protname = program->name;
528 clnt->cl_prog = program->number;
529 clnt->cl_vers = version->number;
530 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500531 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000532 if (err != 0) {
533 rpc_shutdown_client(clnt);
534 clnt = ERR_PTR(err);
535 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800536out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000537 return clnt;
538}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400539EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541/*
542 * Default callback for async RPC calls
543 */
544static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100545rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
547}
548
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100549static const struct rpc_call_ops rpc_default_ops = {
550 .rpc_call_done = rpc_default_callback,
551};
552
Trond Myklebustc970aa82007-07-14 15:39:59 -0400553/**
554 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
555 * @task_setup_data: pointer to task initialisation data
556 */
557struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400558{
559 struct rpc_task *task, *ret;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400560
Trond Myklebust84115e12007-07-14 15:39:59 -0400561 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400562 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400563 rpc_release_calldata(task_setup_data->callback_ops,
564 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400565 ret = ERR_PTR(-ENOMEM);
566 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400567 }
568
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400569 if (task->tk_status != 0) {
570 ret = ERR_PTR(task->tk_status);
571 rpc_put_task(task);
572 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400573 }
574 atomic_inc(&task->tk_count);
575 rpc_execute(task);
576 ret = task;
577out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400578 return ret;
579}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400580EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400581
582/**
583 * rpc_call_sync - Perform a synchronous RPC call
584 * @clnt: pointer to RPC client
585 * @msg: RPC call parameters
586 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500588int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
590 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400591 struct rpc_task_setup task_setup_data = {
592 .rpc_client = clnt,
593 .rpc_message = msg,
594 .callback_ops = &rpc_default_ops,
595 .flags = flags,
596 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400597 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 BUG_ON(flags & RPC_TASK_ASYNC);
600
Trond Myklebustc970aa82007-07-14 15:39:59 -0400601 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400602 if (IS_ERR(task))
603 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100604 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800605 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return status;
607}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400608EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400610/**
611 * rpc_call_async - Perform an asynchronous RPC call
612 * @clnt: pointer to RPC client
613 * @msg: RPC call parameters
614 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800615 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400616 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 */
618int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500619rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100620 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
622 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400623 struct rpc_task_setup task_setup_data = {
624 .rpc_client = clnt,
625 .rpc_message = msg,
626 .callback_ops = tk_ops,
627 .callback_data = data,
628 .flags = flags|RPC_TASK_ASYNC,
629 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Trond Myklebustc970aa82007-07-14 15:39:59 -0400631 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400632 if (IS_ERR(task))
633 return PTR_ERR(task);
634 rpc_put_task(task);
635 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400637EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400639#if defined(CONFIG_NFS_V4_1)
640/**
641 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
642 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400643 * @req: RPC request
644 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400645 */
646struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400647 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400648{
649 struct rpc_task *task;
650 struct xdr_buf *xbufp = &req->rq_snd_buf;
651 struct rpc_task_setup task_setup_data = {
652 .callback_ops = tk_ops,
653 };
654
655 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
656 /*
657 * Create an rpc_task to send the data
658 */
659 task = rpc_new_task(&task_setup_data);
660 if (!task) {
661 xprt_free_bc_request(req);
662 goto out;
663 }
664 task->tk_rqstp = req;
665
666 /*
667 * Set up the xdr_buf length.
668 * This also indicates that the buffer is XDR encoded already.
669 */
670 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
671 xbufp->tail[0].iov_len;
672
673 task->tk_action = call_bc_transmit;
674 atomic_inc(&task->tk_count);
675 BUG_ON(atomic_read(&task->tk_count) != 2);
676 rpc_execute(task);
677
678out:
679 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
680 return task;
681}
682#endif /* CONFIG_NFS_V4_1 */
683
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400685rpc_call_start(struct rpc_task *task)
686{
687 task->tk_action = call_start;
688}
689EXPORT_SYMBOL_GPL(rpc_call_start);
690
Chuck Levered394402006-08-22 20:06:17 -0400691/**
692 * rpc_peeraddr - extract remote peer address from clnt's xprt
693 * @clnt: RPC client structure
694 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800695 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400696 *
697 * Returns the number of bytes that are actually in the stored address.
698 */
699size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
700{
701 size_t bytes;
702 struct rpc_xprt *xprt = clnt->cl_xprt;
703
704 bytes = sizeof(xprt->addr);
705 if (bytes > bufsize)
706 bytes = bufsize;
707 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400708 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400709}
Chuck Leverb86acd52006-08-22 20:06:22 -0400710EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400711
Chuck Leverf425eba2006-08-22 20:06:18 -0400712/**
713 * rpc_peeraddr2str - return remote peer address in printable format
714 * @clnt: RPC client structure
715 * @format: address format
716 *
717 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500718const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
719 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400720{
721 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500722
723 if (xprt->address_strings[format] != NULL)
724 return xprt->address_strings[format];
725 else
726 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400727}
Chuck Leverb86acd52006-08-22 20:06:22 -0400728EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730void
731rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
732{
733 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700734 if (xprt->ops->set_buffer_size)
735 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400737EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
739/*
740 * Return size of largest payload RPC client can support, in bytes
741 *
742 * For stream transports, this is one RPC record fragment (see RFC
743 * 1831), as we don't support multi-record requests yet. For datagram
744 * transports, this is the size of an IP packet minus the IP, UDP, and
745 * RPC header sizes.
746 */
747size_t rpc_max_payload(struct rpc_clnt *clnt)
748{
749 return clnt->cl_xprt->max_payload;
750}
Chuck Leverb86acd52006-08-22 20:06:22 -0400751EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Chuck Lever35f5a422006-01-03 09:55:50 +0100753/**
754 * rpc_force_rebind - force transport to check that remote port is unchanged
755 * @clnt: client to rebind
756 *
757 */
758void rpc_force_rebind(struct rpc_clnt *clnt)
759{
760 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400761 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100762}
Chuck Leverb86acd52006-08-22 20:06:22 -0400763EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400766 * Restart an (async) RPC call from the call_prepare state.
767 * Usually called from within the exit handler.
768 */
769void
770rpc_restart_call_prepare(struct rpc_task *task)
771{
772 if (RPC_ASSASSINATED(task))
773 return;
774 task->tk_action = rpc_prepare_task;
775}
776EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
777
778/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 * Restart an (async) RPC call. Usually called from within the
780 * exit handler.
781 */
782void
783rpc_restart_call(struct rpc_task *task)
784{
785 if (RPC_ASSASSINATED(task))
786 return;
787
788 task->tk_action = call_start;
789}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400790EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Chuck Lever3748f1e2008-05-21 17:09:12 -0400792#ifdef RPC_DEBUG
793static const char *rpc_proc_name(const struct rpc_task *task)
794{
795 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
796
797 if (proc) {
798 if (proc->p_name)
799 return proc->p_name;
800 else
801 return "NULL";
802 } else
803 return "no proc";
804}
805#endif
806
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807/*
808 * 0. Initial state
809 *
810 * Other FSM states can be visited zero or more times, but
811 * this state is visited exactly once for each RPC.
812 */
813static void
814call_start(struct rpc_task *task)
815{
816 struct rpc_clnt *clnt = task->tk_client;
817
Chuck Lever3748f1e2008-05-21 17:09:12 -0400818 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500819 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400820 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500821 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 /* Increment call count */
824 task->tk_msg.rpc_proc->p_count++;
825 clnt->cl_stats->rpccnt++;
826 task->tk_action = call_reserve;
827}
828
829/*
830 * 1. Reserve an RPC call slot
831 */
832static void
833call_reserve(struct rpc_task *task)
834{
Chuck Lever46121cf2007-01-31 12:14:08 -0500835 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
837 if (!rpcauth_uptodatecred(task)) {
838 task->tk_action = call_refresh;
839 return;
840 }
841
842 task->tk_status = 0;
843 task->tk_action = call_reserveresult;
844 xprt_reserve(task);
845}
846
847/*
848 * 1b. Grok the result of xprt_reserve()
849 */
850static void
851call_reserveresult(struct rpc_task *task)
852{
853 int status = task->tk_status;
854
Chuck Lever46121cf2007-01-31 12:14:08 -0500855 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
857 /*
858 * After a call to xprt_reserve(), we must have either
859 * a request slot or else an error status.
860 */
861 task->tk_status = 0;
862 if (status >= 0) {
863 if (task->tk_rqstp) {
864 task->tk_action = call_allocate;
865 return;
866 }
867
868 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800869 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 rpc_exit(task, -EIO);
871 return;
872 }
873
874 /*
875 * Even though there was an error, we may have acquired
876 * a request slot somehow. Make sure not to leak it.
877 */
878 if (task->tk_rqstp) {
879 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800880 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 xprt_release(task);
882 }
883
884 switch (status) {
885 case -EAGAIN: /* woken up; retry */
886 task->tk_action = call_reserve;
887 return;
888 case -EIO: /* probably a shutdown */
889 break;
890 default:
891 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800892 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 break;
894 }
895 rpc_exit(task, status);
896}
897
898/*
899 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100900 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 */
902static void
903call_allocate(struct rpc_task *task)
904{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400905 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100906 struct rpc_rqst *req = task->tk_rqstp;
907 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400908 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Chuck Lever46121cf2007-01-31 12:14:08 -0500910 dprint_status(task);
911
Chuck Lever2bea90d2007-03-29 16:47:53 -0400912 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400914
Chuck Lever02107142006-01-03 09:55:49 +0100915 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 return;
917
Chuck Lever2bea90d2007-03-29 16:47:53 -0400918 if (proc->p_proc != 0) {
919 BUG_ON(proc->p_arglen == 0);
920 if (proc->p_decode != NULL)
921 BUG_ON(proc->p_replen == 0);
922 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Chuck Lever2bea90d2007-03-29 16:47:53 -0400924 /*
925 * Calculate the size (in quads) of the RPC call
926 * and reply headers, and convert both values
927 * to byte sizes.
928 */
929 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
930 req->rq_callsize <<= 2;
931 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
932 req->rq_rcvsize <<= 2;
933
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400934 req->rq_buffer = xprt->ops->buf_alloc(task,
935 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400936 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500938
939 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Trond Myklebust14b218a2005-06-22 17:16:28 +0000941 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400942 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 rpc_delay(task, HZ>>4);
944 return;
945 }
946
947 rpc_exit(task, -ERESTARTSYS);
948}
949
Trond Myklebust940e3312005-11-09 21:45:24 -0500950static inline int
951rpc_task_need_encode(struct rpc_task *task)
952{
953 return task->tk_rqstp->rq_snd_buf.len == 0;
954}
955
956static inline void
957rpc_task_force_reencode(struct rpc_task *task)
958{
959 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -0400960 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -0500961}
962
Chuck Lever2bea90d2007-03-29 16:47:53 -0400963static inline void
964rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
965{
966 buf->head[0].iov_base = start;
967 buf->head[0].iov_len = len;
968 buf->tail[0].iov_len = 0;
969 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400970 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400971 buf->len = 0;
972 buf->buflen = len;
973}
974
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975/*
976 * 3. Encode arguments of an RPC call
977 */
978static void
Chuck Leverb0e1c572008-05-21 17:09:19 -0400979rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700983 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Chuck Lever46121cf2007-01-31 12:14:08 -0500985 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Chuck Lever2bea90d2007-03-29 16:47:53 -0400987 rpc_xdr_buf_init(&req->rq_snd_buf,
988 req->rq_buffer,
989 req->rq_callsize);
990 rpc_xdr_buf_init(&req->rq_rcv_buf,
991 (char *)req->rq_buffer + req->rq_callsize,
992 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Chuck Leverb0e1c572008-05-21 17:09:19 -0400994 p = rpc_encode_header(task);
995 if (p == NULL) {
996 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 rpc_exit(task, -EIO);
998 return;
999 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001000
1001 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001002 if (encode == NULL)
1003 return;
1004
1005 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1006 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
1008
1009/*
1010 * 4. Get the server port number if not yet set
1011 */
1012static void
1013call_bind(struct rpc_task *task)
1014{
Chuck Leverec739ef2006-08-22 20:06:15 -04001015 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
Chuck Lever46121cf2007-01-31 12:14:08 -05001017 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
Chuck Leverda351872005-08-11 16:25:11 -04001019 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001020 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001021 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001022 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001023 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 }
1025}
1026
1027/*
Chuck Leverda351872005-08-11 16:25:11 -04001028 * 4a. Sort out bind result
1029 */
1030static void
1031call_bind_status(struct rpc_task *task)
1032{
Chuck Lever906462a2007-09-11 18:00:47 -04001033 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001034
1035 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001036 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001037 task->tk_status = 0;
1038 task->tk_action = call_connect;
1039 return;
1040 }
1041
1042 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001043 case -ENOMEM:
1044 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1045 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001046 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001047 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001048 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1049 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001050 /* fail immediately if this is an RPC ping */
1051 if (task->tk_msg.rpc_proc->p_proc == 0) {
1052 status = -EOPNOTSUPP;
1053 break;
1054 }
Chuck Leverea635a52005-10-06 23:12:58 -04001055 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001056 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001057 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001058 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001059 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001060 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001061 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001062 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001063 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001064 task->tk_pid);
1065 break;
1066 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001067 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001068 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001069 task->tk_status = 0;
1070 task->tk_action = call_bind;
1071 return;
Chuck Lever012da152009-12-03 15:58:56 -05001072 case -ECONNREFUSED: /* connection problems */
1073 case -ECONNRESET:
1074 case -ENOTCONN:
1075 case -EHOSTDOWN:
1076 case -EHOSTUNREACH:
1077 case -ENETUNREACH:
1078 case -EPIPE:
1079 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1080 task->tk_pid, task->tk_status);
1081 if (!RPC_IS_SOFTCONN(task)) {
1082 rpc_delay(task, 5*HZ);
1083 goto retry_timeout;
1084 }
1085 status = task->tk_status;
1086 break;
Chuck Leverda351872005-08-11 16:25:11 -04001087 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001088 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001089 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001090 }
1091
1092 rpc_exit(task, status);
1093 return;
1094
Trond Myklebustda458282006-08-31 15:44:52 -04001095retry_timeout:
1096 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001097}
1098
1099/*
1100 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 */
1102static void
1103call_connect(struct rpc_task *task)
1104{
Chuck Leverda351872005-08-11 16:25:11 -04001105 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
Chuck Lever46121cf2007-01-31 12:14:08 -05001107 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001108 task->tk_pid, xprt,
1109 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110
Chuck Leverda351872005-08-11 16:25:11 -04001111 task->tk_action = call_transmit;
1112 if (!xprt_connected(xprt)) {
1113 task->tk_action = call_connect_status;
1114 if (task->tk_status < 0)
1115 return;
1116 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118}
1119
1120/*
Chuck Leverda351872005-08-11 16:25:11 -04001121 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 */
1123static void
1124call_connect_status(struct rpc_task *task)
1125{
1126 struct rpc_clnt *clnt = task->tk_client;
1127 int status = task->tk_status;
1128
Chuck Lever46121cf2007-01-31 12:14:08 -05001129 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001130
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001132 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 clnt->cl_stats->netreconn++;
1134 task->tk_action = call_transmit;
1135 return;
1136 }
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001139 /* if soft mounted, test if we've timed out */
1140 case -ETIMEDOUT:
1141 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001142 break;
1143 default:
1144 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 }
1146}
1147
1148/*
1149 * 5. Transmit the RPC request, and wait for reply
1150 */
1151static void
1152call_transmit(struct rpc_task *task)
1153{
Chuck Lever46121cf2007-01-31 12:14:08 -05001154 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
1156 task->tk_action = call_status;
1157 if (task->tk_status < 0)
1158 return;
1159 task->tk_status = xprt_prepare_transmit(task);
1160 if (task->tk_status != 0)
1161 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001162 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001164 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001165 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001166 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001167 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001168 if (task->tk_status != 0) {
1169 /* Was the error nonfatal? */
1170 if (task->tk_status == -EAGAIN)
1171 rpc_delay(task, HZ >> 4);
1172 else
1173 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001174 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001175 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001176 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 xprt_transmit(task);
1178 if (task->tk_status < 0)
1179 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001180 /*
1181 * On success, ensure that we call xprt_end_transmit() before sleeping
1182 * in order to allow access to the socket to other RPC requests.
1183 */
1184 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001185 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001186 return;
1187 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001188 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001189}
1190
1191/*
1192 * 5a. Handle cleanup after a transmission
1193 */
1194static void
1195call_transmit_status(struct rpc_task *task)
1196{
1197 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001198
1199 /*
1200 * Common case: success. Force the compiler to put this
1201 * test first.
1202 */
1203 if (task->tk_status == 0) {
1204 xprt_end_transmit(task);
1205 rpc_task_force_reencode(task);
1206 return;
1207 }
1208
Trond Myklebust15f081c2009-03-11 14:37:57 -04001209 switch (task->tk_status) {
1210 case -EAGAIN:
1211 break;
1212 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001213 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001214 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001215 rpc_task_force_reencode(task);
1216 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001217 /*
1218 * Special cases: if we've been waiting on the
1219 * socket's write_space() callback, or if the
1220 * socket just returned a connection error,
1221 * then hold onto the transport lock.
1222 */
1223 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001224 case -EHOSTDOWN:
1225 case -EHOSTUNREACH:
1226 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001227 if (RPC_IS_SOFTCONN(task)) {
1228 xprt_end_transmit(task);
1229 rpc_exit(task, task->tk_status);
1230 break;
1231 }
1232 case -ECONNRESET:
1233 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001234 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001235 rpc_task_force_reencode(task);
1236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237}
1238
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001239#if defined(CONFIG_NFS_V4_1)
1240/*
1241 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1242 * addition, disconnect on connectivity errors.
1243 */
1244static void
1245call_bc_transmit(struct rpc_task *task)
1246{
1247 struct rpc_rqst *req = task->tk_rqstp;
1248
1249 BUG_ON(task->tk_status != 0);
1250 task->tk_status = xprt_prepare_transmit(task);
1251 if (task->tk_status == -EAGAIN) {
1252 /*
1253 * Could not reserve the transport. Try again after the
1254 * transport is released.
1255 */
1256 task->tk_status = 0;
1257 task->tk_action = call_bc_transmit;
1258 return;
1259 }
1260
1261 task->tk_action = rpc_exit_task;
1262 if (task->tk_status < 0) {
1263 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1264 "error: %d\n", task->tk_status);
1265 return;
1266 }
1267
1268 xprt_transmit(task);
1269 xprt_end_transmit(task);
1270 dprint_status(task);
1271 switch (task->tk_status) {
1272 case 0:
1273 /* Success */
1274 break;
1275 case -EHOSTDOWN:
1276 case -EHOSTUNREACH:
1277 case -ENETUNREACH:
1278 case -ETIMEDOUT:
1279 /*
1280 * Problem reaching the server. Disconnect and let the
1281 * forechannel reestablish the connection. The server will
1282 * have to retransmit the backchannel request and we'll
1283 * reprocess it. Since these ops are idempotent, there's no
1284 * need to cache our reply at this time.
1285 */
1286 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1287 "error: %d\n", task->tk_status);
1288 xprt_conditional_disconnect(task->tk_xprt,
1289 req->rq_connect_cookie);
1290 break;
1291 default:
1292 /*
1293 * We were unable to reply and will have to drop the
1294 * request. The server should reconnect and retransmit.
1295 */
1296 BUG_ON(task->tk_status == -EAGAIN);
1297 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1298 "error: %d\n", task->tk_status);
1299 break;
1300 }
1301 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1302}
1303#endif /* CONFIG_NFS_V4_1 */
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/*
1306 * 6. Sort out the RPC call status
1307 */
1308static void
1309call_status(struct rpc_task *task)
1310{
1311 struct rpc_clnt *clnt = task->tk_client;
1312 struct rpc_rqst *req = task->tk_rqstp;
1313 int status;
1314
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001315 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1316 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
Chuck Lever46121cf2007-01-31 12:14:08 -05001318 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
1320 status = task->tk_status;
1321 if (status >= 0) {
1322 task->tk_action = call_decode;
1323 return;
1324 }
1325
1326 task->tk_status = 0;
1327 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001328 case -EHOSTDOWN:
1329 case -EHOSTUNREACH:
1330 case -ENETUNREACH:
1331 /*
1332 * Delay any retries for 3 seconds, then handle as if it
1333 * were a timeout.
1334 */
1335 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 case -ETIMEDOUT:
1337 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001338 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001339 xprt_conditional_disconnect(task->tk_xprt,
1340 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001342 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001344 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001345 rpc_delay(task, 3*HZ);
1346 case -EPIPE:
1347 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 task->tk_action = call_bind;
1349 break;
1350 case -EAGAIN:
1351 task->tk_action = call_transmit;
1352 break;
1353 case -EIO:
1354 /* shutdown or soft timeout */
1355 rpc_exit(task, status);
1356 break;
1357 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001358 if (clnt->cl_chatty)
1359 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 clnt->cl_protname, -status);
1361 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 }
1363}
1364
1365/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001366 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 * We do not release the request slot, so we keep using the
1368 * same XID for all retransmits.
1369 */
1370static void
1371call_timeout(struct rpc_task *task)
1372{
1373 struct rpc_clnt *clnt = task->tk_client;
1374
1375 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001376 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 goto retry;
1378 }
1379
Chuck Lever46121cf2007-01-31 12:14:08 -05001380 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001381 task->tk_timeouts++;
1382
Chuck Lever3a28bec2009-12-03 15:58:56 -05001383 if (RPC_IS_SOFTCONN(task)) {
1384 rpc_exit(task, -ETIMEDOUT);
1385 return;
1386 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001388 if (clnt->cl_chatty)
1389 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 clnt->cl_protname, clnt->cl_server);
1391 rpc_exit(task, -EIO);
1392 return;
1393 }
1394
Chuck Leverf518e35a2006-01-03 09:55:52 +01001395 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001397 if (clnt->cl_chatty)
1398 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 clnt->cl_protname, clnt->cl_server);
1400 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001401 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001402 /*
1403 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1404 * event? RFC2203 requires the server to drop all such requests.
1405 */
1406 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
1408retry:
1409 clnt->cl_stats->rpcretrans++;
1410 task->tk_action = call_bind;
1411 task->tk_status = 0;
1412}
1413
1414/*
1415 * 7. Decode the RPC reply
1416 */
1417static void
1418call_decode(struct rpc_task *task)
1419{
1420 struct rpc_clnt *clnt = task->tk_client;
1421 struct rpc_rqst *req = task->tk_rqstp;
1422 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001423 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
Chuck Lever46121cf2007-01-31 12:14:08 -05001425 dprintk("RPC: %5u call_decode (status %d)\n",
1426 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Chuck Leverf518e35a2006-01-03 09:55:52 +01001428 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001429 if (clnt->cl_chatty)
1430 printk(KERN_NOTICE "%s: server %s OK\n",
1431 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1433 }
1434
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001435 /*
1436 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001437 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001438 */
1439 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 req->rq_rcv_buf.len = req->rq_private_buf.len;
1441
1442 /* Check that the softirq receive buffer is valid */
1443 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1444 sizeof(req->rq_rcv_buf)) != 0);
1445
Trond Myklebust1e799b62008-03-21 16:19:41 -04001446 if (req->rq_rcv_buf.len < 12) {
1447 if (!RPC_IS_SOFT(task)) {
1448 task->tk_action = call_bind;
1449 clnt->cl_stats->rpcretrans++;
1450 goto out_retry;
1451 }
1452 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1453 clnt->cl_protname, task->tk_status);
1454 task->tk_action = call_timeout;
1455 goto out_retry;
1456 }
1457
Chuck Leverb0e1c572008-05-21 17:09:19 -04001458 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001459 if (IS_ERR(p)) {
1460 if (p == ERR_PTR(-EAGAIN))
1461 goto out_retry;
1462 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 }
1464
Trond Myklebustabbcf282006-01-03 09:55:03 +01001465 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001467 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1469 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001470 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001471 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1472 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 return;
1474out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001476 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001477 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001478 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001479 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001480 xprt_conditional_disconnect(task->tk_xprt,
1481 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001482 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483}
1484
1485/*
1486 * 8. Refresh the credentials if rejected by the server
1487 */
1488static void
1489call_refresh(struct rpc_task *task)
1490{
Chuck Lever46121cf2007-01-31 12:14:08 -05001491 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 task->tk_action = call_refreshresult;
1494 task->tk_status = 0;
1495 task->tk_client->cl_stats->rpcauthrefresh++;
1496 rpcauth_refreshcred(task);
1497}
1498
1499/*
1500 * 8a. Process the results of a credential refresh
1501 */
1502static void
1503call_refreshresult(struct rpc_task *task)
1504{
1505 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001506
1507 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
1509 task->tk_status = 0;
1510 task->tk_action = call_reserve;
1511 if (status >= 0 && rpcauth_uptodatecred(task))
1512 return;
1513 if (status == -EACCES) {
1514 rpc_exit(task, -EACCES);
1515 return;
1516 }
1517 task->tk_action = call_refresh;
1518 if (status != -ETIMEDOUT)
1519 rpc_delay(task, 3*HZ);
1520 return;
1521}
1522
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001523static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001524rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525{
1526 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001528 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
1530 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001531
1532 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 *p++ = req->rq_xid; /* XID */
1534 *p++ = htonl(RPC_CALL); /* CALL */
1535 *p++ = htonl(RPC_VERSION); /* RPC version */
1536 *p++ = htonl(clnt->cl_prog); /* program number */
1537 *p++ = htonl(clnt->cl_vers); /* program version */
1538 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001539 p = rpcauth_marshcred(task, p);
1540 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1541 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542}
1543
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001544static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001545rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546{
1547 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1548 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001549 __be32 *p = iov->iov_base;
1550 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 int error = -EACCES;
1552
David Howellse8896492006-08-24 15:44:19 -04001553 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1554 /* RFC-1014 says that the representation of XDR data must be a
1555 * multiple of four bytes
1556 * - if it isn't pointer subtraction in the NFS client may give
1557 * undefined results
1558 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001559 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001560 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001561 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001562 goto out_eio;
1563 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 if ((len -= 3) < 0)
1565 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001567 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001569 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001570 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001571 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1575 if (--len < 0)
1576 goto out_overflow;
1577 switch ((n = ntohl(*p++))) {
1578 case RPC_AUTH_ERROR:
1579 break;
1580 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001581 dprintk("RPC: %5u %s: RPC call version "
1582 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001583 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001584 error = -EPROTONOSUPPORT;
1585 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001587 dprintk("RPC: %5u %s: RPC call rejected, "
1588 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001589 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 goto out_eio;
1591 }
1592 if (--len < 0)
1593 goto out_overflow;
1594 switch ((n = ntohl(*p++))) {
1595 case RPC_AUTH_REJECTEDCRED:
1596 case RPC_AUTH_REJECTEDVERF:
1597 case RPCSEC_GSS_CREDPROBLEM:
1598 case RPCSEC_GSS_CTXPROBLEM:
1599 if (!task->tk_cred_retry)
1600 break;
1601 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001602 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001603 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001605 /* Ensure we obtain a new XID! */
1606 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001608 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 case RPC_AUTH_BADCRED:
1610 case RPC_AUTH_BADVERF:
1611 /* possibly garbled cred/verf? */
1612 if (!task->tk_garb_retry)
1613 break;
1614 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001615 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001616 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001618 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001620 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001621 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 break;
1623 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001624 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001625 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 error = -EIO;
1627 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001628 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001629 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 goto out_err;
1631 }
1632 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001633 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001634 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001635 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001637 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 if (len < 0)
1639 goto out_overflow;
1640 switch ((n = ntohl(*p++))) {
1641 case RPC_SUCCESS:
1642 return p;
1643 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001644 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001645 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 (unsigned int)task->tk_client->cl_prog,
1647 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001648 error = -EPFNOSUPPORT;
1649 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001651 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001652 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 (unsigned int)task->tk_client->cl_prog,
1654 (unsigned int)task->tk_client->cl_vers,
1655 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001656 error = -EPROTONOSUPPORT;
1657 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001659 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001660 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001661 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001662 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 task->tk_client->cl_prog,
1664 task->tk_client->cl_vers,
1665 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001666 error = -EOPNOTSUPP;
1667 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001669 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001670 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 break; /* retry */
1672 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001673 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001674 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 /* Also retry */
1676 }
1677
Trond Myklebustabbcf282006-01-03 09:55:03 +01001678out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 task->tk_client->cl_stats->rpcgarbage++;
1680 if (task->tk_garb_retry) {
1681 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001682 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001683 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001685out_retry:
1686 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688out_eio:
1689 error = -EIO;
1690out_err:
1691 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001692 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001693 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001694 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001696 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001697 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001698 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001700
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001701static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001702{
1703 return 0;
1704}
1705
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001706static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001707{
1708 return 0;
1709}
1710
1711static struct rpc_procinfo rpcproc_null = {
1712 .p_encode = rpcproc_encode_null,
1713 .p_decode = rpcproc_decode_null,
1714};
1715
Chuck Levercaabea82009-12-03 15:58:56 -05001716static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001717{
1718 struct rpc_message msg = {
1719 .rpc_proc = &rpcproc_null,
1720 };
1721 int err;
1722 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001723 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001724 put_rpccred(msg.rpc_cred);
1725 return err;
1726}
Trond Myklebust188fef12007-06-16 14:18:40 -04001727
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001728struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1729{
1730 struct rpc_message msg = {
1731 .rpc_proc = &rpcproc_null,
1732 .rpc_cred = cred,
1733 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001734 struct rpc_task_setup task_setup_data = {
1735 .rpc_client = clnt,
1736 .rpc_message = &msg,
1737 .callback_ops = &rpc_default_ops,
1738 .flags = flags,
1739 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001740 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001741}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001742EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001743
Trond Myklebust188fef12007-06-16 14:18:40 -04001744#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001745static void rpc_show_header(void)
1746{
Chuck Levercb3997b2008-05-21 17:09:41 -04001747 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1748 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001749}
1750
Chuck Lever38e886e2008-05-21 17:09:33 -04001751static void rpc_show_task(const struct rpc_clnt *clnt,
1752 const struct rpc_task *task)
1753{
1754 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001755 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001756
1757 if (RPC_IS_QUEUED(task))
1758 rpc_waitq = rpc_qname(task->tk_waitqueue);
1759
Chuck Levercb3997b2008-05-21 17:09:41 -04001760 /* map tk_action pointer to a function name; then trim off
1761 * the "+0x0 [sunrpc]" */
1762 sprint_symbol(action, (unsigned long)task->tk_action);
1763 p = strchr(action, '+');
1764 if (p)
1765 *p = '\0';
1766
1767 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1768 task->tk_pid, task->tk_flags, task->tk_status,
1769 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1770 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1771 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001772}
1773
Trond Myklebust188fef12007-06-16 14:18:40 -04001774void rpc_show_tasks(void)
1775{
1776 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001777 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001778 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001779
1780 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001781 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001782 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001783 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001784 if (!header) {
1785 rpc_show_header();
1786 header++;
1787 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001788 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001789 }
1790 spin_unlock(&clnt->cl_lock);
1791 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001792 spin_unlock(&rpc_client_lock);
1793}
1794#endif