blob: c1e467e1b07d471b9baa80f6292eda85a54cf997 [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);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082static int rpc_ping(struct rpc_clnt *clnt, int flags);
83
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,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200291 };
Chuck Lever510deb02007-12-10 14:56:24 -0500292 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400293
Chuck Leverc2866762006-08-22 20:06:20 -0400294 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400295 * If the caller chooses not to specify a hostname, whip
296 * up a string representation of the passed-in address.
297 */
298 if (args->servername == NULL) {
Chuck Lever510deb02007-12-10 14:56:24 -0500299 servername[0] = '\0';
300 switch (args->address->sa_family) {
301 case AF_INET: {
302 struct sockaddr_in *sin =
303 (struct sockaddr_in *)args->address;
Harvey Harrison21454aa2008-10-31 00:54:56 -0700304 snprintf(servername, sizeof(servername), "%pI4",
305 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500306 break;
307 }
308 case AF_INET6: {
309 struct sockaddr_in6 *sin =
310 (struct sockaddr_in6 *)args->address;
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700311 snprintf(servername, sizeof(servername), "%pI6",
Harvey Harrisonfdb46ee2008-10-28 16:10:17 -0700312 &sin->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500313 break;
314 }
315 default:
316 /* caller wants default server name, but
317 * address family isn't recognized. */
318 return ERR_PTR(-EINVAL);
319 }
Chuck Lever43780b82007-07-01 12:13:22 -0400320 args->servername = servername;
321 }
322
Chuck Lever510deb02007-12-10 14:56:24 -0500323 xprt = xprt_create_transport(&xprtargs);
324 if (IS_ERR(xprt))
325 return (struct rpc_clnt *)xprt;
326
Chuck Lever43780b82007-07-01 12:13:22 -0400327 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400328 * By default, kernel RPC client connects from a reserved port.
329 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
330 * but it is always enabled for rpciod, which handles the connect
331 * operation.
332 */
333 xprt->resvport = 1;
334 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
335 xprt->resvport = 0;
336
Trond Myklebust698b6d02007-12-20 16:03:53 -0500337 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400338 if (IS_ERR(clnt))
339 return clnt;
340
341 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Matthew Wilcox150030b2007-12-06 16:24:39 -0500342 int err = rpc_ping(clnt, RPC_TASK_SOFT);
Chuck Leverc2866762006-08-22 20:06:20 -0400343 if (err != 0) {
344 rpc_shutdown_client(clnt);
345 return ERR_PTR(err);
346 }
347 }
348
349 clnt->cl_softrtry = 1;
350 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
351 clnt->cl_softrtry = 0;
352
Chuck Leverc2866762006-08-22 20:06:20 -0400353 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
354 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500355 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
356 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400357 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
358 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400359
360 return clnt;
361}
Chuck Leverb86acd52006-08-22 20:06:22 -0400362EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364/*
365 * This function clones the RPC client structure. It allows us to share the
366 * same transport while varying parameters such as the authentication
367 * flavour.
368 */
369struct rpc_clnt *
370rpc_clone_client(struct rpc_clnt *clnt)
371{
372 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500373 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200375 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 if (!new)
377 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400378 new->cl_parent = clnt;
379 /* Turn off autobind on clones */
380 new->cl_autobind = 0;
381 INIT_LIST_HEAD(&new->cl_tasks);
382 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500383 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500384 new->cl_metrics = rpc_alloc_iostats(clnt);
385 if (new->cl_metrics == NULL)
386 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500387 if (clnt->cl_principal) {
388 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
389 if (new->cl_principal == NULL)
390 goto out_no_principal;
391 }
Trond Myklebust34f52e32007-06-14 16:40:31 -0400392 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500393 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
394 if (err != 0)
395 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 if (new->cl_auth)
397 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400398 xprt_get(clnt->cl_xprt);
399 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400400 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400401 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500403out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500404 kfree(new->cl_principal);
405out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500406 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500407out_no_stats:
408 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800410 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500411 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400413EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415/*
416 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400417 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400419void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400421 dprintk("RPC: shutting down %s client for %s\n",
422 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Trond Myklebust34f52e32007-06-14 16:40:31 -0400424 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800426 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400427 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 }
429
Trond Myklebust4c402b42007-06-14 16:40:32 -0400430 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400432EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400435 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400437static void
438rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400440 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
Chuck Lever46121cf2007-01-31 12:14:08 -0500442 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400444 if (!IS_ERR(clnt->cl_path.dentry)) {
445 rpc_remove_client_dir(clnt->cl_path.dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400446 rpc_put_mount();
447 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500448 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400449 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500450 goto out_free;
451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 if (clnt->cl_server != clnt->cl_inline_name)
453 kfree(clnt->cl_server);
454out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400455 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500456 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500457 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500458 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400459 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400460 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462}
463
464/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400465 * Free an RPC client
466 */
467static void
468rpc_free_auth(struct kref *kref)
469{
470 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
471
472 if (clnt->cl_auth == NULL) {
473 rpc_free_client(kref);
474 return;
475 }
476
477 /*
478 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
479 * release remaining GSS contexts. This mechanism ensures
480 * that it can do so safely.
481 */
482 kref_init(kref);
483 rpcauth_release(clnt->cl_auth);
484 clnt->cl_auth = NULL;
485 kref_put(kref, rpc_free_client);
486}
487
488/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400489 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 */
491void
492rpc_release_client(struct rpc_clnt *clnt)
493{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400494 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Trond Myklebust34f52e32007-06-14 16:40:31 -0400496 if (list_empty(&clnt->cl_tasks))
497 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400498 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400499}
500
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000501/**
502 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800503 * @old: old rpc_client
504 * @program: rpc program to set
505 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000506 *
507 * Clones the rpc client and sets up a new RPC program. This is mainly
508 * of use for enabling different RPC programs to share the same transport.
509 * The Sun NFSv2/v3 ACL protocol can do this.
510 */
511struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
512 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400513 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000514{
515 struct rpc_clnt *clnt;
516 struct rpc_version *version;
517 int err;
518
519 BUG_ON(vers >= program->nrvers || !program->version[vers]);
520 version = program->version[vers];
521 clnt = rpc_clone_client(old);
522 if (IS_ERR(clnt))
523 goto out;
524 clnt->cl_procinfo = version->procs;
525 clnt->cl_maxproc = version->nrprocs;
526 clnt->cl_protname = program->name;
527 clnt->cl_prog = program->number;
528 clnt->cl_vers = version->number;
529 clnt->cl_stats = program->stats;
Matthew Wilcox150030b2007-12-06 16:24:39 -0500530 err = rpc_ping(clnt, RPC_TASK_SOFT);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000531 if (err != 0) {
532 rpc_shutdown_client(clnt);
533 clnt = ERR_PTR(err);
534 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800535out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000536 return clnt;
537}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400538EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540/*
541 * Default callback for async RPC calls
542 */
543static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100544rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546}
547
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100548static const struct rpc_call_ops rpc_default_ops = {
549 .rpc_call_done = rpc_default_callback,
550};
551
Trond Myklebustc970aa82007-07-14 15:39:59 -0400552/**
553 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
554 * @task_setup_data: pointer to task initialisation data
555 */
556struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400557{
558 struct rpc_task *task, *ret;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400559
Trond Myklebust84115e12007-07-14 15:39:59 -0400560 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400561 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400562 rpc_release_calldata(task_setup_data->callback_ops,
563 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400564 ret = ERR_PTR(-ENOMEM);
565 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400566 }
567
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400568 if (task->tk_status != 0) {
569 ret = ERR_PTR(task->tk_status);
570 rpc_put_task(task);
571 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400572 }
573 atomic_inc(&task->tk_count);
574 rpc_execute(task);
575 ret = task;
576out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400577 return ret;
578}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400579EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400580
581/**
582 * rpc_call_sync - Perform a synchronous RPC call
583 * @clnt: pointer to RPC client
584 * @msg: RPC call parameters
585 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500587int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
589 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400590 struct rpc_task_setup task_setup_data = {
591 .rpc_client = clnt,
592 .rpc_message = msg,
593 .callback_ops = &rpc_default_ops,
594 .flags = flags,
595 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400596 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 BUG_ON(flags & RPC_TASK_ASYNC);
599
Trond Myklebustc970aa82007-07-14 15:39:59 -0400600 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400601 if (IS_ERR(task))
602 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100603 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800604 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 return status;
606}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400607EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400609/**
610 * rpc_call_async - Perform an asynchronous RPC call
611 * @clnt: pointer to RPC client
612 * @msg: RPC call parameters
613 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800614 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400615 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 */
617int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500618rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100619 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
621 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400622 struct rpc_task_setup task_setup_data = {
623 .rpc_client = clnt,
624 .rpc_message = msg,
625 .callback_ops = tk_ops,
626 .callback_data = data,
627 .flags = flags|RPC_TASK_ASYNC,
628 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Trond Myklebustc970aa82007-07-14 15:39:59 -0400630 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400631 if (IS_ERR(task))
632 return PTR_ERR(task);
633 rpc_put_task(task);
634 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400636EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400638#if defined(CONFIG_NFS_V4_1)
639/**
640 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
641 * rpc_execute against it
642 * @ops: RPC call ops
643 */
644struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
645 const struct rpc_call_ops *tk_ops)
646{
647 struct rpc_task *task;
648 struct xdr_buf *xbufp = &req->rq_snd_buf;
649 struct rpc_task_setup task_setup_data = {
650 .callback_ops = tk_ops,
651 };
652
653 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
654 /*
655 * Create an rpc_task to send the data
656 */
657 task = rpc_new_task(&task_setup_data);
658 if (!task) {
659 xprt_free_bc_request(req);
660 goto out;
661 }
662 task->tk_rqstp = req;
663
664 /*
665 * Set up the xdr_buf length.
666 * This also indicates that the buffer is XDR encoded already.
667 */
668 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
669 xbufp->tail[0].iov_len;
670
671 task->tk_action = call_bc_transmit;
672 atomic_inc(&task->tk_count);
673 BUG_ON(atomic_read(&task->tk_count) != 2);
674 rpc_execute(task);
675
676out:
677 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
678 return task;
679}
680#endif /* CONFIG_NFS_V4_1 */
681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400683rpc_call_start(struct rpc_task *task)
684{
685 task->tk_action = call_start;
686}
687EXPORT_SYMBOL_GPL(rpc_call_start);
688
Chuck Levered394402006-08-22 20:06:17 -0400689/**
690 * rpc_peeraddr - extract remote peer address from clnt's xprt
691 * @clnt: RPC client structure
692 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800693 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400694 *
695 * Returns the number of bytes that are actually in the stored address.
696 */
697size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
698{
699 size_t bytes;
700 struct rpc_xprt *xprt = clnt->cl_xprt;
701
702 bytes = sizeof(xprt->addr);
703 if (bytes > bufsize)
704 bytes = bufsize;
705 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400706 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400707}
Chuck Leverb86acd52006-08-22 20:06:22 -0400708EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400709
Chuck Leverf425eba2006-08-22 20:06:18 -0400710/**
711 * rpc_peeraddr2str - return remote peer address in printable format
712 * @clnt: RPC client structure
713 * @format: address format
714 *
715 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500716const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
717 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400718{
719 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500720
721 if (xprt->address_strings[format] != NULL)
722 return xprt->address_strings[format];
723 else
724 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400725}
Chuck Leverb86acd52006-08-22 20:06:22 -0400726EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728void
729rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
730{
731 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700732 if (xprt->ops->set_buffer_size)
733 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400735EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
737/*
738 * Return size of largest payload RPC client can support, in bytes
739 *
740 * For stream transports, this is one RPC record fragment (see RFC
741 * 1831), as we don't support multi-record requests yet. For datagram
742 * transports, this is the size of an IP packet minus the IP, UDP, and
743 * RPC header sizes.
744 */
745size_t rpc_max_payload(struct rpc_clnt *clnt)
746{
747 return clnt->cl_xprt->max_payload;
748}
Chuck Leverb86acd52006-08-22 20:06:22 -0400749EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Chuck Lever35f5a422006-01-03 09:55:50 +0100751/**
752 * rpc_force_rebind - force transport to check that remote port is unchanged
753 * @clnt: client to rebind
754 *
755 */
756void rpc_force_rebind(struct rpc_clnt *clnt)
757{
758 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400759 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100760}
Chuck Leverb86acd52006-08-22 20:06:22 -0400761EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400764 * Restart an (async) RPC call from the call_prepare state.
765 * Usually called from within the exit handler.
766 */
767void
768rpc_restart_call_prepare(struct rpc_task *task)
769{
770 if (RPC_ASSASSINATED(task))
771 return;
772 task->tk_action = rpc_prepare_task;
773}
774EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
775
776/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 * Restart an (async) RPC call. Usually called from within the
778 * exit handler.
779 */
780void
781rpc_restart_call(struct rpc_task *task)
782{
783 if (RPC_ASSASSINATED(task))
784 return;
785
786 task->tk_action = call_start;
787}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400788EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Chuck Lever3748f1e2008-05-21 17:09:12 -0400790#ifdef RPC_DEBUG
791static const char *rpc_proc_name(const struct rpc_task *task)
792{
793 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
794
795 if (proc) {
796 if (proc->p_name)
797 return proc->p_name;
798 else
799 return "NULL";
800 } else
801 return "no proc";
802}
803#endif
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805/*
806 * 0. Initial state
807 *
808 * Other FSM states can be visited zero or more times, but
809 * this state is visited exactly once for each RPC.
810 */
811static void
812call_start(struct rpc_task *task)
813{
814 struct rpc_clnt *clnt = task->tk_client;
815
Chuck Lever3748f1e2008-05-21 17:09:12 -0400816 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500817 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400818 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500819 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821 /* Increment call count */
822 task->tk_msg.rpc_proc->p_count++;
823 clnt->cl_stats->rpccnt++;
824 task->tk_action = call_reserve;
825}
826
827/*
828 * 1. Reserve an RPC call slot
829 */
830static void
831call_reserve(struct rpc_task *task)
832{
Chuck Lever46121cf2007-01-31 12:14:08 -0500833 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
835 if (!rpcauth_uptodatecred(task)) {
836 task->tk_action = call_refresh;
837 return;
838 }
839
840 task->tk_status = 0;
841 task->tk_action = call_reserveresult;
842 xprt_reserve(task);
843}
844
845/*
846 * 1b. Grok the result of xprt_reserve()
847 */
848static void
849call_reserveresult(struct rpc_task *task)
850{
851 int status = task->tk_status;
852
Chuck Lever46121cf2007-01-31 12:14:08 -0500853 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
855 /*
856 * After a call to xprt_reserve(), we must have either
857 * a request slot or else an error status.
858 */
859 task->tk_status = 0;
860 if (status >= 0) {
861 if (task->tk_rqstp) {
862 task->tk_action = call_allocate;
863 return;
864 }
865
866 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800867 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 rpc_exit(task, -EIO);
869 return;
870 }
871
872 /*
873 * Even though there was an error, we may have acquired
874 * a request slot somehow. Make sure not to leak it.
875 */
876 if (task->tk_rqstp) {
877 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800878 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 xprt_release(task);
880 }
881
882 switch (status) {
883 case -EAGAIN: /* woken up; retry */
884 task->tk_action = call_reserve;
885 return;
886 case -EIO: /* probably a shutdown */
887 break;
888 default:
889 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800890 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 break;
892 }
893 rpc_exit(task, status);
894}
895
896/*
897 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100898 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 */
900static void
901call_allocate(struct rpc_task *task)
902{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400903 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100904 struct rpc_rqst *req = task->tk_rqstp;
905 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400906 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Chuck Lever46121cf2007-01-31 12:14:08 -0500908 dprint_status(task);
909
Chuck Lever2bea90d2007-03-29 16:47:53 -0400910 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400912
Chuck Lever02107142006-01-03 09:55:49 +0100913 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 return;
915
Chuck Lever2bea90d2007-03-29 16:47:53 -0400916 if (proc->p_proc != 0) {
917 BUG_ON(proc->p_arglen == 0);
918 if (proc->p_decode != NULL)
919 BUG_ON(proc->p_replen == 0);
920 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Chuck Lever2bea90d2007-03-29 16:47:53 -0400922 /*
923 * Calculate the size (in quads) of the RPC call
924 * and reply headers, and convert both values
925 * to byte sizes.
926 */
927 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
928 req->rq_callsize <<= 2;
929 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
930 req->rq_rcvsize <<= 2;
931
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400932 req->rq_buffer = xprt->ops->buf_alloc(task,
933 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400934 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500936
937 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Trond Myklebust14b218a2005-06-22 17:16:28 +0000939 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400940 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 rpc_delay(task, HZ>>4);
942 return;
943 }
944
945 rpc_exit(task, -ERESTARTSYS);
946}
947
Trond Myklebust940e3312005-11-09 21:45:24 -0500948static inline int
949rpc_task_need_encode(struct rpc_task *task)
950{
951 return task->tk_rqstp->rq_snd_buf.len == 0;
952}
953
954static inline void
955rpc_task_force_reencode(struct rpc_task *task)
956{
957 task->tk_rqstp->rq_snd_buf.len = 0;
958}
959
Chuck Lever2bea90d2007-03-29 16:47:53 -0400960static inline void
961rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
962{
963 buf->head[0].iov_base = start;
964 buf->head[0].iov_len = len;
965 buf->tail[0].iov_len = 0;
966 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400967 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400968 buf->len = 0;
969 buf->buflen = len;
970}
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972/*
973 * 3. Encode arguments of an RPC call
974 */
975static void
Chuck Leverb0e1c572008-05-21 17:09:19 -0400976rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700980 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
Chuck Lever46121cf2007-01-31 12:14:08 -0500982 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Chuck Lever2bea90d2007-03-29 16:47:53 -0400984 rpc_xdr_buf_init(&req->rq_snd_buf,
985 req->rq_buffer,
986 req->rq_callsize);
987 rpc_xdr_buf_init(&req->rq_rcv_buf,
988 (char *)req->rq_buffer + req->rq_callsize,
989 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Chuck Leverb0e1c572008-05-21 17:09:19 -0400991 p = rpc_encode_header(task);
992 if (p == NULL) {
993 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 rpc_exit(task, -EIO);
995 return;
996 }
Chuck Leverb0e1c572008-05-21 17:09:19 -0400997
998 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -0400999 if (encode == NULL)
1000 return;
1001
1002 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1003 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004}
1005
1006/*
1007 * 4. Get the server port number if not yet set
1008 */
1009static void
1010call_bind(struct rpc_task *task)
1011{
Chuck Leverec739ef2006-08-22 20:06:15 -04001012 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Chuck Lever46121cf2007-01-31 12:14:08 -05001014 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Chuck Leverda351872005-08-11 16:25:11 -04001016 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001017 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001018 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001019 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001020 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 }
1022}
1023
1024/*
Chuck Leverda351872005-08-11 16:25:11 -04001025 * 4a. Sort out bind result
1026 */
1027static void
1028call_bind_status(struct rpc_task *task)
1029{
Chuck Lever906462a2007-09-11 18:00:47 -04001030 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001031
1032 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001033 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001034 task->tk_status = 0;
1035 task->tk_action = call_connect;
1036 return;
1037 }
1038
1039 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001040 case -ENOMEM:
1041 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1042 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001043 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001044 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001045 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1046 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001047 /* fail immediately if this is an RPC ping */
1048 if (task->tk_msg.rpc_proc->p_proc == 0) {
1049 status = -EOPNOTSUPP;
1050 break;
1051 }
Chuck Leverea635a52005-10-06 23:12:58 -04001052 rpc_delay(task, 3*HZ);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001053 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001054 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001055 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001056 task->tk_pid);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001057 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001058 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001059 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -05001060 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -04001061 task->tk_pid);
1062 break;
1063 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001064 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001065 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001066 task->tk_status = 0;
1067 task->tk_action = call_bind;
1068 return;
Chuck Leverda351872005-08-11 16:25:11 -04001069 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001070 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001071 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001072 }
1073
1074 rpc_exit(task, status);
1075 return;
1076
Trond Myklebustda45828e2006-08-31 15:44:52 -04001077retry_timeout:
1078 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001079}
1080
1081/*
1082 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 */
1084static void
1085call_connect(struct rpc_task *task)
1086{
Chuck Leverda351872005-08-11 16:25:11 -04001087 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Chuck Lever46121cf2007-01-31 12:14:08 -05001089 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001090 task->tk_pid, xprt,
1091 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
Chuck Leverda351872005-08-11 16:25:11 -04001093 task->tk_action = call_transmit;
1094 if (!xprt_connected(xprt)) {
1095 task->tk_action = call_connect_status;
1096 if (task->tk_status < 0)
1097 return;
1098 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100}
1101
1102/*
Chuck Leverda351872005-08-11 16:25:11 -04001103 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 */
1105static void
1106call_connect_status(struct rpc_task *task)
1107{
1108 struct rpc_clnt *clnt = task->tk_client;
1109 int status = task->tk_status;
1110
Chuck Lever46121cf2007-01-31 12:14:08 -05001111 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001112
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001114 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 clnt->cl_stats->netreconn++;
1116 task->tk_action = call_transmit;
1117 return;
1118 }
1119
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 switch (status) {
Trond Myklebustda45828e2006-08-31 15:44:52 -04001121 /* if soft mounted, test if we've timed out */
1122 case -ETIMEDOUT:
1123 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001124 break;
1125 default:
1126 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 }
1128}
1129
1130/*
1131 * 5. Transmit the RPC request, and wait for reply
1132 */
1133static void
1134call_transmit(struct rpc_task *task)
1135{
Chuck Lever46121cf2007-01-31 12:14:08 -05001136 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
1138 task->tk_action = call_status;
1139 if (task->tk_status < 0)
1140 return;
1141 task->tk_status = xprt_prepare_transmit(task);
1142 if (task->tk_status != 0)
1143 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001144 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001146 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001147 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001148 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001149 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001150 if (task->tk_status != 0) {
1151 /* Was the error nonfatal? */
1152 if (task->tk_status == -EAGAIN)
1153 rpc_delay(task, HZ >> 4);
1154 else
1155 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001156 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001157 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001158 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 xprt_transmit(task);
1160 if (task->tk_status < 0)
1161 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001162 /*
1163 * On success, ensure that we call xprt_end_transmit() before sleeping
1164 * in order to allow access to the socket to other RPC requests.
1165 */
1166 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001167 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001168 return;
1169 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001170 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001171}
1172
1173/*
1174 * 5a. Handle cleanup after a transmission
1175 */
1176static void
1177call_transmit_status(struct rpc_task *task)
1178{
1179 task->tk_action = call_status;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001180 switch (task->tk_status) {
1181 case -EAGAIN:
1182 break;
1183 default:
1184 xprt_end_transmit(task);
1185 /*
1186 * Special cases: if we've been waiting on the
1187 * socket's write_space() callback, or if the
1188 * socket just returned a connection error,
1189 * then hold onto the transport lock.
1190 */
1191 case -ECONNREFUSED:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001192 case -ECONNRESET:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001193 case -ENOTCONN:
1194 case -EHOSTDOWN:
1195 case -EHOSTUNREACH:
1196 case -ENETUNREACH:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001197 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001198 rpc_task_force_reencode(task);
1199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200}
1201
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001202#if defined(CONFIG_NFS_V4_1)
1203/*
1204 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1205 * addition, disconnect on connectivity errors.
1206 */
1207static void
1208call_bc_transmit(struct rpc_task *task)
1209{
1210 struct rpc_rqst *req = task->tk_rqstp;
1211
1212 BUG_ON(task->tk_status != 0);
1213 task->tk_status = xprt_prepare_transmit(task);
1214 if (task->tk_status == -EAGAIN) {
1215 /*
1216 * Could not reserve the transport. Try again after the
1217 * transport is released.
1218 */
1219 task->tk_status = 0;
1220 task->tk_action = call_bc_transmit;
1221 return;
1222 }
1223
1224 task->tk_action = rpc_exit_task;
1225 if (task->tk_status < 0) {
1226 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1227 "error: %d\n", task->tk_status);
1228 return;
1229 }
1230
1231 xprt_transmit(task);
1232 xprt_end_transmit(task);
1233 dprint_status(task);
1234 switch (task->tk_status) {
1235 case 0:
1236 /* Success */
1237 break;
1238 case -EHOSTDOWN:
1239 case -EHOSTUNREACH:
1240 case -ENETUNREACH:
1241 case -ETIMEDOUT:
1242 /*
1243 * Problem reaching the server. Disconnect and let the
1244 * forechannel reestablish the connection. The server will
1245 * have to retransmit the backchannel request and we'll
1246 * reprocess it. Since these ops are idempotent, there's no
1247 * need to cache our reply at this time.
1248 */
1249 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1250 "error: %d\n", task->tk_status);
1251 xprt_conditional_disconnect(task->tk_xprt,
1252 req->rq_connect_cookie);
1253 break;
1254 default:
1255 /*
1256 * We were unable to reply and will have to drop the
1257 * request. The server should reconnect and retransmit.
1258 */
1259 BUG_ON(task->tk_status == -EAGAIN);
1260 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1261 "error: %d\n", task->tk_status);
1262 break;
1263 }
1264 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1265}
1266#endif /* CONFIG_NFS_V4_1 */
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268/*
1269 * 6. Sort out the RPC call status
1270 */
1271static void
1272call_status(struct rpc_task *task)
1273{
1274 struct rpc_clnt *clnt = task->tk_client;
1275 struct rpc_rqst *req = task->tk_rqstp;
1276 int status;
1277
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001278 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1279 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Chuck Lever46121cf2007-01-31 12:14:08 -05001281 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
1283 status = task->tk_status;
1284 if (status >= 0) {
1285 task->tk_action = call_decode;
1286 return;
1287 }
1288
1289 task->tk_status = 0;
1290 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001291 case -EHOSTDOWN:
1292 case -EHOSTUNREACH:
1293 case -ENETUNREACH:
1294 /*
1295 * Delay any retries for 3 seconds, then handle as if it
1296 * were a timeout.
1297 */
1298 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 case -ETIMEDOUT:
1300 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001301 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001302 xprt_conditional_disconnect(task->tk_xprt,
1303 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001305 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001307 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001308 rpc_delay(task, 3*HZ);
1309 case -EPIPE:
1310 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 task->tk_action = call_bind;
1312 break;
1313 case -EAGAIN:
1314 task->tk_action = call_transmit;
1315 break;
1316 case -EIO:
1317 /* shutdown or soft timeout */
1318 rpc_exit(task, status);
1319 break;
1320 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001321 if (clnt->cl_chatty)
1322 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 clnt->cl_protname, -status);
1324 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 }
1326}
1327
1328/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001329 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 * We do not release the request slot, so we keep using the
1331 * same XID for all retransmits.
1332 */
1333static void
1334call_timeout(struct rpc_task *task)
1335{
1336 struct rpc_clnt *clnt = task->tk_client;
1337
1338 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001339 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 goto retry;
1341 }
1342
Chuck Lever46121cf2007-01-31 12:14:08 -05001343 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001344 task->tk_timeouts++;
1345
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001347 if (clnt->cl_chatty)
1348 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 clnt->cl_protname, clnt->cl_server);
1350 rpc_exit(task, -EIO);
1351 return;
1352 }
1353
Chuck Leverf518e35a2006-01-03 09:55:52 +01001354 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001356 if (clnt->cl_chatty)
1357 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 clnt->cl_protname, clnt->cl_server);
1359 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001360 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001361 /*
1362 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1363 * event? RFC2203 requires the server to drop all such requests.
1364 */
1365 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
1367retry:
1368 clnt->cl_stats->rpcretrans++;
1369 task->tk_action = call_bind;
1370 task->tk_status = 0;
1371}
1372
1373/*
1374 * 7. Decode the RPC reply
1375 */
1376static void
1377call_decode(struct rpc_task *task)
1378{
1379 struct rpc_clnt *clnt = task->tk_client;
1380 struct rpc_rqst *req = task->tk_rqstp;
1381 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001382 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
Chuck Lever46121cf2007-01-31 12:14:08 -05001384 dprintk("RPC: %5u call_decode (status %d)\n",
1385 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386
Chuck Leverf518e35a2006-01-03 09:55:52 +01001387 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001388 if (clnt->cl_chatty)
1389 printk(KERN_NOTICE "%s: server %s OK\n",
1390 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1392 }
1393
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001394 /*
1395 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001396 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001397 */
1398 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 req->rq_rcv_buf.len = req->rq_private_buf.len;
1400
1401 /* Check that the softirq receive buffer is valid */
1402 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1403 sizeof(req->rq_rcv_buf)) != 0);
1404
Trond Myklebust1e799b62008-03-21 16:19:41 -04001405 if (req->rq_rcv_buf.len < 12) {
1406 if (!RPC_IS_SOFT(task)) {
1407 task->tk_action = call_bind;
1408 clnt->cl_stats->rpcretrans++;
1409 goto out_retry;
1410 }
1411 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1412 clnt->cl_protname, task->tk_status);
1413 task->tk_action = call_timeout;
1414 goto out_retry;
1415 }
1416
Chuck Leverb0e1c572008-05-21 17:09:19 -04001417 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001418 if (IS_ERR(p)) {
1419 if (p == ERR_PTR(-EAGAIN))
1420 goto out_retry;
1421 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 }
1423
Trond Myklebustabbcf282006-01-03 09:55:03 +01001424 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001426 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1428 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001429 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001430 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1431 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 return;
1433out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001435 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001436 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001437 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001438 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001439 xprt_conditional_disconnect(task->tk_xprt,
1440 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001441 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442}
1443
1444/*
1445 * 8. Refresh the credentials if rejected by the server
1446 */
1447static void
1448call_refresh(struct rpc_task *task)
1449{
Chuck Lever46121cf2007-01-31 12:14:08 -05001450 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 task->tk_action = call_refreshresult;
1453 task->tk_status = 0;
1454 task->tk_client->cl_stats->rpcauthrefresh++;
1455 rpcauth_refreshcred(task);
1456}
1457
1458/*
1459 * 8a. Process the results of a credential refresh
1460 */
1461static void
1462call_refreshresult(struct rpc_task *task)
1463{
1464 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001465
1466 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
1468 task->tk_status = 0;
1469 task->tk_action = call_reserve;
1470 if (status >= 0 && rpcauth_uptodatecred(task))
1471 return;
1472 if (status == -EACCES) {
1473 rpc_exit(task, -EACCES);
1474 return;
1475 }
1476 task->tk_action = call_refresh;
1477 if (status != -ETIMEDOUT)
1478 rpc_delay(task, 3*HZ);
1479 return;
1480}
1481
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001482static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001483rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484{
1485 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001487 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
1489 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001490
1491 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 *p++ = req->rq_xid; /* XID */
1493 *p++ = htonl(RPC_CALL); /* CALL */
1494 *p++ = htonl(RPC_VERSION); /* RPC version */
1495 *p++ = htonl(clnt->cl_prog); /* program number */
1496 *p++ = htonl(clnt->cl_vers); /* program version */
1497 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001498 p = rpcauth_marshcred(task, p);
1499 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1500 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
1502
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001503static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001504rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505{
1506 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1507 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001508 __be32 *p = iov->iov_base;
1509 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 int error = -EACCES;
1511
David Howellse8896492006-08-24 15:44:19 -04001512 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1513 /* RFC-1014 says that the representation of XDR data must be a
1514 * multiple of four bytes
1515 * - if it isn't pointer subtraction in the NFS client may give
1516 * undefined results
1517 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001518 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001519 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001520 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001521 goto out_eio;
1522 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 if ((len -= 3) < 0)
1524 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001526 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001528 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001529 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001530 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1534 if (--len < 0)
1535 goto out_overflow;
1536 switch ((n = ntohl(*p++))) {
1537 case RPC_AUTH_ERROR:
1538 break;
1539 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001540 dprintk("RPC: %5u %s: RPC call version "
1541 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001542 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001543 error = -EPROTONOSUPPORT;
1544 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001546 dprintk("RPC: %5u %s: RPC call rejected, "
1547 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001548 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 goto out_eio;
1550 }
1551 if (--len < 0)
1552 goto out_overflow;
1553 switch ((n = ntohl(*p++))) {
1554 case RPC_AUTH_REJECTEDCRED:
1555 case RPC_AUTH_REJECTEDVERF:
1556 case RPCSEC_GSS_CREDPROBLEM:
1557 case RPCSEC_GSS_CTXPROBLEM:
1558 if (!task->tk_cred_retry)
1559 break;
1560 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001561 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001562 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001564 /* Ensure we obtain a new XID! */
1565 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001567 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 case RPC_AUTH_BADCRED:
1569 case RPC_AUTH_BADVERF:
1570 /* possibly garbled cred/verf? */
1571 if (!task->tk_garb_retry)
1572 break;
1573 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001574 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001575 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001577 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001579 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001580 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 break;
1582 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001583 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001584 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 error = -EIO;
1586 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001587 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001588 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 goto out_err;
1590 }
1591 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001592 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001593 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001594 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001596 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 if (len < 0)
1598 goto out_overflow;
1599 switch ((n = ntohl(*p++))) {
1600 case RPC_SUCCESS:
1601 return p;
1602 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001603 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001604 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 (unsigned int)task->tk_client->cl_prog,
1606 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001607 error = -EPFNOSUPPORT;
1608 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001610 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001611 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 (unsigned int)task->tk_client->cl_prog,
1613 (unsigned int)task->tk_client->cl_vers,
1614 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001615 error = -EPROTONOSUPPORT;
1616 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001618 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001619 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001620 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001621 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 task->tk_client->cl_prog,
1623 task->tk_client->cl_vers,
1624 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001625 error = -EOPNOTSUPP;
1626 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001628 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001629 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 break; /* retry */
1631 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001632 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001633 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 /* Also retry */
1635 }
1636
Trond Myklebustabbcf282006-01-03 09:55:03 +01001637out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 task->tk_client->cl_stats->rpcgarbage++;
1639 if (task->tk_garb_retry) {
1640 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001641 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001642 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001644out_retry:
1645 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647out_eio:
1648 error = -EIO;
1649out_err:
1650 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001651 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001652 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001653 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001655 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001656 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001657 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001659
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001660static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001661{
1662 return 0;
1663}
1664
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001665static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001666{
1667 return 0;
1668}
1669
1670static struct rpc_procinfo rpcproc_null = {
1671 .p_encode = rpcproc_encode_null,
1672 .p_decode = rpcproc_decode_null,
1673};
1674
Trond Myklebust64c91a12007-06-23 10:17:16 -04001675static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001676{
1677 struct rpc_message msg = {
1678 .rpc_proc = &rpcproc_null,
1679 };
1680 int err;
1681 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1682 err = rpc_call_sync(clnt, &msg, flags);
1683 put_rpccred(msg.rpc_cred);
1684 return err;
1685}
Trond Myklebust188fef12007-06-16 14:18:40 -04001686
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001687struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1688{
1689 struct rpc_message msg = {
1690 .rpc_proc = &rpcproc_null,
1691 .rpc_cred = cred,
1692 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001693 struct rpc_task_setup task_setup_data = {
1694 .rpc_client = clnt,
1695 .rpc_message = &msg,
1696 .callback_ops = &rpc_default_ops,
1697 .flags = flags,
1698 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001699 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001700}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001701EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001702
Trond Myklebust188fef12007-06-16 14:18:40 -04001703#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001704static void rpc_show_header(void)
1705{
Chuck Levercb3997b2008-05-21 17:09:41 -04001706 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1707 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001708}
1709
Chuck Lever38e886e2008-05-21 17:09:33 -04001710static void rpc_show_task(const struct rpc_clnt *clnt,
1711 const struct rpc_task *task)
1712{
1713 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001714 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001715
1716 if (RPC_IS_QUEUED(task))
1717 rpc_waitq = rpc_qname(task->tk_waitqueue);
1718
Chuck Levercb3997b2008-05-21 17:09:41 -04001719 /* map tk_action pointer to a function name; then trim off
1720 * the "+0x0 [sunrpc]" */
1721 sprint_symbol(action, (unsigned long)task->tk_action);
1722 p = strchr(action, '+');
1723 if (p)
1724 *p = '\0';
1725
1726 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1727 task->tk_pid, task->tk_flags, task->tk_status,
1728 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1729 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1730 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001731}
1732
Trond Myklebust188fef12007-06-16 14:18:40 -04001733void rpc_show_tasks(void)
1734{
1735 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001736 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001737 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001738
1739 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001740 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001741 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001742 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001743 if (!header) {
1744 rpc_show_header();
1745 header++;
1746 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001747 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001748 }
1749 spin_unlock(&clnt->cl_lock);
1750 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001751 spin_unlock(&rpc_client_lock);
1752}
1753#endif