blob: 90e82c5daeb6fecda5998a6d2b5f785e2db9731c [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"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040041#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#ifdef RPC_DEBUG
44# define RPCDBG_FACILITY RPCDBG_CALL
45#endif
46
Chuck Lever46121cf2007-01-31 12:14:08 -050047#define dprint_status(t) \
48 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080049 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050050
Trond Myklebust188fef12007-06-16 14:18:40 -040051/*
52 * All RPC clients are linked into this list
53 */
Trond Myklebust188fef12007-06-16 14:18:40 -040054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
56
57
58static void call_start(struct rpc_task *task);
59static void call_reserve(struct rpc_task *task);
60static void call_reserveresult(struct rpc_task *task);
61static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062static void call_decode(struct rpc_task *task);
63static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040064static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040066#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040067static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050070static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_refresh(struct rpc_task *task);
72static void call_refreshresult(struct rpc_task *task);
73static void call_timeout(struct rpc_task *task);
74static void call_connect(struct rpc_task *task);
75static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Chuck Leverb0e1c572008-05-21 17:09:19 -040077static __be32 *rpc_encode_header(struct rpc_task *task);
78static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050079static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040080
Trond Myklebust188fef12007-06-16 14:18:40 -040081static void rpc_register_client(struct rpc_clnt *clnt)
82{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040083 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
84
85 spin_lock(&sn->rpc_client_lock);
86 list_add(&clnt->cl_clients, &sn->all_clients);
87 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040088}
89
90static void rpc_unregister_client(struct rpc_clnt *clnt)
91{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040092 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
93
94 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040095 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040096 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040097}
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +040099static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
100{
101 if (clnt->cl_path.dentry)
102 rpc_remove_client_dir(clnt->cl_path.dentry);
103 clnt->cl_path.dentry = NULL;
104}
105
106static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
107{
108 struct super_block *pipefs_sb;
109 int put_mnt = 0;
110
111 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
112 if (pipefs_sb) {
113 if (clnt->cl_path.dentry)
114 put_mnt = 1;
115 __rpc_clnt_remove_pipedir(clnt);
116 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
117 }
118 if (put_mnt)
119 rpc_put_mount();
120}
121
122static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
123 struct rpc_clnt *clnt, char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
Trond Myklebustf1345852005-09-23 11:08:25 -0400125 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400126 char name[15];
127 struct qstr q = {
128 .name = name,
129 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400130 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 int error;
132
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 dir = rpc_d_lookup_sb(sb, dir_name);
134 if (dir == NULL)
135 return dir;
136 for (;;) {
137 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
138 name[sizeof(name) - 1] = '\0';
139 q.hash = full_name_hash(q.name, q.len);
140 dentry = rpc_create_client_dir(dir, &q, clnt);
141 if (!IS_ERR(dentry))
142 break;
143 error = PTR_ERR(dentry);
144 if (error != -EEXIST) {
145 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
146 " %s/%s, error %d\n",
147 dir_name, name, error);
148 break;
149 }
150 }
151 dput(dir);
152 return dentry;
153}
154
155static int
156rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
157{
158 struct super_block *pipefs_sb;
159 struct path path;
160
Trond Myklebust7d217ca2009-08-09 15:14:24 -0400161 clnt->cl_path.mnt = ERR_PTR(-ENOENT);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400162 clnt->cl_path.dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 if (dir_name == NULL)
164 return 0;
Trond Myklebust54281542006-03-20 13:44:49 -0500165
Trond Myklebust23ac6582009-08-09 15:14:25 -0400166 path.mnt = rpc_get_mount();
167 if (IS_ERR(path.mnt))
168 return PTR_ERR(path.mnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400169 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
170 if (!pipefs_sb) {
171 rpc_put_mount();
172 return -ENOENT;
Christoph Hellwig278c9952005-07-24 23:53:01 +0100173 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400174 path.dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
175 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
176 if (IS_ERR(path.dentry)) {
177 rpc_put_mount();
178 return PTR_ERR(path.dentry);
179 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400180 clnt->cl_path = path;
181 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182}
183
Trond Myklebust698b6d02007-12-20 16:03:53 -0500184static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
Trond Myklebust698b6d02007-12-20 16:03:53 -0500186 struct rpc_program *program = args->program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 struct rpc_version *version;
188 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000189 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400191 size_t len;
192
193 /* sanity check the name before trying to print it */
194 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500195 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400196 if (len > RPC_MAXNETNAMELEN)
197 goto out_no_rpciod;
198 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Chuck Lever46121cf2007-01-31 12:14:08 -0500200 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500201 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Trond Myklebust4ada5392007-06-14 17:26:17 -0400203 err = rpciod_up();
204 if (err)
205 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 err = -EINVAL;
207 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800208 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500209
210 if (args->version >= program->nrvers)
211 goto out_err;
212 version = program->version[args->version];
213 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 goto out_err;
215
216 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700217 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 if (!clnt)
219 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 clnt->cl_parent = clnt;
221
222 clnt->cl_server = clnt->cl_inline_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 if (len > sizeof(clnt->cl_inline_name)) {
224 char *buf = kmalloc(len, GFP_KERNEL);
Trond Myklebust698b6d02007-12-20 16:03:53 -0500225 if (buf != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 clnt->cl_server = buf;
227 else
228 len = sizeof(clnt->cl_inline_name);
229 }
Trond Myklebust698b6d02007-12-20 16:03:53 -0500230 strlcpy(clnt->cl_server, args->servername, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 clnt->cl_xprt = xprt;
233 clnt->cl_procinfo = version->procs;
234 clnt->cl_maxproc = version->nrprocs;
235 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300236 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500239 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500240 err = -ENOMEM;
241 if (clnt->cl_metrics == NULL)
242 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500243 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400244 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400245 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Chuck Leverec739ef2006-08-22 20:06:15 -0400247 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 clnt->cl_autobind = 1;
249
Trond Myklebustba7392b2007-12-20 16:03:55 -0500250 clnt->cl_timeout = xprt->timeout;
251 if (args->timeout != NULL) {
252 memcpy(&clnt->cl_timeout_default, args->timeout,
253 sizeof(clnt->cl_timeout_default));
254 clnt->cl_timeout = &clnt->cl_timeout_default;
255 }
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500258 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500259 clnt->cl_principal = NULL;
260 if (args->client_name) {
261 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
262 if (!clnt->cl_principal)
263 goto out_no_principal;
264 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Trond Myklebust006abe82010-09-12 19:55:25 -0400266 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
269 if (err < 0)
270 goto out_no_path;
271
Trond Myklebust698b6d02007-12-20 16:03:53 -0500272 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000273 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500275 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000276 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 goto out_no_auth;
278 }
279
280 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400281 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 if (clnt->cl_nodelen > UNX_MAXNODENAME)
283 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400284 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400285 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return clnt;
287
288out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400289 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500291 kfree(clnt->cl_principal);
292out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500293 rpc_free_iostats(clnt->cl_metrics);
294out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 if (clnt->cl_server != clnt->cl_inline_name)
296 kfree(clnt->cl_server);
297 kfree(clnt);
298out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400299 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800300out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400301 rpciod_down();
302out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 return ERR_PTR(err);
304}
305
Chuck Leverc2866762006-08-22 20:06:20 -0400306/*
307 * rpc_create - create an RPC client and transport with one call
308 * @args: rpc_clnt create argument structure
309 *
310 * Creates and initializes an RPC transport and an RPC client.
311 *
312 * It can ping the server in order to determine if it is up, and to see if
313 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
314 * this behavior so asynchronous tasks can also use rpc_create.
315 */
316struct rpc_clnt *rpc_create(struct rpc_create_args *args)
317{
318 struct rpc_xprt *xprt;
319 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400320 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400321 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400322 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200323 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200324 .dstaddr = args->address,
325 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300326 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200327 };
Chuck Lever510deb02007-12-10 14:56:24 -0500328 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400329
Chuck Leverc2866762006-08-22 20:06:20 -0400330 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400331 * If the caller chooses not to specify a hostname, whip
332 * up a string representation of the passed-in address.
333 */
334 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400335 struct sockaddr_un *sun =
336 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400337 struct sockaddr_in *sin =
338 (struct sockaddr_in *)args->address;
339 struct sockaddr_in6 *sin6 =
340 (struct sockaddr_in6 *)args->address;
341
Chuck Lever510deb02007-12-10 14:56:24 -0500342 servername[0] = '\0';
343 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400344 case AF_LOCAL:
345 snprintf(servername, sizeof(servername), "%s",
346 sun->sun_path);
347 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400348 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700349 snprintf(servername, sizeof(servername), "%pI4",
350 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500351 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400352 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700353 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400354 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500355 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500356 default:
357 /* caller wants default server name, but
358 * address family isn't recognized. */
359 return ERR_PTR(-EINVAL);
360 }
Chuck Lever43780b82007-07-01 12:13:22 -0400361 args->servername = servername;
362 }
363
Chuck Lever510deb02007-12-10 14:56:24 -0500364 xprt = xprt_create_transport(&xprtargs);
365 if (IS_ERR(xprt))
366 return (struct rpc_clnt *)xprt;
367
Chuck Lever43780b82007-07-01 12:13:22 -0400368 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400369 * By default, kernel RPC client connects from a reserved port.
370 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
371 * but it is always enabled for rpciod, which handles the connect
372 * operation.
373 */
374 xprt->resvport = 1;
375 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
376 xprt->resvport = 0;
377
Trond Myklebust698b6d02007-12-20 16:03:53 -0500378 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400379 if (IS_ERR(clnt))
380 return clnt;
381
382 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500383 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400384 if (err != 0) {
385 rpc_shutdown_client(clnt);
386 return ERR_PTR(err);
387 }
388 }
389
390 clnt->cl_softrtry = 1;
391 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
392 clnt->cl_softrtry = 0;
393
Chuck Leverc2866762006-08-22 20:06:20 -0400394 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
395 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500396 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
397 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400398 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
399 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400400
401 return clnt;
402}
Chuck Leverb86acd52006-08-22 20:06:22 -0400403EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405/*
406 * This function clones the RPC client structure. It allows us to share the
407 * same transport while varying parameters such as the authentication
408 * flavour.
409 */
410struct rpc_clnt *
411rpc_clone_client(struct rpc_clnt *clnt)
412{
413 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500414 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200416 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 if (!new)
418 goto out_no_clnt;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400419 new->cl_parent = clnt;
420 /* Turn off autobind on clones */
421 new->cl_autobind = 0;
422 INIT_LIST_HEAD(&new->cl_tasks);
423 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500424 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500425 new->cl_metrics = rpc_alloc_iostats(clnt);
426 if (new->cl_metrics == NULL)
427 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500428 if (clnt->cl_principal) {
429 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
430 if (new->cl_principal == NULL)
431 goto out_no_principal;
432 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400433 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500434 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
435 if (err != 0)
436 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 if (new->cl_auth)
438 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400439 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400440 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400441 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400442 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500444out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500445 kfree(new->cl_principal);
446out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500447 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500448out_no_stats:
449 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800451 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500452 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400454EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
456/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400457 * Kill all tasks for the given client.
458 * XXX: kill their descendants as well?
459 */
460void rpc_killall_tasks(struct rpc_clnt *clnt)
461{
462 struct rpc_task *rovr;
463
464
465 if (list_empty(&clnt->cl_tasks))
466 return;
467 dprintk("RPC: killing all tasks for client %p\n", clnt);
468 /*
469 * Spin lock all_tasks to prevent changes...
470 */
471 spin_lock(&clnt->cl_lock);
472 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
473 if (!RPC_IS_ACTIVATED(rovr))
474 continue;
475 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
476 rovr->tk_flags |= RPC_TASK_KILLED;
477 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300478 if (RPC_IS_QUEUED(rovr))
479 rpc_wake_up_queued_task(rovr->tk_waitqueue,
480 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400481 }
482 }
483 spin_unlock(&clnt->cl_lock);
484}
485EXPORT_SYMBOL_GPL(rpc_killall_tasks);
486
487/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400489 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400491void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400493 dprintk("RPC: shutting down %s client for %s\n",
494 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Trond Myklebust34f52e32007-06-14 16:40:31 -0400496 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800498 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400499 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 }
501
Trond Myklebust4c402b42007-06-14 16:40:32 -0400502 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400504EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400507 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400509static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400510rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Chuck Lever46121cf2007-01-31 12:14:08 -0500512 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 clnt->cl_protname, clnt->cl_server);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400514 rpc_clnt_remove_pipedir(clnt);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500515 if (clnt->cl_parent != clnt) {
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400516 rpc_release_client(clnt->cl_parent);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500517 goto out_free;
518 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 if (clnt->cl_server != clnt->cl_inline_name)
520 kfree(clnt->cl_server);
521out_free:
Trond Myklebust6529eba2007-06-14 16:40:14 -0400522 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500523 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500524 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500525 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400526 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400527 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529}
530
531/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400532 * Free an RPC client
533 */
534static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400535rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400536{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400537 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400538 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400539 return;
540 }
541
542 /*
543 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
544 * release remaining GSS contexts. This mechanism ensures
545 * that it can do so safely.
546 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400547 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400548 rpcauth_release(clnt->cl_auth);
549 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400550 if (atomic_dec_and_test(&clnt->cl_count))
551 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400552}
553
554/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400555 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 */
557void
558rpc_release_client(struct rpc_clnt *clnt)
559{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400560 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Trond Myklebust34f52e32007-06-14 16:40:31 -0400562 if (list_empty(&clnt->cl_tasks))
563 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400564 if (atomic_dec_and_test(&clnt->cl_count))
565 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400566}
567
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000568/**
569 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800570 * @old: old rpc_client
571 * @program: rpc program to set
572 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000573 *
574 * Clones the rpc client and sets up a new RPC program. This is mainly
575 * of use for enabling different RPC programs to share the same transport.
576 * The Sun NFSv2/v3 ACL protocol can do this.
577 */
578struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
579 struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400580 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000581{
582 struct rpc_clnt *clnt;
583 struct rpc_version *version;
584 int err;
585
586 BUG_ON(vers >= program->nrvers || !program->version[vers]);
587 version = program->version[vers];
588 clnt = rpc_clone_client(old);
589 if (IS_ERR(clnt))
590 goto out;
591 clnt->cl_procinfo = version->procs;
592 clnt->cl_maxproc = version->nrprocs;
593 clnt->cl_protname = program->name;
594 clnt->cl_prog = program->number;
595 clnt->cl_vers = version->number;
596 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500597 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000598 if (err != 0) {
599 rpc_shutdown_client(clnt);
600 clnt = ERR_PTR(err);
601 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800602out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000603 return clnt;
604}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400605EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000606
Trond Myklebust58f96122010-07-31 14:29:08 -0400607void rpc_task_release_client(struct rpc_task *task)
608{
609 struct rpc_clnt *clnt = task->tk_client;
610
611 if (clnt != NULL) {
612 /* Remove from client task list */
613 spin_lock(&clnt->cl_lock);
614 list_del(&task->tk_task);
615 spin_unlock(&clnt->cl_lock);
616 task->tk_client = NULL;
617
618 rpc_release_client(clnt);
619 }
620}
621
622static
623void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
624{
625 if (clnt != NULL) {
626 rpc_task_release_client(task);
627 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400628 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400629 if (clnt->cl_softrtry)
630 task->tk_flags |= RPC_TASK_SOFT;
631 /* Add to the client's list of all tasks */
632 spin_lock(&clnt->cl_lock);
633 list_add_tail(&task->tk_task, &clnt->cl_tasks);
634 spin_unlock(&clnt->cl_lock);
635 }
636}
637
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000638void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
639{
640 rpc_task_release_client(task);
641 rpc_task_set_client(task, clnt);
642}
643EXPORT_SYMBOL_GPL(rpc_task_reset_client);
644
645
Trond Myklebust58f96122010-07-31 14:29:08 -0400646static void
647rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
648{
649 if (msg != NULL) {
650 task->tk_msg.rpc_proc = msg->rpc_proc;
651 task->tk_msg.rpc_argp = msg->rpc_argp;
652 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400653 if (msg->rpc_cred != NULL)
654 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400655 }
656}
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658/*
659 * Default callback for async RPC calls
660 */
661static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100662rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
664}
665
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100666static const struct rpc_call_ops rpc_default_ops = {
667 .rpc_call_done = rpc_default_callback,
668};
669
Trond Myklebustc970aa82007-07-14 15:39:59 -0400670/**
671 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
672 * @task_setup_data: pointer to task initialisation data
673 */
674struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400675{
Trond Myklebust19445b92010-04-16 16:41:10 -0400676 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400677
Trond Myklebust84115e12007-07-14 15:39:59 -0400678 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400679 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400680 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400681
Trond Myklebust58f96122010-07-31 14:29:08 -0400682 rpc_task_set_client(task, task_setup_data->rpc_client);
683 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
684
Trond Myklebust58f96122010-07-31 14:29:08 -0400685 if (task->tk_action == NULL)
686 rpc_call_start(task);
687
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400688 atomic_inc(&task->tk_count);
689 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400690out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400691 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400692}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400693EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400694
695/**
696 * rpc_call_sync - Perform a synchronous RPC call
697 * @clnt: pointer to RPC client
698 * @msg: RPC call parameters
699 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500701int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
703 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400704 struct rpc_task_setup task_setup_data = {
705 .rpc_client = clnt,
706 .rpc_message = msg,
707 .callback_ops = &rpc_default_ops,
708 .flags = flags,
709 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400710 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 BUG_ON(flags & RPC_TASK_ASYNC);
713
Trond Myklebustc970aa82007-07-14 15:39:59 -0400714 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400715 if (IS_ERR(task))
716 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100717 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800718 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 return status;
720}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400721EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400723/**
724 * rpc_call_async - Perform an asynchronous RPC call
725 * @clnt: pointer to RPC client
726 * @msg: RPC call parameters
727 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800728 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400729 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 */
731int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500732rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100733 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
735 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400736 struct rpc_task_setup task_setup_data = {
737 .rpc_client = clnt,
738 .rpc_message = msg,
739 .callback_ops = tk_ops,
740 .callback_data = data,
741 .flags = flags|RPC_TASK_ASYNC,
742 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Trond Myklebustc970aa82007-07-14 15:39:59 -0400744 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400745 if (IS_ERR(task))
746 return PTR_ERR(task);
747 rpc_put_task(task);
748 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400750EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400752#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400753/**
754 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
755 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400756 * @req: RPC request
757 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400758 */
759struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400760 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400761{
762 struct rpc_task *task;
763 struct xdr_buf *xbufp = &req->rq_snd_buf;
764 struct rpc_task_setup task_setup_data = {
765 .callback_ops = tk_ops,
766 };
767
768 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
769 /*
770 * Create an rpc_task to send the data
771 */
772 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400773 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400774 xprt_free_bc_request(req);
775 goto out;
776 }
777 task->tk_rqstp = req;
778
779 /*
780 * Set up the xdr_buf length.
781 * This also indicates that the buffer is XDR encoded already.
782 */
783 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
784 xbufp->tail[0].iov_len;
785
786 task->tk_action = call_bc_transmit;
787 atomic_inc(&task->tk_count);
788 BUG_ON(atomic_read(&task->tk_count) != 2);
789 rpc_execute(task);
790
791out:
792 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
793 return task;
794}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400795#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400798rpc_call_start(struct rpc_task *task)
799{
800 task->tk_action = call_start;
801}
802EXPORT_SYMBOL_GPL(rpc_call_start);
803
Chuck Levered394402006-08-22 20:06:17 -0400804/**
805 * rpc_peeraddr - extract remote peer address from clnt's xprt
806 * @clnt: RPC client structure
807 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800808 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400809 *
810 * Returns the number of bytes that are actually in the stored address.
811 */
812size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
813{
814 size_t bytes;
815 struct rpc_xprt *xprt = clnt->cl_xprt;
816
817 bytes = sizeof(xprt->addr);
818 if (bytes > bufsize)
819 bytes = bufsize;
820 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400821 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400822}
Chuck Leverb86acd52006-08-22 20:06:22 -0400823EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400824
Chuck Leverf425eba2006-08-22 20:06:18 -0400825/**
826 * rpc_peeraddr2str - return remote peer address in printable format
827 * @clnt: RPC client structure
828 * @format: address format
829 *
830 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500831const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
832 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400833{
834 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500835
836 if (xprt->address_strings[format] != NULL)
837 return xprt->address_strings[format];
838 else
839 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400840}
Chuck Leverb86acd52006-08-22 20:06:22 -0400841EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400842
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843void
844rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
845{
846 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700847 if (xprt->ops->set_buffer_size)
848 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400850EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
852/*
853 * Return size of largest payload RPC client can support, in bytes
854 *
855 * For stream transports, this is one RPC record fragment (see RFC
856 * 1831), as we don't support multi-record requests yet. For datagram
857 * transports, this is the size of an IP packet minus the IP, UDP, and
858 * RPC header sizes.
859 */
860size_t rpc_max_payload(struct rpc_clnt *clnt)
861{
862 return clnt->cl_xprt->max_payload;
863}
Chuck Leverb86acd52006-08-22 20:06:22 -0400864EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
Chuck Lever35f5a422006-01-03 09:55:50 +0100866/**
867 * rpc_force_rebind - force transport to check that remote port is unchanged
868 * @clnt: client to rebind
869 *
870 */
871void rpc_force_rebind(struct rpc_clnt *clnt)
872{
873 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400874 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100875}
Chuck Leverb86acd52006-08-22 20:06:22 -0400876EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100877
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400879 * Restart an (async) RPC call from the call_prepare state.
880 * Usually called from within the exit handler.
881 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400882int
Andy Adamsonaae20062009-04-01 09:22:40 -0400883rpc_restart_call_prepare(struct rpc_task *task)
884{
885 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400886 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700887 task->tk_action = call_start;
888 if (task->tk_ops->rpc_call_prepare != NULL)
889 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400890 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400891}
892EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
893
894/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 * Restart an (async) RPC call. Usually called from within the
896 * exit handler.
897 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400898int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899rpc_restart_call(struct rpc_task *task)
900{
901 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400902 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400904 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400906EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Chuck Lever3748f1e2008-05-21 17:09:12 -0400908#ifdef RPC_DEBUG
909static const char *rpc_proc_name(const struct rpc_task *task)
910{
911 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
912
913 if (proc) {
914 if (proc->p_name)
915 return proc->p_name;
916 else
917 return "NULL";
918 } else
919 return "no proc";
920}
921#endif
922
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923/*
924 * 0. Initial state
925 *
926 * Other FSM states can be visited zero or more times, but
927 * this state is visited exactly once for each RPC.
928 */
929static void
930call_start(struct rpc_task *task)
931{
932 struct rpc_clnt *clnt = task->tk_client;
933
Chuck Lever3748f1e2008-05-21 17:09:12 -0400934 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500935 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400936 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500937 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
939 /* Increment call count */
940 task->tk_msg.rpc_proc->p_count++;
941 clnt->cl_stats->rpccnt++;
942 task->tk_action = call_reserve;
943}
944
945/*
946 * 1. Reserve an RPC call slot
947 */
948static void
949call_reserve(struct rpc_task *task)
950{
Chuck Lever46121cf2007-01-31 12:14:08 -0500951 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 task->tk_status = 0;
954 task->tk_action = call_reserveresult;
955 xprt_reserve(task);
956}
957
958/*
959 * 1b. Grok the result of xprt_reserve()
960 */
961static void
962call_reserveresult(struct rpc_task *task)
963{
964 int status = task->tk_status;
965
Chuck Lever46121cf2007-01-31 12:14:08 -0500966 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
968 /*
969 * After a call to xprt_reserve(), we must have either
970 * a request slot or else an error status.
971 */
972 task->tk_status = 0;
973 if (status >= 0) {
974 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -0400975 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 return;
977 }
978
979 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800980 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 rpc_exit(task, -EIO);
982 return;
983 }
984
985 /*
986 * Even though there was an error, we may have acquired
987 * a request slot somehow. Make sure not to leak it.
988 */
989 if (task->tk_rqstp) {
990 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800991 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 xprt_release(task);
993 }
994
995 switch (status) {
996 case -EAGAIN: /* woken up; retry */
997 task->tk_action = call_reserve;
998 return;
999 case -EIO: /* probably a shutdown */
1000 break;
1001 default:
1002 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001003 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 break;
1005 }
1006 rpc_exit(task, status);
1007}
1008
1009/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001010 * 2. Bind and/or refresh the credentials
1011 */
1012static void
1013call_refresh(struct rpc_task *task)
1014{
1015 dprint_status(task);
1016
1017 task->tk_action = call_refreshresult;
1018 task->tk_status = 0;
1019 task->tk_client->cl_stats->rpcauthrefresh++;
1020 rpcauth_refreshcred(task);
1021}
1022
1023/*
1024 * 2a. Process the results of a credential refresh
1025 */
1026static void
1027call_refreshresult(struct rpc_task *task)
1028{
1029 int status = task->tk_status;
1030
1031 dprint_status(task);
1032
1033 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001034 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001035 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001036 case 0:
1037 if (rpcauth_uptodatecred(task))
1038 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001039 return;
1040 case -ETIMEDOUT:
1041 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001042 case -EAGAIN:
1043 status = -EACCES;
1044 if (!task->tk_cred_retry)
1045 break;
1046 task->tk_cred_retry--;
1047 dprintk("RPC: %5u %s: retry refresh creds\n",
1048 task->tk_pid, __func__);
1049 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001050 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001051 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1052 task->tk_pid, __func__, status);
1053 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001054}
1055
1056/*
1057 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001058 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 */
1060static void
1061call_allocate(struct rpc_task *task)
1062{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001063 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001064 struct rpc_rqst *req = task->tk_rqstp;
1065 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001066 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Chuck Lever46121cf2007-01-31 12:14:08 -05001068 dprint_status(task);
1069
Chuck Lever2bea90d2007-03-29 16:47:53 -04001070 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001071 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001072
Chuck Lever02107142006-01-03 09:55:49 +01001073 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 return;
1075
Chuck Lever2bea90d2007-03-29 16:47:53 -04001076 if (proc->p_proc != 0) {
1077 BUG_ON(proc->p_arglen == 0);
1078 if (proc->p_decode != NULL)
1079 BUG_ON(proc->p_replen == 0);
1080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Chuck Lever2bea90d2007-03-29 16:47:53 -04001082 /*
1083 * Calculate the size (in quads) of the RPC call
1084 * and reply headers, and convert both values
1085 * to byte sizes.
1086 */
1087 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1088 req->rq_callsize <<= 2;
1089 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1090 req->rq_rcvsize <<= 2;
1091
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001092 req->rq_buffer = xprt->ops->buf_alloc(task,
1093 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001094 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001096
1097 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098
Trond Myklebust5afa9132011-06-17 10:14:59 -04001099 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001100 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 rpc_delay(task, HZ>>4);
1102 return;
1103 }
1104
1105 rpc_exit(task, -ERESTARTSYS);
1106}
1107
Trond Myklebust940e3312005-11-09 21:45:24 -05001108static inline int
1109rpc_task_need_encode(struct rpc_task *task)
1110{
1111 return task->tk_rqstp->rq_snd_buf.len == 0;
1112}
1113
1114static inline void
1115rpc_task_force_reencode(struct rpc_task *task)
1116{
1117 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001118 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001119}
1120
Chuck Lever2bea90d2007-03-29 16:47:53 -04001121static inline void
1122rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1123{
1124 buf->head[0].iov_base = start;
1125 buf->head[0].iov_len = len;
1126 buf->tail[0].iov_len = 0;
1127 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001128 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001129 buf->len = 0;
1130 buf->buflen = len;
1131}
1132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133/*
1134 * 3. Encode arguments of an RPC call
1135 */
1136static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001137rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001140 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001141 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
Chuck Lever46121cf2007-01-31 12:14:08 -05001143 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Chuck Lever2bea90d2007-03-29 16:47:53 -04001145 rpc_xdr_buf_init(&req->rq_snd_buf,
1146 req->rq_buffer,
1147 req->rq_callsize);
1148 rpc_xdr_buf_init(&req->rq_rcv_buf,
1149 (char *)req->rq_buffer + req->rq_callsize,
1150 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Chuck Leverb0e1c572008-05-21 17:09:19 -04001152 p = rpc_encode_header(task);
1153 if (p == NULL) {
1154 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 rpc_exit(task, -EIO);
1156 return;
1157 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001158
1159 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001160 if (encode == NULL)
1161 return;
1162
1163 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1164 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165}
1166
1167/*
1168 * 4. Get the server port number if not yet set
1169 */
1170static void
1171call_bind(struct rpc_task *task)
1172{
Chuck Leverec739ef2006-08-22 20:06:15 -04001173 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174
Chuck Lever46121cf2007-01-31 12:14:08 -05001175 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176
Chuck Leverda351872005-08-11 16:25:11 -04001177 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001178 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001179 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001180 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001181 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 }
1183}
1184
1185/*
Chuck Leverda351872005-08-11 16:25:11 -04001186 * 4a. Sort out bind result
1187 */
1188static void
1189call_bind_status(struct rpc_task *task)
1190{
Chuck Lever906462a2007-09-11 18:00:47 -04001191 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001192
1193 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001194 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001195 task->tk_status = 0;
1196 task->tk_action = call_connect;
1197 return;
1198 }
1199
1200 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001201 case -ENOMEM:
1202 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1203 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001204 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001205 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001206 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1207 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001208 /* fail immediately if this is an RPC ping */
1209 if (task->tk_msg.rpc_proc->p_proc == 0) {
1210 status = -EOPNOTSUPP;
1211 break;
1212 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001213 if (task->tk_rebind_retry == 0)
1214 break;
1215 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001216 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001217 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001218 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001219 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001220 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001221 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001222 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001223 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001224 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001225 task->tk_pid);
1226 break;
1227 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001228 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001229 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001230 task->tk_status = 0;
1231 task->tk_action = call_bind;
1232 return;
Chuck Lever012da152009-12-03 15:58:56 -05001233 case -ECONNREFUSED: /* connection problems */
1234 case -ECONNRESET:
1235 case -ENOTCONN:
1236 case -EHOSTDOWN:
1237 case -EHOSTUNREACH:
1238 case -ENETUNREACH:
1239 case -EPIPE:
1240 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1241 task->tk_pid, task->tk_status);
1242 if (!RPC_IS_SOFTCONN(task)) {
1243 rpc_delay(task, 5*HZ);
1244 goto retry_timeout;
1245 }
1246 status = task->tk_status;
1247 break;
Chuck Leverda351872005-08-11 16:25:11 -04001248 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001249 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001250 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001251 }
1252
1253 rpc_exit(task, status);
1254 return;
1255
Trond Myklebustda458282006-08-31 15:44:52 -04001256retry_timeout:
1257 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001258}
1259
1260/*
1261 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 */
1263static void
1264call_connect(struct rpc_task *task)
1265{
Chuck Leverda351872005-08-11 16:25:11 -04001266 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267
Chuck Lever46121cf2007-01-31 12:14:08 -05001268 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001269 task->tk_pid, xprt,
1270 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Chuck Leverda351872005-08-11 16:25:11 -04001272 task->tk_action = call_transmit;
1273 if (!xprt_connected(xprt)) {
1274 task->tk_action = call_connect_status;
1275 if (task->tk_status < 0)
1276 return;
1277 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279}
1280
1281/*
Chuck Leverda351872005-08-11 16:25:11 -04001282 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 */
1284static void
1285call_connect_status(struct rpc_task *task)
1286{
1287 struct rpc_clnt *clnt = task->tk_client;
1288 int status = task->tk_status;
1289
Chuck Lever46121cf2007-01-31 12:14:08 -05001290 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001291
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001293 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 clnt->cl_stats->netreconn++;
1295 task->tk_action = call_transmit;
1296 return;
1297 }
1298
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001300 /* if soft mounted, test if we've timed out */
1301 case -ETIMEDOUT:
1302 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001303 break;
1304 default:
1305 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 }
1307}
1308
1309/*
1310 * 5. Transmit the RPC request, and wait for reply
1311 */
1312static void
1313call_transmit(struct rpc_task *task)
1314{
Chuck Lever46121cf2007-01-31 12:14:08 -05001315 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
1317 task->tk_action = call_status;
1318 if (task->tk_status < 0)
1319 return;
1320 task->tk_status = xprt_prepare_transmit(task);
1321 if (task->tk_status != 0)
1322 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001323 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001325 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001326 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001327 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001328 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001329 if (task->tk_status != 0) {
1330 /* Was the error nonfatal? */
1331 if (task->tk_status == -EAGAIN)
1332 rpc_delay(task, HZ >> 4);
1333 else
1334 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001335 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001336 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 xprt_transmit(task);
1339 if (task->tk_status < 0)
1340 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001341 /*
1342 * On success, ensure that we call xprt_end_transmit() before sleeping
1343 * in order to allow access to the socket to other RPC requests.
1344 */
1345 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001346 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001347 return;
1348 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001349 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001350}
1351
1352/*
1353 * 5a. Handle cleanup after a transmission
1354 */
1355static void
1356call_transmit_status(struct rpc_task *task)
1357{
1358 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001359
1360 /*
1361 * Common case: success. Force the compiler to put this
1362 * test first.
1363 */
1364 if (task->tk_status == 0) {
1365 xprt_end_transmit(task);
1366 rpc_task_force_reencode(task);
1367 return;
1368 }
1369
Trond Myklebust15f081c2009-03-11 14:37:57 -04001370 switch (task->tk_status) {
1371 case -EAGAIN:
1372 break;
1373 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001374 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001375 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001376 rpc_task_force_reencode(task);
1377 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001378 /*
1379 * Special cases: if we've been waiting on the
1380 * socket's write_space() callback, or if the
1381 * socket just returned a connection error,
1382 * then hold onto the transport lock.
1383 */
1384 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001385 case -EHOSTDOWN:
1386 case -EHOSTUNREACH:
1387 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001388 if (RPC_IS_SOFTCONN(task)) {
1389 xprt_end_transmit(task);
1390 rpc_exit(task, task->tk_status);
1391 break;
1392 }
1393 case -ECONNRESET:
1394 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001395 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001396 rpc_task_force_reencode(task);
1397 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398}
1399
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001400#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001401/*
1402 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1403 * addition, disconnect on connectivity errors.
1404 */
1405static void
1406call_bc_transmit(struct rpc_task *task)
1407{
1408 struct rpc_rqst *req = task->tk_rqstp;
1409
1410 BUG_ON(task->tk_status != 0);
1411 task->tk_status = xprt_prepare_transmit(task);
1412 if (task->tk_status == -EAGAIN) {
1413 /*
1414 * Could not reserve the transport. Try again after the
1415 * transport is released.
1416 */
1417 task->tk_status = 0;
1418 task->tk_action = call_bc_transmit;
1419 return;
1420 }
1421
1422 task->tk_action = rpc_exit_task;
1423 if (task->tk_status < 0) {
1424 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1425 "error: %d\n", task->tk_status);
1426 return;
1427 }
1428
1429 xprt_transmit(task);
1430 xprt_end_transmit(task);
1431 dprint_status(task);
1432 switch (task->tk_status) {
1433 case 0:
1434 /* Success */
1435 break;
1436 case -EHOSTDOWN:
1437 case -EHOSTUNREACH:
1438 case -ENETUNREACH:
1439 case -ETIMEDOUT:
1440 /*
1441 * Problem reaching the server. Disconnect and let the
1442 * forechannel reestablish the connection. The server will
1443 * have to retransmit the backchannel request and we'll
1444 * reprocess it. Since these ops are idempotent, there's no
1445 * need to cache our reply at this time.
1446 */
1447 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1448 "error: %d\n", task->tk_status);
1449 xprt_conditional_disconnect(task->tk_xprt,
1450 req->rq_connect_cookie);
1451 break;
1452 default:
1453 /*
1454 * We were unable to reply and will have to drop the
1455 * request. The server should reconnect and retransmit.
1456 */
1457 BUG_ON(task->tk_status == -EAGAIN);
1458 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1459 "error: %d\n", task->tk_status);
1460 break;
1461 }
1462 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1463}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001464#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001465
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466/*
1467 * 6. Sort out the RPC call status
1468 */
1469static void
1470call_status(struct rpc_task *task)
1471{
1472 struct rpc_clnt *clnt = task->tk_client;
1473 struct rpc_rqst *req = task->tk_rqstp;
1474 int status;
1475
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001476 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1477 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Chuck Lever46121cf2007-01-31 12:14:08 -05001479 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
1481 status = task->tk_status;
1482 if (status >= 0) {
1483 task->tk_action = call_decode;
1484 return;
1485 }
1486
1487 task->tk_status = 0;
1488 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001489 case -EHOSTDOWN:
1490 case -EHOSTUNREACH:
1491 case -ENETUNREACH:
1492 /*
1493 * Delay any retries for 3 seconds, then handle as if it
1494 * were a timeout.
1495 */
1496 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 case -ETIMEDOUT:
1498 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001499 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001500 xprt_conditional_disconnect(task->tk_xprt,
1501 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001503 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001505 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001506 rpc_delay(task, 3*HZ);
1507 case -EPIPE:
1508 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 task->tk_action = call_bind;
1510 break;
1511 case -EAGAIN:
1512 task->tk_action = call_transmit;
1513 break;
1514 case -EIO:
1515 /* shutdown or soft timeout */
1516 rpc_exit(task, status);
1517 break;
1518 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001519 if (clnt->cl_chatty)
1520 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 clnt->cl_protname, -status);
1522 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 }
1524}
1525
1526/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001527 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 * We do not release the request slot, so we keep using the
1529 * same XID for all retransmits.
1530 */
1531static void
1532call_timeout(struct rpc_task *task)
1533{
1534 struct rpc_clnt *clnt = task->tk_client;
1535
1536 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001537 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 goto retry;
1539 }
1540
Chuck Lever46121cf2007-01-31 12:14:08 -05001541 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001542 task->tk_timeouts++;
1543
Chuck Lever3a28bec2009-12-03 15:58:56 -05001544 if (RPC_IS_SOFTCONN(task)) {
1545 rpc_exit(task, -ETIMEDOUT);
1546 return;
1547 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001549 if (clnt->cl_chatty)
1550 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001552 if (task->tk_flags & RPC_TASK_TIMEOUT)
1553 rpc_exit(task, -ETIMEDOUT);
1554 else
1555 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 return;
1557 }
1558
Chuck Leverf518e35a2006-01-03 09:55:52 +01001559 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001561 if (clnt->cl_chatty)
1562 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 clnt->cl_protname, clnt->cl_server);
1564 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001565 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001566 /*
1567 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1568 * event? RFC2203 requires the server to drop all such requests.
1569 */
1570 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
1572retry:
1573 clnt->cl_stats->rpcretrans++;
1574 task->tk_action = call_bind;
1575 task->tk_status = 0;
1576}
1577
1578/*
1579 * 7. Decode the RPC reply
1580 */
1581static void
1582call_decode(struct rpc_task *task)
1583{
1584 struct rpc_clnt *clnt = task->tk_client;
1585 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001586 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001587 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Vasily Averin726fd6a2011-06-01 16:23:59 +04001589 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Chuck Leverf518e35a2006-01-03 09:55:52 +01001591 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001592 if (clnt->cl_chatty)
1593 printk(KERN_NOTICE "%s: server %s OK\n",
1594 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1596 }
1597
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001598 /*
1599 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001600 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001601 */
1602 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 req->rq_rcv_buf.len = req->rq_private_buf.len;
1604
1605 /* Check that the softirq receive buffer is valid */
1606 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1607 sizeof(req->rq_rcv_buf)) != 0);
1608
Trond Myklebust1e799b62008-03-21 16:19:41 -04001609 if (req->rq_rcv_buf.len < 12) {
1610 if (!RPC_IS_SOFT(task)) {
1611 task->tk_action = call_bind;
1612 clnt->cl_stats->rpcretrans++;
1613 goto out_retry;
1614 }
1615 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1616 clnt->cl_protname, task->tk_status);
1617 task->tk_action = call_timeout;
1618 goto out_retry;
1619 }
1620
Chuck Leverb0e1c572008-05-21 17:09:19 -04001621 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001622 if (IS_ERR(p)) {
1623 if (p == ERR_PTR(-EAGAIN))
1624 goto out_retry;
1625 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 }
1627
Trond Myklebustabbcf282006-01-03 09:55:03 +01001628 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001630 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1632 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001633 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001634 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1635 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 return;
1637out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001639 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001640 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001641 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001642 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001643 xprt_conditional_disconnect(task->tk_xprt,
1644 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646}
1647
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001648static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001649rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
1651 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001653 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
1655 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001656
1657 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 *p++ = req->rq_xid; /* XID */
1659 *p++ = htonl(RPC_CALL); /* CALL */
1660 *p++ = htonl(RPC_VERSION); /* RPC version */
1661 *p++ = htonl(clnt->cl_prog); /* program number */
1662 *p++ = htonl(clnt->cl_vers); /* program version */
1663 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001664 p = rpcauth_marshcred(task, p);
1665 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1666 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667}
1668
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001669static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001670rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671{
1672 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1673 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001674 __be32 *p = iov->iov_base;
1675 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 int error = -EACCES;
1677
David Howellse8896492006-08-24 15:44:19 -04001678 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1679 /* RFC-1014 says that the representation of XDR data must be a
1680 * multiple of four bytes
1681 * - if it isn't pointer subtraction in the NFS client may give
1682 * undefined results
1683 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001684 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001685 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001686 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001687 goto out_eio;
1688 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 if ((len -= 3) < 0)
1690 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001692 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001694 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001695 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001696 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001698
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1700 if (--len < 0)
1701 goto out_overflow;
1702 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001703 case RPC_AUTH_ERROR:
1704 break;
1705 case RPC_MISMATCH:
1706 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1707 task->tk_pid, __func__);
1708 error = -EPROTONOSUPPORT;
1709 goto out_err;
1710 default:
1711 dprintk("RPC: %5u %s: RPC call rejected, "
1712 "unknown error: %x\n",
1713 task->tk_pid, __func__, n);
1714 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 }
1716 if (--len < 0)
1717 goto out_overflow;
1718 switch ((n = ntohl(*p++))) {
1719 case RPC_AUTH_REJECTEDCRED:
1720 case RPC_AUTH_REJECTEDVERF:
1721 case RPCSEC_GSS_CREDPROBLEM:
1722 case RPCSEC_GSS_CTXPROBLEM:
1723 if (!task->tk_cred_retry)
1724 break;
1725 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001726 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001727 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001729 /* Ensure we obtain a new XID! */
1730 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001731 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001732 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 case RPC_AUTH_BADCRED:
1734 case RPC_AUTH_BADVERF:
1735 /* possibly garbled cred/verf? */
1736 if (!task->tk_garb_retry)
1737 break;
1738 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001739 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001740 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001742 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001744 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001745 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 break;
1747 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001748 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001749 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 error = -EIO;
1751 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001752 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001753 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 goto out_err;
1755 }
1756 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001757 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001758 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001759 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001761 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 if (len < 0)
1763 goto out_overflow;
1764 switch ((n = ntohl(*p++))) {
1765 case RPC_SUCCESS:
1766 return p;
1767 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001768 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001769 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 (unsigned int)task->tk_client->cl_prog,
1771 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001772 error = -EPFNOSUPPORT;
1773 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001775 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001776 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 (unsigned int)task->tk_client->cl_prog,
1778 (unsigned int)task->tk_client->cl_vers,
1779 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001780 error = -EPROTONOSUPPORT;
1781 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001783 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001784 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001785 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001786 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 task->tk_client->cl_prog,
1788 task->tk_client->cl_vers,
1789 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001790 error = -EOPNOTSUPP;
1791 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001793 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001794 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 break; /* retry */
1796 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001797 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001798 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 /* Also retry */
1800 }
1801
Trond Myklebustabbcf282006-01-03 09:55:03 +01001802out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 task->tk_client->cl_stats->rpcgarbage++;
1804 if (task->tk_garb_retry) {
1805 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001806 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001807 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001809out_retry:
1810 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812out_eio:
1813 error = -EIO;
1814out_err:
1815 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001816 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001817 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001818 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001820 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001821 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001822 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001824
Chuck Lever9f06c712010-12-14 14:59:18 +00001825static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001826{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001827}
1828
Chuck Leverbf269552010-12-14 14:59:29 +00001829static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001830{
1831 return 0;
1832}
1833
1834static struct rpc_procinfo rpcproc_null = {
1835 .p_encode = rpcproc_encode_null,
1836 .p_decode = rpcproc_decode_null,
1837};
1838
Chuck Levercaabea82009-12-03 15:58:56 -05001839static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001840{
1841 struct rpc_message msg = {
1842 .rpc_proc = &rpcproc_null,
1843 };
1844 int err;
1845 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001846 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001847 put_rpccred(msg.rpc_cred);
1848 return err;
1849}
Trond Myklebust188fef12007-06-16 14:18:40 -04001850
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001851struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1852{
1853 struct rpc_message msg = {
1854 .rpc_proc = &rpcproc_null,
1855 .rpc_cred = cred,
1856 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001857 struct rpc_task_setup task_setup_data = {
1858 .rpc_client = clnt,
1859 .rpc_message = &msg,
1860 .callback_ops = &rpc_default_ops,
1861 .flags = flags,
1862 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001863 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001864}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001865EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001866
Trond Myklebust188fef12007-06-16 14:18:40 -04001867#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001868static void rpc_show_header(void)
1869{
Chuck Levercb3997b2008-05-21 17:09:41 -04001870 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1871 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001872}
1873
Chuck Lever38e886e2008-05-21 17:09:33 -04001874static void rpc_show_task(const struct rpc_clnt *clnt,
1875 const struct rpc_task *task)
1876{
1877 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001878
1879 if (RPC_IS_QUEUED(task))
1880 rpc_waitq = rpc_qname(task->tk_waitqueue);
1881
Joe Perchesb3bceda2010-12-21 10:52:24 -05001882 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 -04001883 task->tk_pid, task->tk_flags, task->tk_status,
1884 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1885 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001886 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001887}
1888
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001889void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04001890{
1891 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001892 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001893 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001894 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04001895
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001896 spin_lock(&sn->rpc_client_lock);
1897 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001898 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001899 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001900 if (!header) {
1901 rpc_show_header();
1902 header++;
1903 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001904 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001905 }
1906 spin_unlock(&clnt->cl_lock);
1907 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001908 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001909}
1910#endif