blob: b91f8f943c5ea0f2dcf08610710e96224f18737f [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 Myklebust006abe82010-09-12 19:55:25 -0400229 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400230
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 = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400287 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400288 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200289 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200290 .dstaddr = args->address,
291 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300292 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200293 };
Chuck Lever510deb02007-12-10 14:56:24 -0500294 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400295
Chuck Leverc2866762006-08-22 20:06:20 -0400296 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400297 * If the caller chooses not to specify a hostname, whip
298 * up a string representation of the passed-in address.
299 */
300 if (args->servername == NULL) {
Chuck Leverda09eb92011-05-09 15:22:25 -0400301 struct sockaddr_in *sin =
302 (struct sockaddr_in *)args->address;
303 struct sockaddr_in6 *sin6 =
304 (struct sockaddr_in6 *)args->address;
305
Chuck Lever510deb02007-12-10 14:56:24 -0500306 servername[0] = '\0';
307 switch (args->address->sa_family) {
Chuck Leverda09eb92011-05-09 15:22:25 -0400308 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700309 snprintf(servername, sizeof(servername), "%pI4",
310 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500311 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400312 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700313 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400314 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500315 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500316 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 Myklebust006abe82010-09-12 19:55:25 -0400393 atomic_set(&new->cl_count, 1);
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);
Trond Myklebust006abe82010-09-12 19:55:25 -0400400 atomic_inc(&clnt->cl_count);
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);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300438 if (RPC_IS_QUEUED(rovr))
439 rpc_wake_up_queued_task(rovr->tk_waitqueue,
440 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400441 }
442 }
443 spin_unlock(&clnt->cl_lock);
444}
445EXPORT_SYMBOL_GPL(rpc_killall_tasks);
446
447/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400449 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400451void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400453 dprintk("RPC: shutting down %s client for %s\n",
454 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
Trond Myklebust34f52e32007-06-14 16:40:31 -0400456 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800458 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400459 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 }
461
Trond Myklebust4c402b42007-06-14 16:40:32 -0400462 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400464EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400467 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400469static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400470rpc_free_client(struct rpc_clnt *clnt)
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
Trond Myklebust006abe82010-09-12 19:55:25 -0400498rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400499{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400500 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400501 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400502 return;
503 }
504
505 /*
506 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
507 * release remaining GSS contexts. This mechanism ensures
508 * that it can do so safely.
509 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400510 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400511 rpcauth_release(clnt->cl_auth);
512 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400513 if (atomic_dec_and_test(&clnt->cl_count))
514 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400515}
516
517/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400518 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 */
520void
521rpc_release_client(struct rpc_clnt *clnt)
522{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400523 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Trond Myklebust34f52e32007-06-14 16:40:31 -0400525 if (list_empty(&clnt->cl_tasks))
526 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400527 if (atomic_dec_and_test(&clnt->cl_count))
528 rpc_free_auth(clnt);
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;
Trond Myklebust006abe82010-09-12 19:55:25 -0400591 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400592 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
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000601void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
602{
603 rpc_task_release_client(task);
604 rpc_task_set_client(task, clnt);
605}
606EXPORT_SYMBOL_GPL(rpc_task_reset_client);
607
608
Trond Myklebust58f96122010-07-31 14:29:08 -0400609static void
610rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
611{
612 if (msg != NULL) {
613 task->tk_msg.rpc_proc = msg->rpc_proc;
614 task->tk_msg.rpc_argp = msg->rpc_argp;
615 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400616 if (msg->rpc_cred != NULL)
617 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400618 }
619}
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621/*
622 * Default callback for async RPC calls
623 */
624static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100625rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
627}
628
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100629static const struct rpc_call_ops rpc_default_ops = {
630 .rpc_call_done = rpc_default_callback,
631};
632
Trond Myklebustc970aa82007-07-14 15:39:59 -0400633/**
634 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
635 * @task_setup_data: pointer to task initialisation data
636 */
637struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400638{
Trond Myklebust19445b92010-04-16 16:41:10 -0400639 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400640
Trond Myklebust84115e12007-07-14 15:39:59 -0400641 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400642 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400643 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400644
Trond Myklebust58f96122010-07-31 14:29:08 -0400645 rpc_task_set_client(task, task_setup_data->rpc_client);
646 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
647
Trond Myklebust58f96122010-07-31 14:29:08 -0400648 if (task->tk_action == NULL)
649 rpc_call_start(task);
650
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400651 atomic_inc(&task->tk_count);
652 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400653out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400654 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400655}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400656EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400657
658/**
659 * rpc_call_sync - Perform a synchronous RPC call
660 * @clnt: pointer to RPC client
661 * @msg: RPC call parameters
662 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500664int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
666 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400667 struct rpc_task_setup task_setup_data = {
668 .rpc_client = clnt,
669 .rpc_message = msg,
670 .callback_ops = &rpc_default_ops,
671 .flags = flags,
672 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400673 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 BUG_ON(flags & RPC_TASK_ASYNC);
676
Trond Myklebustc970aa82007-07-14 15:39:59 -0400677 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400678 if (IS_ERR(task))
679 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100680 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800681 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return status;
683}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400684EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400686/**
687 * rpc_call_async - Perform an asynchronous RPC call
688 * @clnt: pointer to RPC client
689 * @msg: RPC call parameters
690 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800691 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400692 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 */
694int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500695rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100696 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
698 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400699 struct rpc_task_setup task_setup_data = {
700 .rpc_client = clnt,
701 .rpc_message = msg,
702 .callback_ops = tk_ops,
703 .callback_data = data,
704 .flags = flags|RPC_TASK_ASYNC,
705 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
Trond Myklebustc970aa82007-07-14 15:39:59 -0400707 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400708 if (IS_ERR(task))
709 return PTR_ERR(task);
710 rpc_put_task(task);
711 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400713EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400715#if defined(CONFIG_NFS_V4_1)
716/**
717 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
718 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400719 * @req: RPC request
720 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400721 */
722struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400723 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400724{
725 struct rpc_task *task;
726 struct xdr_buf *xbufp = &req->rq_snd_buf;
727 struct rpc_task_setup task_setup_data = {
728 .callback_ops = tk_ops,
729 };
730
731 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
732 /*
733 * Create an rpc_task to send the data
734 */
735 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400736 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400737 xprt_free_bc_request(req);
738 goto out;
739 }
740 task->tk_rqstp = req;
741
742 /*
743 * Set up the xdr_buf length.
744 * This also indicates that the buffer is XDR encoded already.
745 */
746 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
747 xbufp->tail[0].iov_len;
748
749 task->tk_action = call_bc_transmit;
750 atomic_inc(&task->tk_count);
751 BUG_ON(atomic_read(&task->tk_count) != 2);
752 rpc_execute(task);
753
754out:
755 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
756 return task;
757}
758#endif /* CONFIG_NFS_V4_1 */
759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400761rpc_call_start(struct rpc_task *task)
762{
763 task->tk_action = call_start;
764}
765EXPORT_SYMBOL_GPL(rpc_call_start);
766
Chuck Levered394402006-08-22 20:06:17 -0400767/**
768 * rpc_peeraddr - extract remote peer address from clnt's xprt
769 * @clnt: RPC client structure
770 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800771 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400772 *
773 * Returns the number of bytes that are actually in the stored address.
774 */
775size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
776{
777 size_t bytes;
778 struct rpc_xprt *xprt = clnt->cl_xprt;
779
780 bytes = sizeof(xprt->addr);
781 if (bytes > bufsize)
782 bytes = bufsize;
783 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400784 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400785}
Chuck Leverb86acd52006-08-22 20:06:22 -0400786EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400787
Chuck Leverf425eba2006-08-22 20:06:18 -0400788/**
789 * rpc_peeraddr2str - return remote peer address in printable format
790 * @clnt: RPC client structure
791 * @format: address format
792 *
793 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500794const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
795 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400796{
797 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500798
799 if (xprt->address_strings[format] != NULL)
800 return xprt->address_strings[format];
801 else
802 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400803}
Chuck Leverb86acd52006-08-22 20:06:22 -0400804EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806void
807rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
808{
809 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700810 if (xprt->ops->set_buffer_size)
811 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400813EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814
815/*
816 * Return size of largest payload RPC client can support, in bytes
817 *
818 * For stream transports, this is one RPC record fragment (see RFC
819 * 1831), as we don't support multi-record requests yet. For datagram
820 * transports, this is the size of an IP packet minus the IP, UDP, and
821 * RPC header sizes.
822 */
823size_t rpc_max_payload(struct rpc_clnt *clnt)
824{
825 return clnt->cl_xprt->max_payload;
826}
Chuck Leverb86acd52006-08-22 20:06:22 -0400827EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Chuck Lever35f5a422006-01-03 09:55:50 +0100829/**
830 * rpc_force_rebind - force transport to check that remote port is unchanged
831 * @clnt: client to rebind
832 *
833 */
834void rpc_force_rebind(struct rpc_clnt *clnt)
835{
836 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400837 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100838}
Chuck Leverb86acd52006-08-22 20:06:22 -0400839EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400842 * Restart an (async) RPC call from the call_prepare state.
843 * Usually called from within the exit handler.
844 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400845int
Andy Adamsonaae20062009-04-01 09:22:40 -0400846rpc_restart_call_prepare(struct rpc_task *task)
847{
848 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400849 return 0;
Andy Adamsonaae20062009-04-01 09:22:40 -0400850 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400851 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400852}
853EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
854
855/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 * Restart an (async) RPC call. Usually called from within the
857 * exit handler.
858 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400859int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860rpc_restart_call(struct rpc_task *task)
861{
862 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400863 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400865 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400867EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Chuck Lever3748f1e2008-05-21 17:09:12 -0400869#ifdef RPC_DEBUG
870static const char *rpc_proc_name(const struct rpc_task *task)
871{
872 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
873
874 if (proc) {
875 if (proc->p_name)
876 return proc->p_name;
877 else
878 return "NULL";
879 } else
880 return "no proc";
881}
882#endif
883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884/*
885 * 0. Initial state
886 *
887 * Other FSM states can be visited zero or more times, but
888 * this state is visited exactly once for each RPC.
889 */
890static void
891call_start(struct rpc_task *task)
892{
893 struct rpc_clnt *clnt = task->tk_client;
894
Chuck Lever3748f1e2008-05-21 17:09:12 -0400895 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500896 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400897 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500898 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
900 /* Increment call count */
901 task->tk_msg.rpc_proc->p_count++;
902 clnt->cl_stats->rpccnt++;
903 task->tk_action = call_reserve;
904}
905
906/*
907 * 1. Reserve an RPC call slot
908 */
909static void
910call_reserve(struct rpc_task *task)
911{
Chuck Lever46121cf2007-01-31 12:14:08 -0500912 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 task->tk_status = 0;
915 task->tk_action = call_reserveresult;
916 xprt_reserve(task);
917}
918
919/*
920 * 1b. Grok the result of xprt_reserve()
921 */
922static void
923call_reserveresult(struct rpc_task *task)
924{
925 int status = task->tk_status;
926
Chuck Lever46121cf2007-01-31 12:14:08 -0500927 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
929 /*
930 * After a call to xprt_reserve(), we must have either
931 * a request slot or else an error status.
932 */
933 task->tk_status = 0;
934 if (status >= 0) {
935 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -0400936 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 return;
938 }
939
940 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800941 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 rpc_exit(task, -EIO);
943 return;
944 }
945
946 /*
947 * Even though there was an error, we may have acquired
948 * a request slot somehow. Make sure not to leak it.
949 */
950 if (task->tk_rqstp) {
951 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800952 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 xprt_release(task);
954 }
955
956 switch (status) {
957 case -EAGAIN: /* woken up; retry */
958 task->tk_action = call_reserve;
959 return;
960 case -EIO: /* probably a shutdown */
961 break;
962 default:
963 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800964 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 break;
966 }
967 rpc_exit(task, status);
968}
969
970/*
J. Bruce Fields55576242010-09-12 19:55:25 -0400971 * 2. Bind and/or refresh the credentials
972 */
973static void
974call_refresh(struct rpc_task *task)
975{
976 dprint_status(task);
977
978 task->tk_action = call_refreshresult;
979 task->tk_status = 0;
980 task->tk_client->cl_stats->rpcauthrefresh++;
981 rpcauth_refreshcred(task);
982}
983
984/*
985 * 2a. Process the results of a credential refresh
986 */
987static void
988call_refreshresult(struct rpc_task *task)
989{
990 int status = task->tk_status;
991
992 dprint_status(task);
993
994 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -0500995 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -0400996 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -0500997 case 0:
998 if (rpcauth_uptodatecred(task))
999 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001000 return;
1001 case -ETIMEDOUT:
1002 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001003 case -EAGAIN:
1004 status = -EACCES;
1005 if (!task->tk_cred_retry)
1006 break;
1007 task->tk_cred_retry--;
1008 dprintk("RPC: %5u %s: retry refresh creds\n",
1009 task->tk_pid, __func__);
1010 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001011 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001012 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1013 task->tk_pid, __func__, status);
1014 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001015}
1016
1017/*
1018 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001019 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 */
1021static void
1022call_allocate(struct rpc_task *task)
1023{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001024 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001025 struct rpc_rqst *req = task->tk_rqstp;
1026 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001027 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
Chuck Lever46121cf2007-01-31 12:14:08 -05001029 dprint_status(task);
1030
Chuck Lever2bea90d2007-03-29 16:47:53 -04001031 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001032 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001033
Chuck Lever02107142006-01-03 09:55:49 +01001034 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 return;
1036
Chuck Lever2bea90d2007-03-29 16:47:53 -04001037 if (proc->p_proc != 0) {
1038 BUG_ON(proc->p_arglen == 0);
1039 if (proc->p_decode != NULL)
1040 BUG_ON(proc->p_replen == 0);
1041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
Chuck Lever2bea90d2007-03-29 16:47:53 -04001043 /*
1044 * Calculate the size (in quads) of the RPC call
1045 * and reply headers, and convert both values
1046 * to byte sizes.
1047 */
1048 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1049 req->rq_callsize <<= 2;
1050 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1051 req->rq_rcvsize <<= 2;
1052
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001053 req->rq_buffer = xprt->ops->buf_alloc(task,
1054 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001055 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001057
1058 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Trond Myklebust14b218a2005-06-22 17:16:28 +00001060 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001061 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 rpc_delay(task, HZ>>4);
1063 return;
1064 }
1065
1066 rpc_exit(task, -ERESTARTSYS);
1067}
1068
Trond Myklebust940e3312005-11-09 21:45:24 -05001069static inline int
1070rpc_task_need_encode(struct rpc_task *task)
1071{
1072 return task->tk_rqstp->rq_snd_buf.len == 0;
1073}
1074
1075static inline void
1076rpc_task_force_reencode(struct rpc_task *task)
1077{
1078 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001079 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001080}
1081
Chuck Lever2bea90d2007-03-29 16:47:53 -04001082static inline void
1083rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1084{
1085 buf->head[0].iov_base = start;
1086 buf->head[0].iov_len = len;
1087 buf->tail[0].iov_len = 0;
1088 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001089 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001090 buf->len = 0;
1091 buf->buflen = len;
1092}
1093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094/*
1095 * 3. Encode arguments of an RPC call
1096 */
1097static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001098rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001101 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001102 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Chuck Lever46121cf2007-01-31 12:14:08 -05001104 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
Chuck Lever2bea90d2007-03-29 16:47:53 -04001106 rpc_xdr_buf_init(&req->rq_snd_buf,
1107 req->rq_buffer,
1108 req->rq_callsize);
1109 rpc_xdr_buf_init(&req->rq_rcv_buf,
1110 (char *)req->rq_buffer + req->rq_callsize,
1111 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
Chuck Leverb0e1c572008-05-21 17:09:19 -04001113 p = rpc_encode_header(task);
1114 if (p == NULL) {
1115 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 rpc_exit(task, -EIO);
1117 return;
1118 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001119
1120 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001121 if (encode == NULL)
1122 return;
1123
1124 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1125 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126}
1127
1128/*
1129 * 4. Get the server port number if not yet set
1130 */
1131static void
1132call_bind(struct rpc_task *task)
1133{
Chuck Leverec739ef2006-08-22 20:06:15 -04001134 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Chuck Lever46121cf2007-01-31 12:14:08 -05001136 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
Chuck Leverda351872005-08-11 16:25:11 -04001138 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001139 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001140 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001141 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001142 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 }
1144}
1145
1146/*
Chuck Leverda351872005-08-11 16:25:11 -04001147 * 4a. Sort out bind result
1148 */
1149static void
1150call_bind_status(struct rpc_task *task)
1151{
Chuck Lever906462a2007-09-11 18:00:47 -04001152 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001153
1154 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001155 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001156 task->tk_status = 0;
1157 task->tk_action = call_connect;
1158 return;
1159 }
1160
1161 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001162 case -ENOMEM:
1163 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1164 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001165 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001166 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001167 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1168 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001169 /* fail immediately if this is an RPC ping */
1170 if (task->tk_msg.rpc_proc->p_proc == 0) {
1171 status = -EOPNOTSUPP;
1172 break;
1173 }
Chuck Leverea635a52005-10-06 23:12:58 -04001174 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001175 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001176 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001177 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001178 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001179 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001180 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001181 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001182 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001183 task->tk_pid);
1184 break;
1185 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001186 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001187 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001188 task->tk_status = 0;
1189 task->tk_action = call_bind;
1190 return;
Chuck Lever012da152009-12-03 15:58:56 -05001191 case -ECONNREFUSED: /* connection problems */
1192 case -ECONNRESET:
1193 case -ENOTCONN:
1194 case -EHOSTDOWN:
1195 case -EHOSTUNREACH:
1196 case -ENETUNREACH:
1197 case -EPIPE:
1198 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1199 task->tk_pid, task->tk_status);
1200 if (!RPC_IS_SOFTCONN(task)) {
1201 rpc_delay(task, 5*HZ);
1202 goto retry_timeout;
1203 }
1204 status = task->tk_status;
1205 break;
Chuck Leverda351872005-08-11 16:25:11 -04001206 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001207 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001208 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001209 }
1210
1211 rpc_exit(task, status);
1212 return;
1213
Trond Myklebustda458282006-08-31 15:44:52 -04001214retry_timeout:
1215 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001216}
1217
1218/*
1219 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 */
1221static void
1222call_connect(struct rpc_task *task)
1223{
Chuck Leverda351872005-08-11 16:25:11 -04001224 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
Chuck Lever46121cf2007-01-31 12:14:08 -05001226 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001227 task->tk_pid, xprt,
1228 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229
Chuck Leverda351872005-08-11 16:25:11 -04001230 task->tk_action = call_transmit;
1231 if (!xprt_connected(xprt)) {
1232 task->tk_action = call_connect_status;
1233 if (task->tk_status < 0)
1234 return;
1235 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237}
1238
1239/*
Chuck Leverda351872005-08-11 16:25:11 -04001240 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 */
1242static void
1243call_connect_status(struct rpc_task *task)
1244{
1245 struct rpc_clnt *clnt = task->tk_client;
1246 int status = task->tk_status;
1247
Chuck Lever46121cf2007-01-31 12:14:08 -05001248 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001249
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001251 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 clnt->cl_stats->netreconn++;
1253 task->tk_action = call_transmit;
1254 return;
1255 }
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001258 /* if soft mounted, test if we've timed out */
1259 case -ETIMEDOUT:
1260 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001261 break;
1262 default:
1263 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 }
1265}
1266
1267/*
1268 * 5. Transmit the RPC request, and wait for reply
1269 */
1270static void
1271call_transmit(struct rpc_task *task)
1272{
Chuck Lever46121cf2007-01-31 12:14:08 -05001273 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274
1275 task->tk_action = call_status;
1276 if (task->tk_status < 0)
1277 return;
1278 task->tk_status = xprt_prepare_transmit(task);
1279 if (task->tk_status != 0)
1280 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001281 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001283 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001284 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001285 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001286 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001287 if (task->tk_status != 0) {
1288 /* Was the error nonfatal? */
1289 if (task->tk_status == -EAGAIN)
1290 rpc_delay(task, HZ >> 4);
1291 else
1292 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001293 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001294 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 xprt_transmit(task);
1297 if (task->tk_status < 0)
1298 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001299 /*
1300 * On success, ensure that we call xprt_end_transmit() before sleeping
1301 * in order to allow access to the socket to other RPC requests.
1302 */
1303 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001304 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001305 return;
1306 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001307 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001308}
1309
1310/*
1311 * 5a. Handle cleanup after a transmission
1312 */
1313static void
1314call_transmit_status(struct rpc_task *task)
1315{
1316 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001317
1318 /*
1319 * Common case: success. Force the compiler to put this
1320 * test first.
1321 */
1322 if (task->tk_status == 0) {
1323 xprt_end_transmit(task);
1324 rpc_task_force_reencode(task);
1325 return;
1326 }
1327
Trond Myklebust15f081c2009-03-11 14:37:57 -04001328 switch (task->tk_status) {
1329 case -EAGAIN:
1330 break;
1331 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001332 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001333 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001334 rpc_task_force_reencode(task);
1335 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001336 /*
1337 * Special cases: if we've been waiting on the
1338 * socket's write_space() callback, or if the
1339 * socket just returned a connection error,
1340 * then hold onto the transport lock.
1341 */
1342 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001343 case -EHOSTDOWN:
1344 case -EHOSTUNREACH:
1345 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001346 if (RPC_IS_SOFTCONN(task)) {
1347 xprt_end_transmit(task);
1348 rpc_exit(task, task->tk_status);
1349 break;
1350 }
1351 case -ECONNRESET:
1352 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001353 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001354 rpc_task_force_reencode(task);
1355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356}
1357
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001358#if defined(CONFIG_NFS_V4_1)
1359/*
1360 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1361 * addition, disconnect on connectivity errors.
1362 */
1363static void
1364call_bc_transmit(struct rpc_task *task)
1365{
1366 struct rpc_rqst *req = task->tk_rqstp;
1367
1368 BUG_ON(task->tk_status != 0);
1369 task->tk_status = xprt_prepare_transmit(task);
1370 if (task->tk_status == -EAGAIN) {
1371 /*
1372 * Could not reserve the transport. Try again after the
1373 * transport is released.
1374 */
1375 task->tk_status = 0;
1376 task->tk_action = call_bc_transmit;
1377 return;
1378 }
1379
1380 task->tk_action = rpc_exit_task;
1381 if (task->tk_status < 0) {
1382 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1383 "error: %d\n", task->tk_status);
1384 return;
1385 }
1386
1387 xprt_transmit(task);
1388 xprt_end_transmit(task);
1389 dprint_status(task);
1390 switch (task->tk_status) {
1391 case 0:
1392 /* Success */
1393 break;
1394 case -EHOSTDOWN:
1395 case -EHOSTUNREACH:
1396 case -ENETUNREACH:
1397 case -ETIMEDOUT:
1398 /*
1399 * Problem reaching the server. Disconnect and let the
1400 * forechannel reestablish the connection. The server will
1401 * have to retransmit the backchannel request and we'll
1402 * reprocess it. Since these ops are idempotent, there's no
1403 * need to cache our reply at this time.
1404 */
1405 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1406 "error: %d\n", task->tk_status);
1407 xprt_conditional_disconnect(task->tk_xprt,
1408 req->rq_connect_cookie);
1409 break;
1410 default:
1411 /*
1412 * We were unable to reply and will have to drop the
1413 * request. The server should reconnect and retransmit.
1414 */
1415 BUG_ON(task->tk_status == -EAGAIN);
1416 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1417 "error: %d\n", task->tk_status);
1418 break;
1419 }
1420 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1421}
1422#endif /* CONFIG_NFS_V4_1 */
1423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424/*
1425 * 6. Sort out the RPC call status
1426 */
1427static void
1428call_status(struct rpc_task *task)
1429{
1430 struct rpc_clnt *clnt = task->tk_client;
1431 struct rpc_rqst *req = task->tk_rqstp;
1432 int status;
1433
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001434 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1435 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Chuck Lever46121cf2007-01-31 12:14:08 -05001437 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
1439 status = task->tk_status;
1440 if (status >= 0) {
1441 task->tk_action = call_decode;
1442 return;
1443 }
1444
1445 task->tk_status = 0;
1446 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001447 case -EHOSTDOWN:
1448 case -EHOSTUNREACH:
1449 case -ENETUNREACH:
1450 /*
1451 * Delay any retries for 3 seconds, then handle as if it
1452 * were a timeout.
1453 */
1454 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 case -ETIMEDOUT:
1456 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001457 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001458 xprt_conditional_disconnect(task->tk_xprt,
1459 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001461 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001463 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001464 rpc_delay(task, 3*HZ);
1465 case -EPIPE:
1466 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 task->tk_action = call_bind;
1468 break;
1469 case -EAGAIN:
1470 task->tk_action = call_transmit;
1471 break;
1472 case -EIO:
1473 /* shutdown or soft timeout */
1474 rpc_exit(task, status);
1475 break;
1476 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001477 if (clnt->cl_chatty)
1478 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 clnt->cl_protname, -status);
1480 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 }
1482}
1483
1484/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001485 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 * We do not release the request slot, so we keep using the
1487 * same XID for all retransmits.
1488 */
1489static void
1490call_timeout(struct rpc_task *task)
1491{
1492 struct rpc_clnt *clnt = task->tk_client;
1493
1494 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001495 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 goto retry;
1497 }
1498
Chuck Lever46121cf2007-01-31 12:14:08 -05001499 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001500 task->tk_timeouts++;
1501
Chuck Lever3a28bec2009-12-03 15:58:56 -05001502 if (RPC_IS_SOFTCONN(task)) {
1503 rpc_exit(task, -ETIMEDOUT);
1504 return;
1505 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001507 if (clnt->cl_chatty)
1508 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001510 if (task->tk_flags & RPC_TASK_TIMEOUT)
1511 rpc_exit(task, -ETIMEDOUT);
1512 else
1513 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 return;
1515 }
1516
Chuck Leverf518e35a2006-01-03 09:55:52 +01001517 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001519 if (clnt->cl_chatty)
1520 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 clnt->cl_protname, clnt->cl_server);
1522 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001523 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001524 /*
1525 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1526 * event? RFC2203 requires the server to drop all such requests.
1527 */
1528 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
1530retry:
1531 clnt->cl_stats->rpcretrans++;
1532 task->tk_action = call_bind;
1533 task->tk_status = 0;
1534}
1535
1536/*
1537 * 7. Decode the RPC reply
1538 */
1539static void
1540call_decode(struct rpc_task *task)
1541{
1542 struct rpc_clnt *clnt = task->tk_client;
1543 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001544 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001545 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Chuck Lever46121cf2007-01-31 12:14:08 -05001547 dprintk("RPC: %5u call_decode (status %d)\n",
1548 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Chuck Leverf518e35a2006-01-03 09:55:52 +01001550 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001551 if (clnt->cl_chatty)
1552 printk(KERN_NOTICE "%s: server %s OK\n",
1553 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1555 }
1556
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001557 /*
1558 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001559 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001560 */
1561 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 req->rq_rcv_buf.len = req->rq_private_buf.len;
1563
1564 /* Check that the softirq receive buffer is valid */
1565 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1566 sizeof(req->rq_rcv_buf)) != 0);
1567
Trond Myklebust1e799b62008-03-21 16:19:41 -04001568 if (req->rq_rcv_buf.len < 12) {
1569 if (!RPC_IS_SOFT(task)) {
1570 task->tk_action = call_bind;
1571 clnt->cl_stats->rpcretrans++;
1572 goto out_retry;
1573 }
1574 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1575 clnt->cl_protname, task->tk_status);
1576 task->tk_action = call_timeout;
1577 goto out_retry;
1578 }
1579
Chuck Leverb0e1c572008-05-21 17:09:19 -04001580 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001581 if (IS_ERR(p)) {
1582 if (p == ERR_PTR(-EAGAIN))
1583 goto out_retry;
1584 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 }
1586
Trond Myklebustabbcf282006-01-03 09:55:03 +01001587 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001589 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1591 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001592 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001593 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1594 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 return;
1596out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001598 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001599 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001600 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001601 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001602 xprt_conditional_disconnect(task->tk_xprt,
1603 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001604 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605}
1606
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001607static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001608rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609{
1610 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001612 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
1614 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001615
1616 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 *p++ = req->rq_xid; /* XID */
1618 *p++ = htonl(RPC_CALL); /* CALL */
1619 *p++ = htonl(RPC_VERSION); /* RPC version */
1620 *p++ = htonl(clnt->cl_prog); /* program number */
1621 *p++ = htonl(clnt->cl_vers); /* program version */
1622 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001623 p = rpcauth_marshcred(task, p);
1624 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1625 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626}
1627
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001628static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001629rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630{
1631 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1632 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001633 __be32 *p = iov->iov_base;
1634 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 int error = -EACCES;
1636
David Howellse8896492006-08-24 15:44:19 -04001637 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1638 /* RFC-1014 says that the representation of XDR data must be a
1639 * multiple of four bytes
1640 * - if it isn't pointer subtraction in the NFS client may give
1641 * undefined results
1642 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001643 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001644 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001645 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001646 goto out_eio;
1647 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 if ((len -= 3) < 0)
1649 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001651 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001653 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001654 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001655 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001657
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1659 if (--len < 0)
1660 goto out_overflow;
1661 switch ((n = ntohl(*p++))) {
1662 case RPC_AUTH_ERROR:
1663 break;
1664 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001665 dprintk("RPC: %5u %s: RPC call version "
1666 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001667 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001668 error = -EPROTONOSUPPORT;
1669 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001671 dprintk("RPC: %5u %s: RPC call rejected, "
1672 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001673 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 goto out_eio;
1675 }
1676 if (--len < 0)
1677 goto out_overflow;
1678 switch ((n = ntohl(*p++))) {
1679 case RPC_AUTH_REJECTEDCRED:
1680 case RPC_AUTH_REJECTEDVERF:
1681 case RPCSEC_GSS_CREDPROBLEM:
1682 case RPCSEC_GSS_CTXPROBLEM:
1683 if (!task->tk_cred_retry)
1684 break;
1685 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001686 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001687 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001689 /* Ensure we obtain a new XID! */
1690 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001691 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001692 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 case RPC_AUTH_BADCRED:
1694 case RPC_AUTH_BADVERF:
1695 /* possibly garbled cred/verf? */
1696 if (!task->tk_garb_retry)
1697 break;
1698 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001699 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001700 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001702 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001704 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001705 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 break;
1707 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001708 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001709 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 error = -EIO;
1711 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001712 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001713 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 goto out_err;
1715 }
1716 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001717 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001718 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001719 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001721 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 if (len < 0)
1723 goto out_overflow;
1724 switch ((n = ntohl(*p++))) {
1725 case RPC_SUCCESS:
1726 return p;
1727 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001728 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001729 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 (unsigned int)task->tk_client->cl_prog,
1731 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001732 error = -EPFNOSUPPORT;
1733 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001735 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001736 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 (unsigned int)task->tk_client->cl_prog,
1738 (unsigned int)task->tk_client->cl_vers,
1739 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001740 error = -EPROTONOSUPPORT;
1741 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001743 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001744 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001745 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001746 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 task->tk_client->cl_prog,
1748 task->tk_client->cl_vers,
1749 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001750 error = -EOPNOTSUPP;
1751 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001753 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001754 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 break; /* retry */
1756 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001757 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001758 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 /* Also retry */
1760 }
1761
Trond Myklebustabbcf282006-01-03 09:55:03 +01001762out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 task->tk_client->cl_stats->rpcgarbage++;
1764 if (task->tk_garb_retry) {
1765 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001766 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001767 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001769out_retry:
1770 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772out_eio:
1773 error = -EIO;
1774out_err:
1775 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001776 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001777 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001778 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001780 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001781 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001782 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001784
Chuck Lever9f06c712010-12-14 14:59:18 +00001785static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001786{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001787}
1788
Chuck Leverbf269552010-12-14 14:59:29 +00001789static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001790{
1791 return 0;
1792}
1793
1794static struct rpc_procinfo rpcproc_null = {
1795 .p_encode = rpcproc_encode_null,
1796 .p_decode = rpcproc_decode_null,
1797};
1798
Chuck Levercaabea82009-12-03 15:58:56 -05001799static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001800{
1801 struct rpc_message msg = {
1802 .rpc_proc = &rpcproc_null,
1803 };
1804 int err;
1805 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001806 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001807 put_rpccred(msg.rpc_cred);
1808 return err;
1809}
Trond Myklebust188fef12007-06-16 14:18:40 -04001810
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001811struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1812{
1813 struct rpc_message msg = {
1814 .rpc_proc = &rpcproc_null,
1815 .rpc_cred = cred,
1816 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001817 struct rpc_task_setup task_setup_data = {
1818 .rpc_client = clnt,
1819 .rpc_message = &msg,
1820 .callback_ops = &rpc_default_ops,
1821 .flags = flags,
1822 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001823 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001824}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001825EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001826
Trond Myklebust188fef12007-06-16 14:18:40 -04001827#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001828static void rpc_show_header(void)
1829{
Chuck Levercb3997b2008-05-21 17:09:41 -04001830 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1831 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001832}
1833
Chuck Lever38e886e2008-05-21 17:09:33 -04001834static void rpc_show_task(const struct rpc_clnt *clnt,
1835 const struct rpc_task *task)
1836{
1837 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001838
1839 if (RPC_IS_QUEUED(task))
1840 rpc_waitq = rpc_qname(task->tk_waitqueue);
1841
Joe Perchesb3bceda2010-12-21 10:52:24 -05001842 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
Chuck Levercb3997b2008-05-21 17:09:41 -04001843 task->tk_pid, task->tk_flags, task->tk_status,
1844 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1845 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001846 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001847}
1848
Trond Myklebust188fef12007-06-16 14:18:40 -04001849void rpc_show_tasks(void)
1850{
1851 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001852 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001853 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001854
1855 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001856 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001857 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001858 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001859 if (!header) {
1860 rpc_show_header();
1861 header++;
1862 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001863 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001864 }
1865 spin_unlock(&clnt->cl_lock);
1866 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001867 spin_unlock(&rpc_client_lock);
1868}
1869#endif