blob: fa5549079d79ca7709d3a68bc686b77f10b08243 [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\3c341b02007-09-10 13:47:07 -0400286 struct xprt_create xprtargs = {
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400287 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200288 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200289 .dstaddr = args->address,
290 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300291 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200292 };
Chuck Lever510deb02007-12-10 14:56:24 -0500293 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400294
Chuck Leverc2866762006-08-22 20:06:20 -0400295 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400296 * If the caller chooses not to specify a hostname, whip
297 * up a string representation of the passed-in address.
298 */
299 if (args->servername == NULL) {
Chuck Lever510deb02007-12-10 14:56:24 -0500300 servername[0] = '\0';
301 switch (args->address->sa_family) {
302 case AF_INET: {
303 struct sockaddr_in *sin =
304 (struct sockaddr_in *)args->address;
Harvey Harrison21454aa2008-10-31 00:54:56 -0700305 snprintf(servername, sizeof(servername), "%pI4",
306 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500307 break;
308 }
309 case AF_INET6: {
310 struct sockaddr_in6 *sin =
311 (struct sockaddr_in6 *)args->address;
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700312 snprintf(servername, sizeof(servername), "%pI6",
Harvey Harrisonfdb46ee2008-10-28 16:10:17 -0700313 &sin->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500314 break;
315 }
316 default:
317 /* caller wants default server name, but
318 * address family isn't recognized. */
319 return ERR_PTR(-EINVAL);
320 }
Chuck Lever43780b82007-07-01 12:13:22 -0400321 args->servername = servername;
322 }
323
Chuck Lever510deb02007-12-10 14:56:24 -0500324 xprt = xprt_create_transport(&xprtargs);
325 if (IS_ERR(xprt))
326 return (struct rpc_clnt *)xprt;
327
Chuck Lever43780b82007-07-01 12:13:22 -0400328 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400329 * By default, kernel RPC client connects from a reserved port.
330 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
331 * but it is always enabled for rpciod, which handles the connect
332 * operation.
333 */
334 xprt->resvport = 1;
335 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
336 xprt->resvport = 0;
337
Trond Myklebust698b6d02007-12-20 16:03:53 -0500338 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400339 if (IS_ERR(clnt))
340 return clnt;
341
342 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
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);
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
Trond Myklebust006abe82010-09-12 19:55:25 -0400468rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469{
Chuck Lever46121cf2007-01-31 12:14:08 -0500470 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400472 if (!IS_ERR(clnt->cl_path.dentry)) {
473 rpc_remove_client_dir(clnt->cl_path.dentry);
Trond Myklebust8f8e7a52006-08-14 13:11:15 -0400474 rpc_put_mount();
475 }
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500476 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400477 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500478 goto out_free;
479 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (clnt->cl_server != clnt->cl_inline_name)
481 kfree(clnt->cl_server);
482out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400483 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500484 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500485 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500486 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400487 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400488 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
492/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400493 * Free an RPC client
494 */
495static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400496rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400497{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400498 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400499 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400500 return;
501 }
502
503 /*
504 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
505 * release remaining GSS contexts. This mechanism ensures
506 * that it can do so safely.
507 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400508 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400509 rpcauth_release(clnt->cl_auth);
510 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400511 if (atomic_dec_and_test(&clnt->cl_count))
512 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400513}
514
515/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400516 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 */
518void
519rpc_release_client(struct rpc_clnt *clnt)
520{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400521 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Trond Myklebust34f52e32007-06-14 16:40:31 -0400523 if (list_empty(&clnt->cl_tasks))
524 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400525 if (atomic_dec_and_test(&clnt->cl_count))
526 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400527}
528
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000529/**
530 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800531 * @old: old rpc_client
532 * @program: rpc program to set
533 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000534 *
535 * Clones the rpc client and sets up a new RPC program. This is mainly
536 * of use for enabling different RPC programs to share the same transport.
537 * The Sun NFSv2/v3 ACL protocol can do this.
538 */
539struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
540 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400541 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000542{
543 struct rpc_clnt *clnt;
544 struct rpc_version *version;
545 int err;
546
547 BUG_ON(vers >= program->nrvers || !program->version[vers]);
548 version = program->version[vers];
549 clnt = rpc_clone_client(old);
550 if (IS_ERR(clnt))
551 goto out;
552 clnt->cl_procinfo = version->procs;
553 clnt->cl_maxproc = version->nrprocs;
554 clnt->cl_protname = program->name;
555 clnt->cl_prog = program->number;
556 clnt->cl_vers = version->number;
557 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500558 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000559 if (err != 0) {
560 rpc_shutdown_client(clnt);
561 clnt = ERR_PTR(err);
562 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800563out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000564 return clnt;
565}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400566EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000567
Trond Myklebust58f96122010-07-31 14:29:08 -0400568void rpc_task_release_client(struct rpc_task *task)
569{
570 struct rpc_clnt *clnt = task->tk_client;
571
572 if (clnt != NULL) {
573 /* Remove from client task list */
574 spin_lock(&clnt->cl_lock);
575 list_del(&task->tk_task);
576 spin_unlock(&clnt->cl_lock);
577 task->tk_client = NULL;
578
579 rpc_release_client(clnt);
580 }
581}
582
583static
584void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
585{
586 if (clnt != NULL) {
587 rpc_task_release_client(task);
588 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400589 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400590 if (clnt->cl_softrtry)
591 task->tk_flags |= RPC_TASK_SOFT;
592 /* Add to the client's list of all tasks */
593 spin_lock(&clnt->cl_lock);
594 list_add_tail(&task->tk_task, &clnt->cl_tasks);
595 spin_unlock(&clnt->cl_lock);
596 }
597}
598
599static void
600rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
601{
602 if (msg != NULL) {
603 task->tk_msg.rpc_proc = msg->rpc_proc;
604 task->tk_msg.rpc_argp = msg->rpc_argp;
605 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400606 if (msg->rpc_cred != NULL)
607 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400608 }
609}
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611/*
612 * Default callback for async RPC calls
613 */
614static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100615rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
617}
618
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100619static const struct rpc_call_ops rpc_default_ops = {
620 .rpc_call_done = rpc_default_callback,
621};
622
Trond Myklebustc970aa82007-07-14 15:39:59 -0400623/**
624 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
625 * @task_setup_data: pointer to task initialisation data
626 */
627struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400628{
Trond Myklebust19445b92010-04-16 16:41:10 -0400629 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400630
Trond Myklebust84115e12007-07-14 15:39:59 -0400631 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400632 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400633 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400634
Trond Myklebust58f96122010-07-31 14:29:08 -0400635 rpc_task_set_client(task, task_setup_data->rpc_client);
636 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
637
638 if (task->tk_status != 0) {
639 int ret = task->tk_status;
640 rpc_put_task(task);
641 return ERR_PTR(ret);
642 }
643
644 if (task->tk_action == NULL)
645 rpc_call_start(task);
646
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400647 atomic_inc(&task->tk_count);
648 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400649out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400650 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400651}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400652EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400653
654/**
655 * rpc_call_sync - Perform a synchronous RPC call
656 * @clnt: pointer to RPC client
657 * @msg: RPC call parameters
658 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500660int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
662 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400663 struct rpc_task_setup task_setup_data = {
664 .rpc_client = clnt,
665 .rpc_message = msg,
666 .callback_ops = &rpc_default_ops,
667 .flags = flags,
668 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400669 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 BUG_ON(flags & RPC_TASK_ASYNC);
672
Trond Myklebustc970aa82007-07-14 15:39:59 -0400673 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400674 if (IS_ERR(task))
675 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100676 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800677 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 return status;
679}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400680EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400682/**
683 * rpc_call_async - Perform an asynchronous RPC call
684 * @clnt: pointer to RPC client
685 * @msg: RPC call parameters
686 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800687 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400688 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 */
690int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500691rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100692 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
694 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400695 struct rpc_task_setup task_setup_data = {
696 .rpc_client = clnt,
697 .rpc_message = msg,
698 .callback_ops = tk_ops,
699 .callback_data = data,
700 .flags = flags|RPC_TASK_ASYNC,
701 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Trond Myklebustc970aa82007-07-14 15:39:59 -0400703 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400704 if (IS_ERR(task))
705 return PTR_ERR(task);
706 rpc_put_task(task);
707 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400709EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400711#if defined(CONFIG_NFS_V4_1)
712/**
713 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
714 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400715 * @req: RPC request
716 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400717 */
718struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400719 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400720{
721 struct rpc_task *task;
722 struct xdr_buf *xbufp = &req->rq_snd_buf;
723 struct rpc_task_setup task_setup_data = {
724 .callback_ops = tk_ops,
725 };
726
727 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
728 /*
729 * Create an rpc_task to send the data
730 */
731 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400732 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400733 xprt_free_bc_request(req);
734 goto out;
735 }
736 task->tk_rqstp = req;
737
738 /*
739 * Set up the xdr_buf length.
740 * This also indicates that the buffer is XDR encoded already.
741 */
742 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
743 xbufp->tail[0].iov_len;
744
745 task->tk_action = call_bc_transmit;
746 atomic_inc(&task->tk_count);
747 BUG_ON(atomic_read(&task->tk_count) != 2);
748 rpc_execute(task);
749
750out:
751 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
752 return task;
753}
754#endif /* CONFIG_NFS_V4_1 */
755
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400757rpc_call_start(struct rpc_task *task)
758{
759 task->tk_action = call_start;
760}
761EXPORT_SYMBOL_GPL(rpc_call_start);
762
Chuck Levered394402006-08-22 20:06:17 -0400763/**
764 * rpc_peeraddr - extract remote peer address from clnt's xprt
765 * @clnt: RPC client structure
766 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800767 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400768 *
769 * Returns the number of bytes that are actually in the stored address.
770 */
771size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
772{
773 size_t bytes;
774 struct rpc_xprt *xprt = clnt->cl_xprt;
775
776 bytes = sizeof(xprt->addr);
777 if (bytes > bufsize)
778 bytes = bufsize;
779 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400780 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400781}
Chuck Leverb86acd52006-08-22 20:06:22 -0400782EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400783
Chuck Leverf425eba2006-08-22 20:06:18 -0400784/**
785 * rpc_peeraddr2str - return remote peer address in printable format
786 * @clnt: RPC client structure
787 * @format: address format
788 *
789 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500790const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
791 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400792{
793 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500794
795 if (xprt->address_strings[format] != NULL)
796 return xprt->address_strings[format];
797 else
798 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400799}
Chuck Leverb86acd52006-08-22 20:06:22 -0400800EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802void
803rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
804{
805 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700806 if (xprt->ops->set_buffer_size)
807 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400809EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
811/*
812 * Return size of largest payload RPC client can support, in bytes
813 *
814 * For stream transports, this is one RPC record fragment (see RFC
815 * 1831), as we don't support multi-record requests yet. For datagram
816 * transports, this is the size of an IP packet minus the IP, UDP, and
817 * RPC header sizes.
818 */
819size_t rpc_max_payload(struct rpc_clnt *clnt)
820{
821 return clnt->cl_xprt->max_payload;
822}
Chuck Leverb86acd52006-08-22 20:06:22 -0400823EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Chuck Lever35f5a422006-01-03 09:55:50 +0100825/**
826 * rpc_force_rebind - force transport to check that remote port is unchanged
827 * @clnt: client to rebind
828 *
829 */
830void rpc_force_rebind(struct rpc_clnt *clnt)
831{
832 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400833 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100834}
Chuck Leverb86acd52006-08-22 20:06:22 -0400835EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400838 * Restart an (async) RPC call from the call_prepare state.
839 * Usually called from within the exit handler.
840 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400841int
Andy Adamsonaae20062009-04-01 09:22:40 -0400842rpc_restart_call_prepare(struct rpc_task *task)
843{
844 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400845 return 0;
Andy Adamsonaae20062009-04-01 09:22:40 -0400846 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400847 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400848}
849EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
850
851/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 * Restart an (async) RPC call. Usually called from within the
853 * exit handler.
854 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400855int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856rpc_restart_call(struct rpc_task *task)
857{
858 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400859 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400861 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400863EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
Chuck Lever3748f1e2008-05-21 17:09:12 -0400865#ifdef RPC_DEBUG
866static const char *rpc_proc_name(const struct rpc_task *task)
867{
868 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
869
870 if (proc) {
871 if (proc->p_name)
872 return proc->p_name;
873 else
874 return "NULL";
875 } else
876 return "no proc";
877}
878#endif
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880/*
881 * 0. Initial state
882 *
883 * Other FSM states can be visited zero or more times, but
884 * this state is visited exactly once for each RPC.
885 */
886static void
887call_start(struct rpc_task *task)
888{
889 struct rpc_clnt *clnt = task->tk_client;
890
Chuck Lever3748f1e2008-05-21 17:09:12 -0400891 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500892 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400893 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500894 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
896 /* Increment call count */
897 task->tk_msg.rpc_proc->p_count++;
898 clnt->cl_stats->rpccnt++;
899 task->tk_action = call_reserve;
900}
901
902/*
903 * 1. Reserve an RPC call slot
904 */
905static void
906call_reserve(struct rpc_task *task)
907{
Chuck Lever46121cf2007-01-31 12:14:08 -0500908 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 task->tk_status = 0;
911 task->tk_action = call_reserveresult;
912 xprt_reserve(task);
913}
914
915/*
916 * 1b. Grok the result of xprt_reserve()
917 */
918static void
919call_reserveresult(struct rpc_task *task)
920{
921 int status = task->tk_status;
922
Chuck Lever46121cf2007-01-31 12:14:08 -0500923 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925 /*
926 * After a call to xprt_reserve(), we must have either
927 * a request slot or else an error status.
928 */
929 task->tk_status = 0;
930 if (status >= 0) {
931 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -0400932 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 return;
934 }
935
936 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800937 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 rpc_exit(task, -EIO);
939 return;
940 }
941
942 /*
943 * Even though there was an error, we may have acquired
944 * a request slot somehow. Make sure not to leak it.
945 */
946 if (task->tk_rqstp) {
947 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800948 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 xprt_release(task);
950 }
951
952 switch (status) {
953 case -EAGAIN: /* woken up; retry */
954 task->tk_action = call_reserve;
955 return;
956 case -EIO: /* probably a shutdown */
957 break;
958 default:
959 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800960 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 break;
962 }
963 rpc_exit(task, status);
964}
965
966/*
J. Bruce Fields55576242010-09-12 19:55:25 -0400967 * 2. Bind and/or refresh the credentials
968 */
969static void
970call_refresh(struct rpc_task *task)
971{
972 dprint_status(task);
973
974 task->tk_action = call_refreshresult;
975 task->tk_status = 0;
976 task->tk_client->cl_stats->rpcauthrefresh++;
977 rpcauth_refreshcred(task);
978}
979
980/*
981 * 2a. Process the results of a credential refresh
982 */
983static void
984call_refreshresult(struct rpc_task *task)
985{
986 int status = task->tk_status;
987
988 dprint_status(task);
989
990 task->tk_status = 0;
991 task->tk_action = call_allocate;
992 if (status >= 0 && rpcauth_uptodatecred(task))
993 return;
994 switch (status) {
995 case -EACCES:
996 rpc_exit(task, -EACCES);
997 return;
998 case -ENOMEM:
999 rpc_exit(task, -ENOMEM);
1000 return;
1001 case -ETIMEDOUT:
1002 rpc_delay(task, 3*HZ);
1003 }
1004 task->tk_action = call_refresh;
1005}
1006
1007/*
1008 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001009 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 */
1011static void
1012call_allocate(struct rpc_task *task)
1013{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001014 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001015 struct rpc_rqst *req = task->tk_rqstp;
1016 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001017 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
Chuck Lever46121cf2007-01-31 12:14:08 -05001019 dprint_status(task);
1020
Chuck Lever2bea90d2007-03-29 16:47:53 -04001021 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001022 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001023
Chuck Lever02107142006-01-03 09:55:49 +01001024 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 return;
1026
Chuck Lever2bea90d2007-03-29 16:47:53 -04001027 if (proc->p_proc != 0) {
1028 BUG_ON(proc->p_arglen == 0);
1029 if (proc->p_decode != NULL)
1030 BUG_ON(proc->p_replen == 0);
1031 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
Chuck Lever2bea90d2007-03-29 16:47:53 -04001033 /*
1034 * Calculate the size (in quads) of the RPC call
1035 * and reply headers, and convert both values
1036 * to byte sizes.
1037 */
1038 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1039 req->rq_callsize <<= 2;
1040 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1041 req->rq_rcvsize <<= 2;
1042
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001043 req->rq_buffer = xprt->ops->buf_alloc(task,
1044 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001045 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001047
1048 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Trond Myklebust14b218a2005-06-22 17:16:28 +00001050 if (RPC_IS_ASYNC(task) || !signalled()) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001051 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 rpc_delay(task, HZ>>4);
1053 return;
1054 }
1055
1056 rpc_exit(task, -ERESTARTSYS);
1057}
1058
Trond Myklebust940e3312005-11-09 21:45:24 -05001059static inline int
1060rpc_task_need_encode(struct rpc_task *task)
1061{
1062 return task->tk_rqstp->rq_snd_buf.len == 0;
1063}
1064
1065static inline void
1066rpc_task_force_reencode(struct rpc_task *task)
1067{
1068 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001069 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001070}
1071
Chuck Lever2bea90d2007-03-29 16:47:53 -04001072static inline void
1073rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1074{
1075 buf->head[0].iov_base = start;
1076 buf->head[0].iov_len = len;
1077 buf->tail[0].iov_len = 0;
1078 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001079 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001080 buf->len = 0;
1081 buf->buflen = len;
1082}
1083
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084/*
1085 * 3. Encode arguments of an RPC call
1086 */
1087static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001088rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 struct rpc_rqst *req = task->tk_rqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 kxdrproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001092 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
Chuck Lever46121cf2007-01-31 12:14:08 -05001094 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Chuck Lever2bea90d2007-03-29 16:47:53 -04001096 rpc_xdr_buf_init(&req->rq_snd_buf,
1097 req->rq_buffer,
1098 req->rq_callsize);
1099 rpc_xdr_buf_init(&req->rq_rcv_buf,
1100 (char *)req->rq_buffer + req->rq_callsize,
1101 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
Chuck Leverb0e1c572008-05-21 17:09:19 -04001103 p = rpc_encode_header(task);
1104 if (p == NULL) {
1105 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 rpc_exit(task, -EIO);
1107 return;
1108 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001109
1110 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001111 if (encode == NULL)
1112 return;
1113
1114 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1115 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116}
1117
1118/*
1119 * 4. Get the server port number if not yet set
1120 */
1121static void
1122call_bind(struct rpc_task *task)
1123{
Chuck Leverec739ef2006-08-22 20:06:15 -04001124 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125
Chuck Lever46121cf2007-01-31 12:14:08 -05001126 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
Chuck Leverda351872005-08-11 16:25:11 -04001128 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001129 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001130 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001131 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001132 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 }
1134}
1135
1136/*
Chuck Leverda351872005-08-11 16:25:11 -04001137 * 4a. Sort out bind result
1138 */
1139static void
1140call_bind_status(struct rpc_task *task)
1141{
Chuck Lever906462a2007-09-11 18:00:47 -04001142 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001143
1144 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001145 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001146 task->tk_status = 0;
1147 task->tk_action = call_connect;
1148 return;
1149 }
1150
1151 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001152 case -ENOMEM:
1153 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1154 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001155 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001156 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001157 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1158 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001159 /* fail immediately if this is an RPC ping */
1160 if (task->tk_msg.rpc_proc->p_proc == 0) {
1161 status = -EOPNOTSUPP;
1162 break;
1163 }
Chuck Leverea635a52005-10-06 23:12:58 -04001164 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001165 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001166 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001167 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001168 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001169 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001170 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001171 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001172 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001173 task->tk_pid);
1174 break;
1175 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001176 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001177 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001178 task->tk_status = 0;
1179 task->tk_action = call_bind;
1180 return;
Chuck Lever012da152009-12-03 15:58:56 -05001181 case -ECONNREFUSED: /* connection problems */
1182 case -ECONNRESET:
1183 case -ENOTCONN:
1184 case -EHOSTDOWN:
1185 case -EHOSTUNREACH:
1186 case -ENETUNREACH:
1187 case -EPIPE:
1188 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1189 task->tk_pid, task->tk_status);
1190 if (!RPC_IS_SOFTCONN(task)) {
1191 rpc_delay(task, 5*HZ);
1192 goto retry_timeout;
1193 }
1194 status = task->tk_status;
1195 break;
Chuck Leverda351872005-08-11 16:25:11 -04001196 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001197 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001198 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001199 }
1200
1201 rpc_exit(task, status);
1202 return;
1203
Trond Myklebustda458282006-08-31 15:44:52 -04001204retry_timeout:
1205 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001206}
1207
1208/*
1209 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 */
1211static void
1212call_connect(struct rpc_task *task)
1213{
Chuck Leverda351872005-08-11 16:25:11 -04001214 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Chuck Lever46121cf2007-01-31 12:14:08 -05001216 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001217 task->tk_pid, xprt,
1218 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219
Chuck Leverda351872005-08-11 16:25:11 -04001220 task->tk_action = call_transmit;
1221 if (!xprt_connected(xprt)) {
1222 task->tk_action = call_connect_status;
1223 if (task->tk_status < 0)
1224 return;
1225 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227}
1228
1229/*
Chuck Leverda351872005-08-11 16:25:11 -04001230 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 */
1232static void
1233call_connect_status(struct rpc_task *task)
1234{
1235 struct rpc_clnt *clnt = task->tk_client;
1236 int status = task->tk_status;
1237
Chuck Lever46121cf2007-01-31 12:14:08 -05001238 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001239
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001241 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 clnt->cl_stats->netreconn++;
1243 task->tk_action = call_transmit;
1244 return;
1245 }
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001248 /* if soft mounted, test if we've timed out */
1249 case -ETIMEDOUT:
1250 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001251 break;
1252 default:
1253 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 }
1255}
1256
1257/*
1258 * 5. Transmit the RPC request, and wait for reply
1259 */
1260static void
1261call_transmit(struct rpc_task *task)
1262{
Chuck Lever46121cf2007-01-31 12:14:08 -05001263 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
1265 task->tk_action = call_status;
1266 if (task->tk_status < 0)
1267 return;
1268 task->tk_status = xprt_prepare_transmit(task);
1269 if (task->tk_status != 0)
1270 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001271 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001273 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001274 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001275 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001276 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001277 if (task->tk_status != 0) {
1278 /* Was the error nonfatal? */
1279 if (task->tk_status == -EAGAIN)
1280 rpc_delay(task, HZ >> 4);
1281 else
1282 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001283 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001284 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001285 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 xprt_transmit(task);
1287 if (task->tk_status < 0)
1288 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001289 /*
1290 * On success, ensure that we call xprt_end_transmit() before sleeping
1291 * in order to allow access to the socket to other RPC requests.
1292 */
1293 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001294 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001295 return;
1296 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001297 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001298}
1299
1300/*
1301 * 5a. Handle cleanup after a transmission
1302 */
1303static void
1304call_transmit_status(struct rpc_task *task)
1305{
1306 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001307
1308 /*
1309 * Common case: success. Force the compiler to put this
1310 * test first.
1311 */
1312 if (task->tk_status == 0) {
1313 xprt_end_transmit(task);
1314 rpc_task_force_reencode(task);
1315 return;
1316 }
1317
Trond Myklebust15f081c2009-03-11 14:37:57 -04001318 switch (task->tk_status) {
1319 case -EAGAIN:
1320 break;
1321 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001322 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001323 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001324 rpc_task_force_reencode(task);
1325 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001326 /*
1327 * Special cases: if we've been waiting on the
1328 * socket's write_space() callback, or if the
1329 * socket just returned a connection error,
1330 * then hold onto the transport lock.
1331 */
1332 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001333 case -EHOSTDOWN:
1334 case -EHOSTUNREACH:
1335 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001336 if (RPC_IS_SOFTCONN(task)) {
1337 xprt_end_transmit(task);
1338 rpc_exit(task, task->tk_status);
1339 break;
1340 }
1341 case -ECONNRESET:
1342 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001343 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001344 rpc_task_force_reencode(task);
1345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346}
1347
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001348#if defined(CONFIG_NFS_V4_1)
1349/*
1350 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1351 * addition, disconnect on connectivity errors.
1352 */
1353static void
1354call_bc_transmit(struct rpc_task *task)
1355{
1356 struct rpc_rqst *req = task->tk_rqstp;
1357
1358 BUG_ON(task->tk_status != 0);
1359 task->tk_status = xprt_prepare_transmit(task);
1360 if (task->tk_status == -EAGAIN) {
1361 /*
1362 * Could not reserve the transport. Try again after the
1363 * transport is released.
1364 */
1365 task->tk_status = 0;
1366 task->tk_action = call_bc_transmit;
1367 return;
1368 }
1369
1370 task->tk_action = rpc_exit_task;
1371 if (task->tk_status < 0) {
1372 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1373 "error: %d\n", task->tk_status);
1374 return;
1375 }
1376
1377 xprt_transmit(task);
1378 xprt_end_transmit(task);
1379 dprint_status(task);
1380 switch (task->tk_status) {
1381 case 0:
1382 /* Success */
1383 break;
1384 case -EHOSTDOWN:
1385 case -EHOSTUNREACH:
1386 case -ENETUNREACH:
1387 case -ETIMEDOUT:
1388 /*
1389 * Problem reaching the server. Disconnect and let the
1390 * forechannel reestablish the connection. The server will
1391 * have to retransmit the backchannel request and we'll
1392 * reprocess it. Since these ops are idempotent, there's no
1393 * need to cache our reply at this time.
1394 */
1395 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1396 "error: %d\n", task->tk_status);
1397 xprt_conditional_disconnect(task->tk_xprt,
1398 req->rq_connect_cookie);
1399 break;
1400 default:
1401 /*
1402 * We were unable to reply and will have to drop the
1403 * request. The server should reconnect and retransmit.
1404 */
1405 BUG_ON(task->tk_status == -EAGAIN);
1406 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1407 "error: %d\n", task->tk_status);
1408 break;
1409 }
1410 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1411}
1412#endif /* CONFIG_NFS_V4_1 */
1413
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414/*
1415 * 6. Sort out the RPC call status
1416 */
1417static void
1418call_status(struct rpc_task *task)
1419{
1420 struct rpc_clnt *clnt = task->tk_client;
1421 struct rpc_rqst *req = task->tk_rqstp;
1422 int status;
1423
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001424 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1425 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Chuck Lever46121cf2007-01-31 12:14:08 -05001427 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
1429 status = task->tk_status;
1430 if (status >= 0) {
1431 task->tk_action = call_decode;
1432 return;
1433 }
1434
1435 task->tk_status = 0;
1436 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001437 case -EHOSTDOWN:
1438 case -EHOSTUNREACH:
1439 case -ENETUNREACH:
1440 /*
1441 * Delay any retries for 3 seconds, then handle as if it
1442 * were a timeout.
1443 */
1444 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 case -ETIMEDOUT:
1446 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001447 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001448 xprt_conditional_disconnect(task->tk_xprt,
1449 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001451 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001453 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001454 rpc_delay(task, 3*HZ);
1455 case -EPIPE:
1456 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 task->tk_action = call_bind;
1458 break;
1459 case -EAGAIN:
1460 task->tk_action = call_transmit;
1461 break;
1462 case -EIO:
1463 /* shutdown or soft timeout */
1464 rpc_exit(task, status);
1465 break;
1466 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001467 if (clnt->cl_chatty)
1468 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 clnt->cl_protname, -status);
1470 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 }
1472}
1473
1474/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001475 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 * We do not release the request slot, so we keep using the
1477 * same XID for all retransmits.
1478 */
1479static void
1480call_timeout(struct rpc_task *task)
1481{
1482 struct rpc_clnt *clnt = task->tk_client;
1483
1484 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001485 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 goto retry;
1487 }
1488
Chuck Lever46121cf2007-01-31 12:14:08 -05001489 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001490 task->tk_timeouts++;
1491
Chuck Lever3a28bec2009-12-03 15:58:56 -05001492 if (RPC_IS_SOFTCONN(task)) {
1493 rpc_exit(task, -ETIMEDOUT);
1494 return;
1495 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001497 if (clnt->cl_chatty)
1498 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 clnt->cl_protname, clnt->cl_server);
1500 rpc_exit(task, -EIO);
1501 return;
1502 }
1503
Chuck Leverf518e352006-01-03 09:55:52 +01001504 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001506 if (clnt->cl_chatty)
1507 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 clnt->cl_protname, clnt->cl_server);
1509 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001510 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001511 /*
1512 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1513 * event? RFC2203 requires the server to drop all such requests.
1514 */
1515 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
1517retry:
1518 clnt->cl_stats->rpcretrans++;
1519 task->tk_action = call_bind;
1520 task->tk_status = 0;
1521}
1522
1523/*
1524 * 7. Decode the RPC reply
1525 */
1526static void
1527call_decode(struct rpc_task *task)
1528{
1529 struct rpc_clnt *clnt = task->tk_client;
1530 struct rpc_rqst *req = task->tk_rqstp;
1531 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001532 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Chuck Lever46121cf2007-01-31 12:14:08 -05001534 dprintk("RPC: %5u call_decode (status %d)\n",
1535 task->tk_pid, task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Chuck Leverf518e352006-01-03 09:55:52 +01001537 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001538 if (clnt->cl_chatty)
1539 printk(KERN_NOTICE "%s: server %s OK\n",
1540 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1542 }
1543
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001544 /*
1545 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001546 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001547 */
1548 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 req->rq_rcv_buf.len = req->rq_private_buf.len;
1550
1551 /* Check that the softirq receive buffer is valid */
1552 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1553 sizeof(req->rq_rcv_buf)) != 0);
1554
Trond Myklebust1e799b62008-03-21 16:19:41 -04001555 if (req->rq_rcv_buf.len < 12) {
1556 if (!RPC_IS_SOFT(task)) {
1557 task->tk_action = call_bind;
1558 clnt->cl_stats->rpcretrans++;
1559 goto out_retry;
1560 }
1561 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1562 clnt->cl_protname, task->tk_status);
1563 task->tk_action = call_timeout;
1564 goto out_retry;
1565 }
1566
Chuck Leverb0e1c572008-05-21 17:09:19 -04001567 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001568 if (IS_ERR(p)) {
1569 if (p == ERR_PTR(-EAGAIN))
1570 goto out_retry;
1571 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 }
1573
Trond Myklebustabbcf282006-01-03 09:55:03 +01001574 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001576 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1578 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001579 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001580 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1581 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 return;
1583out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001585 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001586 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001587 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001588 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001589 xprt_conditional_disconnect(task->tk_xprt,
1590 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001591 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592}
1593
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001594static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001595rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596{
1597 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001599 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
1601 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001602
1603 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 *p++ = req->rq_xid; /* XID */
1605 *p++ = htonl(RPC_CALL); /* CALL */
1606 *p++ = htonl(RPC_VERSION); /* RPC version */
1607 *p++ = htonl(clnt->cl_prog); /* program number */
1608 *p++ = htonl(clnt->cl_vers); /* program version */
1609 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001610 p = rpcauth_marshcred(task, p);
1611 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1612 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613}
1614
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001615static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001616rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
1618 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1619 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001620 __be32 *p = iov->iov_base;
1621 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 int error = -EACCES;
1623
David Howellse8896492006-08-24 15:44:19 -04001624 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1625 /* RFC-1014 says that the representation of XDR data must be a
1626 * multiple of four bytes
1627 * - if it isn't pointer subtraction in the NFS client may give
1628 * undefined results
1629 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001630 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001631 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001632 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001633 goto out_eio;
1634 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 if ((len -= 3) < 0)
1636 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001638 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001640 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001641 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001642 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001644
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1646 if (--len < 0)
1647 goto out_overflow;
1648 switch ((n = ntohl(*p++))) {
1649 case RPC_AUTH_ERROR:
1650 break;
1651 case RPC_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001652 dprintk("RPC: %5u %s: RPC call version "
1653 "mismatch!\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001654 task->tk_pid, __func__);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001655 error = -EPROTONOSUPPORT;
1656 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001658 dprintk("RPC: %5u %s: RPC call rejected, "
1659 "unknown error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001660 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 goto out_eio;
1662 }
1663 if (--len < 0)
1664 goto out_overflow;
1665 switch ((n = ntohl(*p++))) {
1666 case RPC_AUTH_REJECTEDCRED:
1667 case RPC_AUTH_REJECTEDVERF:
1668 case RPCSEC_GSS_CREDPROBLEM:
1669 case RPCSEC_GSS_CTXPROBLEM:
1670 if (!task->tk_cred_retry)
1671 break;
1672 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001673 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001674 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001676 /* Ensure we obtain a new XID! */
1677 xprt_release(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 task->tk_action = call_refresh;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001679 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 case RPC_AUTH_BADCRED:
1681 case RPC_AUTH_BADVERF:
1682 /* possibly garbled cred/verf? */
1683 if (!task->tk_garb_retry)
1684 break;
1685 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001686 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001687 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001689 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001691 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001692 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 break;
1694 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001695 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001696 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 error = -EIO;
1698 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001699 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001700 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 goto out_err;
1702 }
1703 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001704 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001705 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001706 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001708 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 if (len < 0)
1710 goto out_overflow;
1711 switch ((n = ntohl(*p++))) {
1712 case RPC_SUCCESS:
1713 return p;
1714 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001715 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001716 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 (unsigned int)task->tk_client->cl_prog,
1718 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001719 error = -EPFNOSUPPORT;
1720 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001722 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001723 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 (unsigned int)task->tk_client->cl_prog,
1725 (unsigned int)task->tk_client->cl_vers,
1726 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001727 error = -EPROTONOSUPPORT;
1728 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001730 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001731 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001732 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001733 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 task->tk_client->cl_prog,
1735 task->tk_client->cl_vers,
1736 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001737 error = -EOPNOTSUPP;
1738 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001740 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001741 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 break; /* retry */
1743 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001744 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001745 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 /* Also retry */
1747 }
1748
Trond Myklebustabbcf282006-01-03 09:55:03 +01001749out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 task->tk_client->cl_stats->rpcgarbage++;
1751 if (task->tk_garb_retry) {
1752 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001753 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001754 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001756out_retry:
1757 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759out_eio:
1760 error = -EIO;
1761out_err:
1762 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001763 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001764 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001765 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001767 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001768 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001769 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001771
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001772static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001773{
1774 return 0;
1775}
1776
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001777static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001778{
1779 return 0;
1780}
1781
1782static struct rpc_procinfo rpcproc_null = {
1783 .p_encode = rpcproc_encode_null,
1784 .p_decode = rpcproc_decode_null,
1785};
1786
Chuck Levercaabea82009-12-03 15:58:56 -05001787static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001788{
1789 struct rpc_message msg = {
1790 .rpc_proc = &rpcproc_null,
1791 };
1792 int err;
1793 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001794 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001795 put_rpccred(msg.rpc_cred);
1796 return err;
1797}
Trond Myklebust188fef12007-06-16 14:18:40 -04001798
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001799struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1800{
1801 struct rpc_message msg = {
1802 .rpc_proc = &rpcproc_null,
1803 .rpc_cred = cred,
1804 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001805 struct rpc_task_setup task_setup_data = {
1806 .rpc_client = clnt,
1807 .rpc_message = &msg,
1808 .callback_ops = &rpc_default_ops,
1809 .flags = flags,
1810 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001811 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001812}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001813EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001814
Trond Myklebust188fef12007-06-16 14:18:40 -04001815#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001816static void rpc_show_header(void)
1817{
Chuck Levercb3997b2008-05-21 17:09:41 -04001818 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1819 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001820}
1821
Chuck Lever38e886e2008-05-21 17:09:33 -04001822static void rpc_show_task(const struct rpc_clnt *clnt,
1823 const struct rpc_task *task)
1824{
1825 const char *rpc_waitq = "none";
Chuck Levercb3997b2008-05-21 17:09:41 -04001826 char *p, action[KSYM_SYMBOL_LEN];
Chuck Lever38e886e2008-05-21 17:09:33 -04001827
1828 if (RPC_IS_QUEUED(task))
1829 rpc_waitq = rpc_qname(task->tk_waitqueue);
1830
Chuck Levercb3997b2008-05-21 17:09:41 -04001831 /* map tk_action pointer to a function name; then trim off
1832 * the "+0x0 [sunrpc]" */
1833 sprint_symbol(action, (unsigned long)task->tk_action);
1834 p = strchr(action, '+');
1835 if (p)
1836 *p = '\0';
1837
1838 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1839 task->tk_pid, task->tk_flags, task->tk_status,
1840 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1841 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1842 action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001843}
1844
Trond Myklebust188fef12007-06-16 14:18:40 -04001845void rpc_show_tasks(void)
1846{
1847 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001848 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001849 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001850
1851 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001852 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001853 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001854 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001855 if (!header) {
1856 rpc_show_header();
1857 header++;
1858 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001859 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001860 }
1861 spin_unlock(&clnt->cl_lock);
1862 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001863 spin_unlock(&rpc_client_lock);
1864}
1865#endif