blob: a417d5ab5dd753432ecf403646356a86d4fa50f5 [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\3c341b02007-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)) {
Matthew Wilcox150030b2007-12-06 16:24:39 -0500343 int err = rpc_ping(clnt, RPC_TASK_SOFT);
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;
Matthew Wilcox150030b2007-12-06 16:24:39 -0500531 err = rpc_ping(clnt, RPC_TASK_SOFT);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000532 if (err != 0) {
533 rpc_shutdown_client(clnt);
534 clnt = ERR_PTR(err);
535 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800536out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000537 return clnt;
538}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400539EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541/*
542 * Default callback for async RPC calls
543 */
544static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100545rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
547}
548
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100549static const struct rpc_call_ops rpc_default_ops = {
550 .rpc_call_done = rpc_default_callback,
551};
552
Trond Myklebustc970aa82007-07-14 15:39:59 -0400553/**
554 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
555 * @task_setup_data: pointer to task initialisation data
556 */
557struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400558{
559 struct rpc_task *task, *ret;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400560
Trond Myklebust84115e12007-07-14 15:39:59 -0400561 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400562 if (task == NULL) {
Trond Myklebust84115e12007-07-14 15:39:59 -0400563 rpc_release_calldata(task_setup_data->callback_ops,
564 task_setup_data->callback_data);
Trond Myklebust50859252007-10-25 18:19:37 -0400565 ret = ERR_PTR(-ENOMEM);
566 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400567 }
568
Trond Myklebustb3ef8b32007-10-25 18:32:34 -0400569 if (task->tk_status != 0) {
570 ret = ERR_PTR(task->tk_status);
571 rpc_put_task(task);
572 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400573 }
574 atomic_inc(&task->tk_count);
575 rpc_execute(task);
576 ret = task;
577out:
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400578 return ret;
579}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400580EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400581
582/**
583 * rpc_call_sync - Perform a synchronous RPC call
584 * @clnt: pointer to RPC client
585 * @msg: RPC call parameters
586 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500588int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
590 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400591 struct rpc_task_setup task_setup_data = {
592 .rpc_client = clnt,
593 .rpc_message = msg,
594 .callback_ops = &rpc_default_ops,
595 .flags = flags,
596 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400597 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 BUG_ON(flags & RPC_TASK_ASYNC);
600
Trond Myklebustc970aa82007-07-14 15:39:59 -0400601 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400602 if (IS_ERR(task))
603 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100604 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800605 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return status;
607}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400608EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400610/**
611 * rpc_call_async - Perform an asynchronous RPC call
612 * @clnt: pointer to RPC client
613 * @msg: RPC call parameters
614 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800615 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400616 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 */
618int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500619rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100620 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
622 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400623 struct rpc_task_setup task_setup_data = {
624 .rpc_client = clnt,
625 .rpc_message = msg,
626 .callback_ops = tk_ops,
627 .callback_data = data,
628 .flags = flags|RPC_TASK_ASYNC,
629 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Trond Myklebustc970aa82007-07-14 15:39:59 -0400631 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400632 if (IS_ERR(task))
633 return PTR_ERR(task);
634 rpc_put_task(task);
635 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400637EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400639#if defined(CONFIG_NFS_V4_1)
640/**
641 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
642 * rpc_execute against it
643 * @ops: RPC call ops
644 */
645struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
646 const struct rpc_call_ops *tk_ops)
647{
648 struct rpc_task *task;
649 struct xdr_buf *xbufp = &req->rq_snd_buf;
650 struct rpc_task_setup task_setup_data = {
651 .callback_ops = tk_ops,
652 };
653
654 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
655 /*
656 * Create an rpc_task to send the data
657 */
658 task = rpc_new_task(&task_setup_data);
659 if (!task) {
660 xprt_free_bc_request(req);
661 goto out;
662 }
663 task->tk_rqstp = req;
664
665 /*
666 * Set up the xdr_buf length.
667 * This also indicates that the buffer is XDR encoded already.
668 */
669 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
670 xbufp->tail[0].iov_len;
671
672 task->tk_action = call_bc_transmit;
673 atomic_inc(&task->tk_count);
674 BUG_ON(atomic_read(&task->tk_count) != 2);
675 rpc_execute(task);
676
677out:
678 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
679 return task;
680}
681#endif /* CONFIG_NFS_V4_1 */
682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400684rpc_call_start(struct rpc_task *task)
685{
686 task->tk_action = call_start;
687}
688EXPORT_SYMBOL_GPL(rpc_call_start);
689
Chuck Levered394402006-08-22 20:06:17 -0400690/**
691 * rpc_peeraddr - extract remote peer address from clnt's xprt
692 * @clnt: RPC client structure
693 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800694 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400695 *
696 * Returns the number of bytes that are actually in the stored address.
697 */
698size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
699{
700 size_t bytes;
701 struct rpc_xprt *xprt = clnt->cl_xprt;
702
703 bytes = sizeof(xprt->addr);
704 if (bytes > bufsize)
705 bytes = bufsize;
706 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400707 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400708}
Chuck Leverb86acd52006-08-22 20:06:22 -0400709EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400710
Chuck Leverf425eba2006-08-22 20:06:18 -0400711/**
712 * rpc_peeraddr2str - return remote peer address in printable format
713 * @clnt: RPC client structure
714 * @format: address format
715 *
716 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500717const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
718 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400719{
720 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500721
722 if (xprt->address_strings[format] != NULL)
723 return xprt->address_strings[format];
724 else
725 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400726}
Chuck Leverb86acd52006-08-22 20:06:22 -0400727EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729void
730rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
731{
732 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700733 if (xprt->ops->set_buffer_size)
734 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400736EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738/*
739 * Return size of largest payload RPC client can support, in bytes
740 *
741 * For stream transports, this is one RPC record fragment (see RFC
742 * 1831), as we don't support multi-record requests yet. For datagram
743 * transports, this is the size of an IP packet minus the IP, UDP, and
744 * RPC header sizes.
745 */
746size_t rpc_max_payload(struct rpc_clnt *clnt)
747{
748 return clnt->cl_xprt->max_payload;
749}
Chuck Leverb86acd52006-08-22 20:06:22 -0400750EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Chuck Lever35f5a422006-01-03 09:55:50 +0100752/**
753 * rpc_force_rebind - force transport to check that remote port is unchanged
754 * @clnt: client to rebind
755 *
756 */
757void rpc_force_rebind(struct rpc_clnt *clnt)
758{
759 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400760 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100761}
Chuck Leverb86acd52006-08-22 20:06:22 -0400762EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400765 * Restart an (async) RPC call from the call_prepare state.
766 * Usually called from within the exit handler.
767 */
768void
769rpc_restart_call_prepare(struct rpc_task *task)
770{
771 if (RPC_ASSASSINATED(task))
772 return;
773 task->tk_action = rpc_prepare_task;
774}
775EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
776
777/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 * Restart an (async) RPC call. Usually called from within the
779 * exit handler.
780 */
781void
782rpc_restart_call(struct rpc_task *task)
783{
784 if (RPC_ASSASSINATED(task))
785 return;
786
787 task->tk_action = call_start;
788}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400789EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Chuck Lever3748f1e2008-05-21 17:09:12 -0400791#ifdef RPC_DEBUG
792static const char *rpc_proc_name(const struct rpc_task *task)
793{
794 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
795
796 if (proc) {
797 if (proc->p_name)
798 return proc->p_name;
799 else
800 return "NULL";
801 } else
802 return "no proc";
803}
804#endif
805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806/*
807 * 0. Initial state
808 *
809 * Other FSM states can be visited zero or more times, but
810 * this state is visited exactly once for each RPC.
811 */
812static void
813call_start(struct rpc_task *task)
814{
815 struct rpc_clnt *clnt = task->tk_client;
816
Chuck Lever3748f1e2008-05-21 17:09:12 -0400817 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500818 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400819 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500820 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
822 /* Increment call count */
823 task->tk_msg.rpc_proc->p_count++;
824 clnt->cl_stats->rpccnt++;
825 task->tk_action = call_reserve;
826}
827
828/*
829 * 1. Reserve an RPC call slot
830 */
831static void
832call_reserve(struct rpc_task *task)
833{
Chuck Lever46121cf2007-01-31 12:14:08 -0500834 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 if (!rpcauth_uptodatecred(task)) {
837 task->tk_action = call_refresh;
838 return;
839 }
840
841 task->tk_status = 0;
842 task->tk_action = call_reserveresult;
843 xprt_reserve(task);
844}
845
846/*
847 * 1b. Grok the result of xprt_reserve()
848 */
849static void
850call_reserveresult(struct rpc_task *task)
851{
852 int status = task->tk_status;
853
Chuck Lever46121cf2007-01-31 12:14:08 -0500854 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
856 /*
857 * After a call to xprt_reserve(), we must have either
858 * a request slot or else an error status.
859 */
860 task->tk_status = 0;
861 if (status >= 0) {
862 if (task->tk_rqstp) {
863 task->tk_action = call_allocate;
864 return;
865 }
866
867 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800868 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 rpc_exit(task, -EIO);
870 return;
871 }
872
873 /*
874 * Even though there was an error, we may have acquired
875 * a request slot somehow. Make sure not to leak it.
876 */
877 if (task->tk_rqstp) {
878 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800879 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 xprt_release(task);
881 }
882
883 switch (status) {
884 case -EAGAIN: /* woken up; retry */
885 task->tk_action = call_reserve;
886 return;
887 case -EIO: /* probably a shutdown */
888 break;
889 default:
890 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800891 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 break;
893 }
894 rpc_exit(task, status);
895}
896
897/*
898 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100899 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 */
901static void
902call_allocate(struct rpc_task *task)
903{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400904 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100905 struct rpc_rqst *req = task->tk_rqstp;
906 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400907 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
Chuck Lever46121cf2007-01-31 12:14:08 -0500909 dprint_status(task);
910
Chuck Lever2bea90d2007-03-29 16:47:53 -0400911 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400913
Chuck Lever02107142006-01-03 09:55:49 +0100914 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 return;
916
Chuck Lever2bea90d2007-03-29 16:47:53 -0400917 if (proc->p_proc != 0) {
918 BUG_ON(proc->p_arglen == 0);
919 if (proc->p_decode != NULL)
920 BUG_ON(proc->p_replen == 0);
921 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Chuck Lever2bea90d2007-03-29 16:47:53 -0400923 /*
924 * Calculate the size (in quads) of the RPC call
925 * and reply headers, and convert both values
926 * to byte sizes.
927 */
928 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
929 req->rq_callsize <<= 2;
930 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
931 req->rq_rcvsize <<= 2;
932
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400933 req->rq_buffer = xprt->ops->buf_alloc(task,
934 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -0400935 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 return;
Chuck Lever46121cf2007-01-31 12:14:08 -0500937
938 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Trond Myklebust14b218a2005-06-22 17:16:28 +0000940 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -0400941 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 rpc_delay(task, HZ>>4);
943 return;
944 }
945
946 rpc_exit(task, -ERESTARTSYS);
947}
948
Trond Myklebust940e3312005-11-09 21:45:24 -0500949static inline int
950rpc_task_need_encode(struct rpc_task *task)
951{
952 return task->tk_rqstp->rq_snd_buf.len == 0;
953}
954
955static inline void
956rpc_task_force_reencode(struct rpc_task *task)
957{
958 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -0400959 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -0500960}
961
Chuck Lever2bea90d2007-03-29 16:47:53 -0400962static inline void
963rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
964{
965 buf->head[0].iov_base = start;
966 buf->head[0].iov_len = len;
967 buf->tail[0].iov_len = 0;
968 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -0400969 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400970 buf->len = 0;
971 buf->buflen = len;
972}
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974/*
975 * 3. Encode arguments of an RPC call
976 */
977static void
Chuck Leverb0e1c572008-05-21 17:09:19 -0400978rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700982 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Chuck Lever46121cf2007-01-31 12:14:08 -0500984 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
Chuck Lever2bea90d2007-03-29 16:47:53 -0400986 rpc_xdr_buf_init(&req->rq_snd_buf,
987 req->rq_buffer,
988 req->rq_callsize);
989 rpc_xdr_buf_init(&req->rq_rcv_buf,
990 (char *)req->rq_buffer + req->rq_callsize,
991 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
Chuck Leverb0e1c572008-05-21 17:09:19 -0400993 p = rpc_encode_header(task);
994 if (p == NULL) {
995 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 rpc_exit(task, -EIO);
997 return;
998 }
Chuck Leverb0e1c572008-05-21 17:09:19 -0400999
1000 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001001 if (encode == NULL)
1002 return;
1003
1004 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1005 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006}
1007
1008/*
1009 * 4. Get the server port number if not yet set
1010 */
1011static void
1012call_bind(struct rpc_task *task)
1013{
Chuck Leverec739ef2006-08-22 20:06:15 -04001014 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Chuck Lever46121cf2007-01-31 12:14:08 -05001016 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Chuck Leverda351872005-08-11 16:25:11 -04001018 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001019 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001020 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001021 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001022 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 }
1024}
1025
1026/*
Chuck Leverda351872005-08-11 16:25:11 -04001027 * 4a. Sort out bind result
1028 */
1029static void
1030call_bind_status(struct rpc_task *task)
1031{
Chuck Lever906462a2007-09-11 18:00:47 -04001032 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001033
1034 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001035 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001036 task->tk_status = 0;
1037 task->tk_action = call_connect;
1038 return;
1039 }
1040
1041 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001042 case -ENOMEM:
1043 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1044 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001045 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001046 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001047 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1048 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001049 /* fail immediately if this is an RPC ping */
1050 if (task->tk_msg.rpc_proc->p_proc == 0) {
1051 status = -EOPNOTSUPP;
1052 break;
1053 }
Chuck Leverea635a52005-10-06 23:12:58 -04001054 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001055 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001056 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001057 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001058 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001059 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001060 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001061 /* server doesn't support any rpcbind version we know of */
Chuck Lever46121cf2007-01-31 12:14:08 -05001062 dprintk("RPC: %5u remote rpcbind service unavailable\n",
Chuck Leverda351872005-08-11 16:25:11 -04001063 task->tk_pid);
1064 break;
1065 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001066 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001067 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001068 task->tk_status = 0;
1069 task->tk_action = call_bind;
1070 return;
Chuck Leverda351872005-08-11 16:25:11 -04001071 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001072 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001073 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001074 }
1075
1076 rpc_exit(task, status);
1077 return;
1078
Trond Myklebustda458282006-08-31 15:44:52 -04001079retry_timeout:
1080 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001081}
1082
1083/*
1084 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 */
1086static void
1087call_connect(struct rpc_task *task)
1088{
Chuck Leverda351872005-08-11 16:25:11 -04001089 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Chuck Lever46121cf2007-01-31 12:14:08 -05001091 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001092 task->tk_pid, xprt,
1093 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Chuck Leverda351872005-08-11 16:25:11 -04001095 task->tk_action = call_transmit;
1096 if (!xprt_connected(xprt)) {
1097 task->tk_action = call_connect_status;
1098 if (task->tk_status < 0)
1099 return;
1100 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102}
1103
1104/*
Chuck Leverda351872005-08-11 16:25:11 -04001105 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 */
1107static void
1108call_connect_status(struct rpc_task *task)
1109{
1110 struct rpc_clnt *clnt = task->tk_client;
1111 int status = task->tk_status;
1112
Chuck Lever46121cf2007-01-31 12:14:08 -05001113 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001114
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001116 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 clnt->cl_stats->netreconn++;
1118 task->tk_action = call_transmit;
1119 return;
1120 }
1121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001123 /* if soft mounted, test if we've timed out */
1124 case -ETIMEDOUT:
1125 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001126 break;
1127 default:
1128 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 }
1130}
1131
1132/*
1133 * 5. Transmit the RPC request, and wait for reply
1134 */
1135static void
1136call_transmit(struct rpc_task *task)
1137{
Chuck Lever46121cf2007-01-31 12:14:08 -05001138 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
1140 task->tk_action = call_status;
1141 if (task->tk_status < 0)
1142 return;
1143 task->tk_status = xprt_prepare_transmit(task);
1144 if (task->tk_status != 0)
1145 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001146 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001148 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001149 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001150 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001151 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001152 if (task->tk_status != 0) {
1153 /* Was the error nonfatal? */
1154 if (task->tk_status == -EAGAIN)
1155 rpc_delay(task, HZ >> 4);
1156 else
1157 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001158 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001159 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 xprt_transmit(task);
1162 if (task->tk_status < 0)
1163 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001164 /*
1165 * On success, ensure that we call xprt_end_transmit() before sleeping
1166 * in order to allow access to the socket to other RPC requests.
1167 */
1168 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001169 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001170 return;
1171 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001172 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001173}
1174
1175/*
1176 * 5a. Handle cleanup after a transmission
1177 */
1178static void
1179call_transmit_status(struct rpc_task *task)
1180{
1181 task->tk_action = call_status;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001182 switch (task->tk_status) {
1183 case -EAGAIN:
1184 break;
1185 default:
1186 xprt_end_transmit(task);
1187 /*
1188 * Special cases: if we've been waiting on the
1189 * socket's write_space() callback, or if the
1190 * socket just returned a connection error,
1191 * then hold onto the transport lock.
1192 */
1193 case -ECONNREFUSED:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001194 case -ECONNRESET:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001195 case -ENOTCONN:
1196 case -EHOSTDOWN:
1197 case -EHOSTUNREACH:
1198 case -ENETUNREACH:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001199 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001200 rpc_task_force_reencode(task);
1201 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202}
1203
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001204#if defined(CONFIG_NFS_V4_1)
1205/*
1206 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1207 * addition, disconnect on connectivity errors.
1208 */
1209static void
1210call_bc_transmit(struct rpc_task *task)
1211{
1212 struct rpc_rqst *req = task->tk_rqstp;
1213
1214 BUG_ON(task->tk_status != 0);
1215 task->tk_status = xprt_prepare_transmit(task);
1216 if (task->tk_status == -EAGAIN) {
1217 /*
1218 * Could not reserve the transport. Try again after the
1219 * transport is released.
1220 */
1221 task->tk_status = 0;
1222 task->tk_action = call_bc_transmit;
1223 return;
1224 }
1225
1226 task->tk_action = rpc_exit_task;
1227 if (task->tk_status < 0) {
1228 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1229 "error: %d\n", task->tk_status);
1230 return;
1231 }
1232
1233 xprt_transmit(task);
1234 xprt_end_transmit(task);
1235 dprint_status(task);
1236 switch (task->tk_status) {
1237 case 0:
1238 /* Success */
1239 break;
1240 case -EHOSTDOWN:
1241 case -EHOSTUNREACH:
1242 case -ENETUNREACH:
1243 case -ETIMEDOUT:
1244 /*
1245 * Problem reaching the server. Disconnect and let the
1246 * forechannel reestablish the connection. The server will
1247 * have to retransmit the backchannel request and we'll
1248 * reprocess it. Since these ops are idempotent, there's no
1249 * need to cache our reply at this time.
1250 */
1251 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1252 "error: %d\n", task->tk_status);
1253 xprt_conditional_disconnect(task->tk_xprt,
1254 req->rq_connect_cookie);
1255 break;
1256 default:
1257 /*
1258 * We were unable to reply and will have to drop the
1259 * request. The server should reconnect and retransmit.
1260 */
1261 BUG_ON(task->tk_status == -EAGAIN);
1262 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1263 "error: %d\n", task->tk_status);
1264 break;
1265 }
1266 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1267}
1268#endif /* CONFIG_NFS_V4_1 */
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270/*
1271 * 6. Sort out the RPC call status
1272 */
1273static void
1274call_status(struct rpc_task *task)
1275{
1276 struct rpc_clnt *clnt = task->tk_client;
1277 struct rpc_rqst *req = task->tk_rqstp;
1278 int status;
1279
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001280 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1281 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Chuck Lever46121cf2007-01-31 12:14:08 -05001283 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
1285 status = task->tk_status;
1286 if (status >= 0) {
1287 task->tk_action = call_decode;
1288 return;
1289 }
1290
1291 task->tk_status = 0;
1292 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001293 case -EHOSTDOWN:
1294 case -EHOSTUNREACH:
1295 case -ENETUNREACH:
1296 /*
1297 * Delay any retries for 3 seconds, then handle as if it
1298 * were a timeout.
1299 */
1300 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 case -ETIMEDOUT:
1302 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001303 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001304 xprt_conditional_disconnect(task->tk_xprt,
1305 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001307 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001309 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001310 rpc_delay(task, 3*HZ);
1311 case -EPIPE:
1312 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 task->tk_action = call_bind;
1314 break;
1315 case -EAGAIN:
1316 task->tk_action = call_transmit;
1317 break;
1318 case -EIO:
1319 /* shutdown or soft timeout */
1320 rpc_exit(task, status);
1321 break;
1322 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001323 if (clnt->cl_chatty)
1324 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 clnt->cl_protname, -status);
1326 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 }
1328}
1329
1330/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001331 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 * We do not release the request slot, so we keep using the
1333 * same XID for all retransmits.
1334 */
1335static void
1336call_timeout(struct rpc_task *task)
1337{
1338 struct rpc_clnt *clnt = task->tk_client;
1339
1340 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001341 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 goto retry;
1343 }
1344
Chuck Lever46121cf2007-01-31 12:14:08 -05001345 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001346 task->tk_timeouts++;
1347
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001349 if (clnt->cl_chatty)
1350 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 clnt->cl_protname, clnt->cl_server);
1352 rpc_exit(task, -EIO);
1353 return;
1354 }
1355
Chuck Leverf518e352006-01-03 09:55:52 +01001356 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001358 if (clnt->cl_chatty)
1359 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 clnt->cl_protname, clnt->cl_server);
1361 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001362 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001363 /*
1364 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1365 * event? RFC2203 requires the server to drop all such requests.
1366 */
1367 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
1369retry:
1370 clnt->cl_stats->rpcretrans++;
1371 task->tk_action = call_bind;
1372 task->tk_status = 0;
1373}
1374
1375/*
1376 * 7. Decode the RPC reply
1377 */
1378static void
1379call_decode(struct rpc_task *task)
1380{
1381 struct rpc_clnt *clnt = task->tk_client;
1382 struct rpc_rqst *req = task->tk_rqstp;
1383 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001384 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Chuck Lever46121cf2007-01-31 12:14:08 -05001386 dprintk("RPC: %5u call_decode (status %d)\n",
1387 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
Chuck Leverf518e352006-01-03 09:55:52 +01001389 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001390 if (clnt->cl_chatty)
1391 printk(KERN_NOTICE "%s: server %s OK\n",
1392 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1394 }
1395
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001396 /*
1397 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001398 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001399 */
1400 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 req->rq_rcv_buf.len = req->rq_private_buf.len;
1402
1403 /* Check that the softirq receive buffer is valid */
1404 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1405 sizeof(req->rq_rcv_buf)) != 0);
1406
Trond Myklebust1e799b62008-03-21 16:19:41 -04001407 if (req->rq_rcv_buf.len < 12) {
1408 if (!RPC_IS_SOFT(task)) {
1409 task->tk_action = call_bind;
1410 clnt->cl_stats->rpcretrans++;
1411 goto out_retry;
1412 }
1413 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1414 clnt->cl_protname, task->tk_status);
1415 task->tk_action = call_timeout;
1416 goto out_retry;
1417 }
1418
Chuck Leverb0e1c572008-05-21 17:09:19 -04001419 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001420 if (IS_ERR(p)) {
1421 if (p == ERR_PTR(-EAGAIN))
1422 goto out_retry;
1423 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 }
1425
Trond Myklebustabbcf282006-01-03 09:55:03 +01001426 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001428 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1430 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001431 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001432 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1433 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 return;
1435out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001437 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001438 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001439 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001440 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001441 xprt_conditional_disconnect(task->tk_xprt,
1442 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001443 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444}
1445
1446/*
1447 * 8. Refresh the credentials if rejected by the server
1448 */
1449static void
1450call_refresh(struct rpc_task *task)
1451{
Chuck Lever46121cf2007-01-31 12:14:08 -05001452 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 task->tk_action = call_refreshresult;
1455 task->tk_status = 0;
1456 task->tk_client->cl_stats->rpcauthrefresh++;
1457 rpcauth_refreshcred(task);
1458}
1459
1460/*
1461 * 8a. Process the results of a credential refresh
1462 */
1463static void
1464call_refreshresult(struct rpc_task *task)
1465{
1466 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001467
1468 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
1470 task->tk_status = 0;
1471 task->tk_action = call_reserve;
1472 if (status >= 0 && rpcauth_uptodatecred(task))
1473 return;
1474 if (status == -EACCES) {
1475 rpc_exit(task, -EACCES);
1476 return;
1477 }
1478 task->tk_action = call_refresh;
1479 if (status != -ETIMEDOUT)
1480 rpc_delay(task, 3*HZ);
1481 return;
1482}
1483
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001484static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001485rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486{
1487 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001489 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
1491 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001492
1493 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 *p++ = req->rq_xid; /* XID */
1495 *p++ = htonl(RPC_CALL); /* CALL */
1496 *p++ = htonl(RPC_VERSION); /* RPC version */
1497 *p++ = htonl(clnt->cl_prog); /* program number */
1498 *p++ = htonl(clnt->cl_vers); /* program version */
1499 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001500 p = rpcauth_marshcred(task, p);
1501 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1502 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503}
1504
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001505static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001506rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
1508 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1509 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001510 __be32 *p = iov->iov_base;
1511 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 int error = -EACCES;
1513
David Howellse8896492006-08-24 15:44:19 -04001514 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1515 /* RFC-1014 says that the representation of XDR data must be a
1516 * multiple of four bytes
1517 * - if it isn't pointer subtraction in the NFS client may give
1518 * undefined results
1519 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001520 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001521 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001522 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001523 goto out_eio;
1524 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 if ((len -= 3) < 0)
1526 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001528 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001530 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001531 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001532 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001534
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1536 if (--len < 0)
1537 goto out_overflow;
1538 switch ((n = ntohl(*p++))) {
1539 case RPC_AUTH_ERROR:
1540 break;
1541 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001542 dprintk("RPC: %5u %s: RPC call version "
1543 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001544 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001545 error = -EPROTONOSUPPORT;
1546 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001548 dprintk("RPC: %5u %s: RPC call rejected, "
1549 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001550 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 goto out_eio;
1552 }
1553 if (--len < 0)
1554 goto out_overflow;
1555 switch ((n = ntohl(*p++))) {
1556 case RPC_AUTH_REJECTEDCRED:
1557 case RPC_AUTH_REJECTEDVERF:
1558 case RPCSEC_GSS_CREDPROBLEM:
1559 case RPCSEC_GSS_CTXPROBLEM:
1560 if (!task->tk_cred_retry)
1561 break;
1562 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001563 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001564 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001566 /* Ensure we obtain a new XID! */
1567 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001569 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 case RPC_AUTH_BADCRED:
1571 case RPC_AUTH_BADVERF:
1572 /* possibly garbled cred/verf? */
1573 if (!task->tk_garb_retry)
1574 break;
1575 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001576 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001577 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001579 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001581 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001582 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 break;
1584 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001585 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001586 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 error = -EIO;
1588 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001589 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001590 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 goto out_err;
1592 }
1593 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001594 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001595 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001596 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001598 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 if (len < 0)
1600 goto out_overflow;
1601 switch ((n = ntohl(*p++))) {
1602 case RPC_SUCCESS:
1603 return p;
1604 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001605 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001606 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 (unsigned int)task->tk_client->cl_prog,
1608 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001609 error = -EPFNOSUPPORT;
1610 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001612 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001613 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 (unsigned int)task->tk_client->cl_prog,
1615 (unsigned int)task->tk_client->cl_vers,
1616 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001617 error = -EPROTONOSUPPORT;
1618 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001620 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001621 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001622 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001623 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 task->tk_client->cl_prog,
1625 task->tk_client->cl_vers,
1626 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001627 error = -EOPNOTSUPP;
1628 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001630 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001631 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 break; /* retry */
1633 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001634 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001635 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 /* Also retry */
1637 }
1638
Trond Myklebustabbcf282006-01-03 09:55:03 +01001639out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 task->tk_client->cl_stats->rpcgarbage++;
1641 if (task->tk_garb_retry) {
1642 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001643 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001644 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001646out_retry:
1647 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649out_eio:
1650 error = -EIO;
1651out_err:
1652 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001653 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001654 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001655 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001657 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001658 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001659 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001661
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001662static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001663{
1664 return 0;
1665}
1666
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001667static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001668{
1669 return 0;
1670}
1671
1672static struct rpc_procinfo rpcproc_null = {
1673 .p_encode = rpcproc_encode_null,
1674 .p_decode = rpcproc_decode_null,
1675};
1676
Trond Myklebust64c91a12007-06-23 10:17:16 -04001677static int rpc_ping(struct rpc_clnt *clnt, int flags)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001678{
1679 struct rpc_message msg = {
1680 .rpc_proc = &rpcproc_null,
1681 };
1682 int err;
1683 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1684 err = rpc_call_sync(clnt, &msg, flags);
1685 put_rpccred(msg.rpc_cred);
1686 return err;
1687}
Trond Myklebust188fef12007-06-16 14:18:40 -04001688
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001689struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1690{
1691 struct rpc_message msg = {
1692 .rpc_proc = &rpcproc_null,
1693 .rpc_cred = cred,
1694 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001695 struct rpc_task_setup task_setup_data = {
1696 .rpc_client = clnt,
1697 .rpc_message = &msg,
1698 .callback_ops = &rpc_default_ops,
1699 .flags = flags,
1700 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001701 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001702}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001703EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001704
Trond Myklebust188fef12007-06-16 14:18:40 -04001705#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001706static void rpc_show_header(void)
1707{
Chuck Levercb3997b2008-05-21 17:09:41 -04001708 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1709 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001710}
1711
Chuck Lever38e886e2008-05-21 17:09:33 -04001712static void rpc_show_task(const struct rpc_clnt *clnt,
1713 const struct rpc_task *task)
1714{
1715 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001716 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001717
1718 if (RPC_IS_QUEUED(task))
1719 rpc_waitq = rpc_qname(task->tk_waitqueue);
1720
Chuck Levercb3997b2008-05-21 17:09:41 -04001721 /* map tk_action pointer to a function name; then trim off
1722 * the "+0x0 [sunrpc]" */
1723 sprint_symbol(action, (unsigned long)task->tk_action);
1724 p = strchr(action, '+');
1725 if (p)
1726 *p = '\0';
1727
1728 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1729 task->tk_pid, task->tk_flags, task->tk_status,
1730 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1731 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1732 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001733}
1734
Trond Myklebust188fef12007-06-16 14:18:40 -04001735void rpc_show_tasks(void)
1736{
1737 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001738 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001739 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001740
1741 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001742 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001743 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001744 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001745 if (!header) {
1746 rpc_show_header();
1747 header++;
1748 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001749 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001750 }
1751 spin_unlock(&clnt->cl_lock);
1752 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001753 spin_unlock(&rpc_client_lock);
1754}
1755#endif