blob: 25c3da53fb690742591f50f580ecf37bc061f5b0 [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>
Steve Dickson5753cba2012-02-06 10:08:08 -050039#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040041#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040042#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifdef RPC_DEBUG
45# define RPCDBG_FACILITY RPCDBG_CALL
46#endif
47
Chuck Lever46121cf2007-01-31 12:14:08 -050048#define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080050 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050051
Trond Myklebust188fef12007-06-16 14:18:40 -040052/*
53 * All RPC clients are linked into this list
54 */
Trond Myklebust188fef12007-06-16 14:18:40 -040055
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{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040084 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
85
86 spin_lock(&sn->rpc_client_lock);
87 list_add(&clnt->cl_clients, &sn->all_clients);
88 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040089}
90
91static void rpc_unregister_client(struct rpc_clnt *clnt)
92{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040093 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
94
95 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040096 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040098}
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400100static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
101{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400102 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400103 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
104 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400107 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400108}
109
110static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
111{
112 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400113
114 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
115 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 __rpc_clnt_remove_pipedir(clnt);
117 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
118 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119}
120
121static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500122 struct rpc_clnt *clnt,
123 const 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
Trond Myklebust080b7942012-01-20 13:53:56 -0500156rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400157{
158 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400159 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400160
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400161 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 if (dir_name == NULL)
163 return 0;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400164 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400165 if (!pipefs_sb)
166 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400167 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400168 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400169 if (IS_ERR(dentry))
170 return PTR_ERR(dentry);
171 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400172 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173}
174
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400175static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
176 struct super_block *sb)
177{
178 struct dentry *dentry;
179 int err = 0;
180
181 switch (event) {
182 case RPC_PIPEFS_MOUNT:
183 if (clnt->cl_program->pipe_dir_name == NULL)
184 break;
185 dentry = rpc_setup_pipedir_sb(sb, clnt,
186 clnt->cl_program->pipe_dir_name);
187 BUG_ON(dentry == NULL);
188 if (IS_ERR(dentry))
189 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400190 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400191 if (clnt->cl_auth->au_ops->pipes_create) {
192 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
193 if (err)
194 __rpc_clnt_remove_pipedir(clnt);
195 }
196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400207static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
208{
209 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
210 struct rpc_clnt *clnt;
211
212 spin_lock(&sn->rpc_client_lock);
213 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
214 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
215 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
216 continue;
217 atomic_inc(&clnt->cl_count);
218 spin_unlock(&sn->rpc_client_lock);
219 return clnt;
220 }
221 spin_unlock(&sn->rpc_client_lock);
222 return NULL;
223}
224
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400225static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
226 void *ptr)
227{
228 struct super_block *sb = ptr;
229 struct rpc_clnt *clnt;
230 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400231
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400232 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400233 error = __rpc_pipefs_event(clnt, event, sb);
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400234 rpc_release_client(clnt);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400235 if (error)
236 break;
237 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400238 return error;
239}
240
241static struct notifier_block rpc_clients_block = {
242 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400243 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244};
245
246int rpc_clients_notifier_register(void)
247{
248 return rpc_pipefs_notifier_register(&rpc_clients_block);
249}
250
251void rpc_clients_notifier_unregister(void)
252{
253 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
254}
255
Trond Myklebust698b6d02007-12-20 16:03:53 -0500256static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500258 const struct rpc_program *program = args->program;
259 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000261 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400263 size_t len;
264
265 /* sanity check the name before trying to print it */
266 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500267 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400268 if (len > RPC_MAXNETNAMELEN)
269 goto out_no_rpciod;
270 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Chuck Lever46121cf2007-01-31 12:14:08 -0500272 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500273 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Trond Myklebust4ada5392007-06-14 17:26:17 -0400275 err = rpciod_up();
276 if (err)
277 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 err = -EINVAL;
279 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800280 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500281
282 if (args->version >= program->nrvers)
283 goto out_err;
284 version = program->version[args->version];
285 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 goto out_err;
287
288 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700289 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 if (!clnt)
291 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 clnt->cl_parent = clnt;
293
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500294 clnt->cl_server = kstrdup(args->servername, GFP_KERNEL);
295 if (clnt->cl_server == NULL)
296 goto out_no_server;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 clnt->cl_xprt = xprt;
299 clnt->cl_procinfo = version->procs;
300 clnt->cl_maxproc = version->nrprocs;
301 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300302 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500305 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500306 err = -ENOMEM;
307 if (clnt->cl_metrics == NULL)
308 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500309 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400310 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400311 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Chuck Leverec739ef2006-08-22 20:06:15 -0400313 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 clnt->cl_autobind = 1;
315
Trond Myklebustba7392b2007-12-20 16:03:55 -0500316 clnt->cl_timeout = xprt->timeout;
317 if (args->timeout != NULL) {
318 memcpy(&clnt->cl_timeout_default, args->timeout,
319 sizeof(clnt->cl_timeout_default));
320 clnt->cl_timeout = &clnt->cl_timeout_default;
321 }
322
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500324 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500325 clnt->cl_principal = NULL;
326 if (args->client_name) {
327 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
328 if (!clnt->cl_principal)
329 goto out_no_principal;
330 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Trond Myklebust006abe82010-09-12 19:55:25 -0400332 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
335 if (err < 0)
336 goto out_no_path;
337
Trond Myklebust698b6d02007-12-20 16:03:53 -0500338 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000339 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500341 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000342 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 goto out_no_auth;
344 }
345
346 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400347 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 if (clnt->cl_nodelen > UNX_MAXNODENAME)
349 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400350 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400351 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 return clnt;
353
354out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400355 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500357 kfree(clnt->cl_principal);
358out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500359 rpc_free_iostats(clnt->cl_metrics);
360out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500361 kfree(clnt->cl_server);
362out_no_server:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 kfree(clnt);
364out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400365 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800366out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400367 rpciod_down();
368out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 return ERR_PTR(err);
370}
371
Chuck Leverc2866762006-08-22 20:06:20 -0400372/*
373 * rpc_create - create an RPC client and transport with one call
374 * @args: rpc_clnt create argument structure
375 *
376 * Creates and initializes an RPC transport and an RPC client.
377 *
378 * It can ping the server in order to determine if it is up, and to see if
379 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
380 * this behavior so asynchronous tasks can also use rpc_create.
381 */
382struct rpc_clnt *rpc_create(struct rpc_create_args *args)
383{
384 struct rpc_xprt *xprt;
385 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400386 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400387 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400388 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200389 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200390 .dstaddr = args->address,
391 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300392 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200393 };
Chuck Lever510deb02007-12-10 14:56:24 -0500394 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400395
Chuck Leverc2866762006-08-22 20:06:20 -0400396 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400397 * If the caller chooses not to specify a hostname, whip
398 * up a string representation of the passed-in address.
399 */
400 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400401 struct sockaddr_un *sun =
402 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400403 struct sockaddr_in *sin =
404 (struct sockaddr_in *)args->address;
405 struct sockaddr_in6 *sin6 =
406 (struct sockaddr_in6 *)args->address;
407
Chuck Lever510deb02007-12-10 14:56:24 -0500408 servername[0] = '\0';
409 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400410 case AF_LOCAL:
411 snprintf(servername, sizeof(servername), "%s",
412 sun->sun_path);
413 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400414 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700415 snprintf(servername, sizeof(servername), "%pI4",
416 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500417 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400418 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700419 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400420 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500421 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500422 default:
423 /* caller wants default server name, but
424 * address family isn't recognized. */
425 return ERR_PTR(-EINVAL);
426 }
Chuck Lever43780b82007-07-01 12:13:22 -0400427 args->servername = servername;
428 }
429
Chuck Lever510deb02007-12-10 14:56:24 -0500430 xprt = xprt_create_transport(&xprtargs);
431 if (IS_ERR(xprt))
432 return (struct rpc_clnt *)xprt;
433
Chuck Lever43780b82007-07-01 12:13:22 -0400434 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400435 * By default, kernel RPC client connects from a reserved port.
436 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
437 * but it is always enabled for rpciod, which handles the connect
438 * operation.
439 */
440 xprt->resvport = 1;
441 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
442 xprt->resvport = 0;
443
Trond Myklebust698b6d02007-12-20 16:03:53 -0500444 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400445 if (IS_ERR(clnt))
446 return clnt;
447
448 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500449 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400450 if (err != 0) {
451 rpc_shutdown_client(clnt);
452 return ERR_PTR(err);
453 }
454 }
455
456 clnt->cl_softrtry = 1;
457 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
458 clnt->cl_softrtry = 0;
459
Chuck Leverc2866762006-08-22 20:06:20 -0400460 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
461 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500462 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
463 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400464 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
465 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400466
467 return clnt;
468}
Chuck Leverb86acd52006-08-22 20:06:22 -0400469EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471/*
472 * This function clones the RPC client structure. It allows us to share the
473 * same transport while varying parameters such as the authentication
474 * flavour.
475 */
476struct rpc_clnt *
477rpc_clone_client(struct rpc_clnt *clnt)
478{
479 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500480 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200482 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 if (!new)
484 goto out_no_clnt;
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500485 new->cl_server = kstrdup(clnt->cl_server, GFP_KERNEL);
486 if (new->cl_server == NULL)
487 goto out_no_server;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400488 new->cl_parent = clnt;
489 /* Turn off autobind on clones */
490 new->cl_autobind = 0;
491 INIT_LIST_HEAD(&new->cl_tasks);
492 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500493 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500494 new->cl_metrics = rpc_alloc_iostats(clnt);
495 if (new->cl_metrics == NULL)
496 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500497 if (clnt->cl_principal) {
498 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
499 if (new->cl_principal == NULL)
500 goto out_no_principal;
501 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400502 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500503 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
504 if (err != 0)
505 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 if (new->cl_auth)
507 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400508 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400509 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400510 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400511 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500513out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500514 kfree(new->cl_principal);
515out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500516 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500517out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500518 kfree(new->cl_server);
519out_no_server:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500520 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800522 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500523 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400525EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400528 * Kill all tasks for the given client.
529 * XXX: kill their descendants as well?
530 */
531void rpc_killall_tasks(struct rpc_clnt *clnt)
532{
533 struct rpc_task *rovr;
534
535
536 if (list_empty(&clnt->cl_tasks))
537 return;
538 dprintk("RPC: killing all tasks for client %p\n", clnt);
539 /*
540 * Spin lock all_tasks to prevent changes...
541 */
542 spin_lock(&clnt->cl_lock);
543 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
544 if (!RPC_IS_ACTIVATED(rovr))
545 continue;
546 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
547 rovr->tk_flags |= RPC_TASK_KILLED;
548 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300549 if (RPC_IS_QUEUED(rovr))
550 rpc_wake_up_queued_task(rovr->tk_waitqueue,
551 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400552 }
553 }
554 spin_unlock(&clnt->cl_lock);
555}
556EXPORT_SYMBOL_GPL(rpc_killall_tasks);
557
558/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400560 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400562void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400564 dprintk("RPC: shutting down %s client for %s\n",
565 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Trond Myklebust34f52e32007-06-14 16:40:31 -0400567 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800569 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400570 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
572
Trond Myklebust4c402b42007-06-14 16:40:32 -0400573 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400575EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400578 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400580static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400581rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
Chuck Lever46121cf2007-01-31 12:14:08 -0500583 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 clnt->cl_protname, clnt->cl_server);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500585 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400586 rpc_release_client(clnt->cl_parent);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500587 kfree(clnt->cl_server);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400588 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400589 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500590 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500591 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500592 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400593 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400594 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596}
597
598/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400599 * Free an RPC client
600 */
601static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400602rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400603{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400604 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400605 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400606 return;
607 }
608
609 /*
610 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
611 * release remaining GSS contexts. This mechanism ensures
612 * that it can do so safely.
613 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400614 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400615 rpcauth_release(clnt->cl_auth);
616 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400617 if (atomic_dec_and_test(&clnt->cl_count))
618 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400619}
620
621/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400622 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 */
624void
625rpc_release_client(struct rpc_clnt *clnt)
626{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400627 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Trond Myklebust34f52e32007-06-14 16:40:31 -0400629 if (list_empty(&clnt->cl_tasks))
630 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400631 if (atomic_dec_and_test(&clnt->cl_count))
632 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400633}
634
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000635/**
636 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800637 * @old: old rpc_client
638 * @program: rpc program to set
639 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000640 *
641 * Clones the rpc client and sets up a new RPC program. This is mainly
642 * of use for enabling different RPC programs to share the same transport.
643 * The Sun NFSv2/v3 ACL protocol can do this.
644 */
645struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500646 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400647 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000648{
649 struct rpc_clnt *clnt;
Trond Myklebusta613fa12012-01-20 13:53:56 -0500650 const struct rpc_version *version;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000651 int err;
652
653 BUG_ON(vers >= program->nrvers || !program->version[vers]);
654 version = program->version[vers];
655 clnt = rpc_clone_client(old);
656 if (IS_ERR(clnt))
657 goto out;
658 clnt->cl_procinfo = version->procs;
659 clnt->cl_maxproc = version->nrprocs;
660 clnt->cl_protname = program->name;
661 clnt->cl_prog = program->number;
662 clnt->cl_vers = version->number;
663 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500664 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000665 if (err != 0) {
666 rpc_shutdown_client(clnt);
667 clnt = ERR_PTR(err);
668 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800669out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000670 return clnt;
671}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400672EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000673
Trond Myklebust58f96122010-07-31 14:29:08 -0400674void rpc_task_release_client(struct rpc_task *task)
675{
676 struct rpc_clnt *clnt = task->tk_client;
677
678 if (clnt != NULL) {
679 /* Remove from client task list */
680 spin_lock(&clnt->cl_lock);
681 list_del(&task->tk_task);
682 spin_unlock(&clnt->cl_lock);
683 task->tk_client = NULL;
684
685 rpc_release_client(clnt);
686 }
687}
688
689static
690void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
691{
692 if (clnt != NULL) {
693 rpc_task_release_client(task);
694 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400695 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400696 if (clnt->cl_softrtry)
697 task->tk_flags |= RPC_TASK_SOFT;
698 /* Add to the client's list of all tasks */
699 spin_lock(&clnt->cl_lock);
700 list_add_tail(&task->tk_task, &clnt->cl_tasks);
701 spin_unlock(&clnt->cl_lock);
702 }
703}
704
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000705void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
706{
707 rpc_task_release_client(task);
708 rpc_task_set_client(task, clnt);
709}
710EXPORT_SYMBOL_GPL(rpc_task_reset_client);
711
712
Trond Myklebust58f96122010-07-31 14:29:08 -0400713static void
714rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
715{
716 if (msg != NULL) {
717 task->tk_msg.rpc_proc = msg->rpc_proc;
718 task->tk_msg.rpc_argp = msg->rpc_argp;
719 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400720 if (msg->rpc_cred != NULL)
721 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400722 }
723}
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725/*
726 * Default callback for async RPC calls
727 */
728static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100729rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
731}
732
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100733static const struct rpc_call_ops rpc_default_ops = {
734 .rpc_call_done = rpc_default_callback,
735};
736
Trond Myklebustc970aa82007-07-14 15:39:59 -0400737/**
738 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
739 * @task_setup_data: pointer to task initialisation data
740 */
741struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400742{
Trond Myklebust19445b92010-04-16 16:41:10 -0400743 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400744
Trond Myklebust84115e12007-07-14 15:39:59 -0400745 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400746 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400747 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400748
Trond Myklebust58f96122010-07-31 14:29:08 -0400749 rpc_task_set_client(task, task_setup_data->rpc_client);
750 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
751
Trond Myklebust58f96122010-07-31 14:29:08 -0400752 if (task->tk_action == NULL)
753 rpc_call_start(task);
754
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400755 atomic_inc(&task->tk_count);
756 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400757out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400758 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400759}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400760EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400761
762/**
763 * rpc_call_sync - Perform a synchronous RPC call
764 * @clnt: pointer to RPC client
765 * @msg: RPC call parameters
766 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500768int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769{
770 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400771 struct rpc_task_setup task_setup_data = {
772 .rpc_client = clnt,
773 .rpc_message = msg,
774 .callback_ops = &rpc_default_ops,
775 .flags = flags,
776 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400777 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 BUG_ON(flags & RPC_TASK_ASYNC);
780
Trond Myklebustc970aa82007-07-14 15:39:59 -0400781 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400782 if (IS_ERR(task))
783 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100784 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800785 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 return status;
787}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400788EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400790/**
791 * rpc_call_async - Perform an asynchronous RPC call
792 * @clnt: pointer to RPC client
793 * @msg: RPC call parameters
794 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800795 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400796 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 */
798int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500799rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100800 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
802 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400803 struct rpc_task_setup task_setup_data = {
804 .rpc_client = clnt,
805 .rpc_message = msg,
806 .callback_ops = tk_ops,
807 .callback_data = data,
808 .flags = flags|RPC_TASK_ASYNC,
809 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Trond Myklebustc970aa82007-07-14 15:39:59 -0400811 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400812 if (IS_ERR(task))
813 return PTR_ERR(task);
814 rpc_put_task(task);
815 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400817EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400819#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400820/**
821 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
822 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400823 * @req: RPC request
824 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400825 */
826struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400827 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400828{
829 struct rpc_task *task;
830 struct xdr_buf *xbufp = &req->rq_snd_buf;
831 struct rpc_task_setup task_setup_data = {
832 .callback_ops = tk_ops,
833 };
834
835 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
836 /*
837 * Create an rpc_task to send the data
838 */
839 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400840 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400841 xprt_free_bc_request(req);
842 goto out;
843 }
844 task->tk_rqstp = req;
845
846 /*
847 * Set up the xdr_buf length.
848 * This also indicates that the buffer is XDR encoded already.
849 */
850 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
851 xbufp->tail[0].iov_len;
852
853 task->tk_action = call_bc_transmit;
854 atomic_inc(&task->tk_count);
855 BUG_ON(atomic_read(&task->tk_count) != 2);
856 rpc_execute(task);
857
858out:
859 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
860 return task;
861}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400862#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400865rpc_call_start(struct rpc_task *task)
866{
867 task->tk_action = call_start;
868}
869EXPORT_SYMBOL_GPL(rpc_call_start);
870
Chuck Levered394402006-08-22 20:06:17 -0400871/**
872 * rpc_peeraddr - extract remote peer address from clnt's xprt
873 * @clnt: RPC client structure
874 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800875 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400876 *
877 * Returns the number of bytes that are actually in the stored address.
878 */
879size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
880{
881 size_t bytes;
882 struct rpc_xprt *xprt = clnt->cl_xprt;
883
884 bytes = sizeof(xprt->addr);
885 if (bytes > bufsize)
886 bytes = bufsize;
887 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400888 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400889}
Chuck Leverb86acd52006-08-22 20:06:22 -0400890EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400891
Chuck Leverf425eba2006-08-22 20:06:18 -0400892/**
893 * rpc_peeraddr2str - return remote peer address in printable format
894 * @clnt: RPC client structure
895 * @format: address format
896 *
897 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500898const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
899 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400900{
901 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500902
903 if (xprt->address_strings[format] != NULL)
904 return xprt->address_strings[format];
905 else
906 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400907}
Chuck Leverb86acd52006-08-22 20:06:22 -0400908EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910void
911rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
912{
913 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700914 if (xprt->ops->set_buffer_size)
915 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400917EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919/*
920 * Return size of largest payload RPC client can support, in bytes
921 *
922 * For stream transports, this is one RPC record fragment (see RFC
923 * 1831), as we don't support multi-record requests yet. For datagram
924 * transports, this is the size of an IP packet minus the IP, UDP, and
925 * RPC header sizes.
926 */
927size_t rpc_max_payload(struct rpc_clnt *clnt)
928{
929 return clnt->cl_xprt->max_payload;
930}
Chuck Leverb86acd52006-08-22 20:06:22 -0400931EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
Chuck Lever35f5a422006-01-03 09:55:50 +0100933/**
934 * rpc_force_rebind - force transport to check that remote port is unchanged
935 * @clnt: client to rebind
936 *
937 */
938void rpc_force_rebind(struct rpc_clnt *clnt)
939{
940 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400941 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100942}
Chuck Leverb86acd52006-08-22 20:06:22 -0400943EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100944
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400946 * Restart an (async) RPC call from the call_prepare state.
947 * Usually called from within the exit handler.
948 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400949int
Andy Adamsonaae20062009-04-01 09:22:40 -0400950rpc_restart_call_prepare(struct rpc_task *task)
951{
952 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400953 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700954 task->tk_action = call_start;
955 if (task->tk_ops->rpc_call_prepare != NULL)
956 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400957 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400958}
959EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
960
961/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * Restart an (async) RPC call. Usually called from within the
963 * exit handler.
964 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400965int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966rpc_restart_call(struct rpc_task *task)
967{
968 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400969 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400971 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400973EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Chuck Lever3748f1e2008-05-21 17:09:12 -0400975#ifdef RPC_DEBUG
976static const char *rpc_proc_name(const struct rpc_task *task)
977{
978 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
979
980 if (proc) {
981 if (proc->p_name)
982 return proc->p_name;
983 else
984 return "NULL";
985 } else
986 return "no proc";
987}
988#endif
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990/*
991 * 0. Initial state
992 *
993 * Other FSM states can be visited zero or more times, but
994 * this state is visited exactly once for each RPC.
995 */
996static void
997call_start(struct rpc_task *task)
998{
999 struct rpc_clnt *clnt = task->tk_client;
1000
Chuck Lever3748f1e2008-05-21 17:09:12 -04001001 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001002 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001003 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001004 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
1006 /* Increment call count */
1007 task->tk_msg.rpc_proc->p_count++;
1008 clnt->cl_stats->rpccnt++;
1009 task->tk_action = call_reserve;
1010}
1011
1012/*
1013 * 1. Reserve an RPC call slot
1014 */
1015static void
1016call_reserve(struct rpc_task *task)
1017{
Chuck Lever46121cf2007-01-31 12:14:08 -05001018 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 task->tk_status = 0;
1021 task->tk_action = call_reserveresult;
1022 xprt_reserve(task);
1023}
1024
1025/*
1026 * 1b. Grok the result of xprt_reserve()
1027 */
1028static void
1029call_reserveresult(struct rpc_task *task)
1030{
1031 int status = task->tk_status;
1032
Chuck Lever46121cf2007-01-31 12:14:08 -05001033 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
1035 /*
1036 * After a call to xprt_reserve(), we must have either
1037 * a request slot or else an error status.
1038 */
1039 task->tk_status = 0;
1040 if (status >= 0) {
1041 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001042 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 return;
1044 }
1045
1046 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001047 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 rpc_exit(task, -EIO);
1049 return;
1050 }
1051
1052 /*
1053 * Even though there was an error, we may have acquired
1054 * a request slot somehow. Make sure not to leak it.
1055 */
1056 if (task->tk_rqstp) {
1057 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001058 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 xprt_release(task);
1060 }
1061
1062 switch (status) {
1063 case -EAGAIN: /* woken up; retry */
1064 task->tk_action = call_reserve;
1065 return;
1066 case -EIO: /* probably a shutdown */
1067 break;
1068 default:
1069 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001070 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 break;
1072 }
1073 rpc_exit(task, status);
1074}
1075
1076/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001077 * 2. Bind and/or refresh the credentials
1078 */
1079static void
1080call_refresh(struct rpc_task *task)
1081{
1082 dprint_status(task);
1083
1084 task->tk_action = call_refreshresult;
1085 task->tk_status = 0;
1086 task->tk_client->cl_stats->rpcauthrefresh++;
1087 rpcauth_refreshcred(task);
1088}
1089
1090/*
1091 * 2a. Process the results of a credential refresh
1092 */
1093static void
1094call_refreshresult(struct rpc_task *task)
1095{
1096 int status = task->tk_status;
1097
1098 dprint_status(task);
1099
1100 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001101 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001102 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001103 case 0:
1104 if (rpcauth_uptodatecred(task))
1105 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001106 return;
1107 case -ETIMEDOUT:
1108 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001109 case -EAGAIN:
1110 status = -EACCES;
1111 if (!task->tk_cred_retry)
1112 break;
1113 task->tk_cred_retry--;
1114 dprintk("RPC: %5u %s: retry refresh creds\n",
1115 task->tk_pid, __func__);
1116 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001117 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001118 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1119 task->tk_pid, __func__, status);
1120 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001121}
1122
1123/*
1124 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001125 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 */
1127static void
1128call_allocate(struct rpc_task *task)
1129{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001130 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001131 struct rpc_rqst *req = task->tk_rqstp;
1132 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001133 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
Chuck Lever46121cf2007-01-31 12:14:08 -05001135 dprint_status(task);
1136
Chuck Lever2bea90d2007-03-29 16:47:53 -04001137 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001138 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001139
Chuck Lever02107142006-01-03 09:55:49 +01001140 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 return;
1142
Chuck Lever2bea90d2007-03-29 16:47:53 -04001143 if (proc->p_proc != 0) {
1144 BUG_ON(proc->p_arglen == 0);
1145 if (proc->p_decode != NULL)
1146 BUG_ON(proc->p_replen == 0);
1147 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
Chuck Lever2bea90d2007-03-29 16:47:53 -04001149 /*
1150 * Calculate the size (in quads) of the RPC call
1151 * and reply headers, and convert both values
1152 * to byte sizes.
1153 */
1154 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1155 req->rq_callsize <<= 2;
1156 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1157 req->rq_rcvsize <<= 2;
1158
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001159 req->rq_buffer = xprt->ops->buf_alloc(task,
1160 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001161 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001163
1164 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Trond Myklebust5afa9132011-06-17 10:14:59 -04001166 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001167 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 rpc_delay(task, HZ>>4);
1169 return;
1170 }
1171
1172 rpc_exit(task, -ERESTARTSYS);
1173}
1174
Trond Myklebust940e3312005-11-09 21:45:24 -05001175static inline int
1176rpc_task_need_encode(struct rpc_task *task)
1177{
1178 return task->tk_rqstp->rq_snd_buf.len == 0;
1179}
1180
1181static inline void
1182rpc_task_force_reencode(struct rpc_task *task)
1183{
1184 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001185 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001186}
1187
Chuck Lever2bea90d2007-03-29 16:47:53 -04001188static inline void
1189rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1190{
1191 buf->head[0].iov_base = start;
1192 buf->head[0].iov_len = len;
1193 buf->tail[0].iov_len = 0;
1194 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001195 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001196 buf->len = 0;
1197 buf->buflen = len;
1198}
1199
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200/*
1201 * 3. Encode arguments of an RPC call
1202 */
1203static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001204rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001207 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001208 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Chuck Lever46121cf2007-01-31 12:14:08 -05001210 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Chuck Lever2bea90d2007-03-29 16:47:53 -04001212 rpc_xdr_buf_init(&req->rq_snd_buf,
1213 req->rq_buffer,
1214 req->rq_callsize);
1215 rpc_xdr_buf_init(&req->rq_rcv_buf,
1216 (char *)req->rq_buffer + req->rq_callsize,
1217 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Chuck Leverb0e1c572008-05-21 17:09:19 -04001219 p = rpc_encode_header(task);
1220 if (p == NULL) {
1221 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 rpc_exit(task, -EIO);
1223 return;
1224 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001225
1226 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001227 if (encode == NULL)
1228 return;
1229
1230 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1231 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232}
1233
1234/*
1235 * 4. Get the server port number if not yet set
1236 */
1237static void
1238call_bind(struct rpc_task *task)
1239{
Chuck Leverec739ef2006-08-22 20:06:15 -04001240 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Chuck Lever46121cf2007-01-31 12:14:08 -05001242 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
Chuck Leverda351872005-08-11 16:25:11 -04001244 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001245 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001246 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001247 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001248 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 }
1250}
1251
1252/*
Chuck Leverda351872005-08-11 16:25:11 -04001253 * 4a. Sort out bind result
1254 */
1255static void
1256call_bind_status(struct rpc_task *task)
1257{
Chuck Lever906462a2007-09-11 18:00:47 -04001258 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001259
1260 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001261 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001262 task->tk_status = 0;
1263 task->tk_action = call_connect;
1264 return;
1265 }
1266
Steve Dickson5753cba2012-02-06 10:08:08 -05001267 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001268 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001269 case -ENOMEM:
1270 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1271 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001272 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001273 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001274 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1275 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001276 /* fail immediately if this is an RPC ping */
1277 if (task->tk_msg.rpc_proc->p_proc == 0) {
1278 status = -EOPNOTSUPP;
1279 break;
1280 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001281 if (task->tk_rebind_retry == 0)
1282 break;
1283 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001284 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001285 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001286 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001287 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001288 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001289 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001290 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001291 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001292 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001293 task->tk_pid);
1294 break;
1295 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001296 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001297 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001298 task->tk_status = 0;
1299 task->tk_action = call_bind;
1300 return;
Chuck Lever012da152009-12-03 15:58:56 -05001301 case -ECONNREFUSED: /* connection problems */
1302 case -ECONNRESET:
1303 case -ENOTCONN:
1304 case -EHOSTDOWN:
1305 case -EHOSTUNREACH:
1306 case -ENETUNREACH:
1307 case -EPIPE:
1308 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1309 task->tk_pid, task->tk_status);
1310 if (!RPC_IS_SOFTCONN(task)) {
1311 rpc_delay(task, 5*HZ);
1312 goto retry_timeout;
1313 }
1314 status = task->tk_status;
1315 break;
Chuck Leverda351872005-08-11 16:25:11 -04001316 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001317 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001318 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001319 }
1320
1321 rpc_exit(task, status);
1322 return;
1323
Trond Myklebustda458282006-08-31 15:44:52 -04001324retry_timeout:
1325 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001326}
1327
1328/*
1329 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 */
1331static void
1332call_connect(struct rpc_task *task)
1333{
Chuck Leverda351872005-08-11 16:25:11 -04001334 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Chuck Lever46121cf2007-01-31 12:14:08 -05001336 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001337 task->tk_pid, xprt,
1338 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Chuck Leverda351872005-08-11 16:25:11 -04001340 task->tk_action = call_transmit;
1341 if (!xprt_connected(xprt)) {
1342 task->tk_action = call_connect_status;
1343 if (task->tk_status < 0)
1344 return;
1345 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347}
1348
1349/*
Chuck Leverda351872005-08-11 16:25:11 -04001350 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 */
1352static void
1353call_connect_status(struct rpc_task *task)
1354{
1355 struct rpc_clnt *clnt = task->tk_client;
1356 int status = task->tk_status;
1357
Chuck Lever46121cf2007-01-31 12:14:08 -05001358 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001361 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 clnt->cl_stats->netreconn++;
1363 task->tk_action = call_transmit;
1364 return;
1365 }
1366
Steve Dickson5753cba2012-02-06 10:08:08 -05001367 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001369 /* if soft mounted, test if we've timed out */
1370 case -ETIMEDOUT:
1371 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001372 break;
1373 default:
1374 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 }
1376}
1377
1378/*
1379 * 5. Transmit the RPC request, and wait for reply
1380 */
1381static void
1382call_transmit(struct rpc_task *task)
1383{
Chuck Lever46121cf2007-01-31 12:14:08 -05001384 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
1386 task->tk_action = call_status;
1387 if (task->tk_status < 0)
1388 return;
1389 task->tk_status = xprt_prepare_transmit(task);
1390 if (task->tk_status != 0)
1391 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001392 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001394 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001395 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001396 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001397 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001398 if (task->tk_status != 0) {
1399 /* Was the error nonfatal? */
1400 if (task->tk_status == -EAGAIN)
1401 rpc_delay(task, HZ >> 4);
1402 else
1403 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001404 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001405 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001406 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 xprt_transmit(task);
1408 if (task->tk_status < 0)
1409 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001410 /*
1411 * On success, ensure that we call xprt_end_transmit() before sleeping
1412 * in order to allow access to the socket to other RPC requests.
1413 */
1414 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001415 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001416 return;
1417 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001418 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001419}
1420
1421/*
1422 * 5a. Handle cleanup after a transmission
1423 */
1424static void
1425call_transmit_status(struct rpc_task *task)
1426{
1427 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001428
1429 /*
1430 * Common case: success. Force the compiler to put this
1431 * test first.
1432 */
1433 if (task->tk_status == 0) {
1434 xprt_end_transmit(task);
1435 rpc_task_force_reencode(task);
1436 return;
1437 }
1438
Trond Myklebust15f081c2009-03-11 14:37:57 -04001439 switch (task->tk_status) {
1440 case -EAGAIN:
1441 break;
1442 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001443 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001444 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001445 rpc_task_force_reencode(task);
1446 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001447 /*
1448 * Special cases: if we've been waiting on the
1449 * socket's write_space() callback, or if the
1450 * socket just returned a connection error,
1451 * then hold onto the transport lock.
1452 */
1453 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001454 case -EHOSTDOWN:
1455 case -EHOSTUNREACH:
1456 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001457 if (RPC_IS_SOFTCONN(task)) {
1458 xprt_end_transmit(task);
1459 rpc_exit(task, task->tk_status);
1460 break;
1461 }
1462 case -ECONNRESET:
1463 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001464 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001465 rpc_task_force_reencode(task);
1466 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467}
1468
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001469#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001470/*
1471 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1472 * addition, disconnect on connectivity errors.
1473 */
1474static void
1475call_bc_transmit(struct rpc_task *task)
1476{
1477 struct rpc_rqst *req = task->tk_rqstp;
1478
1479 BUG_ON(task->tk_status != 0);
1480 task->tk_status = xprt_prepare_transmit(task);
1481 if (task->tk_status == -EAGAIN) {
1482 /*
1483 * Could not reserve the transport. Try again after the
1484 * transport is released.
1485 */
1486 task->tk_status = 0;
1487 task->tk_action = call_bc_transmit;
1488 return;
1489 }
1490
1491 task->tk_action = rpc_exit_task;
1492 if (task->tk_status < 0) {
1493 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1494 "error: %d\n", task->tk_status);
1495 return;
1496 }
1497
1498 xprt_transmit(task);
1499 xprt_end_transmit(task);
1500 dprint_status(task);
1501 switch (task->tk_status) {
1502 case 0:
1503 /* Success */
1504 break;
1505 case -EHOSTDOWN:
1506 case -EHOSTUNREACH:
1507 case -ENETUNREACH:
1508 case -ETIMEDOUT:
1509 /*
1510 * Problem reaching the server. Disconnect and let the
1511 * forechannel reestablish the connection. The server will
1512 * have to retransmit the backchannel request and we'll
1513 * reprocess it. Since these ops are idempotent, there's no
1514 * need to cache our reply at this time.
1515 */
1516 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1517 "error: %d\n", task->tk_status);
1518 xprt_conditional_disconnect(task->tk_xprt,
1519 req->rq_connect_cookie);
1520 break;
1521 default:
1522 /*
1523 * We were unable to reply and will have to drop the
1524 * request. The server should reconnect and retransmit.
1525 */
1526 BUG_ON(task->tk_status == -EAGAIN);
1527 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1528 "error: %d\n", task->tk_status);
1529 break;
1530 }
1531 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1532}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001533#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001534
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535/*
1536 * 6. Sort out the RPC call status
1537 */
1538static void
1539call_status(struct rpc_task *task)
1540{
1541 struct rpc_clnt *clnt = task->tk_client;
1542 struct rpc_rqst *req = task->tk_rqstp;
1543 int status;
1544
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001545 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1546 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
Chuck Lever46121cf2007-01-31 12:14:08 -05001548 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
1550 status = task->tk_status;
1551 if (status >= 0) {
1552 task->tk_action = call_decode;
1553 return;
1554 }
1555
Steve Dickson5753cba2012-02-06 10:08:08 -05001556 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 task->tk_status = 0;
1558 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001559 case -EHOSTDOWN:
1560 case -EHOSTUNREACH:
1561 case -ENETUNREACH:
1562 /*
1563 * Delay any retries for 3 seconds, then handle as if it
1564 * were a timeout.
1565 */
1566 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 case -ETIMEDOUT:
1568 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001569 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001570 xprt_conditional_disconnect(task->tk_xprt,
1571 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001573 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001575 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001576 rpc_delay(task, 3*HZ);
1577 case -EPIPE:
1578 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 task->tk_action = call_bind;
1580 break;
1581 case -EAGAIN:
1582 task->tk_action = call_transmit;
1583 break;
1584 case -EIO:
1585 /* shutdown or soft timeout */
1586 rpc_exit(task, status);
1587 break;
1588 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001589 if (clnt->cl_chatty)
1590 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 clnt->cl_protname, -status);
1592 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 }
1594}
1595
1596/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001597 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 * We do not release the request slot, so we keep using the
1599 * same XID for all retransmits.
1600 */
1601static void
1602call_timeout(struct rpc_task *task)
1603{
1604 struct rpc_clnt *clnt = task->tk_client;
1605
1606 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001607 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 goto retry;
1609 }
1610
Chuck Lever46121cf2007-01-31 12:14:08 -05001611 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001612 task->tk_timeouts++;
1613
Chuck Lever3a28bec2009-12-03 15:58:56 -05001614 if (RPC_IS_SOFTCONN(task)) {
1615 rpc_exit(task, -ETIMEDOUT);
1616 return;
1617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001619 if (clnt->cl_chatty)
1620 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001622 if (task->tk_flags & RPC_TASK_TIMEOUT)
1623 rpc_exit(task, -ETIMEDOUT);
1624 else
1625 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 return;
1627 }
1628
Chuck Leverf518e35a2006-01-03 09:55:52 +01001629 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001631 if (clnt->cl_chatty)
1632 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 clnt->cl_protname, clnt->cl_server);
1634 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001635 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001636 /*
1637 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1638 * event? RFC2203 requires the server to drop all such requests.
1639 */
1640 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
1642retry:
1643 clnt->cl_stats->rpcretrans++;
1644 task->tk_action = call_bind;
1645 task->tk_status = 0;
1646}
1647
1648/*
1649 * 7. Decode the RPC reply
1650 */
1651static void
1652call_decode(struct rpc_task *task)
1653{
1654 struct rpc_clnt *clnt = task->tk_client;
1655 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001656 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001657 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Vasily Averin726fd6a2011-06-01 16:23:59 +04001659 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
Chuck Leverf518e35a2006-01-03 09:55:52 +01001661 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001662 if (clnt->cl_chatty)
1663 printk(KERN_NOTICE "%s: server %s OK\n",
1664 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1666 }
1667
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001668 /*
1669 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001670 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001671 */
1672 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 req->rq_rcv_buf.len = req->rq_private_buf.len;
1674
1675 /* Check that the softirq receive buffer is valid */
1676 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1677 sizeof(req->rq_rcv_buf)) != 0);
1678
Trond Myklebust1e799b62008-03-21 16:19:41 -04001679 if (req->rq_rcv_buf.len < 12) {
1680 if (!RPC_IS_SOFT(task)) {
1681 task->tk_action = call_bind;
1682 clnt->cl_stats->rpcretrans++;
1683 goto out_retry;
1684 }
1685 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1686 clnt->cl_protname, task->tk_status);
1687 task->tk_action = call_timeout;
1688 goto out_retry;
1689 }
1690
Chuck Leverb0e1c572008-05-21 17:09:19 -04001691 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001692 if (IS_ERR(p)) {
1693 if (p == ERR_PTR(-EAGAIN))
1694 goto out_retry;
1695 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 }
1697
Trond Myklebustabbcf282006-01-03 09:55:03 +01001698 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001700 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1702 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001703 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001704 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1705 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 return;
1707out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001709 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001710 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001711 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001712 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001713 xprt_conditional_disconnect(task->tk_xprt,
1714 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001715 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716}
1717
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001718static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001719rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720{
1721 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001723 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724
1725 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001726
1727 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 *p++ = req->rq_xid; /* XID */
1729 *p++ = htonl(RPC_CALL); /* CALL */
1730 *p++ = htonl(RPC_VERSION); /* RPC version */
1731 *p++ = htonl(clnt->cl_prog); /* program number */
1732 *p++ = htonl(clnt->cl_vers); /* program version */
1733 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001734 p = rpcauth_marshcred(task, p);
1735 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1736 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737}
1738
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001739static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001740rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741{
1742 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1743 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001744 __be32 *p = iov->iov_base;
1745 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 int error = -EACCES;
1747
David Howellse8896492006-08-24 15:44:19 -04001748 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1749 /* RFC-1014 says that the representation of XDR data must be a
1750 * multiple of four bytes
1751 * - if it isn't pointer subtraction in the NFS client may give
1752 * undefined results
1753 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001754 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001755 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001756 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001757 goto out_eio;
1758 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 if ((len -= 3) < 0)
1760 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001762 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001764 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001765 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001766 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1770 if (--len < 0)
1771 goto out_overflow;
1772 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001773 case RPC_AUTH_ERROR:
1774 break;
1775 case RPC_MISMATCH:
1776 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1777 task->tk_pid, __func__);
1778 error = -EPROTONOSUPPORT;
1779 goto out_err;
1780 default:
1781 dprintk("RPC: %5u %s: RPC call rejected, "
1782 "unknown error: %x\n",
1783 task->tk_pid, __func__, n);
1784 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 }
1786 if (--len < 0)
1787 goto out_overflow;
1788 switch ((n = ntohl(*p++))) {
1789 case RPC_AUTH_REJECTEDCRED:
1790 case RPC_AUTH_REJECTEDVERF:
1791 case RPCSEC_GSS_CREDPROBLEM:
1792 case RPCSEC_GSS_CTXPROBLEM:
1793 if (!task->tk_cred_retry)
1794 break;
1795 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001796 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001797 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001799 /* Ensure we obtain a new XID! */
1800 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001801 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001802 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 case RPC_AUTH_BADCRED:
1804 case RPC_AUTH_BADVERF:
1805 /* possibly garbled cred/verf? */
1806 if (!task->tk_garb_retry)
1807 break;
1808 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001809 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001810 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001812 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001814 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001815 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 break;
1817 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001818 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001819 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 error = -EIO;
1821 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001822 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001823 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 goto out_err;
1825 }
1826 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001827 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001828 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001829 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001831 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 if (len < 0)
1833 goto out_overflow;
1834 switch ((n = ntohl(*p++))) {
1835 case RPC_SUCCESS:
1836 return p;
1837 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001838 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001839 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 (unsigned int)task->tk_client->cl_prog,
1841 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001842 error = -EPFNOSUPPORT;
1843 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001845 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001846 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 (unsigned int)task->tk_client->cl_prog,
1848 (unsigned int)task->tk_client->cl_vers,
1849 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001850 error = -EPROTONOSUPPORT;
1851 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001853 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001854 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001855 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001856 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 task->tk_client->cl_prog,
1858 task->tk_client->cl_vers,
1859 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001860 error = -EOPNOTSUPP;
1861 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001863 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001864 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 break; /* retry */
1866 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001867 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001868 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 /* Also retry */
1870 }
1871
Trond Myklebustabbcf282006-01-03 09:55:03 +01001872out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 task->tk_client->cl_stats->rpcgarbage++;
1874 if (task->tk_garb_retry) {
1875 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001876 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001877 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001879out_retry:
1880 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882out_eio:
1883 error = -EIO;
1884out_err:
1885 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001886 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001887 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001888 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001890 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001891 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001892 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001894
Chuck Lever9f06c712010-12-14 14:59:18 +00001895static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001896{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001897}
1898
Chuck Leverbf269552010-12-14 14:59:29 +00001899static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001900{
1901 return 0;
1902}
1903
1904static struct rpc_procinfo rpcproc_null = {
1905 .p_encode = rpcproc_encode_null,
1906 .p_decode = rpcproc_decode_null,
1907};
1908
Chuck Levercaabea82009-12-03 15:58:56 -05001909static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001910{
1911 struct rpc_message msg = {
1912 .rpc_proc = &rpcproc_null,
1913 };
1914 int err;
1915 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001916 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001917 put_rpccred(msg.rpc_cred);
1918 return err;
1919}
Trond Myklebust188fef12007-06-16 14:18:40 -04001920
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001921struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1922{
1923 struct rpc_message msg = {
1924 .rpc_proc = &rpcproc_null,
1925 .rpc_cred = cred,
1926 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001927 struct rpc_task_setup task_setup_data = {
1928 .rpc_client = clnt,
1929 .rpc_message = &msg,
1930 .callback_ops = &rpc_default_ops,
1931 .flags = flags,
1932 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001933 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001934}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001935EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001936
Trond Myklebust188fef12007-06-16 14:18:40 -04001937#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001938static void rpc_show_header(void)
1939{
Chuck Levercb3997b2008-05-21 17:09:41 -04001940 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1941 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001942}
1943
Chuck Lever38e886e2008-05-21 17:09:33 -04001944static void rpc_show_task(const struct rpc_clnt *clnt,
1945 const struct rpc_task *task)
1946{
1947 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001948
1949 if (RPC_IS_QUEUED(task))
1950 rpc_waitq = rpc_qname(task->tk_waitqueue);
1951
Joe Perchesb3bceda2010-12-21 10:52:24 -05001952 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 -04001953 task->tk_pid, task->tk_flags, task->tk_status,
1954 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1955 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001956 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001957}
1958
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001959void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04001960{
1961 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001962 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001963 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001964 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04001965
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001966 spin_lock(&sn->rpc_client_lock);
1967 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001968 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001969 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001970 if (!header) {
1971 rpc_show_header();
1972 header++;
1973 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001974 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001975 }
1976 spin_unlock(&clnt->cl_lock);
1977 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001978 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001979}
1980#endif