blob: 8c7b5433022a24a33afdb8c5add46725a15b2850 [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{
Trond Myklebust19445b92010-04-16 16:41:10 -0400559 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400560
Trond Myklebust84115e12007-07-14 15:39:59 -0400561 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400562 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400563 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400564
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400565 atomic_inc(&task->tk_count);
566 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400567out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400568 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400569}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400570EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400571
572/**
573 * rpc_call_sync - Perform a synchronous RPC call
574 * @clnt: pointer to RPC client
575 * @msg: RPC call parameters
576 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500578int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
580 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400581 struct rpc_task_setup task_setup_data = {
582 .rpc_client = clnt,
583 .rpc_message = msg,
584 .callback_ops = &rpc_default_ops,
585 .flags = flags,
586 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400587 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 BUG_ON(flags & RPC_TASK_ASYNC);
590
Trond Myklebustc970aa82007-07-14 15:39:59 -0400591 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400592 if (IS_ERR(task))
593 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100594 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800595 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 return status;
597}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400598EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400600/**
601 * rpc_call_async - Perform an asynchronous RPC call
602 * @clnt: pointer to RPC client
603 * @msg: RPC call parameters
604 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800605 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400606 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 */
608int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500609rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100610 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400613 struct rpc_task_setup task_setup_data = {
614 .rpc_client = clnt,
615 .rpc_message = msg,
616 .callback_ops = tk_ops,
617 .callback_data = data,
618 .flags = flags|RPC_TASK_ASYNC,
619 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Trond Myklebustc970aa82007-07-14 15:39:59 -0400621 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400622 if (IS_ERR(task))
623 return PTR_ERR(task);
624 rpc_put_task(task);
625 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400627EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400629#if defined(CONFIG_NFS_V4_1)
630/**
631 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
632 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400633 * @req: RPC request
634 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400635 */
636struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400637 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400638{
639 struct rpc_task *task;
640 struct xdr_buf *xbufp = &req->rq_snd_buf;
641 struct rpc_task_setup task_setup_data = {
642 .callback_ops = tk_ops,
643 };
644
645 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
646 /*
647 * Create an rpc_task to send the data
648 */
649 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400650 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400651 xprt_free_bc_request(req);
652 goto out;
653 }
654 task->tk_rqstp = req;
655
656 /*
657 * Set up the xdr_buf length.
658 * This also indicates that the buffer is XDR encoded already.
659 */
660 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
661 xbufp->tail[0].iov_len;
662
663 task->tk_action = call_bc_transmit;
664 atomic_inc(&task->tk_count);
665 BUG_ON(atomic_read(&task->tk_count) != 2);
666 rpc_execute(task);
667
668out:
669 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
670 return task;
671}
672#endif /* CONFIG_NFS_V4_1 */
673
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400675rpc_call_start(struct rpc_task *task)
676{
677 task->tk_action = call_start;
678}
679EXPORT_SYMBOL_GPL(rpc_call_start);
680
Chuck Levered394402006-08-22 20:06:17 -0400681/**
682 * rpc_peeraddr - extract remote peer address from clnt's xprt
683 * @clnt: RPC client structure
684 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800685 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400686 *
687 * Returns the number of bytes that are actually in the stored address.
688 */
689size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
690{
691 size_t bytes;
692 struct rpc_xprt *xprt = clnt->cl_xprt;
693
694 bytes = sizeof(xprt->addr);
695 if (bytes > bufsize)
696 bytes = bufsize;
697 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400698 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400699}
Chuck Leverb86acd52006-08-22 20:06:22 -0400700EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400701
Chuck Leverf425eba2006-08-22 20:06:18 -0400702/**
703 * rpc_peeraddr2str - return remote peer address in printable format
704 * @clnt: RPC client structure
705 * @format: address format
706 *
707 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500708const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
709 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400710{
711 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500712
713 if (xprt->address_strings[format] != NULL)
714 return xprt->address_strings[format];
715 else
716 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400717}
Chuck Leverb86acd52006-08-22 20:06:22 -0400718EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720void
721rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
722{
723 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700724 if (xprt->ops->set_buffer_size)
725 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400727EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729/*
730 * Return size of largest payload RPC client can support, in bytes
731 *
732 * For stream transports, this is one RPC record fragment (see RFC
733 * 1831), as we don't support multi-record requests yet. For datagram
734 * transports, this is the size of an IP packet minus the IP, UDP, and
735 * RPC header sizes.
736 */
737size_t rpc_max_payload(struct rpc_clnt *clnt)
738{
739 return clnt->cl_xprt->max_payload;
740}
Chuck Leverb86acd52006-08-22 20:06:22 -0400741EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742
Chuck Lever35f5a422006-01-03 09:55:50 +0100743/**
744 * rpc_force_rebind - force transport to check that remote port is unchanged
745 * @clnt: client to rebind
746 *
747 */
748void rpc_force_rebind(struct rpc_clnt *clnt)
749{
750 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400751 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100752}
Chuck Leverb86acd52006-08-22 20:06:22 -0400753EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400756 * Restart an (async) RPC call from the call_prepare state.
757 * Usually called from within the exit handler.
758 */
759void
760rpc_restart_call_prepare(struct rpc_task *task)
761{
762 if (RPC_ASSASSINATED(task))
763 return;
764 task->tk_action = rpc_prepare_task;
765}
766EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
767
768/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 * Restart an (async) RPC call. Usually called from within the
770 * exit handler.
771 */
772void
773rpc_restart_call(struct rpc_task *task)
774{
775 if (RPC_ASSASSINATED(task))
776 return;
777
778 task->tk_action = call_start;
779}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400780EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Chuck Lever3748f1e2008-05-21 17:09:12 -0400782#ifdef RPC_DEBUG
783static const char *rpc_proc_name(const struct rpc_task *task)
784{
785 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
786
787 if (proc) {
788 if (proc->p_name)
789 return proc->p_name;
790 else
791 return "NULL";
792 } else
793 return "no proc";
794}
795#endif
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797/*
798 * 0. Initial state
799 *
800 * Other FSM states can be visited zero or more times, but
801 * this state is visited exactly once for each RPC.
802 */
803static void
804call_start(struct rpc_task *task)
805{
806 struct rpc_clnt *clnt = task->tk_client;
807
Chuck Lever3748f1e2008-05-21 17:09:12 -0400808 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500809 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400810 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500811 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
813 /* Increment call count */
814 task->tk_msg.rpc_proc->p_count++;
815 clnt->cl_stats->rpccnt++;
816 task->tk_action = call_reserve;
817}
818
819/*
820 * 1. Reserve an RPC call slot
821 */
822static void
823call_reserve(struct rpc_task *task)
824{
Chuck Lever46121cf2007-01-31 12:14:08 -0500825 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 if (!rpcauth_uptodatecred(task)) {
828 task->tk_action = call_refresh;
829 return;
830 }
831
832 task->tk_status = 0;
833 task->tk_action = call_reserveresult;
834 xprt_reserve(task);
835}
836
837/*
838 * 1b. Grok the result of xprt_reserve()
839 */
840static void
841call_reserveresult(struct rpc_task *task)
842{
843 int status = task->tk_status;
844
Chuck Lever46121cf2007-01-31 12:14:08 -0500845 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
847 /*
848 * After a call to xprt_reserve(), we must have either
849 * a request slot or else an error status.
850 */
851 task->tk_status = 0;
852 if (status >= 0) {
853 if (task->tk_rqstp) {
854 task->tk_action = call_allocate;
855 return;
856 }
857
858 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800859 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 rpc_exit(task, -EIO);
861 return;
862 }
863
864 /*
865 * Even though there was an error, we may have acquired
866 * a request slot somehow. Make sure not to leak it.
867 */
868 if (task->tk_rqstp) {
869 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800870 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 xprt_release(task);
872 }
873
874 switch (status) {
875 case -EAGAIN: /* woken up; retry */
876 task->tk_action = call_reserve;
877 return;
878 case -EIO: /* probably a shutdown */
879 break;
880 default:
881 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800882 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 break;
884 }
885 rpc_exit(task, status);
886}
887
888/*
889 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100890 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 */
892static void
893call_allocate(struct rpc_task *task)
894{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400895 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100896 struct rpc_rqst *req = task->tk_rqstp;
897 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400898 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Chuck Lever46121cf2007-01-31 12:14:08 -0500900 dprint_status(task);
901
Chuck Lever2bea90d2007-03-29 16:47:53 -0400902 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400904
Chuck Lever02107142006-01-03 09:55:49 +0100905 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 return;
907
Chuck Lever2bea90d2007-03-29 16:47:53 -0400908 if (proc->p_proc != 0) {
909 BUG_ON(proc->p_arglen == 0);
910 if (proc->p_decode != NULL)
911 BUG_ON(proc->p_replen == 0);
912 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
Chuck Lever2bea90d2007-03-29 16:47:53 -0400914 /*
915 * Calculate the size (in quads) of the RPC call
916 * and reply headers, and convert both values
917 * to byte sizes.
918 */
919 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
920 req->rq_callsize <<= 2;
921 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
922 req->rq_rcvsize <<= 2;
923
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400924 req->rq_buffer = xprt->ops->buf_alloc(task,
925 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400926 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500928
929 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
Trond Myklebust14b218a2005-06-22 17:16:28 +0000931 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400932 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 rpc_delay(task, HZ>>4);
934 return;
935 }
936
937 rpc_exit(task, -ERESTARTSYS);
938}
939
Trond Myklebust940e3312005-11-09 21:45:24 -0500940static inline int
941rpc_task_need_encode(struct rpc_task *task)
942{
943 return task->tk_rqstp->rq_snd_buf.len == 0;
944}
945
946static inline void
947rpc_task_force_reencode(struct rpc_task *task)
948{
949 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -0400950 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -0500951}
952
Chuck Lever2bea90d2007-03-29 16:47:53 -0400953static inline void
954rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
955{
956 buf->head[0].iov_base = start;
957 buf->head[0].iov_len = len;
958 buf->tail[0].iov_len = 0;
959 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400960 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400961 buf->len = 0;
962 buf->buflen = len;
963}
964
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965/*
966 * 3. Encode arguments of an RPC call
967 */
968static void
Chuck Leverb0e1c572008-05-21 17:09:19 -0400969rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700973 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Chuck Lever46121cf2007-01-31 12:14:08 -0500975 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Chuck Lever2bea90d2007-03-29 16:47:53 -0400977 rpc_xdr_buf_init(&req->rq_snd_buf,
978 req->rq_buffer,
979 req->rq_callsize);
980 rpc_xdr_buf_init(&req->rq_rcv_buf,
981 (char *)req->rq_buffer + req->rq_callsize,
982 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Chuck Leverb0e1c572008-05-21 17:09:19 -0400984 p = rpc_encode_header(task);
985 if (p == NULL) {
986 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 rpc_exit(task, -EIO);
988 return;
989 }
Chuck Leverb0e1c572008-05-21 17:09:19 -0400990
991 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400992 if (encode == NULL)
993 return;
994
995 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
996 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997}
998
999/*
1000 * 4. Get the server port number if not yet set
1001 */
1002static void
1003call_bind(struct rpc_task *task)
1004{
Chuck Leverec739ef2006-08-22 20:06:15 -04001005 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Chuck Lever46121cf2007-01-31 12:14:08 -05001007 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Chuck Leverda351872005-08-11 16:25:11 -04001009 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001010 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001011 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001012 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001013 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 }
1015}
1016
1017/*
Chuck Leverda351872005-08-11 16:25:11 -04001018 * 4a. Sort out bind result
1019 */
1020static void
1021call_bind_status(struct rpc_task *task)
1022{
Chuck Lever906462a2007-09-11 18:00:47 -04001023 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001024
1025 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001026 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001027 task->tk_status = 0;
1028 task->tk_action = call_connect;
1029 return;
1030 }
1031
1032 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001033 case -ENOMEM:
1034 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1035 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001036 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001037 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001038 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1039 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001040 /* fail immediately if this is an RPC ping */
1041 if (task->tk_msg.rpc_proc->p_proc == 0) {
1042 status = -EOPNOTSUPP;
1043 break;
1044 }
Chuck Leverea635a52005-10-06 23:12:58 -04001045 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001046 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001047 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001048 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001049 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001050 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001051 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001052 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001053 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001054 task->tk_pid);
1055 break;
1056 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001057 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001058 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001059 task->tk_status = 0;
1060 task->tk_action = call_bind;
1061 return;
Chuck Lever012da152009-12-03 15:58:56 -05001062 case -ECONNREFUSED: /* connection problems */
1063 case -ECONNRESET:
1064 case -ENOTCONN:
1065 case -EHOSTDOWN:
1066 case -EHOSTUNREACH:
1067 case -ENETUNREACH:
1068 case -EPIPE:
1069 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1070 task->tk_pid, task->tk_status);
1071 if (!RPC_IS_SOFTCONN(task)) {
1072 rpc_delay(task, 5*HZ);
1073 goto retry_timeout;
1074 }
1075 status = task->tk_status;
1076 break;
Chuck Leverda351872005-08-11 16:25:11 -04001077 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001078 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001079 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001080 }
1081
1082 rpc_exit(task, status);
1083 return;
1084
Trond Myklebustda458282006-08-31 15:44:52 -04001085retry_timeout:
1086 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001087}
1088
1089/*
1090 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 */
1092static void
1093call_connect(struct rpc_task *task)
1094{
Chuck Leverda351872005-08-11 16:25:11 -04001095 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Chuck Lever46121cf2007-01-31 12:14:08 -05001097 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001098 task->tk_pid, xprt,
1099 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
Chuck Leverda351872005-08-11 16:25:11 -04001101 task->tk_action = call_transmit;
1102 if (!xprt_connected(xprt)) {
1103 task->tk_action = call_connect_status;
1104 if (task->tk_status < 0)
1105 return;
1106 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108}
1109
1110/*
Chuck Leverda351872005-08-11 16:25:11 -04001111 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 */
1113static void
1114call_connect_status(struct rpc_task *task)
1115{
1116 struct rpc_clnt *clnt = task->tk_client;
1117 int status = task->tk_status;
1118
Chuck Lever46121cf2007-01-31 12:14:08 -05001119 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001120
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001122 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 clnt->cl_stats->netreconn++;
1124 task->tk_action = call_transmit;
1125 return;
1126 }
1127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001129 /* if soft mounted, test if we've timed out */
1130 case -ETIMEDOUT:
1131 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001132 break;
1133 default:
1134 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 }
1136}
1137
1138/*
1139 * 5. Transmit the RPC request, and wait for reply
1140 */
1141static void
1142call_transmit(struct rpc_task *task)
1143{
Chuck Lever46121cf2007-01-31 12:14:08 -05001144 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
1146 task->tk_action = call_status;
1147 if (task->tk_status < 0)
1148 return;
1149 task->tk_status = xprt_prepare_transmit(task);
1150 if (task->tk_status != 0)
1151 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001152 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001154 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001155 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001156 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001157 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001158 if (task->tk_status != 0) {
1159 /* Was the error nonfatal? */
1160 if (task->tk_status == -EAGAIN)
1161 rpc_delay(task, HZ >> 4);
1162 else
1163 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001164 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001165 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001166 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 xprt_transmit(task);
1168 if (task->tk_status < 0)
1169 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001170 /*
1171 * On success, ensure that we call xprt_end_transmit() before sleeping
1172 * in order to allow access to the socket to other RPC requests.
1173 */
1174 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001175 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001176 return;
1177 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001178 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001179}
1180
1181/*
1182 * 5a. Handle cleanup after a transmission
1183 */
1184static void
1185call_transmit_status(struct rpc_task *task)
1186{
1187 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001188
1189 /*
1190 * Common case: success. Force the compiler to put this
1191 * test first.
1192 */
1193 if (task->tk_status == 0) {
1194 xprt_end_transmit(task);
1195 rpc_task_force_reencode(task);
1196 return;
1197 }
1198
Trond Myklebust15f081c2009-03-11 14:37:57 -04001199 switch (task->tk_status) {
1200 case -EAGAIN:
1201 break;
1202 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001203 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001204 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001205 rpc_task_force_reencode(task);
1206 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001207 /*
1208 * Special cases: if we've been waiting on the
1209 * socket's write_space() callback, or if the
1210 * socket just returned a connection error,
1211 * then hold onto the transport lock.
1212 */
1213 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001214 case -EHOSTDOWN:
1215 case -EHOSTUNREACH:
1216 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001217 if (RPC_IS_SOFTCONN(task)) {
1218 xprt_end_transmit(task);
1219 rpc_exit(task, task->tk_status);
1220 break;
1221 }
1222 case -ECONNRESET:
1223 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001224 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001225 rpc_task_force_reencode(task);
1226 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227}
1228
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001229#if defined(CONFIG_NFS_V4_1)
1230/*
1231 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1232 * addition, disconnect on connectivity errors.
1233 */
1234static void
1235call_bc_transmit(struct rpc_task *task)
1236{
1237 struct rpc_rqst *req = task->tk_rqstp;
1238
1239 BUG_ON(task->tk_status != 0);
1240 task->tk_status = xprt_prepare_transmit(task);
1241 if (task->tk_status == -EAGAIN) {
1242 /*
1243 * Could not reserve the transport. Try again after the
1244 * transport is released.
1245 */
1246 task->tk_status = 0;
1247 task->tk_action = call_bc_transmit;
1248 return;
1249 }
1250
1251 task->tk_action = rpc_exit_task;
1252 if (task->tk_status < 0) {
1253 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1254 "error: %d\n", task->tk_status);
1255 return;
1256 }
1257
1258 xprt_transmit(task);
1259 xprt_end_transmit(task);
1260 dprint_status(task);
1261 switch (task->tk_status) {
1262 case 0:
1263 /* Success */
1264 break;
1265 case -EHOSTDOWN:
1266 case -EHOSTUNREACH:
1267 case -ENETUNREACH:
1268 case -ETIMEDOUT:
1269 /*
1270 * Problem reaching the server. Disconnect and let the
1271 * forechannel reestablish the connection. The server will
1272 * have to retransmit the backchannel request and we'll
1273 * reprocess it. Since these ops are idempotent, there's no
1274 * need to cache our reply at this time.
1275 */
1276 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1277 "error: %d\n", task->tk_status);
1278 xprt_conditional_disconnect(task->tk_xprt,
1279 req->rq_connect_cookie);
1280 break;
1281 default:
1282 /*
1283 * We were unable to reply and will have to drop the
1284 * request. The server should reconnect and retransmit.
1285 */
1286 BUG_ON(task->tk_status == -EAGAIN);
1287 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1288 "error: %d\n", task->tk_status);
1289 break;
1290 }
1291 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1292}
1293#endif /* CONFIG_NFS_V4_1 */
1294
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295/*
1296 * 6. Sort out the RPC call status
1297 */
1298static void
1299call_status(struct rpc_task *task)
1300{
1301 struct rpc_clnt *clnt = task->tk_client;
1302 struct rpc_rqst *req = task->tk_rqstp;
1303 int status;
1304
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001305 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1306 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
Chuck Lever46121cf2007-01-31 12:14:08 -05001308 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
1310 status = task->tk_status;
1311 if (status >= 0) {
1312 task->tk_action = call_decode;
1313 return;
1314 }
1315
1316 task->tk_status = 0;
1317 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001318 case -EHOSTDOWN:
1319 case -EHOSTUNREACH:
1320 case -ENETUNREACH:
1321 /*
1322 * Delay any retries for 3 seconds, then handle as if it
1323 * were a timeout.
1324 */
1325 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 case -ETIMEDOUT:
1327 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001328 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001329 xprt_conditional_disconnect(task->tk_xprt,
1330 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001332 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001334 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001335 rpc_delay(task, 3*HZ);
1336 case -EPIPE:
1337 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 task->tk_action = call_bind;
1339 break;
1340 case -EAGAIN:
1341 task->tk_action = call_transmit;
1342 break;
1343 case -EIO:
1344 /* shutdown or soft timeout */
1345 rpc_exit(task, status);
1346 break;
1347 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001348 if (clnt->cl_chatty)
1349 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 clnt->cl_protname, -status);
1351 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 }
1353}
1354
1355/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001356 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 * We do not release the request slot, so we keep using the
1358 * same XID for all retransmits.
1359 */
1360static void
1361call_timeout(struct rpc_task *task)
1362{
1363 struct rpc_clnt *clnt = task->tk_client;
1364
1365 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001366 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 goto retry;
1368 }
1369
Chuck Lever46121cf2007-01-31 12:14:08 -05001370 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001371 task->tk_timeouts++;
1372
Chuck Lever3a28bec2009-12-03 15:58:56 -05001373 if (RPC_IS_SOFTCONN(task)) {
1374 rpc_exit(task, -ETIMEDOUT);
1375 return;
1376 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001378 if (clnt->cl_chatty)
1379 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 clnt->cl_protname, clnt->cl_server);
1381 rpc_exit(task, -EIO);
1382 return;
1383 }
1384
Chuck Leverf518e35a2006-01-03 09:55:52 +01001385 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001387 if (clnt->cl_chatty)
1388 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 clnt->cl_protname, clnt->cl_server);
1390 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001391 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001392 /*
1393 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1394 * event? RFC2203 requires the server to drop all such requests.
1395 */
1396 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
1398retry:
1399 clnt->cl_stats->rpcretrans++;
1400 task->tk_action = call_bind;
1401 task->tk_status = 0;
1402}
1403
1404/*
1405 * 7. Decode the RPC reply
1406 */
1407static void
1408call_decode(struct rpc_task *task)
1409{
1410 struct rpc_clnt *clnt = task->tk_client;
1411 struct rpc_rqst *req = task->tk_rqstp;
1412 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001413 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Chuck Lever46121cf2007-01-31 12:14:08 -05001415 dprintk("RPC: %5u call_decode (status %d)\n",
1416 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
Chuck Leverf518e35a2006-01-03 09:55:52 +01001418 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001419 if (clnt->cl_chatty)
1420 printk(KERN_NOTICE "%s: server %s OK\n",
1421 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1423 }
1424
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001425 /*
1426 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001427 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001428 */
1429 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 req->rq_rcv_buf.len = req->rq_private_buf.len;
1431
1432 /* Check that the softirq receive buffer is valid */
1433 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1434 sizeof(req->rq_rcv_buf)) != 0);
1435
Trond Myklebust1e799b62008-03-21 16:19:41 -04001436 if (req->rq_rcv_buf.len < 12) {
1437 if (!RPC_IS_SOFT(task)) {
1438 task->tk_action = call_bind;
1439 clnt->cl_stats->rpcretrans++;
1440 goto out_retry;
1441 }
1442 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1443 clnt->cl_protname, task->tk_status);
1444 task->tk_action = call_timeout;
1445 goto out_retry;
1446 }
1447
Chuck Leverb0e1c572008-05-21 17:09:19 -04001448 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001449 if (IS_ERR(p)) {
1450 if (p == ERR_PTR(-EAGAIN))
1451 goto out_retry;
1452 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 }
1454
Trond Myklebustabbcf282006-01-03 09:55:03 +01001455 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001457 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1459 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001460 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001461 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1462 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 return;
1464out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001466 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001467 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001468 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001469 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001470 xprt_conditional_disconnect(task->tk_xprt,
1471 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001472 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473}
1474
1475/*
1476 * 8. Refresh the credentials if rejected by the server
1477 */
1478static void
1479call_refresh(struct rpc_task *task)
1480{
Chuck Lever46121cf2007-01-31 12:14:08 -05001481 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 task->tk_action = call_refreshresult;
1484 task->tk_status = 0;
1485 task->tk_client->cl_stats->rpcauthrefresh++;
1486 rpcauth_refreshcred(task);
1487}
1488
1489/*
1490 * 8a. Process the results of a credential refresh
1491 */
1492static void
1493call_refreshresult(struct rpc_task *task)
1494{
1495 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001496
1497 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
1499 task->tk_status = 0;
1500 task->tk_action = call_reserve;
1501 if (status >= 0 && rpcauth_uptodatecred(task))
1502 return;
1503 if (status == -EACCES) {
1504 rpc_exit(task, -EACCES);
1505 return;
1506 }
1507 task->tk_action = call_refresh;
1508 if (status != -ETIMEDOUT)
1509 rpc_delay(task, 3*HZ);
1510 return;
1511}
1512
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001513static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001514rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515{
1516 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001518 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
1520 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001521
1522 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 *p++ = req->rq_xid; /* XID */
1524 *p++ = htonl(RPC_CALL); /* CALL */
1525 *p++ = htonl(RPC_VERSION); /* RPC version */
1526 *p++ = htonl(clnt->cl_prog); /* program number */
1527 *p++ = htonl(clnt->cl_vers); /* program version */
1528 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001529 p = rpcauth_marshcred(task, p);
1530 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1531 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532}
1533
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001534static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001535rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536{
1537 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1538 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001539 __be32 *p = iov->iov_base;
1540 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 int error = -EACCES;
1542
David Howellse8896492006-08-24 15:44:19 -04001543 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1544 /* RFC-1014 says that the representation of XDR data must be a
1545 * multiple of four bytes
1546 * - if it isn't pointer subtraction in the NFS client may give
1547 * undefined results
1548 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001549 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001550 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001551 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001552 goto out_eio;
1553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 if ((len -= 3) < 0)
1555 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001557 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001559 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001560 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001561 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001563
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1565 if (--len < 0)
1566 goto out_overflow;
1567 switch ((n = ntohl(*p++))) {
1568 case RPC_AUTH_ERROR:
1569 break;
1570 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001571 dprintk("RPC: %5u %s: RPC call version "
1572 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001573 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001574 error = -EPROTONOSUPPORT;
1575 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001577 dprintk("RPC: %5u %s: RPC call rejected, "
1578 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001579 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 goto out_eio;
1581 }
1582 if (--len < 0)
1583 goto out_overflow;
1584 switch ((n = ntohl(*p++))) {
1585 case RPC_AUTH_REJECTEDCRED:
1586 case RPC_AUTH_REJECTEDVERF:
1587 case RPCSEC_GSS_CREDPROBLEM:
1588 case RPCSEC_GSS_CTXPROBLEM:
1589 if (!task->tk_cred_retry)
1590 break;
1591 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001592 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001593 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001595 /* Ensure we obtain a new XID! */
1596 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001598 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 case RPC_AUTH_BADCRED:
1600 case RPC_AUTH_BADVERF:
1601 /* possibly garbled cred/verf? */
1602 if (!task->tk_garb_retry)
1603 break;
1604 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001605 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001606 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001608 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001610 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001611 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 break;
1613 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001614 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001615 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 error = -EIO;
1617 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001618 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001619 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 goto out_err;
1621 }
1622 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001623 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001624 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001625 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001627 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 if (len < 0)
1629 goto out_overflow;
1630 switch ((n = ntohl(*p++))) {
1631 case RPC_SUCCESS:
1632 return p;
1633 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001634 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001635 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 (unsigned int)task->tk_client->cl_prog,
1637 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001638 error = -EPFNOSUPPORT;
1639 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001641 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001642 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 (unsigned int)task->tk_client->cl_prog,
1644 (unsigned int)task->tk_client->cl_vers,
1645 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001646 error = -EPROTONOSUPPORT;
1647 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001649 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001650 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001651 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001652 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 task->tk_client->cl_prog,
1654 task->tk_client->cl_vers,
1655 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001656 error = -EOPNOTSUPP;
1657 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001659 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001660 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 break; /* retry */
1662 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001663 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001664 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 /* Also retry */
1666 }
1667
Trond Myklebustabbcf282006-01-03 09:55:03 +01001668out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 task->tk_client->cl_stats->rpcgarbage++;
1670 if (task->tk_garb_retry) {
1671 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001672 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001673 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001675out_retry:
1676 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678out_eio:
1679 error = -EIO;
1680out_err:
1681 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001682 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001683 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001684 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001686 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001687 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001688 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001690
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001691static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001692{
1693 return 0;
1694}
1695
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001696static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001697{
1698 return 0;
1699}
1700
1701static struct rpc_procinfo rpcproc_null = {
1702 .p_encode = rpcproc_encode_null,
1703 .p_decode = rpcproc_decode_null,
1704};
1705
Chuck Levercaabea82009-12-03 15:58:56 -05001706static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001707{
1708 struct rpc_message msg = {
1709 .rpc_proc = &rpcproc_null,
1710 };
1711 int err;
1712 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001713 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001714 put_rpccred(msg.rpc_cred);
1715 return err;
1716}
Trond Myklebust188fef12007-06-16 14:18:40 -04001717
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001718struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1719{
1720 struct rpc_message msg = {
1721 .rpc_proc = &rpcproc_null,
1722 .rpc_cred = cred,
1723 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001724 struct rpc_task_setup task_setup_data = {
1725 .rpc_client = clnt,
1726 .rpc_message = &msg,
1727 .callback_ops = &rpc_default_ops,
1728 .flags = flags,
1729 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001730 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001731}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001732EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001733
Trond Myklebust188fef12007-06-16 14:18:40 -04001734#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001735static void rpc_show_header(void)
1736{
Chuck Levercb3997b2008-05-21 17:09:41 -04001737 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1738 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001739}
1740
Chuck Lever38e886e2008-05-21 17:09:33 -04001741static void rpc_show_task(const struct rpc_clnt *clnt,
1742 const struct rpc_task *task)
1743{
1744 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001745 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001746
1747 if (RPC_IS_QUEUED(task))
1748 rpc_waitq = rpc_qname(task->tk_waitqueue);
1749
Chuck Levercb3997b2008-05-21 17:09:41 -04001750 /* map tk_action pointer to a function name; then trim off
1751 * the "+0x0 [sunrpc]" */
1752 sprint_symbol(action, (unsigned long)task->tk_action);
1753 p = strchr(action, '+');
1754 if (p)
1755 *p = '\0';
1756
1757 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1758 task->tk_pid, task->tk_flags, task->tk_status,
1759 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1760 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1761 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001762}
1763
Trond Myklebust188fef12007-06-16 14:18:40 -04001764void rpc_show_tasks(void)
1765{
1766 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001767 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001768 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001769
1770 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001771 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001772 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001773 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001774 if (!header) {
1775 rpc_show_header();
1776 header++;
1777 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001778 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001779 }
1780 spin_unlock(&clnt->cl_lock);
1781 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001782 spin_unlock(&rpc_client_lock);
1783}
1784#endif