blob: 5ef192c1a57cf3cf26c3a5c6a93833fb83e43bc0 [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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
20#include <asm/system.h>
21
22#include <linux/module.h>
23#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040024#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040026#include <linux/namei.h>
27#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050037#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040038#include <linux/sunrpc/bc_xprt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040040#include "sunrpc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#ifdef RPC_DEBUG
43# define RPCDBG_FACILITY RPCDBG_CALL
44#endif
45
Chuck Lever46121cf2007-01-31 12:14:08 -050046#define dprint_status(t) \
47 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080048 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050049
Trond Myklebust188fef12007-06-16 14:18:40 -040050/*
51 * All RPC clients are linked into this list
52 */
53static LIST_HEAD(all_clients);
54static DEFINE_SPINLOCK(rpc_client_lock);
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
57
58
59static void call_start(struct rpc_task *task);
60static void call_reserve(struct rpc_task *task);
61static void call_reserveresult(struct rpc_task *task);
62static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063static void call_decode(struct rpc_task *task);
64static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040065static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040067#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040068static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040069#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050071static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_refresh(struct rpc_task *task);
73static void call_refreshresult(struct rpc_task *task);
74static void call_timeout(struct rpc_task *task);
75static void call_connect(struct rpc_task *task);
76static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Chuck Leverb0e1c572008-05-21 17:09:19 -040078static __be32 *rpc_encode_header(struct rpc_task *task);
79static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050080static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040081
Trond Myklebust188fef12007-06-16 14:18:40 -040082static void rpc_register_client(struct rpc_clnt *clnt)
83{
84 spin_lock(&rpc_client_lock);
85 list_add(&clnt->cl_clients, &all_clients);
86 spin_unlock(&rpc_client_lock);
87}
88
89static void rpc_unregister_client(struct rpc_clnt *clnt)
90{
91 spin_lock(&rpc_client_lock);
92 list_del(&clnt->cl_clients);
93 spin_unlock(&rpc_client_lock);
94}
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +040096static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
97{
98 if (clnt->cl_path.dentry)
99 rpc_remove_client_dir(clnt->cl_path.dentry);
100 clnt->cl_path.dentry = NULL;
101}
102
103static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
105 struct super_block *pipefs_sb;
106 int put_mnt = 0;
107
108 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
109 if (pipefs_sb) {
110 if (clnt->cl_path.dentry)
111 put_mnt = 1;
112 __rpc_clnt_remove_pipedir(clnt);
113 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
114 }
115 if (put_mnt)
116 rpc_put_mount();
117}
118
119static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
120 struct rpc_clnt *clnt, char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
Trond Myklebustf1345852005-09-23 11:08:25 -0400122 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400123 char name[15];
124 struct qstr q = {
125 .name = name,
126 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400127 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 int error;
129
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400130 dir = rpc_d_lookup_sb(sb, dir_name);
131 if (dir == NULL)
132 return dir;
133 for (;;) {
134 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
135 name[sizeof(name) - 1] = '\0';
136 q.hash = full_name_hash(q.name, q.len);
137 dentry = rpc_create_client_dir(dir, &q, clnt);
138 if (!IS_ERR(dentry))
139 break;
140 error = PTR_ERR(dentry);
141 if (error != -EEXIST) {
142 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
143 " %s/%s, error %d\n",
144 dir_name, name, error);
145 break;
146 }
147 }
148 dput(dir);
149 return dentry;
150}
151
152static int
153rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
154{
155 struct super_block *pipefs_sb;
156 struct path path;
157
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400158 clnt->cl_path.mnt = ERR_PTR(-ENOENT);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400159 clnt->cl_path.dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 if (dir_name == NULL)
161 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500162
Trond Myklebust23ac6582009-08-09 15:14:25 -0400163 path.mnt = rpc_get_mount();
164 if (IS_ERR(path.mnt))
165 return PTR_ERR(path.mnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400166 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
167 if (!pipefs_sb) {
168 rpc_put_mount();
169 return -ENOENT;
Christoph Hellwig278c9952005-07-24 23:53:01 +0100170 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400171 path.dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
172 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
173 if (IS_ERR(path.dentry)) {
174 rpc_put_mount();
175 return PTR_ERR(path.dentry);
176 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400177 clnt->cl_path = path;
178 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179}
180
Trond Myklebust698b6d02007-12-20 16:03:53 -0500181static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500183 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 struct rpc_version *version;
185 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000186 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400188 size_t len;
189
190 /* sanity check the name before trying to print it */
191 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500192 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400193 if (len > RPC_MAXNETNAMELEN)
194 goto out_no_rpciod;
195 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Chuck Lever46121cf2007-01-31 12:14:08 -0500197 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500198 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Trond Myklebust4ada5392007-06-14 17:26:17 -0400200 err = rpciod_up();
201 if (err)
202 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 err = -EINVAL;
204 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800205 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500206
207 if (args->version >= program->nrvers)
208 goto out_err;
209 version = program->version[args->version];
210 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 goto out_err;
212
213 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700214 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 if (!clnt)
216 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 clnt->cl_parent = clnt;
218
219 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 if (len > sizeof(clnt->cl_inline_name)) {
221 char *buf = kmalloc(len, GFP_KERNEL);
Trond Myklebust698b6d02007-12-20 16:03:53 -0500222 if (buf != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 clnt->cl_server = buf;
224 else
225 len = sizeof(clnt->cl_inline_name);
226 }
Trond Myklebust698b6d02007-12-20 16:03:53 -0500227 strlcpy(clnt->cl_server, args->servername, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229 clnt->cl_xprt = xprt;
230 clnt->cl_procinfo = version->procs;
231 clnt->cl_maxproc = version->nrprocs;
232 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300233 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500236 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500237 err = -ENOMEM;
238 if (clnt->cl_metrics == NULL)
239 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500240 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400241 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400242 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Chuck Leverec739ef2006-08-22 20:06:15 -0400244 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 clnt->cl_autobind = 1;
246
Trond Myklebustba7392b2007-12-20 16:03:55 -0500247 clnt->cl_timeout = xprt->timeout;
248 if (args->timeout != NULL) {
249 memcpy(&clnt->cl_timeout_default, args->timeout,
250 sizeof(clnt->cl_timeout_default));
251 clnt->cl_timeout = &clnt->cl_timeout_default;
252 }
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500255 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500256 clnt->cl_principal = NULL;
257 if (args->client_name) {
258 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
259 if (!clnt->cl_principal)
260 goto out_no_principal;
261 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Trond Myklebust006abe82010-09-12 19:55:25 -0400263 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
266 if (err < 0)
267 goto out_no_path;
268
Trond Myklebust698b6d02007-12-20 16:03:53 -0500269 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000270 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500272 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000273 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 goto out_no_auth;
275 }
276
277 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400278 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 if (clnt->cl_nodelen > UNX_MAXNODENAME)
280 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400281 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400282 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 return clnt;
284
285out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400286 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500288 kfree(clnt->cl_principal);
289out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500290 rpc_free_iostats(clnt->cl_metrics);
291out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 if (clnt->cl_server != clnt->cl_inline_name)
293 kfree(clnt->cl_server);
294 kfree(clnt);
295out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400296 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800297out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400298 rpciod_down();
299out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 return ERR_PTR(err);
301}
302
Chuck Leverc2866762006-08-22 20:06:20 -0400303/*
304 * rpc_create - create an RPC client and transport with one call
305 * @args: rpc_clnt create argument structure
306 *
307 * Creates and initializes an RPC transport and an RPC client.
308 *
309 * It can ping the server in order to determine if it is up, and to see if
310 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
311 * this behavior so asynchronous tasks can also use rpc_create.
312 */
313struct rpc_clnt *rpc_create(struct rpc_create_args *args)
314{
315 struct rpc_xprt *xprt;
316 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400317 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400318 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400319 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200320 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200321 .dstaddr = args->address,
322 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300323 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200324 };
Chuck Lever510deb02007-12-10 14:56:24 -0500325 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400326
Chuck Leverc2866762006-08-22 20:06:20 -0400327 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400328 * If the caller chooses not to specify a hostname, whip
329 * up a string representation of the passed-in address.
330 */
331 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400332 struct sockaddr_un *sun =
333 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400334 struct sockaddr_in *sin =
335 (struct sockaddr_in *)args->address;
336 struct sockaddr_in6 *sin6 =
337 (struct sockaddr_in6 *)args->address;
338
Chuck Lever510deb02007-12-10 14:56:24 -0500339 servername[0] = '\0';
340 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400341 case AF_LOCAL:
342 snprintf(servername, sizeof(servername), "%s",
343 sun->sun_path);
344 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400345 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700346 snprintf(servername, sizeof(servername), "%pI4",
347 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500348 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400349 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700350 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400351 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500352 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500353 default:
354 /* caller wants default server name, but
355 * address family isn't recognized. */
356 return ERR_PTR(-EINVAL);
357 }
Chuck Lever43780b82007-07-01 12:13:22 -0400358 args->servername = servername;
359 }
360
Chuck Lever510deb02007-12-10 14:56:24 -0500361 xprt = xprt_create_transport(&xprtargs);
362 if (IS_ERR(xprt))
363 return (struct rpc_clnt *)xprt;
364
Chuck Lever43780b82007-07-01 12:13:22 -0400365 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400366 * By default, kernel RPC client connects from a reserved port.
367 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
368 * but it is always enabled for rpciod, which handles the connect
369 * operation.
370 */
371 xprt->resvport = 1;
372 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
373 xprt->resvport = 0;
374
Trond Myklebust698b6d02007-12-20 16:03:53 -0500375 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400376 if (IS_ERR(clnt))
377 return clnt;
378
379 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500380 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400381 if (err != 0) {
382 rpc_shutdown_client(clnt);
383 return ERR_PTR(err);
384 }
385 }
386
387 clnt->cl_softrtry = 1;
388 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
389 clnt->cl_softrtry = 0;
390
Chuck Leverc2866762006-08-22 20:06:20 -0400391 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
392 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500393 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
394 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400395 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
396 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400397
398 return clnt;
399}
Chuck Leverb86acd52006-08-22 20:06:22 -0400400EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400401
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402/*
403 * This function clones the RPC client structure. It allows us to share the
404 * same transport while varying parameters such as the authentication
405 * flavour.
406 */
407struct rpc_clnt *
408rpc_clone_client(struct rpc_clnt *clnt)
409{
410 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500411 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200413 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 if (!new)
415 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400416 new->cl_parent = clnt;
417 /* Turn off autobind on clones */
418 new->cl_autobind = 0;
419 INIT_LIST_HEAD(&new->cl_tasks);
420 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500421 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500422 new->cl_metrics = rpc_alloc_iostats(clnt);
423 if (new->cl_metrics == NULL)
424 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500425 if (clnt->cl_principal) {
426 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
427 if (new->cl_principal == NULL)
428 goto out_no_principal;
429 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400430 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500431 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
432 if (err != 0)
433 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 if (new->cl_auth)
435 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400436 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400437 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400438 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400439 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500441out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500442 kfree(new->cl_principal);
443out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500444 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500445out_no_stats:
446 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800448 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500449 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400451EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
453/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400454 * Kill all tasks for the given client.
455 * XXX: kill their descendants as well?
456 */
457void rpc_killall_tasks(struct rpc_clnt *clnt)
458{
459 struct rpc_task *rovr;
460
461
462 if (list_empty(&clnt->cl_tasks))
463 return;
464 dprintk("RPC: killing all tasks for client %p\n", clnt);
465 /*
466 * Spin lock all_tasks to prevent changes...
467 */
468 spin_lock(&clnt->cl_lock);
469 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
470 if (!RPC_IS_ACTIVATED(rovr))
471 continue;
472 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
473 rovr->tk_flags |= RPC_TASK_KILLED;
474 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300475 if (RPC_IS_QUEUED(rovr))
476 rpc_wake_up_queued_task(rovr->tk_waitqueue,
477 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400478 }
479 }
480 spin_unlock(&clnt->cl_lock);
481}
482EXPORT_SYMBOL_GPL(rpc_killall_tasks);
483
484/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400486 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400488void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400490 dprintk("RPC: shutting down %s client for %s\n",
491 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
Trond Myklebust34f52e32007-06-14 16:40:31 -0400493 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800495 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400496 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
498
Trond Myklebust4c402b42007-06-14 16:40:32 -0400499 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400501EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
503/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400504 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400506static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400507rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
Chuck Lever46121cf2007-01-31 12:14:08 -0500509 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 clnt->cl_protname, clnt->cl_server);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400511 rpc_clnt_remove_pipedir(clnt);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500512 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400513 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500514 goto out_free;
515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 if (clnt->cl_server != clnt->cl_inline_name)
517 kfree(clnt->cl_server);
518out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400519 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500520 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500521 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500522 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400523 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400524 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526}
527
528/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400529 * Free an RPC client
530 */
531static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400532rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400533{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400534 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400535 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400536 return;
537 }
538
539 /*
540 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
541 * release remaining GSS contexts. This mechanism ensures
542 * that it can do so safely.
543 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400544 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400545 rpcauth_release(clnt->cl_auth);
546 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400547 if (atomic_dec_and_test(&clnt->cl_count))
548 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400549}
550
551/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400552 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
554void
555rpc_release_client(struct rpc_clnt *clnt)
556{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400557 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Trond Myklebust34f52e32007-06-14 16:40:31 -0400559 if (list_empty(&clnt->cl_tasks))
560 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400561 if (atomic_dec_and_test(&clnt->cl_count))
562 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400563}
564
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000565/**
566 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800567 * @old: old rpc_client
568 * @program: rpc program to set
569 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000570 *
571 * Clones the rpc client and sets up a new RPC program. This is mainly
572 * of use for enabling different RPC programs to share the same transport.
573 * The Sun NFSv2/v3 ACL protocol can do this.
574 */
575struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
576 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400577 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000578{
579 struct rpc_clnt *clnt;
580 struct rpc_version *version;
581 int err;
582
583 BUG_ON(vers >= program->nrvers || !program->version[vers]);
584 version = program->version[vers];
585 clnt = rpc_clone_client(old);
586 if (IS_ERR(clnt))
587 goto out;
588 clnt->cl_procinfo = version->procs;
589 clnt->cl_maxproc = version->nrprocs;
590 clnt->cl_protname = program->name;
591 clnt->cl_prog = program->number;
592 clnt->cl_vers = version->number;
593 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500594 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000595 if (err != 0) {
596 rpc_shutdown_client(clnt);
597 clnt = ERR_PTR(err);
598 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800599out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000600 return clnt;
601}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400602EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000603
Trond Myklebust58f96122010-07-31 14:29:08 -0400604void rpc_task_release_client(struct rpc_task *task)
605{
606 struct rpc_clnt *clnt = task->tk_client;
607
608 if (clnt != NULL) {
609 /* Remove from client task list */
610 spin_lock(&clnt->cl_lock);
611 list_del(&task->tk_task);
612 spin_unlock(&clnt->cl_lock);
613 task->tk_client = NULL;
614
615 rpc_release_client(clnt);
616 }
617}
618
619static
620void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
621{
622 if (clnt != NULL) {
623 rpc_task_release_client(task);
624 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400625 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400626 if (clnt->cl_softrtry)
627 task->tk_flags |= RPC_TASK_SOFT;
628 /* Add to the client's list of all tasks */
629 spin_lock(&clnt->cl_lock);
630 list_add_tail(&task->tk_task, &clnt->cl_tasks);
631 spin_unlock(&clnt->cl_lock);
632 }
633}
634
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000635void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
636{
637 rpc_task_release_client(task);
638 rpc_task_set_client(task, clnt);
639}
640EXPORT_SYMBOL_GPL(rpc_task_reset_client);
641
642
Trond Myklebust58f96122010-07-31 14:29:08 -0400643static void
644rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
645{
646 if (msg != NULL) {
647 task->tk_msg.rpc_proc = msg->rpc_proc;
648 task->tk_msg.rpc_argp = msg->rpc_argp;
649 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400650 if (msg->rpc_cred != NULL)
651 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400652 }
653}
654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655/*
656 * Default callback for async RPC calls
657 */
658static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100659rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
661}
662
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100663static const struct rpc_call_ops rpc_default_ops = {
664 .rpc_call_done = rpc_default_callback,
665};
666
Trond Myklebustc970aa82007-07-14 15:39:59 -0400667/**
668 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
669 * @task_setup_data: pointer to task initialisation data
670 */
671struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400672{
Trond Myklebust19445b92010-04-16 16:41:10 -0400673 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400674
Trond Myklebust84115e12007-07-14 15:39:59 -0400675 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400676 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400677 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400678
Trond Myklebust58f96122010-07-31 14:29:08 -0400679 rpc_task_set_client(task, task_setup_data->rpc_client);
680 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
681
Trond Myklebust58f96122010-07-31 14:29:08 -0400682 if (task->tk_action == NULL)
683 rpc_call_start(task);
684
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400685 atomic_inc(&task->tk_count);
686 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400687out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400688 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400689}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400690EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400691
692/**
693 * rpc_call_sync - Perform a synchronous RPC call
694 * @clnt: pointer to RPC client
695 * @msg: RPC call parameters
696 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500698int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699{
700 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400701 struct rpc_task_setup task_setup_data = {
702 .rpc_client = clnt,
703 .rpc_message = msg,
704 .callback_ops = &rpc_default_ops,
705 .flags = flags,
706 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400707 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 BUG_ON(flags & RPC_TASK_ASYNC);
710
Trond Myklebustc970aa82007-07-14 15:39:59 -0400711 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400712 if (IS_ERR(task))
713 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100714 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800715 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 return status;
717}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400718EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400720/**
721 * rpc_call_async - Perform an asynchronous RPC call
722 * @clnt: pointer to RPC client
723 * @msg: RPC call parameters
724 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800725 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400726 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 */
728int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500729rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100730 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731{
732 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400733 struct rpc_task_setup task_setup_data = {
734 .rpc_client = clnt,
735 .rpc_message = msg,
736 .callback_ops = tk_ops,
737 .callback_data = data,
738 .flags = flags|RPC_TASK_ASYNC,
739 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
Trond Myklebustc970aa82007-07-14 15:39:59 -0400741 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400742 if (IS_ERR(task))
743 return PTR_ERR(task);
744 rpc_put_task(task);
745 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400747EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400749#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400750/**
751 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
752 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400753 * @req: RPC request
754 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400755 */
756struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400757 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400758{
759 struct rpc_task *task;
760 struct xdr_buf *xbufp = &req->rq_snd_buf;
761 struct rpc_task_setup task_setup_data = {
762 .callback_ops = tk_ops,
763 };
764
765 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
766 /*
767 * Create an rpc_task to send the data
768 */
769 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400770 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400771 xprt_free_bc_request(req);
772 goto out;
773 }
774 task->tk_rqstp = req;
775
776 /*
777 * Set up the xdr_buf length.
778 * This also indicates that the buffer is XDR encoded already.
779 */
780 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
781 xbufp->tail[0].iov_len;
782
783 task->tk_action = call_bc_transmit;
784 atomic_inc(&task->tk_count);
785 BUG_ON(atomic_read(&task->tk_count) != 2);
786 rpc_execute(task);
787
788out:
789 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
790 return task;
791}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400792#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400793
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400795rpc_call_start(struct rpc_task *task)
796{
797 task->tk_action = call_start;
798}
799EXPORT_SYMBOL_GPL(rpc_call_start);
800
Chuck Levered394402006-08-22 20:06:17 -0400801/**
802 * rpc_peeraddr - extract remote peer address from clnt's xprt
803 * @clnt: RPC client structure
804 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800805 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400806 *
807 * Returns the number of bytes that are actually in the stored address.
808 */
809size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
810{
811 size_t bytes;
812 struct rpc_xprt *xprt = clnt->cl_xprt;
813
814 bytes = sizeof(xprt->addr);
815 if (bytes > bufsize)
816 bytes = bufsize;
817 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400818 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400819}
Chuck Leverb86acd52006-08-22 20:06:22 -0400820EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400821
Chuck Leverf425eba2006-08-22 20:06:18 -0400822/**
823 * rpc_peeraddr2str - return remote peer address in printable format
824 * @clnt: RPC client structure
825 * @format: address format
826 *
827 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500828const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
829 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400830{
831 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500832
833 if (xprt->address_strings[format] != NULL)
834 return xprt->address_strings[format];
835 else
836 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400837}
Chuck Leverb86acd52006-08-22 20:06:22 -0400838EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840void
841rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
842{
843 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700844 if (xprt->ops->set_buffer_size)
845 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400847EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
849/*
850 * Return size of largest payload RPC client can support, in bytes
851 *
852 * For stream transports, this is one RPC record fragment (see RFC
853 * 1831), as we don't support multi-record requests yet. For datagram
854 * transports, this is the size of an IP packet minus the IP, UDP, and
855 * RPC header sizes.
856 */
857size_t rpc_max_payload(struct rpc_clnt *clnt)
858{
859 return clnt->cl_xprt->max_payload;
860}
Chuck Leverb86acd52006-08-22 20:06:22 -0400861EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Chuck Lever35f5a422006-01-03 09:55:50 +0100863/**
864 * rpc_force_rebind - force transport to check that remote port is unchanged
865 * @clnt: client to rebind
866 *
867 */
868void rpc_force_rebind(struct rpc_clnt *clnt)
869{
870 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400871 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100872}
Chuck Leverb86acd52006-08-22 20:06:22 -0400873EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100874
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400876 * Restart an (async) RPC call from the call_prepare state.
877 * Usually called from within the exit handler.
878 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400879int
Andy Adamsonaae20062009-04-01 09:22:40 -0400880rpc_restart_call_prepare(struct rpc_task *task)
881{
882 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400883 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700884 task->tk_action = call_start;
885 if (task->tk_ops->rpc_call_prepare != NULL)
886 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400887 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400888}
889EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
890
891/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 * Restart an (async) RPC call. Usually called from within the
893 * exit handler.
894 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400895int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896rpc_restart_call(struct rpc_task *task)
897{
898 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400899 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400901 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400903EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Chuck Lever3748f1e2008-05-21 17:09:12 -0400905#ifdef RPC_DEBUG
906static const char *rpc_proc_name(const struct rpc_task *task)
907{
908 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
909
910 if (proc) {
911 if (proc->p_name)
912 return proc->p_name;
913 else
914 return "NULL";
915 } else
916 return "no proc";
917}
918#endif
919
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920/*
921 * 0. Initial state
922 *
923 * Other FSM states can be visited zero or more times, but
924 * this state is visited exactly once for each RPC.
925 */
926static void
927call_start(struct rpc_task *task)
928{
929 struct rpc_clnt *clnt = task->tk_client;
930
Chuck Lever3748f1e2008-05-21 17:09:12 -0400931 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500932 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400933 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500934 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
936 /* Increment call count */
937 task->tk_msg.rpc_proc->p_count++;
938 clnt->cl_stats->rpccnt++;
939 task->tk_action = call_reserve;
940}
941
942/*
943 * 1. Reserve an RPC call slot
944 */
945static void
946call_reserve(struct rpc_task *task)
947{
Chuck Lever46121cf2007-01-31 12:14:08 -0500948 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 task->tk_status = 0;
951 task->tk_action = call_reserveresult;
952 xprt_reserve(task);
953}
954
955/*
956 * 1b. Grok the result of xprt_reserve()
957 */
958static void
959call_reserveresult(struct rpc_task *task)
960{
961 int status = task->tk_status;
962
Chuck Lever46121cf2007-01-31 12:14:08 -0500963 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
965 /*
966 * After a call to xprt_reserve(), we must have either
967 * a request slot or else an error status.
968 */
969 task->tk_status = 0;
970 if (status >= 0) {
971 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -0400972 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 return;
974 }
975
976 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800977 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 rpc_exit(task, -EIO);
979 return;
980 }
981
982 /*
983 * Even though there was an error, we may have acquired
984 * a request slot somehow. Make sure not to leak it.
985 */
986 if (task->tk_rqstp) {
987 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800988 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 xprt_release(task);
990 }
991
992 switch (status) {
993 case -EAGAIN: /* woken up; retry */
994 task->tk_action = call_reserve;
995 return;
996 case -EIO: /* probably a shutdown */
997 break;
998 default:
999 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001000 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 break;
1002 }
1003 rpc_exit(task, status);
1004}
1005
1006/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001007 * 2. Bind and/or refresh the credentials
1008 */
1009static void
1010call_refresh(struct rpc_task *task)
1011{
1012 dprint_status(task);
1013
1014 task->tk_action = call_refreshresult;
1015 task->tk_status = 0;
1016 task->tk_client->cl_stats->rpcauthrefresh++;
1017 rpcauth_refreshcred(task);
1018}
1019
1020/*
1021 * 2a. Process the results of a credential refresh
1022 */
1023static void
1024call_refreshresult(struct rpc_task *task)
1025{
1026 int status = task->tk_status;
1027
1028 dprint_status(task);
1029
1030 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001031 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001032 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001033 case 0:
1034 if (rpcauth_uptodatecred(task))
1035 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001036 return;
1037 case -ETIMEDOUT:
1038 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001039 case -EAGAIN:
1040 status = -EACCES;
1041 if (!task->tk_cred_retry)
1042 break;
1043 task->tk_cred_retry--;
1044 dprintk("RPC: %5u %s: retry refresh creds\n",
1045 task->tk_pid, __func__);
1046 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001047 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001048 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1049 task->tk_pid, __func__, status);
1050 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001051}
1052
1053/*
1054 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001055 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 */
1057static void
1058call_allocate(struct rpc_task *task)
1059{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001060 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001061 struct rpc_rqst *req = task->tk_rqstp;
1062 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001063 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
Chuck Lever46121cf2007-01-31 12:14:08 -05001065 dprint_status(task);
1066
Chuck Lever2bea90d2007-03-29 16:47:53 -04001067 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001068 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001069
Chuck Lever02107142006-01-03 09:55:49 +01001070 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 return;
1072
Chuck Lever2bea90d2007-03-29 16:47:53 -04001073 if (proc->p_proc != 0) {
1074 BUG_ON(proc->p_arglen == 0);
1075 if (proc->p_decode != NULL)
1076 BUG_ON(proc->p_replen == 0);
1077 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078
Chuck Lever2bea90d2007-03-29 16:47:53 -04001079 /*
1080 * Calculate the size (in quads) of the RPC call
1081 * and reply headers, and convert both values
1082 * to byte sizes.
1083 */
1084 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1085 req->rq_callsize <<= 2;
1086 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1087 req->rq_rcvsize <<= 2;
1088
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001089 req->rq_buffer = xprt->ops->buf_alloc(task,
1090 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001091 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001093
1094 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Trond Myklebust5afa9132011-06-17 10:14:59 -04001096 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001097 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 rpc_delay(task, HZ>>4);
1099 return;
1100 }
1101
1102 rpc_exit(task, -ERESTARTSYS);
1103}
1104
Trond Myklebust940e3312005-11-09 21:45:24 -05001105static inline int
1106rpc_task_need_encode(struct rpc_task *task)
1107{
1108 return task->tk_rqstp->rq_snd_buf.len == 0;
1109}
1110
1111static inline void
1112rpc_task_force_reencode(struct rpc_task *task)
1113{
1114 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001115 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001116}
1117
Chuck Lever2bea90d2007-03-29 16:47:53 -04001118static inline void
1119rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1120{
1121 buf->head[0].iov_base = start;
1122 buf->head[0].iov_len = len;
1123 buf->tail[0].iov_len = 0;
1124 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001125 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001126 buf->len = 0;
1127 buf->buflen = len;
1128}
1129
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130/*
1131 * 3. Encode arguments of an RPC call
1132 */
1133static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001134rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001137 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001138 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Chuck Lever46121cf2007-01-31 12:14:08 -05001140 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
Chuck Lever2bea90d2007-03-29 16:47:53 -04001142 rpc_xdr_buf_init(&req->rq_snd_buf,
1143 req->rq_buffer,
1144 req->rq_callsize);
1145 rpc_xdr_buf_init(&req->rq_rcv_buf,
1146 (char *)req->rq_buffer + req->rq_callsize,
1147 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Chuck Leverb0e1c572008-05-21 17:09:19 -04001149 p = rpc_encode_header(task);
1150 if (p == NULL) {
1151 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 rpc_exit(task, -EIO);
1153 return;
1154 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001155
1156 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001157 if (encode == NULL)
1158 return;
1159
1160 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1161 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162}
1163
1164/*
1165 * 4. Get the server port number if not yet set
1166 */
1167static void
1168call_bind(struct rpc_task *task)
1169{
Chuck Leverec739ef2006-08-22 20:06:15 -04001170 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
Chuck Lever46121cf2007-01-31 12:14:08 -05001172 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
Chuck Leverda351872005-08-11 16:25:11 -04001174 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001175 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001176 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001177 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001178 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 }
1180}
1181
1182/*
Chuck Leverda351872005-08-11 16:25:11 -04001183 * 4a. Sort out bind result
1184 */
1185static void
1186call_bind_status(struct rpc_task *task)
1187{
Chuck Lever906462a2007-09-11 18:00:47 -04001188 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001189
1190 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001191 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001192 task->tk_status = 0;
1193 task->tk_action = call_connect;
1194 return;
1195 }
1196
1197 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001198 case -ENOMEM:
1199 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1200 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001201 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001202 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001203 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1204 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001205 /* fail immediately if this is an RPC ping */
1206 if (task->tk_msg.rpc_proc->p_proc == 0) {
1207 status = -EOPNOTSUPP;
1208 break;
1209 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001210 if (task->tk_rebind_retry == 0)
1211 break;
1212 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001213 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001214 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001215 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001216 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001217 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001218 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001219 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001220 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001221 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001222 task->tk_pid);
1223 break;
1224 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001225 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001226 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001227 task->tk_status = 0;
1228 task->tk_action = call_bind;
1229 return;
Chuck Lever012da152009-12-03 15:58:56 -05001230 case -ECONNREFUSED: /* connection problems */
1231 case -ECONNRESET:
1232 case -ENOTCONN:
1233 case -EHOSTDOWN:
1234 case -EHOSTUNREACH:
1235 case -ENETUNREACH:
1236 case -EPIPE:
1237 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1238 task->tk_pid, task->tk_status);
1239 if (!RPC_IS_SOFTCONN(task)) {
1240 rpc_delay(task, 5*HZ);
1241 goto retry_timeout;
1242 }
1243 status = task->tk_status;
1244 break;
Chuck Leverda351872005-08-11 16:25:11 -04001245 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001246 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001247 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001248 }
1249
1250 rpc_exit(task, status);
1251 return;
1252
Trond Myklebustda458282006-08-31 15:44:52 -04001253retry_timeout:
1254 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001255}
1256
1257/*
1258 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 */
1260static void
1261call_connect(struct rpc_task *task)
1262{
Chuck Leverda351872005-08-11 16:25:11 -04001263 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Chuck Lever46121cf2007-01-31 12:14:08 -05001265 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001266 task->tk_pid, xprt,
1267 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
Chuck Leverda351872005-08-11 16:25:11 -04001269 task->tk_action = call_transmit;
1270 if (!xprt_connected(xprt)) {
1271 task->tk_action = call_connect_status;
1272 if (task->tk_status < 0)
1273 return;
1274 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276}
1277
1278/*
Chuck Leverda351872005-08-11 16:25:11 -04001279 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 */
1281static void
1282call_connect_status(struct rpc_task *task)
1283{
1284 struct rpc_clnt *clnt = task->tk_client;
1285 int status = task->tk_status;
1286
Chuck Lever46121cf2007-01-31 12:14:08 -05001287 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001288
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001290 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 clnt->cl_stats->netreconn++;
1292 task->tk_action = call_transmit;
1293 return;
1294 }
1295
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001297 /* if soft mounted, test if we've timed out */
1298 case -ETIMEDOUT:
1299 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001300 break;
1301 default:
1302 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 }
1304}
1305
1306/*
1307 * 5. Transmit the RPC request, and wait for reply
1308 */
1309static void
1310call_transmit(struct rpc_task *task)
1311{
Chuck Lever46121cf2007-01-31 12:14:08 -05001312 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
1314 task->tk_action = call_status;
1315 if (task->tk_status < 0)
1316 return;
1317 task->tk_status = xprt_prepare_transmit(task);
1318 if (task->tk_status != 0)
1319 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001320 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001322 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001323 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001324 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001325 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001326 if (task->tk_status != 0) {
1327 /* Was the error nonfatal? */
1328 if (task->tk_status == -EAGAIN)
1329 rpc_delay(task, HZ >> 4);
1330 else
1331 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001332 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001333 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001334 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 xprt_transmit(task);
1336 if (task->tk_status < 0)
1337 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001338 /*
1339 * On success, ensure that we call xprt_end_transmit() before sleeping
1340 * in order to allow access to the socket to other RPC requests.
1341 */
1342 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001343 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001344 return;
1345 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001346 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001347}
1348
1349/*
1350 * 5a. Handle cleanup after a transmission
1351 */
1352static void
1353call_transmit_status(struct rpc_task *task)
1354{
1355 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001356
1357 /*
1358 * Common case: success. Force the compiler to put this
1359 * test first.
1360 */
1361 if (task->tk_status == 0) {
1362 xprt_end_transmit(task);
1363 rpc_task_force_reencode(task);
1364 return;
1365 }
1366
Trond Myklebust15f081c2009-03-11 14:37:57 -04001367 switch (task->tk_status) {
1368 case -EAGAIN:
1369 break;
1370 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001371 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001372 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001373 rpc_task_force_reencode(task);
1374 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001375 /*
1376 * Special cases: if we've been waiting on the
1377 * socket's write_space() callback, or if the
1378 * socket just returned a connection error,
1379 * then hold onto the transport lock.
1380 */
1381 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001382 case -EHOSTDOWN:
1383 case -EHOSTUNREACH:
1384 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001385 if (RPC_IS_SOFTCONN(task)) {
1386 xprt_end_transmit(task);
1387 rpc_exit(task, task->tk_status);
1388 break;
1389 }
1390 case -ECONNRESET:
1391 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001392 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001393 rpc_task_force_reencode(task);
1394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395}
1396
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001397#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001398/*
1399 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1400 * addition, disconnect on connectivity errors.
1401 */
1402static void
1403call_bc_transmit(struct rpc_task *task)
1404{
1405 struct rpc_rqst *req = task->tk_rqstp;
1406
1407 BUG_ON(task->tk_status != 0);
1408 task->tk_status = xprt_prepare_transmit(task);
1409 if (task->tk_status == -EAGAIN) {
1410 /*
1411 * Could not reserve the transport. Try again after the
1412 * transport is released.
1413 */
1414 task->tk_status = 0;
1415 task->tk_action = call_bc_transmit;
1416 return;
1417 }
1418
1419 task->tk_action = rpc_exit_task;
1420 if (task->tk_status < 0) {
1421 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1422 "error: %d\n", task->tk_status);
1423 return;
1424 }
1425
1426 xprt_transmit(task);
1427 xprt_end_transmit(task);
1428 dprint_status(task);
1429 switch (task->tk_status) {
1430 case 0:
1431 /* Success */
1432 break;
1433 case -EHOSTDOWN:
1434 case -EHOSTUNREACH:
1435 case -ENETUNREACH:
1436 case -ETIMEDOUT:
1437 /*
1438 * Problem reaching the server. Disconnect and let the
1439 * forechannel reestablish the connection. The server will
1440 * have to retransmit the backchannel request and we'll
1441 * reprocess it. Since these ops are idempotent, there's no
1442 * need to cache our reply at this time.
1443 */
1444 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1445 "error: %d\n", task->tk_status);
1446 xprt_conditional_disconnect(task->tk_xprt,
1447 req->rq_connect_cookie);
1448 break;
1449 default:
1450 /*
1451 * We were unable to reply and will have to drop the
1452 * request. The server should reconnect and retransmit.
1453 */
1454 BUG_ON(task->tk_status == -EAGAIN);
1455 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1456 "error: %d\n", task->tk_status);
1457 break;
1458 }
1459 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1460}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001461#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001462
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463/*
1464 * 6. Sort out the RPC call status
1465 */
1466static void
1467call_status(struct rpc_task *task)
1468{
1469 struct rpc_clnt *clnt = task->tk_client;
1470 struct rpc_rqst *req = task->tk_rqstp;
1471 int status;
1472
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001473 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1474 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
Chuck Lever46121cf2007-01-31 12:14:08 -05001476 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
1478 status = task->tk_status;
1479 if (status >= 0) {
1480 task->tk_action = call_decode;
1481 return;
1482 }
1483
1484 task->tk_status = 0;
1485 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001486 case -EHOSTDOWN:
1487 case -EHOSTUNREACH:
1488 case -ENETUNREACH:
1489 /*
1490 * Delay any retries for 3 seconds, then handle as if it
1491 * were a timeout.
1492 */
1493 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 case -ETIMEDOUT:
1495 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001496 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001497 xprt_conditional_disconnect(task->tk_xprt,
1498 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001500 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001502 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001503 rpc_delay(task, 3*HZ);
1504 case -EPIPE:
1505 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 task->tk_action = call_bind;
1507 break;
1508 case -EAGAIN:
1509 task->tk_action = call_transmit;
1510 break;
1511 case -EIO:
1512 /* shutdown or soft timeout */
1513 rpc_exit(task, status);
1514 break;
1515 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001516 if (clnt->cl_chatty)
1517 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 clnt->cl_protname, -status);
1519 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 }
1521}
1522
1523/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001524 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 * We do not release the request slot, so we keep using the
1526 * same XID for all retransmits.
1527 */
1528static void
1529call_timeout(struct rpc_task *task)
1530{
1531 struct rpc_clnt *clnt = task->tk_client;
1532
1533 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001534 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 goto retry;
1536 }
1537
Chuck Lever46121cf2007-01-31 12:14:08 -05001538 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001539 task->tk_timeouts++;
1540
Chuck Lever3a28bec2009-12-03 15:58:56 -05001541 if (RPC_IS_SOFTCONN(task)) {
1542 rpc_exit(task, -ETIMEDOUT);
1543 return;
1544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001546 if (clnt->cl_chatty)
1547 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001549 if (task->tk_flags & RPC_TASK_TIMEOUT)
1550 rpc_exit(task, -ETIMEDOUT);
1551 else
1552 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 return;
1554 }
1555
Chuck Leverf518e35a2006-01-03 09:55:52 +01001556 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001558 if (clnt->cl_chatty)
1559 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 clnt->cl_protname, clnt->cl_server);
1561 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001562 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001563 /*
1564 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1565 * event? RFC2203 requires the server to drop all such requests.
1566 */
1567 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
1569retry:
1570 clnt->cl_stats->rpcretrans++;
1571 task->tk_action = call_bind;
1572 task->tk_status = 0;
1573}
1574
1575/*
1576 * 7. Decode the RPC reply
1577 */
1578static void
1579call_decode(struct rpc_task *task)
1580{
1581 struct rpc_clnt *clnt = task->tk_client;
1582 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001583 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001584 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Vasily Averin726fd6a2011-06-01 16:23:59 +04001586 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
Chuck Leverf518e35a2006-01-03 09:55:52 +01001588 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001589 if (clnt->cl_chatty)
1590 printk(KERN_NOTICE "%s: server %s OK\n",
1591 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1593 }
1594
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001595 /*
1596 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001597 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001598 */
1599 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 req->rq_rcv_buf.len = req->rq_private_buf.len;
1601
1602 /* Check that the softirq receive buffer is valid */
1603 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1604 sizeof(req->rq_rcv_buf)) != 0);
1605
Trond Myklebust1e799b62008-03-21 16:19:41 -04001606 if (req->rq_rcv_buf.len < 12) {
1607 if (!RPC_IS_SOFT(task)) {
1608 task->tk_action = call_bind;
1609 clnt->cl_stats->rpcretrans++;
1610 goto out_retry;
1611 }
1612 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1613 clnt->cl_protname, task->tk_status);
1614 task->tk_action = call_timeout;
1615 goto out_retry;
1616 }
1617
Chuck Leverb0e1c572008-05-21 17:09:19 -04001618 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001619 if (IS_ERR(p)) {
1620 if (p == ERR_PTR(-EAGAIN))
1621 goto out_retry;
1622 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 }
1624
Trond Myklebustabbcf282006-01-03 09:55:03 +01001625 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001627 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1629 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001630 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001631 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1632 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 return;
1634out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001636 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001637 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001638 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001639 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001640 xprt_conditional_disconnect(task->tk_xprt,
1641 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643}
1644
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001645static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001646rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647{
1648 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001650 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
1652 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001653
1654 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 *p++ = req->rq_xid; /* XID */
1656 *p++ = htonl(RPC_CALL); /* CALL */
1657 *p++ = htonl(RPC_VERSION); /* RPC version */
1658 *p++ = htonl(clnt->cl_prog); /* program number */
1659 *p++ = htonl(clnt->cl_vers); /* program version */
1660 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001661 p = rpcauth_marshcred(task, p);
1662 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1663 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664}
1665
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001666static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001667rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668{
1669 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1670 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001671 __be32 *p = iov->iov_base;
1672 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 int error = -EACCES;
1674
David Howellse8896492006-08-24 15:44:19 -04001675 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1676 /* RFC-1014 says that the representation of XDR data must be a
1677 * multiple of four bytes
1678 * - if it isn't pointer subtraction in the NFS client may give
1679 * undefined results
1680 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001681 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001682 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001683 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001684 goto out_eio;
1685 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 if ((len -= 3) < 0)
1687 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001689 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001691 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001692 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001693 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001695
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1697 if (--len < 0)
1698 goto out_overflow;
1699 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001700 case RPC_AUTH_ERROR:
1701 break;
1702 case RPC_MISMATCH:
1703 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1704 task->tk_pid, __func__);
1705 error = -EPROTONOSUPPORT;
1706 goto out_err;
1707 default:
1708 dprintk("RPC: %5u %s: RPC call rejected, "
1709 "unknown error: %x\n",
1710 task->tk_pid, __func__, n);
1711 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 }
1713 if (--len < 0)
1714 goto out_overflow;
1715 switch ((n = ntohl(*p++))) {
1716 case RPC_AUTH_REJECTEDCRED:
1717 case RPC_AUTH_REJECTEDVERF:
1718 case RPCSEC_GSS_CREDPROBLEM:
1719 case RPCSEC_GSS_CTXPROBLEM:
1720 if (!task->tk_cred_retry)
1721 break;
1722 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001723 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001724 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001726 /* Ensure we obtain a new XID! */
1727 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001728 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001729 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 case RPC_AUTH_BADCRED:
1731 case RPC_AUTH_BADVERF:
1732 /* possibly garbled cred/verf? */
1733 if (!task->tk_garb_retry)
1734 break;
1735 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001736 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001737 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001739 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001741 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001742 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 break;
1744 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001745 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001746 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 error = -EIO;
1748 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001749 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001750 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 goto out_err;
1752 }
1753 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001754 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001755 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001756 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001758 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 if (len < 0)
1760 goto out_overflow;
1761 switch ((n = ntohl(*p++))) {
1762 case RPC_SUCCESS:
1763 return p;
1764 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001765 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001766 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 (unsigned int)task->tk_client->cl_prog,
1768 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001769 error = -EPFNOSUPPORT;
1770 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001772 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001773 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 (unsigned int)task->tk_client->cl_prog,
1775 (unsigned int)task->tk_client->cl_vers,
1776 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001777 error = -EPROTONOSUPPORT;
1778 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001780 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001781 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001782 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001783 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 task->tk_client->cl_prog,
1785 task->tk_client->cl_vers,
1786 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001787 error = -EOPNOTSUPP;
1788 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001790 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001791 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 break; /* retry */
1793 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001794 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001795 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 /* Also retry */
1797 }
1798
Trond Myklebustabbcf282006-01-03 09:55:03 +01001799out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 task->tk_client->cl_stats->rpcgarbage++;
1801 if (task->tk_garb_retry) {
1802 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001803 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001804 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001806out_retry:
1807 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809out_eio:
1810 error = -EIO;
1811out_err:
1812 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001813 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001814 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001815 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001817 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001818 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001819 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001821
Chuck Lever9f06c712010-12-14 14:59:18 +00001822static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001823{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001824}
1825
Chuck Leverbf269552010-12-14 14:59:29 +00001826static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001827{
1828 return 0;
1829}
1830
1831static struct rpc_procinfo rpcproc_null = {
1832 .p_encode = rpcproc_encode_null,
1833 .p_decode = rpcproc_decode_null,
1834};
1835
Chuck Levercaabea82009-12-03 15:58:56 -05001836static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001837{
1838 struct rpc_message msg = {
1839 .rpc_proc = &rpcproc_null,
1840 };
1841 int err;
1842 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001843 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001844 put_rpccred(msg.rpc_cred);
1845 return err;
1846}
Trond Myklebust188fef12007-06-16 14:18:40 -04001847
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001848struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1849{
1850 struct rpc_message msg = {
1851 .rpc_proc = &rpcproc_null,
1852 .rpc_cred = cred,
1853 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001854 struct rpc_task_setup task_setup_data = {
1855 .rpc_client = clnt,
1856 .rpc_message = &msg,
1857 .callback_ops = &rpc_default_ops,
1858 .flags = flags,
1859 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001860 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001861}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001862EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001863
Trond Myklebust188fef12007-06-16 14:18:40 -04001864#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001865static void rpc_show_header(void)
1866{
Chuck Levercb3997b2008-05-21 17:09:41 -04001867 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1868 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001869}
1870
Chuck Lever38e886e2008-05-21 17:09:33 -04001871static void rpc_show_task(const struct rpc_clnt *clnt,
1872 const struct rpc_task *task)
1873{
1874 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001875
1876 if (RPC_IS_QUEUED(task))
1877 rpc_waitq = rpc_qname(task->tk_waitqueue);
1878
Joe Perchesb3bceda2010-12-21 10:52:24 -05001879 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 -04001880 task->tk_pid, task->tk_flags, task->tk_status,
1881 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1882 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001883 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001884}
1885
Trond Myklebust188fef12007-06-16 14:18:40 -04001886void rpc_show_tasks(void)
1887{
1888 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001889 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001890 int header = 0;
Trond Myklebust188fef12007-06-16 14:18:40 -04001891
1892 spin_lock(&rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001893 list_for_each_entry(clnt, &all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001894 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001895 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001896 if (!header) {
1897 rpc_show_header();
1898 header++;
1899 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001900 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001901 }
1902 spin_unlock(&clnt->cl_lock);
1903 }
Trond Myklebust188fef12007-06-16 14:18:40 -04001904 spin_unlock(&rpc_client_lock);
1905}
1906#endif