blob: aa401560777b22ea0ec54abba730007f3347ea57 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400108 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400109 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400110 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500115 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117
Trond Myklebust2446ab62012-03-01 17:00:56 -0500118 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400120 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500121 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500126 struct rpc_clnt *clnt,
127 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Trond Myklebustf1345852005-09-23 11:08:25 -0400129 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400130 char name[15];
Linus Torvalds26fe5752012-05-10 13:14:12 -0700131 struct qstr q = { .name = name };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400132 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int error;
134
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400136 if (dir == NULL) {
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400139 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 for (;;) {
141 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
142 name[sizeof(name) - 1] = '\0';
143 q.hash = full_name_hash(q.name, q.len);
144 dentry = rpc_create_client_dir(dir, &q, clnt);
145 if (!IS_ERR(dentry))
146 break;
147 error = PTR_ERR(dentry);
148 if (error != -EEXIST) {
149 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name, name, error);
152 break;
153 }
154 }
155 dput(dir);
156 return dentry;
157}
158
159static int
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400160rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name,
161 struct super_block *pipefs_sb)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400162{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400163 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400164
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400165 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 if (dir_name == NULL)
167 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400168 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
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 Kinsburskyea8cfa02012-04-27 13:00:17 +0400175static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
176{
177 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
178 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
179 return 1;
Stanislav Kinsbursky4f6bb242013-06-24 11:52:59 +0400180 if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
181 return 1;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400182 return 0;
183}
184
185static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
186 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400187{
188 struct dentry *dentry;
189 int err = 0;
190
191 switch (event) {
192 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400193 dentry = rpc_setup_pipedir_sb(sb, clnt,
194 clnt->cl_program->pipe_dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400195 if (!dentry)
196 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400197 if (IS_ERR(dentry))
198 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400199 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400200 if (clnt->cl_auth->au_ops->pipes_create) {
201 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
202 if (err)
203 __rpc_clnt_remove_pipedir(clnt);
204 }
205 break;
206 case RPC_PIPEFS_UMOUNT:
207 __rpc_clnt_remove_pipedir(clnt);
208 break;
209 default:
210 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
211 return -ENOTSUPP;
212 }
213 return err;
214}
215
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400216static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
217 struct super_block *sb)
218{
219 int error = 0;
220
221 for (;; clnt = clnt->cl_parent) {
222 if (!rpc_clnt_skip_event(clnt, event))
223 error = __rpc_clnt_handle_event(clnt, event, sb);
224 if (error || clnt == clnt->cl_parent)
225 break;
226 }
227 return error;
228}
229
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
231{
232 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
233 struct rpc_clnt *clnt;
234
235 spin_lock(&sn->rpc_client_lock);
236 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400237 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300238 continue;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400239 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400240 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400241 spin_unlock(&sn->rpc_client_lock);
242 return clnt;
243 }
244 spin_unlock(&sn->rpc_client_lock);
245 return NULL;
246}
247
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400248static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
249 void *ptr)
250{
251 struct super_block *sb = ptr;
252 struct rpc_clnt *clnt;
253 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400254
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400255 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400256 error = __rpc_pipefs_event(clnt, event, sb);
257 if (error)
258 break;
259 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400260 return error;
261}
262
263static struct notifier_block rpc_clients_block = {
264 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400265 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400266};
267
268int rpc_clients_notifier_register(void)
269{
270 return rpc_pipefs_notifier_register(&rpc_clients_block);
271}
272
273void rpc_clients_notifier_unregister(void)
274{
275 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
276}
277
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400278static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
279{
280 clnt->cl_nodelen = strlen(nodename);
281 if (clnt->cl_nodelen > UNX_MAXNODENAME)
282 clnt->cl_nodelen = UNX_MAXNODENAME;
283 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
284}
285
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400286static int rpc_client_register(const struct rpc_create_args *args,
287 struct rpc_clnt *clnt)
288{
289 const struct rpc_program *program = args->program;
290 struct rpc_auth *auth;
291 struct net *net = rpc_net_ns(clnt);
292 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400293 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400294
295 pipefs_sb = rpc_get_sb_net(net);
296 if (pipefs_sb) {
297 err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
298 if (err)
299 goto out;
300 }
301
Trond Myklebusteeee2452013-07-10 15:33:01 -0400302 rpc_register_client(clnt);
303 if (pipefs_sb)
304 rpc_put_sb_net(net);
305
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400306 auth = rpcauth_create(args->authflavor, clnt);
307 if (IS_ERR(auth)) {
308 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
309 args->authflavor);
310 err = PTR_ERR(auth);
311 goto err_auth;
312 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400313 return 0;
314err_auth:
315 pipefs_sb = rpc_get_sb_net(net);
316 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400317out:
318 if (pipefs_sb)
319 rpc_put_sb_net(net);
320 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400321}
322
Trond Myklebust698b6d02007-12-20 16:03:53 -0500323static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500325 const struct rpc_program *program = args->program;
326 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 struct rpc_clnt *clnt = NULL;
328 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400329
330 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500331 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500332 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Trond Myklebust4ada5392007-06-14 17:26:17 -0400334 err = rpciod_up();
335 if (err)
336 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500337
Trond Myklebustf05c1242013-04-05 14:13:21 -0400338 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500339 if (args->version >= program->nrvers)
340 goto out_err;
341 version = program->version[args->version];
342 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 goto out_err;
344
345 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700346 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 if (!clnt)
348 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 clnt->cl_parent = clnt;
350
Trond Myklebust2446ab62012-03-01 17:00:56 -0500351 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 clnt->cl_procinfo = version->procs;
353 clnt->cl_maxproc = version->nrprocs;
354 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300355 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500358 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500359 err = -ENOMEM;
360 if (clnt->cl_metrics == NULL)
361 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500362 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400363 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400364 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Trond Myklebust2446ab62012-03-01 17:00:56 -0500366 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 clnt->cl_autobind = 1;
368
Trond Myklebustba7392b2007-12-20 16:03:55 -0500369 clnt->cl_timeout = xprt->timeout;
370 if (args->timeout != NULL) {
371 memcpy(&clnt->cl_timeout_default, args->timeout,
372 sizeof(clnt->cl_timeout_default));
373 clnt->cl_timeout = &clnt->cl_timeout_default;
374 }
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500377 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500378 clnt->cl_principal = NULL;
379 if (args->client_name) {
380 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
381 if (!clnt->cl_principal)
382 goto out_no_principal;
383 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Trond Myklebust006abe82010-09-12 19:55:25 -0400385 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400388 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400389
390 err = rpc_client_register(args, clnt);
391 if (err)
392 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 return clnt;
394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500396 kfree(clnt->cl_principal);
397out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500398 rpc_free_iostats(clnt->cl_metrics);
399out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 kfree(clnt);
401out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400402 rpciod_down();
403out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400404 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 return ERR_PTR(err);
406}
407
Ben Hutchings2c530402012-07-10 10:55:09 +0000408/**
Chuck Leverc2866762006-08-22 20:06:20 -0400409 * rpc_create - create an RPC client and transport with one call
410 * @args: rpc_clnt create argument structure
411 *
412 * Creates and initializes an RPC transport and an RPC client.
413 *
414 * It can ping the server in order to determine if it is up, and to see if
415 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
416 * this behavior so asynchronous tasks can also use rpc_create.
417 */
418struct rpc_clnt *rpc_create(struct rpc_create_args *args)
419{
420 struct rpc_xprt *xprt;
421 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400422 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400423 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400424 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200425 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200426 .dstaddr = args->address,
427 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500428 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300429 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200430 };
Chuck Lever510deb02007-12-10 14:56:24 -0500431 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400432
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400433 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
434 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400435 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
436 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400437 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400438 * If the caller chooses not to specify a hostname, whip
439 * up a string representation of the passed-in address.
440 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500441 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400442 struct sockaddr_un *sun =
443 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400444 struct sockaddr_in *sin =
445 (struct sockaddr_in *)args->address;
446 struct sockaddr_in6 *sin6 =
447 (struct sockaddr_in6 *)args->address;
448
Chuck Lever510deb02007-12-10 14:56:24 -0500449 servername[0] = '\0';
450 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400451 case AF_LOCAL:
452 snprintf(servername, sizeof(servername), "%s",
453 sun->sun_path);
454 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400455 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700456 snprintf(servername, sizeof(servername), "%pI4",
457 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500458 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400459 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700460 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400461 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500462 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500463 default:
464 /* caller wants default server name, but
465 * address family isn't recognized. */
466 return ERR_PTR(-EINVAL);
467 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500468 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400469 }
470
Chuck Lever510deb02007-12-10 14:56:24 -0500471 xprt = xprt_create_transport(&xprtargs);
472 if (IS_ERR(xprt))
473 return (struct rpc_clnt *)xprt;
474
Chuck Lever43780b82007-07-01 12:13:22 -0400475 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400476 * By default, kernel RPC client connects from a reserved port.
477 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
478 * but it is always enabled for rpciod, which handles the connect
479 * operation.
480 */
481 xprt->resvport = 1;
482 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
483 xprt->resvport = 0;
484
Trond Myklebust698b6d02007-12-20 16:03:53 -0500485 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400486 if (IS_ERR(clnt))
487 return clnt;
488
489 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500490 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400491 if (err != 0) {
492 rpc_shutdown_client(clnt);
493 return ERR_PTR(err);
494 }
495 }
496
497 clnt->cl_softrtry = 1;
498 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
499 clnt->cl_softrtry = 0;
500
Chuck Leverc2866762006-08-22 20:06:20 -0400501 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
502 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500503 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
504 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400505 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
506 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400507
508 return clnt;
509}
Chuck Leverb86acd52006-08-22 20:06:22 -0400510EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512/*
513 * This function clones the RPC client structure. It allows us to share the
514 * same transport while varying parameters such as the authentication
515 * flavour.
516 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400517static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
518 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500520 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400521 struct rpc_clnt *new;
522 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Chuck Lever1b63a752012-09-14 17:23:52 -0400524 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500525 rcu_read_lock();
526 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
527 rcu_read_unlock();
528 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400529 goto out_err;
530 args->servername = xprt->servername;
531
532 new = rpc_new_client(args, xprt);
533 if (IS_ERR(new)) {
534 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400535 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400536 }
537
Trond Myklebust006abe82010-09-12 19:55:25 -0400538 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400539 new->cl_parent = clnt;
540
541 /* Turn off autobind on clones */
542 new->cl_autobind = 0;
543 new->cl_softrtry = clnt->cl_softrtry;
544 new->cl_discrtry = clnt->cl_discrtry;
545 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400547
Chuck Lever1b63a752012-09-14 17:23:52 -0400548out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800549 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500550 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551}
Chuck Lever1b63a752012-09-14 17:23:52 -0400552
553/**
554 * rpc_clone_client - Clone an RPC client structure
555 *
556 * @clnt: RPC client whose parameters are copied
557 *
558 * Returns a fresh RPC client or an ERR_PTR.
559 */
560struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
561{
562 struct rpc_create_args args = {
563 .program = clnt->cl_program,
564 .prognumber = clnt->cl_prog,
565 .version = clnt->cl_vers,
566 .authflavor = clnt->cl_auth->au_flavor,
567 .client_name = clnt->cl_principal,
568 };
569 return __rpc_clone_client(&args, clnt);
570}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400571EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Chuck Leverba9b5842012-09-14 17:24:02 -0400573/**
574 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
575 *
576 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800577 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400578 *
579 * Returns a fresh RPC client or an ERR_PTR.
580 */
581struct rpc_clnt *
582rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
583{
584 struct rpc_create_args args = {
585 .program = clnt->cl_program,
586 .prognumber = clnt->cl_prog,
587 .version = clnt->cl_vers,
588 .authflavor = flavor,
589 .client_name = clnt->cl_principal,
590 };
591 return __rpc_clone_client(&args, clnt);
592}
593EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400596 * Kill all tasks for the given client.
597 * XXX: kill their descendants as well?
598 */
599void rpc_killall_tasks(struct rpc_clnt *clnt)
600{
601 struct rpc_task *rovr;
602
603
604 if (list_empty(&clnt->cl_tasks))
605 return;
606 dprintk("RPC: killing all tasks for client %p\n", clnt);
607 /*
608 * Spin lock all_tasks to prevent changes...
609 */
610 spin_lock(&clnt->cl_lock);
611 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
612 if (!RPC_IS_ACTIVATED(rovr))
613 continue;
614 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
615 rovr->tk_flags |= RPC_TASK_KILLED;
616 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300617 if (RPC_IS_QUEUED(rovr))
618 rpc_wake_up_queued_task(rovr->tk_waitqueue,
619 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400620 }
621 }
622 spin_unlock(&clnt->cl_lock);
623}
624EXPORT_SYMBOL_GPL(rpc_killall_tasks);
625
626/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400628 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400630void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400632 might_sleep();
633
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500634 dprintk_rcu("RPC: shutting down %s client for %s\n",
635 clnt->cl_protname,
636 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Trond Myklebust34f52e32007-06-14 16:40:31 -0400638 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800640 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400641 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 }
643
Trond Myklebust4c402b42007-06-14 16:40:32 -0400644 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400646EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
648/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400649 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400651static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400652rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500654 dprintk_rcu("RPC: destroying %s client for %s\n",
655 clnt->cl_protname,
656 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500657 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400658 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400659 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400660 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500661 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500662 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500663 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500664 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400665 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667}
668
669/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400670 * Free an RPC client
671 */
672static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400673rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400674{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400675 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400676 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400677 return;
678 }
679
680 /*
681 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
682 * release remaining GSS contexts. This mechanism ensures
683 * that it can do so safely.
684 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400685 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400686 rpcauth_release(clnt->cl_auth);
687 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400688 if (atomic_dec_and_test(&clnt->cl_count))
689 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400690}
691
692/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400693 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 */
695void
696rpc_release_client(struct rpc_clnt *clnt)
697{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400698 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
Trond Myklebust34f52e32007-06-14 16:40:31 -0400700 if (list_empty(&clnt->cl_tasks))
701 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400702 if (atomic_dec_and_test(&clnt->cl_count))
703 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400704}
Simo Sorce1d658332012-05-25 18:09:55 -0400705EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400706
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000707/**
708 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800709 * @old: old rpc_client
710 * @program: rpc program to set
711 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000712 *
713 * Clones the rpc client and sets up a new RPC program. This is mainly
714 * of use for enabling different RPC programs to share the same transport.
715 * The Sun NFSv2/v3 ACL protocol can do this.
716 */
717struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500718 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400719 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000720{
Trond Myklebustf994c432012-11-01 12:14:14 -0400721 struct rpc_create_args args = {
722 .program = program,
723 .prognumber = program->number,
724 .version = vers,
725 .authflavor = old->cl_auth->au_flavor,
726 .client_name = old->cl_principal,
727 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000728 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000729 int err;
730
Trond Myklebustf994c432012-11-01 12:14:14 -0400731 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000732 if (IS_ERR(clnt))
733 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500734 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000735 if (err != 0) {
736 rpc_shutdown_client(clnt);
737 clnt = ERR_PTR(err);
738 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800739out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000740 return clnt;
741}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400742EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000743
Trond Myklebust58f96122010-07-31 14:29:08 -0400744void rpc_task_release_client(struct rpc_task *task)
745{
746 struct rpc_clnt *clnt = task->tk_client;
747
748 if (clnt != NULL) {
749 /* Remove from client task list */
750 spin_lock(&clnt->cl_lock);
751 list_del(&task->tk_task);
752 spin_unlock(&clnt->cl_lock);
753 task->tk_client = NULL;
754
755 rpc_release_client(clnt);
756 }
757}
758
759static
760void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
761{
762 if (clnt != NULL) {
763 rpc_task_release_client(task);
764 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400765 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400766 if (clnt->cl_softrtry)
767 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700768 if (sk_memalloc_socks()) {
769 struct rpc_xprt *xprt;
770
771 rcu_read_lock();
772 xprt = rcu_dereference(clnt->cl_xprt);
773 if (xprt->swapper)
774 task->tk_flags |= RPC_TASK_SWAPPER;
775 rcu_read_unlock();
776 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400777 /* Add to the client's list of all tasks */
778 spin_lock(&clnt->cl_lock);
779 list_add_tail(&task->tk_task, &clnt->cl_tasks);
780 spin_unlock(&clnt->cl_lock);
781 }
782}
783
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000784void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
785{
786 rpc_task_release_client(task);
787 rpc_task_set_client(task, clnt);
788}
789EXPORT_SYMBOL_GPL(rpc_task_reset_client);
790
791
Trond Myklebust58f96122010-07-31 14:29:08 -0400792static void
793rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
794{
795 if (msg != NULL) {
796 task->tk_msg.rpc_proc = msg->rpc_proc;
797 task->tk_msg.rpc_argp = msg->rpc_argp;
798 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400799 if (msg->rpc_cred != NULL)
800 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400801 }
802}
803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804/*
805 * Default callback for async RPC calls
806 */
807static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100808rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
810}
811
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100812static const struct rpc_call_ops rpc_default_ops = {
813 .rpc_call_done = rpc_default_callback,
814};
815
Trond Myklebustc970aa82007-07-14 15:39:59 -0400816/**
817 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
818 * @task_setup_data: pointer to task initialisation data
819 */
820struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400821{
Trond Myklebust19445b92010-04-16 16:41:10 -0400822 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400823
Trond Myklebust84115e12007-07-14 15:39:59 -0400824 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400825 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400826 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400827
Trond Myklebust58f96122010-07-31 14:29:08 -0400828 rpc_task_set_client(task, task_setup_data->rpc_client);
829 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
830
Trond Myklebust58f96122010-07-31 14:29:08 -0400831 if (task->tk_action == NULL)
832 rpc_call_start(task);
833
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400834 atomic_inc(&task->tk_count);
835 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400836out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400837 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400838}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400839EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400840
841/**
842 * rpc_call_sync - Perform a synchronous RPC call
843 * @clnt: pointer to RPC client
844 * @msg: RPC call parameters
845 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500847int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
849 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400850 struct rpc_task_setup task_setup_data = {
851 .rpc_client = clnt,
852 .rpc_message = msg,
853 .callback_ops = &rpc_default_ops,
854 .flags = flags,
855 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400856 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400858 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
859 if (flags & RPC_TASK_ASYNC) {
860 rpc_release_calldata(task_setup_data.callback_ops,
861 task_setup_data.callback_data);
862 return -EINVAL;
863 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
Trond Myklebustc970aa82007-07-14 15:39:59 -0400865 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400866 if (IS_ERR(task))
867 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100868 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800869 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 return status;
871}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400872EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400874/**
875 * rpc_call_async - Perform an asynchronous RPC call
876 * @clnt: pointer to RPC client
877 * @msg: RPC call parameters
878 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800879 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400880 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 */
882int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500883rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100884 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885{
886 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400887 struct rpc_task_setup task_setup_data = {
888 .rpc_client = clnt,
889 .rpc_message = msg,
890 .callback_ops = tk_ops,
891 .callback_data = data,
892 .flags = flags|RPC_TASK_ASYNC,
893 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
Trond Myklebustc970aa82007-07-14 15:39:59 -0400895 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400896 if (IS_ERR(task))
897 return PTR_ERR(task);
898 rpc_put_task(task);
899 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400901EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400903#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400904/**
905 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
906 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400907 * @req: RPC request
908 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400909 */
910struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400911 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400912{
913 struct rpc_task *task;
914 struct xdr_buf *xbufp = &req->rq_snd_buf;
915 struct rpc_task_setup task_setup_data = {
916 .callback_ops = tk_ops,
917 };
918
919 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
920 /*
921 * Create an rpc_task to send the data
922 */
923 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400924 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400925 xprt_free_bc_request(req);
926 goto out;
927 }
928 task->tk_rqstp = req;
929
930 /*
931 * Set up the xdr_buf length.
932 * This also indicates that the buffer is XDR encoded already.
933 */
934 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
935 xbufp->tail[0].iov_len;
936
937 task->tk_action = call_bc_transmit;
938 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400939 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400940 rpc_execute(task);
941
942out:
943 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
944 return task;
945}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400946#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400947
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400949rpc_call_start(struct rpc_task *task)
950{
951 task->tk_action = call_start;
952}
953EXPORT_SYMBOL_GPL(rpc_call_start);
954
Chuck Levered394402006-08-22 20:06:17 -0400955/**
956 * rpc_peeraddr - extract remote peer address from clnt's xprt
957 * @clnt: RPC client structure
958 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800959 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400960 *
961 * Returns the number of bytes that are actually in the stored address.
962 */
963size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
964{
965 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500966 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400967
Trond Myklebust2446ab62012-03-01 17:00:56 -0500968 rcu_read_lock();
969 xprt = rcu_dereference(clnt->cl_xprt);
970
971 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400972 if (bytes > bufsize)
973 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500974 memcpy(buf, &xprt->addr, bytes);
975 rcu_read_unlock();
976
977 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400978}
Chuck Leverb86acd52006-08-22 20:06:22 -0400979EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400980
Chuck Leverf425eba2006-08-22 20:06:18 -0400981/**
982 * rpc_peeraddr2str - return remote peer address in printable format
983 * @clnt: RPC client structure
984 * @format: address format
985 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500986 * NB: the lifetime of the memory referenced by the returned pointer is
987 * the same as the rpc_xprt itself. As long as the caller uses this
988 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400989 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500990const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
991 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400992{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500993 struct rpc_xprt *xprt;
994
995 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500996
997 if (xprt->address_strings[format] != NULL)
998 return xprt->address_strings[format];
999 else
1000 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001001}
Chuck Leverb86acd52006-08-22 20:06:22 -04001002EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001003
Chuck Lever2e738fd2012-03-01 17:01:14 -05001004static const struct sockaddr_in rpc_inaddr_loopback = {
1005 .sin_family = AF_INET,
1006 .sin_addr.s_addr = htonl(INADDR_ANY),
1007};
1008
1009static const struct sockaddr_in6 rpc_in6addr_loopback = {
1010 .sin6_family = AF_INET6,
1011 .sin6_addr = IN6ADDR_ANY_INIT,
1012};
1013
1014/*
1015 * Try a getsockname() on a connected datagram socket. Using a
1016 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1017 * This conserves the ephemeral port number space.
1018 *
1019 * Returns zero and fills in "buf" if successful; otherwise, a
1020 * negative errno is returned.
1021 */
1022static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1023 struct sockaddr *buf, int buflen)
1024{
1025 struct socket *sock;
1026 int err;
1027
1028 err = __sock_create(net, sap->sa_family,
1029 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1030 if (err < 0) {
1031 dprintk("RPC: can't create UDP socket (%d)\n", err);
1032 goto out;
1033 }
1034
1035 switch (sap->sa_family) {
1036 case AF_INET:
1037 err = kernel_bind(sock,
1038 (struct sockaddr *)&rpc_inaddr_loopback,
1039 sizeof(rpc_inaddr_loopback));
1040 break;
1041 case AF_INET6:
1042 err = kernel_bind(sock,
1043 (struct sockaddr *)&rpc_in6addr_loopback,
1044 sizeof(rpc_in6addr_loopback));
1045 break;
1046 default:
1047 err = -EAFNOSUPPORT;
1048 goto out;
1049 }
1050 if (err < 0) {
1051 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1052 goto out_release;
1053 }
1054
1055 err = kernel_connect(sock, sap, salen, 0);
1056 if (err < 0) {
1057 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1058 goto out_release;
1059 }
1060
1061 err = kernel_getsockname(sock, buf, &buflen);
1062 if (err < 0) {
1063 dprintk("RPC: getsockname failed (%d)\n", err);
1064 goto out_release;
1065 }
1066
1067 err = 0;
1068 if (buf->sa_family == AF_INET6) {
1069 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1070 sin6->sin6_scope_id = 0;
1071 }
1072 dprintk("RPC: %s succeeded\n", __func__);
1073
1074out_release:
1075 sock_release(sock);
1076out:
1077 return err;
1078}
1079
1080/*
1081 * Scraping a connected socket failed, so we don't have a useable
1082 * local address. Fallback: generate an address that will prevent
1083 * the server from calling us back.
1084 *
1085 * Returns zero and fills in "buf" if successful; otherwise, a
1086 * negative errno is returned.
1087 */
1088static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1089{
1090 switch (family) {
1091 case AF_INET:
1092 if (buflen < sizeof(rpc_inaddr_loopback))
1093 return -EINVAL;
1094 memcpy(buf, &rpc_inaddr_loopback,
1095 sizeof(rpc_inaddr_loopback));
1096 break;
1097 case AF_INET6:
1098 if (buflen < sizeof(rpc_in6addr_loopback))
1099 return -EINVAL;
1100 memcpy(buf, &rpc_in6addr_loopback,
1101 sizeof(rpc_in6addr_loopback));
1102 default:
1103 dprintk("RPC: %s: address family not supported\n",
1104 __func__);
1105 return -EAFNOSUPPORT;
1106 }
1107 dprintk("RPC: %s: succeeded\n", __func__);
1108 return 0;
1109}
1110
1111/**
1112 * rpc_localaddr - discover local endpoint address for an RPC client
1113 * @clnt: RPC client structure
1114 * @buf: target buffer
1115 * @buflen: size of target buffer, in bytes
1116 *
1117 * Returns zero and fills in "buf" and "buflen" if successful;
1118 * otherwise, a negative errno is returned.
1119 *
1120 * This works even if the underlying transport is not currently connected,
1121 * or if the upper layer never previously provided a source address.
1122 *
1123 * The result of this function call is transient: multiple calls in
1124 * succession may give different results, depending on how local
1125 * networking configuration changes over time.
1126 */
1127int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1128{
1129 struct sockaddr_storage address;
1130 struct sockaddr *sap = (struct sockaddr *)&address;
1131 struct rpc_xprt *xprt;
1132 struct net *net;
1133 size_t salen;
1134 int err;
1135
1136 rcu_read_lock();
1137 xprt = rcu_dereference(clnt->cl_xprt);
1138 salen = xprt->addrlen;
1139 memcpy(sap, &xprt->addr, salen);
1140 net = get_net(xprt->xprt_net);
1141 rcu_read_unlock();
1142
1143 rpc_set_port(sap, 0);
1144 err = rpc_sockname(net, sap, salen, buf, buflen);
1145 put_net(net);
1146 if (err != 0)
1147 /* Couldn't discover local address, return ANYADDR */
1148 return rpc_anyaddr(sap->sa_family, buf, buflen);
1149 return 0;
1150}
1151EXPORT_SYMBOL_GPL(rpc_localaddr);
1152
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153void
1154rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1155{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001156 struct rpc_xprt *xprt;
1157
1158 rcu_read_lock();
1159 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001160 if (xprt->ops->set_buffer_size)
1161 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001162 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001164EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
Trond Myklebust2446ab62012-03-01 17:00:56 -05001166/**
1167 * rpc_protocol - Get transport protocol number for an RPC client
1168 * @clnt: RPC client to query
1169 *
1170 */
1171int rpc_protocol(struct rpc_clnt *clnt)
1172{
1173 int protocol;
1174
1175 rcu_read_lock();
1176 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1177 rcu_read_unlock();
1178 return protocol;
1179}
1180EXPORT_SYMBOL_GPL(rpc_protocol);
1181
1182/**
1183 * rpc_net_ns - Get the network namespace for this RPC client
1184 * @clnt: RPC client to query
1185 *
1186 */
1187struct net *rpc_net_ns(struct rpc_clnt *clnt)
1188{
1189 struct net *ret;
1190
1191 rcu_read_lock();
1192 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1193 rcu_read_unlock();
1194 return ret;
1195}
1196EXPORT_SYMBOL_GPL(rpc_net_ns);
1197
1198/**
1199 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1200 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 *
1202 * For stream transports, this is one RPC record fragment (see RFC
1203 * 1831), as we don't support multi-record requests yet. For datagram
1204 * transports, this is the size of an IP packet minus the IP, UDP, and
1205 * RPC header sizes.
1206 */
1207size_t rpc_max_payload(struct rpc_clnt *clnt)
1208{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001209 size_t ret;
1210
1211 rcu_read_lock();
1212 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1213 rcu_read_unlock();
1214 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215}
Chuck Leverb86acd52006-08-22 20:06:22 -04001216EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
Chuck Lever35f5a422006-01-03 09:55:50 +01001218/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001219 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001220 * @clnt: RPC client to query
1221 */
1222unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1223{
1224 unsigned long ret;
1225
1226 rcu_read_lock();
1227 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1228 rcu_read_unlock();
1229 return ret;
1230}
1231EXPORT_SYMBOL_GPL(rpc_get_timeout);
1232
1233/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001234 * rpc_force_rebind - force transport to check that remote port is unchanged
1235 * @clnt: client to rebind
1236 *
1237 */
1238void rpc_force_rebind(struct rpc_clnt *clnt)
1239{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001240 if (clnt->cl_autobind) {
1241 rcu_read_lock();
1242 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1243 rcu_read_unlock();
1244 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001245}
Chuck Leverb86acd52006-08-22 20:06:22 -04001246EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001247
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001249 * Restart an (async) RPC call from the call_prepare state.
1250 * Usually called from within the exit handler.
1251 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001252int
Andy Adamsonaae20062009-04-01 09:22:40 -04001253rpc_restart_call_prepare(struct rpc_task *task)
1254{
1255 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001256 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001257 task->tk_action = call_start;
1258 if (task->tk_ops->rpc_call_prepare != NULL)
1259 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001260 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001261}
1262EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1263
1264/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 * Restart an (async) RPC call. Usually called from within the
1266 * exit handler.
1267 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001268int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269rpc_restart_call(struct rpc_task *task)
1270{
1271 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001272 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001274 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001276EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Chuck Lever3748f1e2008-05-21 17:09:12 -04001278#ifdef RPC_DEBUG
1279static const char *rpc_proc_name(const struct rpc_task *task)
1280{
1281 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1282
1283 if (proc) {
1284 if (proc->p_name)
1285 return proc->p_name;
1286 else
1287 return "NULL";
1288 } else
1289 return "no proc";
1290}
1291#endif
1292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293/*
1294 * 0. Initial state
1295 *
1296 * Other FSM states can be visited zero or more times, but
1297 * this state is visited exactly once for each RPC.
1298 */
1299static void
1300call_start(struct rpc_task *task)
1301{
1302 struct rpc_clnt *clnt = task->tk_client;
1303
Chuck Lever3748f1e2008-05-21 17:09:12 -04001304 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001305 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001306 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001307 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308
1309 /* Increment call count */
1310 task->tk_msg.rpc_proc->p_count++;
1311 clnt->cl_stats->rpccnt++;
1312 task->tk_action = call_reserve;
1313}
1314
1315/*
1316 * 1. Reserve an RPC call slot
1317 */
1318static void
1319call_reserve(struct rpc_task *task)
1320{
Chuck Lever46121cf2007-01-31 12:14:08 -05001321 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 task->tk_status = 0;
1324 task->tk_action = call_reserveresult;
1325 xprt_reserve(task);
1326}
1327
Trond Myklebustba60eb22013-04-14 10:49:37 -04001328static void call_retry_reserve(struct rpc_task *task);
1329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330/*
1331 * 1b. Grok the result of xprt_reserve()
1332 */
1333static void
1334call_reserveresult(struct rpc_task *task)
1335{
1336 int status = task->tk_status;
1337
Chuck Lever46121cf2007-01-31 12:14:08 -05001338 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
1340 /*
1341 * After a call to xprt_reserve(), we must have either
1342 * a request slot or else an error status.
1343 */
1344 task->tk_status = 0;
1345 if (status >= 0) {
1346 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001347 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 return;
1349 }
1350
1351 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001352 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 rpc_exit(task, -EIO);
1354 return;
1355 }
1356
1357 /*
1358 * Even though there was an error, we may have acquired
1359 * a request slot somehow. Make sure not to leak it.
1360 */
1361 if (task->tk_rqstp) {
1362 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001363 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 xprt_release(task);
1365 }
1366
1367 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001368 case -ENOMEM:
1369 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001371 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 return;
1373 case -EIO: /* probably a shutdown */
1374 break;
1375 default:
1376 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001377 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 break;
1379 }
1380 rpc_exit(task, status);
1381}
1382
1383/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001384 * 1c. Retry reserving an RPC call slot
1385 */
1386static void
1387call_retry_reserve(struct rpc_task *task)
1388{
1389 dprint_status(task);
1390
1391 task->tk_status = 0;
1392 task->tk_action = call_reserveresult;
1393 xprt_retry_reserve(task);
1394}
1395
1396/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001397 * 2. Bind and/or refresh the credentials
1398 */
1399static void
1400call_refresh(struct rpc_task *task)
1401{
1402 dprint_status(task);
1403
1404 task->tk_action = call_refreshresult;
1405 task->tk_status = 0;
1406 task->tk_client->cl_stats->rpcauthrefresh++;
1407 rpcauth_refreshcred(task);
1408}
1409
1410/*
1411 * 2a. Process the results of a credential refresh
1412 */
1413static void
1414call_refreshresult(struct rpc_task *task)
1415{
1416 int status = task->tk_status;
1417
1418 dprint_status(task);
1419
1420 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001421 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001422 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001423 case 0:
1424 if (rpcauth_uptodatecred(task))
1425 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001426 return;
1427 case -ETIMEDOUT:
1428 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001429 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001430 case -EAGAIN:
1431 status = -EACCES;
1432 if (!task->tk_cred_retry)
1433 break;
1434 task->tk_cred_retry--;
1435 dprintk("RPC: %5u %s: retry refresh creds\n",
1436 task->tk_pid, __func__);
1437 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001438 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001439 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1440 task->tk_pid, __func__, status);
1441 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001442}
1443
1444/*
1445 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001446 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 */
1448static void
1449call_allocate(struct rpc_task *task)
1450{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001451 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001452 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001453 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001454 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455
Chuck Lever46121cf2007-01-31 12:14:08 -05001456 dprint_status(task);
1457
Chuck Lever2bea90d2007-03-29 16:47:53 -04001458 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001459 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001460
Chuck Lever02107142006-01-03 09:55:49 +01001461 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 return;
1463
Chuck Lever2bea90d2007-03-29 16:47:53 -04001464 if (proc->p_proc != 0) {
1465 BUG_ON(proc->p_arglen == 0);
1466 if (proc->p_decode != NULL)
1467 BUG_ON(proc->p_replen == 0);
1468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
Chuck Lever2bea90d2007-03-29 16:47:53 -04001470 /*
1471 * Calculate the size (in quads) of the RPC call
1472 * and reply headers, and convert both values
1473 * to byte sizes.
1474 */
1475 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1476 req->rq_callsize <<= 2;
1477 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1478 req->rq_rcvsize <<= 2;
1479
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001480 req->rq_buffer = xprt->ops->buf_alloc(task,
1481 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001482 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001484
1485 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Trond Myklebust5afa91332011-06-17 10:14:59 -04001487 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001488 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 rpc_delay(task, HZ>>4);
1490 return;
1491 }
1492
1493 rpc_exit(task, -ERESTARTSYS);
1494}
1495
Trond Myklebust940e3312005-11-09 21:45:24 -05001496static inline int
1497rpc_task_need_encode(struct rpc_task *task)
1498{
1499 return task->tk_rqstp->rq_snd_buf.len == 0;
1500}
1501
1502static inline void
1503rpc_task_force_reencode(struct rpc_task *task)
1504{
1505 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001506 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001507}
1508
Chuck Lever2bea90d2007-03-29 16:47:53 -04001509static inline void
1510rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1511{
1512 buf->head[0].iov_base = start;
1513 buf->head[0].iov_len = len;
1514 buf->tail[0].iov_len = 0;
1515 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001516 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001517 buf->len = 0;
1518 buf->buflen = len;
1519}
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521/*
1522 * 3. Encode arguments of an RPC call
1523 */
1524static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001525rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001528 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001529 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Chuck Lever46121cf2007-01-31 12:14:08 -05001531 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Chuck Lever2bea90d2007-03-29 16:47:53 -04001533 rpc_xdr_buf_init(&req->rq_snd_buf,
1534 req->rq_buffer,
1535 req->rq_callsize);
1536 rpc_xdr_buf_init(&req->rq_rcv_buf,
1537 (char *)req->rq_buffer + req->rq_callsize,
1538 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Chuck Leverb0e1c572008-05-21 17:09:19 -04001540 p = rpc_encode_header(task);
1541 if (p == NULL) {
1542 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 rpc_exit(task, -EIO);
1544 return;
1545 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001546
1547 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001548 if (encode == NULL)
1549 return;
1550
1551 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1552 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553}
1554
1555/*
1556 * 4. Get the server port number if not yet set
1557 */
1558static void
1559call_bind(struct rpc_task *task)
1560{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001561 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Chuck Lever46121cf2007-01-31 12:14:08 -05001563 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Chuck Leverda351872005-08-11 16:25:11 -04001565 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001566 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001567 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001568 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001569 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 }
1571}
1572
1573/*
Chuck Leverda351872005-08-11 16:25:11 -04001574 * 4a. Sort out bind result
1575 */
1576static void
1577call_bind_status(struct rpc_task *task)
1578{
Chuck Lever906462a2007-09-11 18:00:47 -04001579 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001580
1581 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001582 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001583 task->tk_status = 0;
1584 task->tk_action = call_connect;
1585 return;
1586 }
1587
Steve Dickson5753cba2012-02-06 10:08:08 -05001588 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001589 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001590 case -ENOMEM:
1591 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1592 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001593 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001594 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001595 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1596 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001597 /* fail immediately if this is an RPC ping */
1598 if (task->tk_msg.rpc_proc->p_proc == 0) {
1599 status = -EOPNOTSUPP;
1600 break;
1601 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001602 if (task->tk_rebind_retry == 0)
1603 break;
1604 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001605 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001606 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001607 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001608 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001609 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001610 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001611 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001612 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001613 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001614 task->tk_pid);
1615 break;
1616 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001617 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001618 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001619 task->tk_status = 0;
1620 task->tk_action = call_bind;
1621 return;
Chuck Lever012da152009-12-03 15:58:56 -05001622 case -ECONNREFUSED: /* connection problems */
1623 case -ECONNRESET:
1624 case -ENOTCONN:
1625 case -EHOSTDOWN:
1626 case -EHOSTUNREACH:
1627 case -ENETUNREACH:
1628 case -EPIPE:
1629 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1630 task->tk_pid, task->tk_status);
1631 if (!RPC_IS_SOFTCONN(task)) {
1632 rpc_delay(task, 5*HZ);
1633 goto retry_timeout;
1634 }
1635 status = task->tk_status;
1636 break;
Chuck Leverda351872005-08-11 16:25:11 -04001637 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001638 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001639 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001640 }
1641
1642 rpc_exit(task, status);
1643 return;
1644
Trond Myklebustda458282006-08-31 15:44:52 -04001645retry_timeout:
1646 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001647}
1648
1649/*
1650 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 */
1652static void
1653call_connect(struct rpc_task *task)
1654{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001655 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Chuck Lever46121cf2007-01-31 12:14:08 -05001657 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001658 task->tk_pid, xprt,
1659 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
Chuck Leverda351872005-08-11 16:25:11 -04001661 task->tk_action = call_transmit;
1662 if (!xprt_connected(xprt)) {
1663 task->tk_action = call_connect_status;
1664 if (task->tk_status < 0)
1665 return;
1666 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668}
1669
1670/*
Chuck Leverda351872005-08-11 16:25:11 -04001671 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 */
1673static void
1674call_connect_status(struct rpc_task *task)
1675{
1676 struct rpc_clnt *clnt = task->tk_client;
1677 int status = task->tk_status;
1678
Chuck Lever46121cf2007-01-31 12:14:08 -05001679 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001680
Steve Dickson5753cba2012-02-06 10:08:08 -05001681 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001683 /* if soft mounted, test if we've timed out */
1684 case -ETIMEDOUT:
1685 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001686 return;
1687 case -ECONNREFUSED:
1688 case -ECONNRESET:
1689 case -ENETUNREACH:
1690 if (RPC_IS_SOFTCONN(task))
1691 break;
1692 /* retry with existing socket, after a delay */
1693 case 0:
1694 case -EAGAIN:
1695 task->tk_status = 0;
1696 clnt->cl_stats->netreconn++;
1697 task->tk_action = call_transmit;
1698 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001700 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701}
1702
1703/*
1704 * 5. Transmit the RPC request, and wait for reply
1705 */
1706static void
1707call_transmit(struct rpc_task *task)
1708{
Chuck Lever46121cf2007-01-31 12:14:08 -05001709 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
1711 task->tk_action = call_status;
1712 if (task->tk_status < 0)
1713 return;
1714 task->tk_status = xprt_prepare_transmit(task);
1715 if (task->tk_status != 0)
1716 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001717 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001719 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001720 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001721 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001722 if (task->tk_status != 0) {
1723 /* Was the error nonfatal? */
1724 if (task->tk_status == -EAGAIN)
1725 rpc_delay(task, HZ >> 4);
1726 else
1727 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001728 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001729 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001730 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 xprt_transmit(task);
1732 if (task->tk_status < 0)
1733 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001734 /*
1735 * On success, ensure that we call xprt_end_transmit() before sleeping
1736 * in order to allow access to the socket to other RPC requests.
1737 */
1738 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001739 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001740 return;
1741 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001742 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001743}
1744
1745/*
1746 * 5a. Handle cleanup after a transmission
1747 */
1748static void
1749call_transmit_status(struct rpc_task *task)
1750{
1751 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001752
1753 /*
1754 * Common case: success. Force the compiler to put this
1755 * test first.
1756 */
1757 if (task->tk_status == 0) {
1758 xprt_end_transmit(task);
1759 rpc_task_force_reencode(task);
1760 return;
1761 }
1762
Trond Myklebust15f081c2009-03-11 14:37:57 -04001763 switch (task->tk_status) {
1764 case -EAGAIN:
1765 break;
1766 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001767 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001768 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001769 rpc_task_force_reencode(task);
1770 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001771 /*
1772 * Special cases: if we've been waiting on the
1773 * socket's write_space() callback, or if the
1774 * socket just returned a connection error,
1775 * then hold onto the transport lock.
1776 */
1777 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001778 case -EHOSTDOWN:
1779 case -EHOSTUNREACH:
1780 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001781 if (RPC_IS_SOFTCONN(task)) {
1782 xprt_end_transmit(task);
1783 rpc_exit(task, task->tk_status);
1784 break;
1785 }
1786 case -ECONNRESET:
1787 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001788 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001789 rpc_task_force_reencode(task);
1790 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791}
1792
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001793#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001794/*
1795 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1796 * addition, disconnect on connectivity errors.
1797 */
1798static void
1799call_bc_transmit(struct rpc_task *task)
1800{
1801 struct rpc_rqst *req = task->tk_rqstp;
1802
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001803 task->tk_status = xprt_prepare_transmit(task);
1804 if (task->tk_status == -EAGAIN) {
1805 /*
1806 * Could not reserve the transport. Try again after the
1807 * transport is released.
1808 */
1809 task->tk_status = 0;
1810 task->tk_action = call_bc_transmit;
1811 return;
1812 }
1813
1814 task->tk_action = rpc_exit_task;
1815 if (task->tk_status < 0) {
1816 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1817 "error: %d\n", task->tk_status);
1818 return;
1819 }
1820
1821 xprt_transmit(task);
1822 xprt_end_transmit(task);
1823 dprint_status(task);
1824 switch (task->tk_status) {
1825 case 0:
1826 /* Success */
1827 break;
1828 case -EHOSTDOWN:
1829 case -EHOSTUNREACH:
1830 case -ENETUNREACH:
1831 case -ETIMEDOUT:
1832 /*
1833 * Problem reaching the server. Disconnect and let the
1834 * forechannel reestablish the connection. The server will
1835 * have to retransmit the backchannel request and we'll
1836 * reprocess it. Since these ops are idempotent, there's no
1837 * need to cache our reply at this time.
1838 */
1839 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1840 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001841 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001842 req->rq_connect_cookie);
1843 break;
1844 default:
1845 /*
1846 * We were unable to reply and will have to drop the
1847 * request. The server should reconnect and retransmit.
1848 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001849 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001850 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1851 "error: %d\n", task->tk_status);
1852 break;
1853 }
1854 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1855}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001856#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001857
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858/*
1859 * 6. Sort out the RPC call status
1860 */
1861static void
1862call_status(struct rpc_task *task)
1863{
1864 struct rpc_clnt *clnt = task->tk_client;
1865 struct rpc_rqst *req = task->tk_rqstp;
1866 int status;
1867
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001868 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1869 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
Chuck Lever46121cf2007-01-31 12:14:08 -05001871 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872
1873 status = task->tk_status;
1874 if (status >= 0) {
1875 task->tk_action = call_decode;
1876 return;
1877 }
1878
Steve Dickson5753cba2012-02-06 10:08:08 -05001879 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 task->tk_status = 0;
1881 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001882 case -EHOSTDOWN:
1883 case -EHOSTUNREACH:
1884 case -ENETUNREACH:
1885 /*
1886 * Delay any retries for 3 seconds, then handle as if it
1887 * were a timeout.
1888 */
1889 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 case -ETIMEDOUT:
1891 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001892 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001893 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001894 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001896 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001898 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001899 rpc_delay(task, 3*HZ);
1900 case -EPIPE:
1901 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 task->tk_action = call_bind;
1903 break;
1904 case -EAGAIN:
1905 task->tk_action = call_transmit;
1906 break;
1907 case -EIO:
1908 /* shutdown or soft timeout */
1909 rpc_exit(task, status);
1910 break;
1911 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001912 if (clnt->cl_chatty)
1913 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 clnt->cl_protname, -status);
1915 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 }
1917}
1918
1919/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001920 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 * We do not release the request slot, so we keep using the
1922 * same XID for all retransmits.
1923 */
1924static void
1925call_timeout(struct rpc_task *task)
1926{
1927 struct rpc_clnt *clnt = task->tk_client;
1928
1929 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001930 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 goto retry;
1932 }
1933
Chuck Lever46121cf2007-01-31 12:14:08 -05001934 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001935 task->tk_timeouts++;
1936
Chuck Lever3a28bec2009-12-03 15:58:56 -05001937 if (RPC_IS_SOFTCONN(task)) {
1938 rpc_exit(task, -ETIMEDOUT);
1939 return;
1940 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001942 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001943 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001944 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001945 clnt->cl_protname,
1946 rcu_dereference(clnt->cl_xprt)->servername);
1947 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001948 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001949 if (task->tk_flags & RPC_TASK_TIMEOUT)
1950 rpc_exit(task, -ETIMEDOUT);
1951 else
1952 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 return;
1954 }
1955
Chuck Leverf518e35a2006-01-03 09:55:52 +01001956 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001958 if (clnt->cl_chatty) {
1959 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001960 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001961 clnt->cl_protname,
1962 rcu_dereference(clnt->cl_xprt)->servername);
1963 rcu_read_unlock();
1964 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001966 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001967 /*
1968 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1969 * event? RFC2203 requires the server to drop all such requests.
1970 */
1971 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973retry:
1974 clnt->cl_stats->rpcretrans++;
1975 task->tk_action = call_bind;
1976 task->tk_status = 0;
1977}
1978
1979/*
1980 * 7. Decode the RPC reply
1981 */
1982static void
1983call_decode(struct rpc_task *task)
1984{
1985 struct rpc_clnt *clnt = task->tk_client;
1986 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001987 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001988 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
Vasily Averin726fd6a2011-06-01 16:23:59 +04001990 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991
Chuck Leverf518e35a2006-01-03 09:55:52 +01001992 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001993 if (clnt->cl_chatty) {
1994 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001995 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001996 clnt->cl_protname,
1997 rcu_dereference(clnt->cl_xprt)->servername);
1998 rcu_read_unlock();
1999 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2001 }
2002
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002003 /*
2004 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002005 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002006 */
2007 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 req->rq_rcv_buf.len = req->rq_private_buf.len;
2009
2010 /* Check that the softirq receive buffer is valid */
2011 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2012 sizeof(req->rq_rcv_buf)) != 0);
2013
Trond Myklebust1e799b62008-03-21 16:19:41 -04002014 if (req->rq_rcv_buf.len < 12) {
2015 if (!RPC_IS_SOFT(task)) {
2016 task->tk_action = call_bind;
2017 clnt->cl_stats->rpcretrans++;
2018 goto out_retry;
2019 }
2020 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2021 clnt->cl_protname, task->tk_status);
2022 task->tk_action = call_timeout;
2023 goto out_retry;
2024 }
2025
Chuck Leverb0e1c572008-05-21 17:09:19 -04002026 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002027 if (IS_ERR(p)) {
2028 if (p == ERR_PTR(-EAGAIN))
2029 goto out_retry;
2030 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 }
2032
Trond Myklebustabbcf282006-01-03 09:55:03 +01002033 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002035 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2037 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002038 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002039 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2040 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 return;
2042out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002044 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002045 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002046 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002047 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002048 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002049 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002050 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051}
2052
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002053static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002054rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055{
2056 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002058 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059
2060 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002061
Trond Myklebusta4f08352013-01-08 09:10:21 -05002062 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 *p++ = req->rq_xid; /* XID */
2064 *p++ = htonl(RPC_CALL); /* CALL */
2065 *p++ = htonl(RPC_VERSION); /* RPC version */
2066 *p++ = htonl(clnt->cl_prog); /* program number */
2067 *p++ = htonl(clnt->cl_vers); /* program version */
2068 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002069 p = rpcauth_marshcred(task, p);
2070 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2071 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072}
2073
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002074static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002075rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002077 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2079 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002080 __be32 *p = iov->iov_base;
2081 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 int error = -EACCES;
2083
David Howellse8896492006-08-24 15:44:19 -04002084 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2085 /* RFC-1014 says that the representation of XDR data must be a
2086 * multiple of four bytes
2087 * - if it isn't pointer subtraction in the NFS client may give
2088 * undefined results
2089 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002090 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002091 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002092 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002093 goto out_eio;
2094 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 if ((len -= 3) < 0)
2096 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002098 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002100 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002101 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002102 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002104
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2106 if (--len < 0)
2107 goto out_overflow;
2108 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002109 case RPC_AUTH_ERROR:
2110 break;
2111 case RPC_MISMATCH:
2112 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2113 task->tk_pid, __func__);
2114 error = -EPROTONOSUPPORT;
2115 goto out_err;
2116 default:
2117 dprintk("RPC: %5u %s: RPC call rejected, "
2118 "unknown error: %x\n",
2119 task->tk_pid, __func__, n);
2120 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 }
2122 if (--len < 0)
2123 goto out_overflow;
2124 switch ((n = ntohl(*p++))) {
2125 case RPC_AUTH_REJECTEDCRED:
2126 case RPC_AUTH_REJECTEDVERF:
2127 case RPCSEC_GSS_CREDPROBLEM:
2128 case RPCSEC_GSS_CTXPROBLEM:
2129 if (!task->tk_cred_retry)
2130 break;
2131 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002132 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002133 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002135 /* Ensure we obtain a new XID! */
2136 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002137 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002138 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 case RPC_AUTH_BADCRED:
2140 case RPC_AUTH_BADVERF:
2141 /* possibly garbled cred/verf? */
2142 if (!task->tk_garb_retry)
2143 break;
2144 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002145 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002146 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002148 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002150 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002151 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002152 "authentication.\n",
2153 rcu_dereference(clnt->cl_xprt)->servername);
2154 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 break;
2156 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002157 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002158 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 error = -EIO;
2160 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002161 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002162 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 goto out_err;
2164 }
2165 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002166 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002167 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002168 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002170 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 if (len < 0)
2172 goto out_overflow;
2173 switch ((n = ntohl(*p++))) {
2174 case RPC_SUCCESS:
2175 return p;
2176 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002177 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2178 "by server %s\n", task->tk_pid, __func__,
2179 (unsigned int)clnt->cl_prog,
2180 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002181 error = -EPFNOSUPPORT;
2182 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002184 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2185 "by server %s\n", task->tk_pid, __func__,
2186 (unsigned int)clnt->cl_prog,
2187 (unsigned int)clnt->cl_vers,
2188 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002189 error = -EPROTONOSUPPORT;
2190 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002192 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002193 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002194 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002195 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002196 clnt->cl_prog, clnt->cl_vers,
2197 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002198 error = -EOPNOTSUPP;
2199 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002201 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002202 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 break; /* retry */
2204 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002205 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002206 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 /* Also retry */
2208 }
2209
Trond Myklebustabbcf282006-01-03 09:55:03 +01002210out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002211 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 if (task->tk_garb_retry) {
2213 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002214 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002215 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002217out_retry:
2218 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220out_eio:
2221 error = -EIO;
2222out_err:
2223 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002224 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002225 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002226 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002228 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002229 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002230 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002232
Chuck Lever9f06c712010-12-14 14:59:18 +00002233static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002234{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002235}
2236
Chuck Leverbf269552010-12-14 14:59:29 +00002237static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002238{
2239 return 0;
2240}
2241
2242static struct rpc_procinfo rpcproc_null = {
2243 .p_encode = rpcproc_encode_null,
2244 .p_decode = rpcproc_decode_null,
2245};
2246
Chuck Levercaabea82009-12-03 15:58:56 -05002247static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002248{
2249 struct rpc_message msg = {
2250 .rpc_proc = &rpcproc_null,
2251 };
2252 int err;
2253 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002254 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002255 put_rpccred(msg.rpc_cred);
2256 return err;
2257}
Trond Myklebust188fef12007-06-16 14:18:40 -04002258
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002259struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2260{
2261 struct rpc_message msg = {
2262 .rpc_proc = &rpcproc_null,
2263 .rpc_cred = cred,
2264 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002265 struct rpc_task_setup task_setup_data = {
2266 .rpc_client = clnt,
2267 .rpc_message = &msg,
2268 .callback_ops = &rpc_default_ops,
2269 .flags = flags,
2270 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002271 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002272}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002273EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002274
Trond Myklebust188fef12007-06-16 14:18:40 -04002275#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002276static void rpc_show_header(void)
2277{
Chuck Levercb3997b2008-05-21 17:09:41 -04002278 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2279 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002280}
2281
Chuck Lever38e886e2008-05-21 17:09:33 -04002282static void rpc_show_task(const struct rpc_clnt *clnt,
2283 const struct rpc_task *task)
2284{
2285 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002286
2287 if (RPC_IS_QUEUED(task))
2288 rpc_waitq = rpc_qname(task->tk_waitqueue);
2289
Joe Perchesb3bceda2010-12-21 10:52:24 -05002290 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 -04002291 task->tk_pid, task->tk_flags, task->tk_status,
2292 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2293 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002294 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002295}
2296
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002297void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002298{
2299 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002300 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002301 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002302 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002303
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002304 spin_lock(&sn->rpc_client_lock);
2305 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002306 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002307 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002308 if (!header) {
2309 rpc_show_header();
2310 header++;
2311 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002312 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002313 }
2314 spin_unlock(&clnt->cl_lock);
2315 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002316 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002317}
2318#endif