blob: 3647c81fd68984c42e7ee25d26035d4b0e5e0e9c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
19 *
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
22 */
23
24#include <asm/system.h>
25
26#include <linux/module.h>
27#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040028#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040030#include <linux/namei.h>
31#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050034#include <linux/workqueue.h>
Chuck Lever510deb02007-12-10 14:56:24 -050035#include <linux/in6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050039#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040040#include <linux/sunrpc/bc_xprt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifdef RPC_DEBUG
45# define RPCDBG_FACILITY RPCDBG_CALL
46#endif
47
Chuck Lever46121cf2007-01-31 12:14:08 -050048#define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080050 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050051
Trond Myklebust188fef12007-06-16 14:18:40 -040052/*
53 * All RPC clients are linked into this list
54 */
55static LIST_HEAD(all_clients);
56static DEFINE_SPINLOCK(rpc_client_lock);
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
59
60
61static void call_start(struct rpc_task *task);
62static void call_reserve(struct rpc_task *task);
63static void call_reserveresult(struct rpc_task *task);
64static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065static void call_decode(struct rpc_task *task);
66static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040067static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068static void call_transmit(struct rpc_task *task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069#if defined(CONFIG_NFS_V4_1)
70static void call_bc_transmit(struct rpc_task *task);
71#endif /* CONFIG_NFS_V4_1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050073static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074static void call_refresh(struct rpc_task *task);
75static void call_refreshresult(struct rpc_task *task);
76static void call_timeout(struct rpc_task *task);
77static void call_connect(struct rpc_task *task);
78static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Chuck Leverb0e1c572008-05-21 17:09:19 -040080static __be32 *rpc_encode_header(struct rpc_task *task);
81static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050082static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040083
Trond Myklebust188fef12007-06-16 14:18:40 -040084static void rpc_register_client(struct rpc_clnt *clnt)
85{
86 spin_lock(&rpc_client_lock);
87 list_add(&clnt->cl_clients, &all_clients);
88 spin_unlock(&rpc_client_lock);
89}
90
91static void rpc_unregister_client(struct rpc_clnt *clnt)
92{
93 spin_lock(&rpc_client_lock);
94 list_del(&clnt->cl_clients);
95 spin_unlock(&rpc_client_lock);
96}
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98static int
99rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
100{
Trond Myklebustf1345852005-09-23 11:08:25 -0400101 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400102 struct nameidata nd;
103 struct path path;
104 char name[15];
105 struct qstr q = {
106 .name = name,
107 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 int error;
109
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400110 clnt->cl_path.mnt = ERR_PTR(-ENOENT);
111 clnt->cl_path.dentry = ERR_PTR(-ENOENT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 if (dir_name == NULL)
113 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500114
Trond Myklebust23ac6582009-08-09 15:14:25 -0400115 path.mnt = rpc_get_mount();
116 if (IS_ERR(path.mnt))
117 return PTR_ERR(path.mnt);
118 error = vfs_path_lookup(path.mnt->mnt_root, path.mnt, dir_name, 0, &nd);
119 if (error)
120 goto err;
Trond Myklebust54281542006-03-20 13:44:49 -0500121
Trond Myklebustf1345852005-09-23 11:08:25 -0400122 for (;;) {
Trond Myklebust23ac6582009-08-09 15:14:25 -0400123 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
124 name[sizeof(name) - 1] = '\0';
125 q.hash = full_name_hash(q.name, q.len);
126 path.dentry = rpc_create_client_dir(nd.path.dentry, &q, clnt);
127 if (!IS_ERR(path.dentry))
128 break;
129 error = PTR_ERR(path.dentry);
Trond Myklebustf1345852005-09-23 11:08:25 -0400130 if (error != -EEXIST) {
Trond Myklebust23ac6582009-08-09 15:14:25 -0400131 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
132 " %s/%s, error %d\n",
133 dir_name, name, error);
134 goto err_path_put;
Trond Myklebustf1345852005-09-23 11:08:25 -0400135 }
Christoph Hellwig278c9952005-07-24 23:53:01 +0100136 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400137 path_put(&nd.path);
138 clnt->cl_path = path;
139 return 0;
140err_path_put:
141 path_put(&nd.path);
142err:
143 rpc_put_mount();
144 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
Trond Myklebust698b6d02007-12-20 16:03:53 -0500147static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500149 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 struct rpc_version *version;
151 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000152 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400154 size_t len;
155
156 /* sanity check the name before trying to print it */
157 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500158 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400159 if (len > RPC_MAXNETNAMELEN)
160 goto out_no_rpciod;
161 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Chuck Lever46121cf2007-01-31 12:14:08 -0500163 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500164 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Trond Myklebust4ada5392007-06-14 17:26:17 -0400166 err = rpciod_up();
167 if (err)
168 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 err = -EINVAL;
170 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800171 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500172
173 if (args->version >= program->nrvers)
174 goto out_err;
175 version = program->version[args->version];
176 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 goto out_err;
178
179 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700180 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 if (!clnt)
182 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 clnt->cl_parent = clnt;
184
185 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 if (len > sizeof(clnt->cl_inline_name)) {
187 char *buf = kmalloc(len, GFP_KERNEL);
Trond Myklebust698b6d02007-12-20 16:03:53 -0500188 if (buf != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 clnt->cl_server = buf;
190 else
191 len = sizeof(clnt->cl_inline_name);
192 }
Trond Myklebust698b6d02007-12-20 16:03:53 -0500193 strlcpy(clnt->cl_server, args->servername, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
195 clnt->cl_xprt = xprt;
196 clnt->cl_procinfo = version->procs;
197 clnt->cl_maxproc = version->nrprocs;
198 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300199 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500202 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500203 err = -ENOMEM;
204 if (clnt->cl_metrics == NULL)
205 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500206 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400207 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400208 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Chuck Leverec739ef2006-08-22 20:06:15 -0400210 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 clnt->cl_autobind = 1;
212
Trond Myklebustba7392b2007-12-20 16:03:55 -0500213 clnt->cl_timeout = xprt->timeout;
214 if (args->timeout != NULL) {
215 memcpy(&clnt->cl_timeout_default, args->timeout,
216 sizeof(clnt->cl_timeout_default));
217 clnt->cl_timeout = &clnt->cl_timeout_default;
218 }
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500221 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500222 clnt->cl_principal = NULL;
223 if (args->client_name) {
224 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
225 if (!clnt->cl_principal)
226 goto out_no_principal;
227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Trond Myklebust34f52e32007-06-14 16:40:31 -0400229 kref_init(&clnt->cl_kref);
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
232 if (err < 0)
233 goto out_no_path;
234
Trond Myklebust698b6d02007-12-20 16:03:53 -0500235 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000236 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500238 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000239 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 goto out_no_auth;
241 }
242
243 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400244 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 if (clnt->cl_nodelen > UNX_MAXNODENAME)
246 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400247 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400248 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 return clnt;
250
251out_no_auth:
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400252 if (!IS_ERR(clnt->cl_path.dentry)) {
253 rpc_remove_client_dir(clnt->cl_path.dentry);
Trond Myklebust54281542006-03-20 13:44:49 -0500254 rpc_put_mount();
255 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500257 kfree(clnt->cl_principal);
258out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500259 rpc_free_iostats(clnt->cl_metrics);
260out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 if (clnt->cl_server != clnt->cl_inline_name)
262 kfree(clnt->cl_server);
263 kfree(clnt);
264out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400265 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800266out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400267 rpciod_down();
268out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 return ERR_PTR(err);
270}
271
Chuck Leverc2866762006-08-22 20:06:20 -0400272/*
273 * rpc_create - create an RPC client and transport with one call
274 * @args: rpc_clnt create argument structure
275 *
276 * Creates and initializes an RPC transport and an RPC client.
277 *
278 * It can ping the server in order to determine if it is up, and to see if
279 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
280 * this behavior so asynchronous tasks can also use rpc_create.
281 */
282struct rpc_clnt *rpc_create(struct rpc_create_args *args)
283{
284 struct rpc_xprt *xprt;
285 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400286 struct xprt_create xprtargs = {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400287 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200288 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200289 .dstaddr = args->address,
290 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300291 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200292 };
Chuck Lever510deb02007-12-10 14:56:24 -0500293 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400294
Chuck Leverc2866762006-08-22 20:06:20 -0400295 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400296 * If the caller chooses not to specify a hostname, whip
297 * up a string representation of the passed-in address.
298 */
299 if (args->servername == NULL) {
Chuck Lever510deb02007-12-10 14:56:24 -0500300 servername[0] = '\0';
301 switch (args->address->sa_family) {
302 case AF_INET: {
303 struct sockaddr_in *sin =
304 (struct sockaddr_in *)args->address;
Harvey Harrison21454aa2008-10-31 00:54:56 -0700305 snprintf(servername, sizeof(servername), "%pI4",
306 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500307 break;
308 }
309 case AF_INET6: {
310 struct sockaddr_in6 *sin =
311 (struct sockaddr_in6 *)args->address;
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700312 snprintf(servername, sizeof(servername), "%pI6",
Harvey Harrisonfdb46ee2008-10-28 16:10:17 -0700313 &sin->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500314 break;
315 }
316 default:
317 /* caller wants default server name, but
318 * address family isn't recognized. */
319 return ERR_PTR(-EINVAL);
320 }
Chuck Lever43780b82007-07-01 12:13:22 -0400321 args->servername = servername;
322 }
323
Chuck Lever510deb02007-12-10 14:56:24 -0500324 xprt = xprt_create_transport(&xprtargs);
325 if (IS_ERR(xprt))
326 return (struct rpc_clnt *)xprt;
327
Chuck Lever43780b82007-07-01 12:13:22 -0400328 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400329 * By default, kernel RPC client connects from a reserved port.
330 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
331 * but it is always enabled for rpciod, which handles the connect
332 * operation.
333 */
334 xprt->resvport = 1;
335 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
336 xprt->resvport = 0;
337
Trond Myklebust698b6d02007-12-20 16:03:53 -0500338 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400339 if (IS_ERR(clnt))
340 return clnt;
341
342 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500343 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400344 if (err != 0) {
345 rpc_shutdown_client(clnt);
346 return ERR_PTR(err);
347 }
348 }
349
350 clnt->cl_softrtry = 1;
351 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
352 clnt->cl_softrtry = 0;
353
Chuck Leverc2866762006-08-22 20:06:20 -0400354 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
355 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500356 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
357 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400358 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
359 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400360
361 return clnt;
362}
Chuck Leverb86acd52006-08-22 20:06:22 -0400363EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365/*
366 * This function clones the RPC client structure. It allows us to share the
367 * same transport while varying parameters such as the authentication
368 * flavour.
369 */
370struct rpc_clnt *
371rpc_clone_client(struct rpc_clnt *clnt)
372{
373 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500374 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200376 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 if (!new)
378 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400379 new->cl_parent = clnt;
380 /* Turn off autobind on clones */
381 new->cl_autobind = 0;
382 INIT_LIST_HEAD(&new->cl_tasks);
383 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500384 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500385 new->cl_metrics = rpc_alloc_iostats(clnt);
386 if (new->cl_metrics == NULL)
387 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500388 if (clnt->cl_principal) {
389 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
390 if (new->cl_principal == NULL)
391 goto out_no_principal;
392 }
Trond Myklebust34f52e32007-06-14 16:40:31 -0400393 kref_init(&new->cl_kref);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500394 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
395 if (err != 0)
396 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 if (new->cl_auth)
398 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400399 xprt_get(clnt->cl_xprt);
400 kref_get(&clnt->cl_kref);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400401 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400402 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500404out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500405 kfree(new->cl_principal);
406out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500407 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500408out_no_stats:
409 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800411 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500412 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400414EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400417 * Kill all tasks for the given client.
418 * XXX: kill their descendants as well?
419 */
420void rpc_killall_tasks(struct rpc_clnt *clnt)
421{
422 struct rpc_task *rovr;
423
424
425 if (list_empty(&clnt->cl_tasks))
426 return;
427 dprintk("RPC: killing all tasks for client %p\n", clnt);
428 /*
429 * Spin lock all_tasks to prevent changes...
430 */
431 spin_lock(&clnt->cl_lock);
432 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
433 if (!RPC_IS_ACTIVATED(rovr))
434 continue;
435 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
436 rovr->tk_flags |= RPC_TASK_KILLED;
437 rpc_exit(rovr, -EIO);
438 rpc_wake_up_queued_task(rovr->tk_waitqueue, rovr);
439 }
440 }
441 spin_unlock(&clnt->cl_lock);
442}
443EXPORT_SYMBOL_GPL(rpc_killall_tasks);
444
445/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400447 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400449void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400451 dprintk("RPC: shutting down %s client for %s\n",
452 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Trond Myklebust34f52e32007-06-14 16:40:31 -0400454 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800456 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400457 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 }
459
Trond Myklebust4c402b42007-06-14 16:40:32 -0400460 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400462EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
464/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400465 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400467static void
468rpc_free_client(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400470 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Chuck Lever46121cf2007-01-31 12:14:08 -0500472 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400474 if (!IS_ERR(clnt->cl_path.dentry)) {
475 rpc_remove_client_dir(clnt->cl_path.dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400476 rpc_put_mount();
477 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500478 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400479 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500480 goto out_free;
481 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 if (clnt->cl_server != clnt->cl_inline_name)
483 kfree(clnt->cl_server);
484out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400485 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500486 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500487 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500488 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400489 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400490 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492}
493
494/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400495 * Free an RPC client
496 */
497static void
498rpc_free_auth(struct kref *kref)
499{
500 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
501
502 if (clnt->cl_auth == NULL) {
503 rpc_free_client(kref);
504 return;
505 }
506
507 /*
508 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
509 * release remaining GSS contexts. This mechanism ensures
510 * that it can do so safely.
511 */
512 kref_init(kref);
513 rpcauth_release(clnt->cl_auth);
514 clnt->cl_auth = NULL;
515 kref_put(kref, rpc_free_client);
516}
517
518/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400519 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 */
521void
522rpc_release_client(struct rpc_clnt *clnt)
523{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400524 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Trond Myklebust34f52e32007-06-14 16:40:31 -0400526 if (list_empty(&clnt->cl_tasks))
527 wake_up(&destroy_wait);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400528 kref_put(&clnt->cl_kref, rpc_free_auth);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400529}
530
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000531/**
532 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800533 * @old: old rpc_client
534 * @program: rpc program to set
535 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000536 *
537 * Clones the rpc client and sets up a new RPC program. This is mainly
538 * of use for enabling different RPC programs to share the same transport.
539 * The Sun NFSv2/v3 ACL protocol can do this.
540 */
541struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
542 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400543 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000544{
545 struct rpc_clnt *clnt;
546 struct rpc_version *version;
547 int err;
548
549 BUG_ON(vers >= program->nrvers || !program->version[vers]);
550 version = program->version[vers];
551 clnt = rpc_clone_client(old);
552 if (IS_ERR(clnt))
553 goto out;
554 clnt->cl_procinfo = version->procs;
555 clnt->cl_maxproc = version->nrprocs;
556 clnt->cl_protname = program->name;
557 clnt->cl_prog = program->number;
558 clnt->cl_vers = version->number;
559 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500560 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000561 if (err != 0) {
562 rpc_shutdown_client(clnt);
563 clnt = ERR_PTR(err);
564 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800565out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000566 return clnt;
567}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400568EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000569
Trond Myklebust58f96122010-07-31 14:29:08 -0400570void rpc_task_release_client(struct rpc_task *task)
571{
572 struct rpc_clnt *clnt = task->tk_client;
573
574 if (clnt != NULL) {
575 /* Remove from client task list */
576 spin_lock(&clnt->cl_lock);
577 list_del(&task->tk_task);
578 spin_unlock(&clnt->cl_lock);
579 task->tk_client = NULL;
580
581 rpc_release_client(clnt);
582 }
583}
584
585static
586void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
587{
588 if (clnt != NULL) {
589 rpc_task_release_client(task);
590 task->tk_client = clnt;
591 kref_get(&clnt->cl_kref);
592 if (clnt->cl_softrtry)
593 task->tk_flags |= RPC_TASK_SOFT;
594 /* Add to the client's list of all tasks */
595 spin_lock(&clnt->cl_lock);
596 list_add_tail(&task->tk_task, &clnt->cl_tasks);
597 spin_unlock(&clnt->cl_lock);
598 }
599}
600
601static void
602rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
603{
604 if (msg != NULL) {
605 task->tk_msg.rpc_proc = msg->rpc_proc;
606 task->tk_msg.rpc_argp = msg->rpc_argp;
607 task->tk_msg.rpc_resp = msg->rpc_resp;
608 /* Bind the user cred */
609 rpcauth_bindcred(task, msg->rpc_cred, task->tk_flags);
610 }
611}
612
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613/*
614 * Default callback for async RPC calls
615 */
616static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100617rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
619}
620
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100621static const struct rpc_call_ops rpc_default_ops = {
622 .rpc_call_done = rpc_default_callback,
623};
624
Trond Myklebustc970aa82007-07-14 15:39:59 -0400625/**
626 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
627 * @task_setup_data: pointer to task initialisation data
628 */
629struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400630{
Trond Myklebust19445b92010-04-16 16:41:10 -0400631 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400632
Trond Myklebust84115e12007-07-14 15:39:59 -0400633 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400634 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400635 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400636
Trond Myklebust58f96122010-07-31 14:29:08 -0400637 rpc_task_set_client(task, task_setup_data->rpc_client);
638 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
639
640 if (task->tk_status != 0) {
641 int ret = task->tk_status;
642 rpc_put_task(task);
643 return ERR_PTR(ret);
644 }
645
646 if (task->tk_action == NULL)
647 rpc_call_start(task);
648
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400649 atomic_inc(&task->tk_count);
650 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400651out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400652 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400653}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400654EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400655
656/**
657 * rpc_call_sync - Perform a synchronous RPC call
658 * @clnt: pointer to RPC client
659 * @msg: RPC call parameters
660 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500662int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
664 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400665 struct rpc_task_setup task_setup_data = {
666 .rpc_client = clnt,
667 .rpc_message = msg,
668 .callback_ops = &rpc_default_ops,
669 .flags = flags,
670 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400671 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 BUG_ON(flags & RPC_TASK_ASYNC);
674
Trond Myklebustc970aa82007-07-14 15:39:59 -0400675 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400676 if (IS_ERR(task))
677 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100678 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800679 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 return status;
681}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400682EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400684/**
685 * rpc_call_async - Perform an asynchronous RPC call
686 * @clnt: pointer to RPC client
687 * @msg: RPC call parameters
688 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800689 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400690 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 */
692int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500693rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100694 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
696 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400697 struct rpc_task_setup task_setup_data = {
698 .rpc_client = clnt,
699 .rpc_message = msg,
700 .callback_ops = tk_ops,
701 .callback_data = data,
702 .flags = flags|RPC_TASK_ASYNC,
703 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Trond Myklebustc970aa82007-07-14 15:39:59 -0400705 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400706 if (IS_ERR(task))
707 return PTR_ERR(task);
708 rpc_put_task(task);
709 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400711EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400713#if defined(CONFIG_NFS_V4_1)
714/**
715 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
716 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400717 * @req: RPC request
718 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400719 */
720struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400721 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400722{
723 struct rpc_task *task;
724 struct xdr_buf *xbufp = &req->rq_snd_buf;
725 struct rpc_task_setup task_setup_data = {
726 .callback_ops = tk_ops,
727 };
728
729 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
730 /*
731 * Create an rpc_task to send the data
732 */
733 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400734 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400735 xprt_free_bc_request(req);
736 goto out;
737 }
738 task->tk_rqstp = req;
739
740 /*
741 * Set up the xdr_buf length.
742 * This also indicates that the buffer is XDR encoded already.
743 */
744 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
745 xbufp->tail[0].iov_len;
746
747 task->tk_action = call_bc_transmit;
748 atomic_inc(&task->tk_count);
749 BUG_ON(atomic_read(&task->tk_count) != 2);
750 rpc_execute(task);
751
752out:
753 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
754 return task;
755}
756#endif /* CONFIG_NFS_V4_1 */
757
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400759rpc_call_start(struct rpc_task *task)
760{
761 task->tk_action = call_start;
762}
763EXPORT_SYMBOL_GPL(rpc_call_start);
764
Chuck Levered394402006-08-22 20:06:17 -0400765/**
766 * rpc_peeraddr - extract remote peer address from clnt's xprt
767 * @clnt: RPC client structure
768 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800769 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400770 *
771 * Returns the number of bytes that are actually in the stored address.
772 */
773size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
774{
775 size_t bytes;
776 struct rpc_xprt *xprt = clnt->cl_xprt;
777
778 bytes = sizeof(xprt->addr);
779 if (bytes > bufsize)
780 bytes = bufsize;
781 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400782 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400783}
Chuck Leverb86acd52006-08-22 20:06:22 -0400784EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400785
Chuck Leverf425eba2006-08-22 20:06:18 -0400786/**
787 * rpc_peeraddr2str - return remote peer address in printable format
788 * @clnt: RPC client structure
789 * @format: address format
790 *
791 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500792const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
793 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400794{
795 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500796
797 if (xprt->address_strings[format] != NULL)
798 return xprt->address_strings[format];
799 else
800 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400801}
Chuck Leverb86acd52006-08-22 20:06:22 -0400802EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804void
805rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
806{
807 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700808 if (xprt->ops->set_buffer_size)
809 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400811EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
813/*
814 * Return size of largest payload RPC client can support, in bytes
815 *
816 * For stream transports, this is one RPC record fragment (see RFC
817 * 1831), as we don't support multi-record requests yet. For datagram
818 * transports, this is the size of an IP packet minus the IP, UDP, and
819 * RPC header sizes.
820 */
821size_t rpc_max_payload(struct rpc_clnt *clnt)
822{
823 return clnt->cl_xprt->max_payload;
824}
Chuck Leverb86acd52006-08-22 20:06:22 -0400825EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Chuck Lever35f5a422006-01-03 09:55:50 +0100827/**
828 * rpc_force_rebind - force transport to check that remote port is unchanged
829 * @clnt: client to rebind
830 *
831 */
832void rpc_force_rebind(struct rpc_clnt *clnt)
833{
834 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400835 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100836}
Chuck Leverb86acd52006-08-22 20:06:22 -0400837EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400840 * Restart an (async) RPC call from the call_prepare state.
841 * Usually called from within the exit handler.
842 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400843int
Andy Adamsonaae20062009-04-01 09:22:40 -0400844rpc_restart_call_prepare(struct rpc_task *task)
845{
846 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400847 return 0;
Andy Adamsonaae20062009-04-01 09:22:40 -0400848 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400849 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400850}
851EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
852
853/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 * Restart an (async) RPC call. Usually called from within the
855 * exit handler.
856 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400857int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858rpc_restart_call(struct rpc_task *task)
859{
860 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400861 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400863 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400865EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Chuck Lever3748f1e2008-05-21 17:09:12 -0400867#ifdef RPC_DEBUG
868static const char *rpc_proc_name(const struct rpc_task *task)
869{
870 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
871
872 if (proc) {
873 if (proc->p_name)
874 return proc->p_name;
875 else
876 return "NULL";
877 } else
878 return "no proc";
879}
880#endif
881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882/*
883 * 0. Initial state
884 *
885 * Other FSM states can be visited zero or more times, but
886 * this state is visited exactly once for each RPC.
887 */
888static void
889call_start(struct rpc_task *task)
890{
891 struct rpc_clnt *clnt = task->tk_client;
892
Chuck Lever3748f1e2008-05-21 17:09:12 -0400893 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500894 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400895 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500896 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897
898 /* Increment call count */
899 task->tk_msg.rpc_proc->p_count++;
900 clnt->cl_stats->rpccnt++;
901 task->tk_action = call_reserve;
902}
903
904/*
905 * 1. Reserve an RPC call slot
906 */
907static void
908call_reserve(struct rpc_task *task)
909{
Chuck Lever46121cf2007-01-31 12:14:08 -0500910 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
912 if (!rpcauth_uptodatecred(task)) {
913 task->tk_action = call_refresh;
914 return;
915 }
916
917 task->tk_status = 0;
918 task->tk_action = call_reserveresult;
919 xprt_reserve(task);
920}
921
922/*
923 * 1b. Grok the result of xprt_reserve()
924 */
925static void
926call_reserveresult(struct rpc_task *task)
927{
928 int status = task->tk_status;
929
Chuck Lever46121cf2007-01-31 12:14:08 -0500930 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932 /*
933 * After a call to xprt_reserve(), we must have either
934 * a request slot or else an error status.
935 */
936 task->tk_status = 0;
937 if (status >= 0) {
938 if (task->tk_rqstp) {
939 task->tk_action = call_allocate;
940 return;
941 }
942
943 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800944 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 rpc_exit(task, -EIO);
946 return;
947 }
948
949 /*
950 * Even though there was an error, we may have acquired
951 * a request slot somehow. Make sure not to leak it.
952 */
953 if (task->tk_rqstp) {
954 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800955 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 xprt_release(task);
957 }
958
959 switch (status) {
960 case -EAGAIN: /* woken up; retry */
961 task->tk_action = call_reserve;
962 return;
963 case -EIO: /* probably a shutdown */
964 break;
965 default:
966 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800967 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 break;
969 }
970 rpc_exit(task, status);
971}
972
973/*
974 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +0100975 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 */
977static void
978call_allocate(struct rpc_task *task)
979{
Trond Myklebust1be27f32007-06-27 14:29:04 -0400980 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +0100981 struct rpc_rqst *req = task->tk_rqstp;
982 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400983 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Chuck Lever46121cf2007-01-31 12:14:08 -0500985 dprint_status(task);
986
Chuck Lever2bea90d2007-03-29 16:47:53 -0400987 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -0400989
Chuck Lever02107142006-01-03 09:55:49 +0100990 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 return;
992
Chuck Lever2bea90d2007-03-29 16:47:53 -0400993 if (proc->p_proc != 0) {
994 BUG_ON(proc->p_arglen == 0);
995 if (proc->p_decode != NULL)
996 BUG_ON(proc->p_replen == 0);
997 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Chuck Lever2bea90d2007-03-29 16:47:53 -0400999 /*
1000 * Calculate the size (in quads) of the RPC call
1001 * and reply headers, and convert both values
1002 * to byte sizes.
1003 */
1004 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1005 req->rq_callsize <<= 2;
1006 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1007 req->rq_rcvsize <<= 2;
1008
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001009 req->rq_buffer = xprt->ops->buf_alloc(task,
1010 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001011 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001013
1014 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Trond Myklebust14b218a2005-06-22 17:16:28 +00001016 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001017 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 rpc_delay(task, HZ>>4);
1019 return;
1020 }
1021
1022 rpc_exit(task, -ERESTARTSYS);
1023}
1024
Trond Myklebust940e3312005-11-09 21:45:24 -05001025static inline int
1026rpc_task_need_encode(struct rpc_task *task)
1027{
1028 return task->tk_rqstp->rq_snd_buf.len == 0;
1029}
1030
1031static inline void
1032rpc_task_force_reencode(struct rpc_task *task)
1033{
1034 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001035 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001036}
1037
Chuck Lever2bea90d2007-03-29 16:47:53 -04001038static inline void
1039rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1040{
1041 buf->head[0].iov_base = start;
1042 buf->head[0].iov_len = len;
1043 buf->tail[0].iov_len = 0;
1044 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001045 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001046 buf->len = 0;
1047 buf->buflen = len;
1048}
1049
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050/*
1051 * 3. Encode arguments of an RPC call
1052 */
1053static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001054rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001058 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Chuck Lever46121cf2007-01-31 12:14:08 -05001060 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
Chuck Lever2bea90d2007-03-29 16:47:53 -04001062 rpc_xdr_buf_init(&req->rq_snd_buf,
1063 req->rq_buffer,
1064 req->rq_callsize);
1065 rpc_xdr_buf_init(&req->rq_rcv_buf,
1066 (char *)req->rq_buffer + req->rq_callsize,
1067 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
Chuck Leverb0e1c572008-05-21 17:09:19 -04001069 p = rpc_encode_header(task);
1070 if (p == NULL) {
1071 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 rpc_exit(task, -EIO);
1073 return;
1074 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001075
1076 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001077 if (encode == NULL)
1078 return;
1079
1080 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1081 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082}
1083
1084/*
1085 * 4. Get the server port number if not yet set
1086 */
1087static void
1088call_bind(struct rpc_task *task)
1089{
Chuck Leverec739ef2006-08-22 20:06:15 -04001090 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Chuck Lever46121cf2007-01-31 12:14:08 -05001092 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
Chuck Leverda351872005-08-11 16:25:11 -04001094 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001095 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001096 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001097 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001098 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 }
1100}
1101
1102/*
Chuck Leverda351872005-08-11 16:25:11 -04001103 * 4a. Sort out bind result
1104 */
1105static void
1106call_bind_status(struct rpc_task *task)
1107{
Chuck Lever906462a2007-09-11 18:00:47 -04001108 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001109
1110 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001111 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001112 task->tk_status = 0;
1113 task->tk_action = call_connect;
1114 return;
1115 }
1116
1117 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001118 case -ENOMEM:
1119 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1120 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001121 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001122 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001123 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1124 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001125 /* fail immediately if this is an RPC ping */
1126 if (task->tk_msg.rpc_proc->p_proc == 0) {
1127 status = -EOPNOTSUPP;
1128 break;
1129 }
Chuck Leverea635a52005-10-06 23:12:58 -04001130 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001131 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001132 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001133 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001134 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001135 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001136 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001137 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001138 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001139 task->tk_pid);
1140 break;
1141 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001142 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001143 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001144 task->tk_status = 0;
1145 task->tk_action = call_bind;
1146 return;
Chuck Lever012da152009-12-03 15:58:56 -05001147 case -ECONNREFUSED: /* connection problems */
1148 case -ECONNRESET:
1149 case -ENOTCONN:
1150 case -EHOSTDOWN:
1151 case -EHOSTUNREACH:
1152 case -ENETUNREACH:
1153 case -EPIPE:
1154 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1155 task->tk_pid, task->tk_status);
1156 if (!RPC_IS_SOFTCONN(task)) {
1157 rpc_delay(task, 5*HZ);
1158 goto retry_timeout;
1159 }
1160 status = task->tk_status;
1161 break;
Chuck Leverda351872005-08-11 16:25:11 -04001162 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001163 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001164 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001165 }
1166
1167 rpc_exit(task, status);
1168 return;
1169
Trond Myklebustda458282006-08-31 15:44:52 -04001170retry_timeout:
1171 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001172}
1173
1174/*
1175 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 */
1177static void
1178call_connect(struct rpc_task *task)
1179{
Chuck Leverda351872005-08-11 16:25:11 -04001180 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181
Chuck Lever46121cf2007-01-31 12:14:08 -05001182 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001183 task->tk_pid, xprt,
1184 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185
Chuck Leverda351872005-08-11 16:25:11 -04001186 task->tk_action = call_transmit;
1187 if (!xprt_connected(xprt)) {
1188 task->tk_action = call_connect_status;
1189 if (task->tk_status < 0)
1190 return;
1191 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193}
1194
1195/*
Chuck Leverda351872005-08-11 16:25:11 -04001196 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 */
1198static void
1199call_connect_status(struct rpc_task *task)
1200{
1201 struct rpc_clnt *clnt = task->tk_client;
1202 int status = task->tk_status;
1203
Chuck Lever46121cf2007-01-31 12:14:08 -05001204 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001205
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001207 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 clnt->cl_stats->netreconn++;
1209 task->tk_action = call_transmit;
1210 return;
1211 }
1212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001214 /* if soft mounted, test if we've timed out */
1215 case -ETIMEDOUT:
1216 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001217 break;
1218 default:
1219 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 }
1221}
1222
1223/*
1224 * 5. Transmit the RPC request, and wait for reply
1225 */
1226static void
1227call_transmit(struct rpc_task *task)
1228{
Chuck Lever46121cf2007-01-31 12:14:08 -05001229 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
1231 task->tk_action = call_status;
1232 if (task->tk_status < 0)
1233 return;
1234 task->tk_status = xprt_prepare_transmit(task);
1235 if (task->tk_status != 0)
1236 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001237 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001239 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001240 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001241 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001242 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001243 if (task->tk_status != 0) {
1244 /* Was the error nonfatal? */
1245 if (task->tk_status == -EAGAIN)
1246 rpc_delay(task, HZ >> 4);
1247 else
1248 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001249 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001250 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 xprt_transmit(task);
1253 if (task->tk_status < 0)
1254 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001255 /*
1256 * On success, ensure that we call xprt_end_transmit() before sleeping
1257 * in order to allow access to the socket to other RPC requests.
1258 */
1259 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001260 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001261 return;
1262 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001263 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001264}
1265
1266/*
1267 * 5a. Handle cleanup after a transmission
1268 */
1269static void
1270call_transmit_status(struct rpc_task *task)
1271{
1272 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001273
1274 /*
1275 * Common case: success. Force the compiler to put this
1276 * test first.
1277 */
1278 if (task->tk_status == 0) {
1279 xprt_end_transmit(task);
1280 rpc_task_force_reencode(task);
1281 return;
1282 }
1283
Trond Myklebust15f081c2009-03-11 14:37:57 -04001284 switch (task->tk_status) {
1285 case -EAGAIN:
1286 break;
1287 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001288 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001289 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001290 rpc_task_force_reencode(task);
1291 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001292 /*
1293 * Special cases: if we've been waiting on the
1294 * socket's write_space() callback, or if the
1295 * socket just returned a connection error,
1296 * then hold onto the transport lock.
1297 */
1298 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001299 case -EHOSTDOWN:
1300 case -EHOSTUNREACH:
1301 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001302 if (RPC_IS_SOFTCONN(task)) {
1303 xprt_end_transmit(task);
1304 rpc_exit(task, task->tk_status);
1305 break;
1306 }
1307 case -ECONNRESET:
1308 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001309 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001310 rpc_task_force_reencode(task);
1311 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312}
1313
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001314#if defined(CONFIG_NFS_V4_1)
1315/*
1316 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1317 * addition, disconnect on connectivity errors.
1318 */
1319static void
1320call_bc_transmit(struct rpc_task *task)
1321{
1322 struct rpc_rqst *req = task->tk_rqstp;
1323
1324 BUG_ON(task->tk_status != 0);
1325 task->tk_status = xprt_prepare_transmit(task);
1326 if (task->tk_status == -EAGAIN) {
1327 /*
1328 * Could not reserve the transport. Try again after the
1329 * transport is released.
1330 */
1331 task->tk_status = 0;
1332 task->tk_action = call_bc_transmit;
1333 return;
1334 }
1335
1336 task->tk_action = rpc_exit_task;
1337 if (task->tk_status < 0) {
1338 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1339 "error: %d\n", task->tk_status);
1340 return;
1341 }
1342
1343 xprt_transmit(task);
1344 xprt_end_transmit(task);
1345 dprint_status(task);
1346 switch (task->tk_status) {
1347 case 0:
1348 /* Success */
1349 break;
1350 case -EHOSTDOWN:
1351 case -EHOSTUNREACH:
1352 case -ENETUNREACH:
1353 case -ETIMEDOUT:
1354 /*
1355 * Problem reaching the server. Disconnect and let the
1356 * forechannel reestablish the connection. The server will
1357 * have to retransmit the backchannel request and we'll
1358 * reprocess it. Since these ops are idempotent, there's no
1359 * need to cache our reply at this time.
1360 */
1361 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1362 "error: %d\n", task->tk_status);
1363 xprt_conditional_disconnect(task->tk_xprt,
1364 req->rq_connect_cookie);
1365 break;
1366 default:
1367 /*
1368 * We were unable to reply and will have to drop the
1369 * request. The server should reconnect and retransmit.
1370 */
1371 BUG_ON(task->tk_status == -EAGAIN);
1372 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1373 "error: %d\n", task->tk_status);
1374 break;
1375 }
1376 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1377}
1378#endif /* CONFIG_NFS_V4_1 */
1379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380/*
1381 * 6. Sort out the RPC call status
1382 */
1383static void
1384call_status(struct rpc_task *task)
1385{
1386 struct rpc_clnt *clnt = task->tk_client;
1387 struct rpc_rqst *req = task->tk_rqstp;
1388 int status;
1389
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001390 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1391 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Chuck Lever46121cf2007-01-31 12:14:08 -05001393 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
1395 status = task->tk_status;
1396 if (status >= 0) {
1397 task->tk_action = call_decode;
1398 return;
1399 }
1400
1401 task->tk_status = 0;
1402 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001403 case -EHOSTDOWN:
1404 case -EHOSTUNREACH:
1405 case -ENETUNREACH:
1406 /*
1407 * Delay any retries for 3 seconds, then handle as if it
1408 * were a timeout.
1409 */
1410 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 case -ETIMEDOUT:
1412 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001413 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001414 xprt_conditional_disconnect(task->tk_xprt,
1415 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001417 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001419 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001420 rpc_delay(task, 3*HZ);
1421 case -EPIPE:
1422 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 task->tk_action = call_bind;
1424 break;
1425 case -EAGAIN:
1426 task->tk_action = call_transmit;
1427 break;
1428 case -EIO:
1429 /* shutdown or soft timeout */
1430 rpc_exit(task, status);
1431 break;
1432 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001433 if (clnt->cl_chatty)
1434 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 clnt->cl_protname, -status);
1436 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 }
1438}
1439
1440/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001441 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 * We do not release the request slot, so we keep using the
1443 * same XID for all retransmits.
1444 */
1445static void
1446call_timeout(struct rpc_task *task)
1447{
1448 struct rpc_clnt *clnt = task->tk_client;
1449
1450 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001451 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 goto retry;
1453 }
1454
Chuck Lever46121cf2007-01-31 12:14:08 -05001455 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001456 task->tk_timeouts++;
1457
Chuck Lever3a28bec2009-12-03 15:58:56 -05001458 if (RPC_IS_SOFTCONN(task)) {
1459 rpc_exit(task, -ETIMEDOUT);
1460 return;
1461 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001463 if (clnt->cl_chatty)
1464 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 clnt->cl_protname, clnt->cl_server);
1466 rpc_exit(task, -EIO);
1467 return;
1468 }
1469
Chuck Leverf518e35a2006-01-03 09:55:52 +01001470 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001472 if (clnt->cl_chatty)
1473 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 clnt->cl_protname, clnt->cl_server);
1475 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001476 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001477 /*
1478 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1479 * event? RFC2203 requires the server to drop all such requests.
1480 */
1481 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
1483retry:
1484 clnt->cl_stats->rpcretrans++;
1485 task->tk_action = call_bind;
1486 task->tk_status = 0;
1487}
1488
1489/*
1490 * 7. Decode the RPC reply
1491 */
1492static void
1493call_decode(struct rpc_task *task)
1494{
1495 struct rpc_clnt *clnt = task->tk_client;
1496 struct rpc_rqst *req = task->tk_rqstp;
1497 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001498 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
Chuck Lever46121cf2007-01-31 12:14:08 -05001500 dprintk("RPC: %5u call_decode (status %d)\n",
1501 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
Chuck Leverf518e35a2006-01-03 09:55:52 +01001503 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001504 if (clnt->cl_chatty)
1505 printk(KERN_NOTICE "%s: server %s OK\n",
1506 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1508 }
1509
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001510 /*
1511 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001512 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001513 */
1514 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 req->rq_rcv_buf.len = req->rq_private_buf.len;
1516
1517 /* Check that the softirq receive buffer is valid */
1518 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1519 sizeof(req->rq_rcv_buf)) != 0);
1520
Trond Myklebust1e799b62008-03-21 16:19:41 -04001521 if (req->rq_rcv_buf.len < 12) {
1522 if (!RPC_IS_SOFT(task)) {
1523 task->tk_action = call_bind;
1524 clnt->cl_stats->rpcretrans++;
1525 goto out_retry;
1526 }
1527 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1528 clnt->cl_protname, task->tk_status);
1529 task->tk_action = call_timeout;
1530 goto out_retry;
1531 }
1532
Chuck Leverb0e1c572008-05-21 17:09:19 -04001533 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001534 if (IS_ERR(p)) {
1535 if (p == ERR_PTR(-EAGAIN))
1536 goto out_retry;
1537 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 }
1539
Trond Myklebustabbcf282006-01-03 09:55:03 +01001540 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001542 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1544 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001545 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001546 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1547 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 return;
1549out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001551 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001552 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001553 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001554 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001555 xprt_conditional_disconnect(task->tk_xprt,
1556 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558}
1559
1560/*
1561 * 8. Refresh the credentials if rejected by the server
1562 */
1563static void
1564call_refresh(struct rpc_task *task)
1565{
Chuck Lever46121cf2007-01-31 12:14:08 -05001566 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 task->tk_action = call_refreshresult;
1569 task->tk_status = 0;
1570 task->tk_client->cl_stats->rpcauthrefresh++;
1571 rpcauth_refreshcred(task);
1572}
1573
1574/*
1575 * 8a. Process the results of a credential refresh
1576 */
1577static void
1578call_refreshresult(struct rpc_task *task)
1579{
1580 int status = task->tk_status;
Chuck Lever46121cf2007-01-31 12:14:08 -05001581
1582 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
1584 task->tk_status = 0;
1585 task->tk_action = call_reserve;
1586 if (status >= 0 && rpcauth_uptodatecred(task))
1587 return;
1588 if (status == -EACCES) {
1589 rpc_exit(task, -EACCES);
1590 return;
1591 }
1592 task->tk_action = call_refresh;
1593 if (status != -ETIMEDOUT)
1594 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595}
1596
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001597static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001598rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599{
1600 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001602 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
1604 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001605
1606 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 *p++ = req->rq_xid; /* XID */
1608 *p++ = htonl(RPC_CALL); /* CALL */
1609 *p++ = htonl(RPC_VERSION); /* RPC version */
1610 *p++ = htonl(clnt->cl_prog); /* program number */
1611 *p++ = htonl(clnt->cl_vers); /* program version */
1612 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001613 p = rpcauth_marshcred(task, p);
1614 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1615 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616}
1617
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001618static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001619rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620{
1621 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1622 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001623 __be32 *p = iov->iov_base;
1624 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 int error = -EACCES;
1626
David Howellse8896492006-08-24 15:44:19 -04001627 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1628 /* RFC-1014 says that the representation of XDR data must be a
1629 * multiple of four bytes
1630 * - if it isn't pointer subtraction in the NFS client may give
1631 * undefined results
1632 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001633 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001634 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001635 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001636 goto out_eio;
1637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 if ((len -= 3) < 0)
1639 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001641 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001643 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001644 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001645 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001647
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1649 if (--len < 0)
1650 goto out_overflow;
1651 switch ((n = ntohl(*p++))) {
1652 case RPC_AUTH_ERROR:
1653 break;
1654 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001655 dprintk("RPC: %5u %s: RPC call version "
1656 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001657 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001658 error = -EPROTONOSUPPORT;
1659 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001661 dprintk("RPC: %5u %s: RPC call rejected, "
1662 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001663 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 goto out_eio;
1665 }
1666 if (--len < 0)
1667 goto out_overflow;
1668 switch ((n = ntohl(*p++))) {
1669 case RPC_AUTH_REJECTEDCRED:
1670 case RPC_AUTH_REJECTEDVERF:
1671 case RPCSEC_GSS_CREDPROBLEM:
1672 case RPCSEC_GSS_CTXPROBLEM:
1673 if (!task->tk_cred_retry)
1674 break;
1675 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001676 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001677 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001679 /* Ensure we obtain a new XID! */
1680 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001682 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 case RPC_AUTH_BADCRED:
1684 case RPC_AUTH_BADVERF:
1685 /* possibly garbled cred/verf? */
1686 if (!task->tk_garb_retry)
1687 break;
1688 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001689 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001690 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001692 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001694 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001695 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 break;
1697 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001698 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001699 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 error = -EIO;
1701 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001702 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001703 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 goto out_err;
1705 }
1706 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001707 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001708 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001709 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001711 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 if (len < 0)
1713 goto out_overflow;
1714 switch ((n = ntohl(*p++))) {
1715 case RPC_SUCCESS:
1716 return p;
1717 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001718 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001719 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 (unsigned int)task->tk_client->cl_prog,
1721 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001722 error = -EPFNOSUPPORT;
1723 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001725 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001726 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 (unsigned int)task->tk_client->cl_prog,
1728 (unsigned int)task->tk_client->cl_vers,
1729 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001730 error = -EPROTONOSUPPORT;
1731 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001733 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001734 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001735 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001736 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 task->tk_client->cl_prog,
1738 task->tk_client->cl_vers,
1739 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001740 error = -EOPNOTSUPP;
1741 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001743 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001744 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 break; /* retry */
1746 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001747 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001748 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 /* Also retry */
1750 }
1751
Trond Myklebustabbcf282006-01-03 09:55:03 +01001752out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 task->tk_client->cl_stats->rpcgarbage++;
1754 if (task->tk_garb_retry) {
1755 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001756 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001757 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001759out_retry:
1760 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762out_eio:
1763 error = -EIO;
1764out_err:
1765 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001766 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001767 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001768 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001770 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001771 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001772 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001774
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001775static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001776{
1777 return 0;
1778}
1779
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001780static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001781{
1782 return 0;
1783}
1784
1785static struct rpc_procinfo rpcproc_null = {
1786 .p_encode = rpcproc_encode_null,
1787 .p_decode = rpcproc_decode_null,
1788};
1789
Chuck Levercaabea82009-12-03 15:58:56 -05001790static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001791{
1792 struct rpc_message msg = {
1793 .rpc_proc = &rpcproc_null,
1794 };
1795 int err;
1796 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001797 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001798 put_rpccred(msg.rpc_cred);
1799 return err;
1800}
Trond Myklebust188fef12007-06-16 14:18:40 -04001801
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001802struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1803{
1804 struct rpc_message msg = {
1805 .rpc_proc = &rpcproc_null,
1806 .rpc_cred = cred,
1807 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001808 struct rpc_task_setup task_setup_data = {
1809 .rpc_client = clnt,
1810 .rpc_message = &msg,
1811 .callback_ops = &rpc_default_ops,
1812 .flags = flags,
1813 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001814 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001815}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001816EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001817
Trond Myklebust188fef12007-06-16 14:18:40 -04001818#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001819static void rpc_show_header(void)
1820{
Chuck Levercb3997b2008-05-21 17:09:41 -04001821 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1822 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001823}
1824
Chuck Lever38e886e2008-05-21 17:09:33 -04001825static void rpc_show_task(const struct rpc_clnt *clnt,
1826 const struct rpc_task *task)
1827{
1828 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001829 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001830
1831 if (RPC_IS_QUEUED(task))
1832 rpc_waitq = rpc_qname(task->tk_waitqueue);
1833
Chuck Levercb3997b2008-05-21 17:09:41 -04001834 /* map tk_action pointer to a function name; then trim off
1835 * the "+0x0 [sunrpc]" */
1836 sprint_symbol(action, (unsigned long)task->tk_action);
1837 p = strchr(action, '+');
1838 if (p)
1839 *p = '\0';
1840
1841 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1842 task->tk_pid, task->tk_flags, task->tk_status,
1843 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1844 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1845 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001846}
1847
Trond Myklebust188fef12007-06-16 14:18:40 -04001848void rpc_show_tasks(void)
1849{
1850 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001851 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001852 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001853
1854 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001855 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001856 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001857 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001858 if (!header) {
1859 rpc_show_header();
1860 header++;
1861 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001862 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001863 }
1864 spin_unlock(&clnt->cl_lock);
1865 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001866 spin_unlock(&rpc_client_lock);
1867}
1868#endif