blob: 41f180c5a49840eecd9a7cb3c046da59d9e750f5 [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;
180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400191 dentry = rpc_setup_pipedir_sb(sb, clnt,
192 clnt->cl_program->pipe_dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400193 if (!dentry)
194 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 if (IS_ERR(dentry))
196 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400197 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400198 if (clnt->cl_auth->au_ops->pipes_create) {
199 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
200 if (err)
201 __rpc_clnt_remove_pipedir(clnt);
202 }
203 break;
204 case RPC_PIPEFS_UMOUNT:
205 __rpc_clnt_remove_pipedir(clnt);
206 break;
207 default:
208 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
209 return -ENOTSUPP;
210 }
211 return err;
212}
213
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400214static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
215 struct super_block *sb)
216{
217 int error = 0;
218
219 for (;; clnt = clnt->cl_parent) {
220 if (!rpc_clnt_skip_event(clnt, event))
221 error = __rpc_clnt_handle_event(clnt, event, sb);
222 if (error || clnt == clnt->cl_parent)
223 break;
224 }
225 return error;
226}
227
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400228static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
229{
230 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
231 struct rpc_clnt *clnt;
232
233 spin_lock(&sn->rpc_client_lock);
234 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400235 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300236 continue;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400237 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400238 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400239 spin_unlock(&sn->rpc_client_lock);
240 return clnt;
241 }
242 spin_unlock(&sn->rpc_client_lock);
243 return NULL;
244}
245
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400246static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
247 void *ptr)
248{
249 struct super_block *sb = ptr;
250 struct rpc_clnt *clnt;
251 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400252
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400253 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400254 error = __rpc_pipefs_event(clnt, event, sb);
255 if (error)
256 break;
257 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400258 return error;
259}
260
261static struct notifier_block rpc_clients_block = {
262 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400263 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400264};
265
266int rpc_clients_notifier_register(void)
267{
268 return rpc_pipefs_notifier_register(&rpc_clients_block);
269}
270
271void rpc_clients_notifier_unregister(void)
272{
273 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
274}
275
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400276static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
277{
278 clnt->cl_nodelen = strlen(nodename);
279 if (clnt->cl_nodelen > UNX_MAXNODENAME)
280 clnt->cl_nodelen = UNX_MAXNODENAME;
281 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
282}
283
Trond Myklebust698b6d02007-12-20 16:03:53 -0500284static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500286 const struct rpc_program *program = args->program;
287 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000289 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 int err;
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400291 struct super_block *pipefs_sb;
Chuck Lever06b8d252007-09-11 18:00:20 -0400292
293 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500294 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500295 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Trond Myklebust4ada5392007-06-14 17:26:17 -0400297 err = rpciod_up();
298 if (err)
299 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500300
Trond Myklebustf05c1242013-04-05 14:13:21 -0400301 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500302 if (args->version >= program->nrvers)
303 goto out_err;
304 version = program->version[args->version];
305 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 goto out_err;
307
308 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700309 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 if (!clnt)
311 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 clnt->cl_parent = clnt;
313
Trond Myklebust2446ab62012-03-01 17:00:56 -0500314 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 clnt->cl_procinfo = version->procs;
316 clnt->cl_maxproc = version->nrprocs;
317 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300318 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500321 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500322 err = -ENOMEM;
323 if (clnt->cl_metrics == NULL)
324 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500325 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400326 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400327 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Trond Myklebust2446ab62012-03-01 17:00:56 -0500329 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 clnt->cl_autobind = 1;
331
Trond Myklebustba7392b2007-12-20 16:03:55 -0500332 clnt->cl_timeout = xprt->timeout;
333 if (args->timeout != NULL) {
334 memcpy(&clnt->cl_timeout_default, args->timeout,
335 sizeof(clnt->cl_timeout_default));
336 clnt->cl_timeout = &clnt->cl_timeout_default;
337 }
338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500340 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500341 clnt->cl_principal = NULL;
342 if (args->client_name) {
343 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
344 if (!clnt->cl_principal)
345 goto out_no_principal;
346 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Trond Myklebust006abe82010-09-12 19:55:25 -0400348 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400349
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400350 pipefs_sb = rpc_get_sb_net(rpc_net_ns(clnt));
351 if (pipefs_sb) {
352 err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
353 if (err)
354 goto out_no_path;
355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
Trond Myklebust698b6d02007-12-20 16:03:53 -0500357 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000358 if (IS_ERR(auth)) {
Trond Myklebust9b1d75b2013-05-01 09:17:50 -0400359 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500360 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000361 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 goto out_no_auth;
363 }
364
365 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400366 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400367 rpc_register_client(clnt);
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400368 if (pipefs_sb)
369 rpc_put_sb_net(rpc_net_ns(clnt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 return clnt;
371
372out_no_auth:
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400373 if (pipefs_sb)
374 __rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375out_no_path:
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400376 if (pipefs_sb)
377 rpc_put_sb_net(rpc_net_ns(clnt));
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500378 kfree(clnt->cl_principal);
379out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500380 rpc_free_iostats(clnt->cl_metrics);
381out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 kfree(clnt);
383out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400384 rpciod_down();
385out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400386 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 return ERR_PTR(err);
388}
389
Ben Hutchings2c530402012-07-10 10:55:09 +0000390/**
Chuck Leverc2866762006-08-22 20:06:20 -0400391 * rpc_create - create an RPC client and transport with one call
392 * @args: rpc_clnt create argument structure
393 *
394 * Creates and initializes an RPC transport and an RPC client.
395 *
396 * It can ping the server in order to determine if it is up, and to see if
397 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
398 * this behavior so asynchronous tasks can also use rpc_create.
399 */
400struct rpc_clnt *rpc_create(struct rpc_create_args *args)
401{
402 struct rpc_xprt *xprt;
403 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400404 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400405 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400406 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200407 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200408 .dstaddr = args->address,
409 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500410 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300411 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200412 };
Chuck Lever510deb02007-12-10 14:56:24 -0500413 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400414
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400415 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
416 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400417 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
418 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400419 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400420 * If the caller chooses not to specify a hostname, whip
421 * up a string representation of the passed-in address.
422 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500423 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400424 struct sockaddr_un *sun =
425 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400426 struct sockaddr_in *sin =
427 (struct sockaddr_in *)args->address;
428 struct sockaddr_in6 *sin6 =
429 (struct sockaddr_in6 *)args->address;
430
Chuck Lever510deb02007-12-10 14:56:24 -0500431 servername[0] = '\0';
432 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400433 case AF_LOCAL:
434 snprintf(servername, sizeof(servername), "%s",
435 sun->sun_path);
436 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400437 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700438 snprintf(servername, sizeof(servername), "%pI4",
439 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500440 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400441 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700442 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400443 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500444 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500445 default:
446 /* caller wants default server name, but
447 * address family isn't recognized. */
448 return ERR_PTR(-EINVAL);
449 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500450 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400451 }
452
Chuck Lever510deb02007-12-10 14:56:24 -0500453 xprt = xprt_create_transport(&xprtargs);
454 if (IS_ERR(xprt))
455 return (struct rpc_clnt *)xprt;
456
Chuck Lever43780b82007-07-01 12:13:22 -0400457 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400458 * By default, kernel RPC client connects from a reserved port.
459 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
460 * but it is always enabled for rpciod, which handles the connect
461 * operation.
462 */
463 xprt->resvport = 1;
464 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
465 xprt->resvport = 0;
466
Trond Myklebust698b6d02007-12-20 16:03:53 -0500467 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400468 if (IS_ERR(clnt))
469 return clnt;
470
471 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500472 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400473 if (err != 0) {
474 rpc_shutdown_client(clnt);
475 return ERR_PTR(err);
476 }
477 }
478
479 clnt->cl_softrtry = 1;
480 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
481 clnt->cl_softrtry = 0;
482
Chuck Leverc2866762006-08-22 20:06:20 -0400483 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
484 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500485 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
486 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400487 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
488 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400489
490 return clnt;
491}
Chuck Leverb86acd52006-08-22 20:06:22 -0400492EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494/*
495 * This function clones the RPC client structure. It allows us to share the
496 * same transport while varying parameters such as the authentication
497 * flavour.
498 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400499static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
500 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500502 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400503 struct rpc_clnt *new;
504 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Chuck Lever1b63a752012-09-14 17:23:52 -0400506 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500507 rcu_read_lock();
508 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
509 rcu_read_unlock();
510 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400511 goto out_err;
512 args->servername = xprt->servername;
513
514 new = rpc_new_client(args, xprt);
515 if (IS_ERR(new)) {
516 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400517 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400518 }
519
Trond Myklebust006abe82010-09-12 19:55:25 -0400520 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400521 new->cl_parent = clnt;
522
523 /* Turn off autobind on clones */
524 new->cl_autobind = 0;
525 new->cl_softrtry = clnt->cl_softrtry;
526 new->cl_discrtry = clnt->cl_discrtry;
527 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400529
Chuck Lever1b63a752012-09-14 17:23:52 -0400530out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800531 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500532 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
Chuck Lever1b63a752012-09-14 17:23:52 -0400534
535/**
536 * rpc_clone_client - Clone an RPC client structure
537 *
538 * @clnt: RPC client whose parameters are copied
539 *
540 * Returns a fresh RPC client or an ERR_PTR.
541 */
542struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
543{
544 struct rpc_create_args args = {
545 .program = clnt->cl_program,
546 .prognumber = clnt->cl_prog,
547 .version = clnt->cl_vers,
548 .authflavor = clnt->cl_auth->au_flavor,
549 .client_name = clnt->cl_principal,
550 };
551 return __rpc_clone_client(&args, clnt);
552}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400553EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Chuck Leverba9b5842012-09-14 17:24:02 -0400555/**
556 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
557 *
558 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800559 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400560 *
561 * Returns a fresh RPC client or an ERR_PTR.
562 */
563struct rpc_clnt *
564rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
565{
566 struct rpc_create_args args = {
567 .program = clnt->cl_program,
568 .prognumber = clnt->cl_prog,
569 .version = clnt->cl_vers,
570 .authflavor = flavor,
571 .client_name = clnt->cl_principal,
572 };
573 return __rpc_clone_client(&args, clnt);
574}
575EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400578 * Kill all tasks for the given client.
579 * XXX: kill their descendants as well?
580 */
581void rpc_killall_tasks(struct rpc_clnt *clnt)
582{
583 struct rpc_task *rovr;
584
585
586 if (list_empty(&clnt->cl_tasks))
587 return;
588 dprintk("RPC: killing all tasks for client %p\n", clnt);
589 /*
590 * Spin lock all_tasks to prevent changes...
591 */
592 spin_lock(&clnt->cl_lock);
593 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
594 if (!RPC_IS_ACTIVATED(rovr))
595 continue;
596 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
597 rovr->tk_flags |= RPC_TASK_KILLED;
598 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300599 if (RPC_IS_QUEUED(rovr))
600 rpc_wake_up_queued_task(rovr->tk_waitqueue,
601 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400602 }
603 }
604 spin_unlock(&clnt->cl_lock);
605}
606EXPORT_SYMBOL_GPL(rpc_killall_tasks);
607
608/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400610 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400612void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400614 might_sleep();
615
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500616 dprintk_rcu("RPC: shutting down %s client for %s\n",
617 clnt->cl_protname,
618 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Trond Myklebust34f52e32007-06-14 16:40:31 -0400620 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800622 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400623 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 }
625
Trond Myklebust4c402b42007-06-14 16:40:32 -0400626 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400628EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400631 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400633static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400634rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500636 dprintk_rcu("RPC: destroying %s client for %s\n",
637 clnt->cl_protname,
638 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500639 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400640 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400641 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400642 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500643 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500644 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500645 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500646 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400647 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
651/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400652 * Free an RPC client
653 */
654static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400655rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400656{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400657 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400658 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400659 return;
660 }
661
662 /*
663 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
664 * release remaining GSS contexts. This mechanism ensures
665 * that it can do so safely.
666 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400667 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400668 rpcauth_release(clnt->cl_auth);
669 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400670 if (atomic_dec_and_test(&clnt->cl_count))
671 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400672}
673
674/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400675 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 */
677void
678rpc_release_client(struct rpc_clnt *clnt)
679{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400680 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Trond Myklebust34f52e32007-06-14 16:40:31 -0400682 if (list_empty(&clnt->cl_tasks))
683 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400684 if (atomic_dec_and_test(&clnt->cl_count))
685 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400686}
Simo Sorce1d658332012-05-25 18:09:55 -0400687EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400688
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000689/**
690 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800691 * @old: old rpc_client
692 * @program: rpc program to set
693 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000694 *
695 * Clones the rpc client and sets up a new RPC program. This is mainly
696 * of use for enabling different RPC programs to share the same transport.
697 * The Sun NFSv2/v3 ACL protocol can do this.
698 */
699struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500700 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400701 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000702{
Trond Myklebustf994c432012-11-01 12:14:14 -0400703 struct rpc_create_args args = {
704 .program = program,
705 .prognumber = program->number,
706 .version = vers,
707 .authflavor = old->cl_auth->au_flavor,
708 .client_name = old->cl_principal,
709 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000710 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000711 int err;
712
Trond Myklebustf994c432012-11-01 12:14:14 -0400713 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000714 if (IS_ERR(clnt))
715 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500716 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000717 if (err != 0) {
718 rpc_shutdown_client(clnt);
719 clnt = ERR_PTR(err);
720 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800721out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000722 return clnt;
723}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400724EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000725
Trond Myklebust58f96122010-07-31 14:29:08 -0400726void rpc_task_release_client(struct rpc_task *task)
727{
728 struct rpc_clnt *clnt = task->tk_client;
729
730 if (clnt != NULL) {
731 /* Remove from client task list */
732 spin_lock(&clnt->cl_lock);
733 list_del(&task->tk_task);
734 spin_unlock(&clnt->cl_lock);
735 task->tk_client = NULL;
736
737 rpc_release_client(clnt);
738 }
739}
740
741static
742void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
743{
744 if (clnt != NULL) {
745 rpc_task_release_client(task);
746 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400747 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400748 if (clnt->cl_softrtry)
749 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700750 if (sk_memalloc_socks()) {
751 struct rpc_xprt *xprt;
752
753 rcu_read_lock();
754 xprt = rcu_dereference(clnt->cl_xprt);
755 if (xprt->swapper)
756 task->tk_flags |= RPC_TASK_SWAPPER;
757 rcu_read_unlock();
758 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400759 /* Add to the client's list of all tasks */
760 spin_lock(&clnt->cl_lock);
761 list_add_tail(&task->tk_task, &clnt->cl_tasks);
762 spin_unlock(&clnt->cl_lock);
763 }
764}
765
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000766void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
767{
768 rpc_task_release_client(task);
769 rpc_task_set_client(task, clnt);
770}
771EXPORT_SYMBOL_GPL(rpc_task_reset_client);
772
773
Trond Myklebust58f96122010-07-31 14:29:08 -0400774static void
775rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
776{
777 if (msg != NULL) {
778 task->tk_msg.rpc_proc = msg->rpc_proc;
779 task->tk_msg.rpc_argp = msg->rpc_argp;
780 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400781 if (msg->rpc_cred != NULL)
782 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400783 }
784}
785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786/*
787 * Default callback for async RPC calls
788 */
789static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100790rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
792}
793
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100794static const struct rpc_call_ops rpc_default_ops = {
795 .rpc_call_done = rpc_default_callback,
796};
797
Trond Myklebustc970aa82007-07-14 15:39:59 -0400798/**
799 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
800 * @task_setup_data: pointer to task initialisation data
801 */
802struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400803{
Trond Myklebust19445b92010-04-16 16:41:10 -0400804 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400805
Trond Myklebust84115e12007-07-14 15:39:59 -0400806 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400807 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400808 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400809
Trond Myklebust58f96122010-07-31 14:29:08 -0400810 rpc_task_set_client(task, task_setup_data->rpc_client);
811 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
812
Trond Myklebust58f96122010-07-31 14:29:08 -0400813 if (task->tk_action == NULL)
814 rpc_call_start(task);
815
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400816 atomic_inc(&task->tk_count);
817 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400818out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400819 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400820}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400821EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400822
823/**
824 * rpc_call_sync - Perform a synchronous RPC call
825 * @clnt: pointer to RPC client
826 * @msg: RPC call parameters
827 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500829int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
831 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400832 struct rpc_task_setup task_setup_data = {
833 .rpc_client = clnt,
834 .rpc_message = msg,
835 .callback_ops = &rpc_default_ops,
836 .flags = flags,
837 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400838 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400840 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
841 if (flags & RPC_TASK_ASYNC) {
842 rpc_release_calldata(task_setup_data.callback_ops,
843 task_setup_data.callback_data);
844 return -EINVAL;
845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846
Trond Myklebustc970aa82007-07-14 15:39:59 -0400847 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400848 if (IS_ERR(task))
849 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100850 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800851 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 return status;
853}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400854EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400856/**
857 * rpc_call_async - Perform an asynchronous RPC call
858 * @clnt: pointer to RPC client
859 * @msg: RPC call parameters
860 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800861 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400862 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 */
864int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500865rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100866 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
868 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400869 struct rpc_task_setup task_setup_data = {
870 .rpc_client = clnt,
871 .rpc_message = msg,
872 .callback_ops = tk_ops,
873 .callback_data = data,
874 .flags = flags|RPC_TASK_ASYNC,
875 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Trond Myklebustc970aa82007-07-14 15:39:59 -0400877 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400878 if (IS_ERR(task))
879 return PTR_ERR(task);
880 rpc_put_task(task);
881 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400883EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400885#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400886/**
887 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
888 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400889 * @req: RPC request
890 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400891 */
892struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400893 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400894{
895 struct rpc_task *task;
896 struct xdr_buf *xbufp = &req->rq_snd_buf;
897 struct rpc_task_setup task_setup_data = {
898 .callback_ops = tk_ops,
899 };
900
901 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
902 /*
903 * Create an rpc_task to send the data
904 */
905 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400906 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400907 xprt_free_bc_request(req);
908 goto out;
909 }
910 task->tk_rqstp = req;
911
912 /*
913 * Set up the xdr_buf length.
914 * This also indicates that the buffer is XDR encoded already.
915 */
916 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
917 xbufp->tail[0].iov_len;
918
919 task->tk_action = call_bc_transmit;
920 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400921 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400922 rpc_execute(task);
923
924out:
925 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
926 return task;
927}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400928#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400929
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400931rpc_call_start(struct rpc_task *task)
932{
933 task->tk_action = call_start;
934}
935EXPORT_SYMBOL_GPL(rpc_call_start);
936
Chuck Levered394402006-08-22 20:06:17 -0400937/**
938 * rpc_peeraddr - extract remote peer address from clnt's xprt
939 * @clnt: RPC client structure
940 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800941 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400942 *
943 * Returns the number of bytes that are actually in the stored address.
944 */
945size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
946{
947 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500948 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400949
Trond Myklebust2446ab62012-03-01 17:00:56 -0500950 rcu_read_lock();
951 xprt = rcu_dereference(clnt->cl_xprt);
952
953 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400954 if (bytes > bufsize)
955 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500956 memcpy(buf, &xprt->addr, bytes);
957 rcu_read_unlock();
958
959 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400960}
Chuck Leverb86acd52006-08-22 20:06:22 -0400961EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400962
Chuck Leverf425eba2006-08-22 20:06:18 -0400963/**
964 * rpc_peeraddr2str - return remote peer address in printable format
965 * @clnt: RPC client structure
966 * @format: address format
967 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500968 * NB: the lifetime of the memory referenced by the returned pointer is
969 * the same as the rpc_xprt itself. As long as the caller uses this
970 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400971 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500972const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
973 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400974{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500975 struct rpc_xprt *xprt;
976
977 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500978
979 if (xprt->address_strings[format] != NULL)
980 return xprt->address_strings[format];
981 else
982 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400983}
Chuck Leverb86acd52006-08-22 20:06:22 -0400984EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400985
Chuck Lever2e738fd2012-03-01 17:01:14 -0500986static const struct sockaddr_in rpc_inaddr_loopback = {
987 .sin_family = AF_INET,
988 .sin_addr.s_addr = htonl(INADDR_ANY),
989};
990
991static const struct sockaddr_in6 rpc_in6addr_loopback = {
992 .sin6_family = AF_INET6,
993 .sin6_addr = IN6ADDR_ANY_INIT,
994};
995
996/*
997 * Try a getsockname() on a connected datagram socket. Using a
998 * connected datagram socket prevents leaving a socket in TIME_WAIT.
999 * This conserves the ephemeral port number space.
1000 *
1001 * Returns zero and fills in "buf" if successful; otherwise, a
1002 * negative errno is returned.
1003 */
1004static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1005 struct sockaddr *buf, int buflen)
1006{
1007 struct socket *sock;
1008 int err;
1009
1010 err = __sock_create(net, sap->sa_family,
1011 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1012 if (err < 0) {
1013 dprintk("RPC: can't create UDP socket (%d)\n", err);
1014 goto out;
1015 }
1016
1017 switch (sap->sa_family) {
1018 case AF_INET:
1019 err = kernel_bind(sock,
1020 (struct sockaddr *)&rpc_inaddr_loopback,
1021 sizeof(rpc_inaddr_loopback));
1022 break;
1023 case AF_INET6:
1024 err = kernel_bind(sock,
1025 (struct sockaddr *)&rpc_in6addr_loopback,
1026 sizeof(rpc_in6addr_loopback));
1027 break;
1028 default:
1029 err = -EAFNOSUPPORT;
1030 goto out;
1031 }
1032 if (err < 0) {
1033 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1034 goto out_release;
1035 }
1036
1037 err = kernel_connect(sock, sap, salen, 0);
1038 if (err < 0) {
1039 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1040 goto out_release;
1041 }
1042
1043 err = kernel_getsockname(sock, buf, &buflen);
1044 if (err < 0) {
1045 dprintk("RPC: getsockname failed (%d)\n", err);
1046 goto out_release;
1047 }
1048
1049 err = 0;
1050 if (buf->sa_family == AF_INET6) {
1051 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1052 sin6->sin6_scope_id = 0;
1053 }
1054 dprintk("RPC: %s succeeded\n", __func__);
1055
1056out_release:
1057 sock_release(sock);
1058out:
1059 return err;
1060}
1061
1062/*
1063 * Scraping a connected socket failed, so we don't have a useable
1064 * local address. Fallback: generate an address that will prevent
1065 * the server from calling us back.
1066 *
1067 * Returns zero and fills in "buf" if successful; otherwise, a
1068 * negative errno is returned.
1069 */
1070static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1071{
1072 switch (family) {
1073 case AF_INET:
1074 if (buflen < sizeof(rpc_inaddr_loopback))
1075 return -EINVAL;
1076 memcpy(buf, &rpc_inaddr_loopback,
1077 sizeof(rpc_inaddr_loopback));
1078 break;
1079 case AF_INET6:
1080 if (buflen < sizeof(rpc_in6addr_loopback))
1081 return -EINVAL;
1082 memcpy(buf, &rpc_in6addr_loopback,
1083 sizeof(rpc_in6addr_loopback));
1084 default:
1085 dprintk("RPC: %s: address family not supported\n",
1086 __func__);
1087 return -EAFNOSUPPORT;
1088 }
1089 dprintk("RPC: %s: succeeded\n", __func__);
1090 return 0;
1091}
1092
1093/**
1094 * rpc_localaddr - discover local endpoint address for an RPC client
1095 * @clnt: RPC client structure
1096 * @buf: target buffer
1097 * @buflen: size of target buffer, in bytes
1098 *
1099 * Returns zero and fills in "buf" and "buflen" if successful;
1100 * otherwise, a negative errno is returned.
1101 *
1102 * This works even if the underlying transport is not currently connected,
1103 * or if the upper layer never previously provided a source address.
1104 *
1105 * The result of this function call is transient: multiple calls in
1106 * succession may give different results, depending on how local
1107 * networking configuration changes over time.
1108 */
1109int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1110{
1111 struct sockaddr_storage address;
1112 struct sockaddr *sap = (struct sockaddr *)&address;
1113 struct rpc_xprt *xprt;
1114 struct net *net;
1115 size_t salen;
1116 int err;
1117
1118 rcu_read_lock();
1119 xprt = rcu_dereference(clnt->cl_xprt);
1120 salen = xprt->addrlen;
1121 memcpy(sap, &xprt->addr, salen);
1122 net = get_net(xprt->xprt_net);
1123 rcu_read_unlock();
1124
1125 rpc_set_port(sap, 0);
1126 err = rpc_sockname(net, sap, salen, buf, buflen);
1127 put_net(net);
1128 if (err != 0)
1129 /* Couldn't discover local address, return ANYADDR */
1130 return rpc_anyaddr(sap->sa_family, buf, buflen);
1131 return 0;
1132}
1133EXPORT_SYMBOL_GPL(rpc_localaddr);
1134
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135void
1136rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1137{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001138 struct rpc_xprt *xprt;
1139
1140 rcu_read_lock();
1141 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001142 if (xprt->ops->set_buffer_size)
1143 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001144 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001146EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
Trond Myklebust2446ab62012-03-01 17:00:56 -05001148/**
1149 * rpc_protocol - Get transport protocol number for an RPC client
1150 * @clnt: RPC client to query
1151 *
1152 */
1153int rpc_protocol(struct rpc_clnt *clnt)
1154{
1155 int protocol;
1156
1157 rcu_read_lock();
1158 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1159 rcu_read_unlock();
1160 return protocol;
1161}
1162EXPORT_SYMBOL_GPL(rpc_protocol);
1163
1164/**
1165 * rpc_net_ns - Get the network namespace for this RPC client
1166 * @clnt: RPC client to query
1167 *
1168 */
1169struct net *rpc_net_ns(struct rpc_clnt *clnt)
1170{
1171 struct net *ret;
1172
1173 rcu_read_lock();
1174 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1175 rcu_read_unlock();
1176 return ret;
1177}
1178EXPORT_SYMBOL_GPL(rpc_net_ns);
1179
1180/**
1181 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1182 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 *
1184 * For stream transports, this is one RPC record fragment (see RFC
1185 * 1831), as we don't support multi-record requests yet. For datagram
1186 * transports, this is the size of an IP packet minus the IP, UDP, and
1187 * RPC header sizes.
1188 */
1189size_t rpc_max_payload(struct rpc_clnt *clnt)
1190{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001191 size_t ret;
1192
1193 rcu_read_lock();
1194 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1195 rcu_read_unlock();
1196 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197}
Chuck Leverb86acd52006-08-22 20:06:22 -04001198EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Chuck Lever35f5a422006-01-03 09:55:50 +01001200/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001201 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001202 * @clnt: RPC client to query
1203 */
1204unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1205{
1206 unsigned long ret;
1207
1208 rcu_read_lock();
1209 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1210 rcu_read_unlock();
1211 return ret;
1212}
1213EXPORT_SYMBOL_GPL(rpc_get_timeout);
1214
1215/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001216 * rpc_force_rebind - force transport to check that remote port is unchanged
1217 * @clnt: client to rebind
1218 *
1219 */
1220void rpc_force_rebind(struct rpc_clnt *clnt)
1221{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001222 if (clnt->cl_autobind) {
1223 rcu_read_lock();
1224 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1225 rcu_read_unlock();
1226 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001227}
Chuck Leverb86acd52006-08-22 20:06:22 -04001228EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001229
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001231 * Restart an (async) RPC call from the call_prepare state.
1232 * Usually called from within the exit handler.
1233 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001234int
Andy Adamsonaae20062009-04-01 09:22:40 -04001235rpc_restart_call_prepare(struct rpc_task *task)
1236{
1237 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001238 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001239 task->tk_action = call_start;
1240 if (task->tk_ops->rpc_call_prepare != NULL)
1241 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001242 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001243}
1244EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1245
1246/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 * Restart an (async) RPC call. Usually called from within the
1248 * exit handler.
1249 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001250int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251rpc_restart_call(struct rpc_task *task)
1252{
1253 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001254 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001256 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001258EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
Chuck Lever3748f1e2008-05-21 17:09:12 -04001260#ifdef RPC_DEBUG
1261static const char *rpc_proc_name(const struct rpc_task *task)
1262{
1263 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1264
1265 if (proc) {
1266 if (proc->p_name)
1267 return proc->p_name;
1268 else
1269 return "NULL";
1270 } else
1271 return "no proc";
1272}
1273#endif
1274
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275/*
1276 * 0. Initial state
1277 *
1278 * Other FSM states can be visited zero or more times, but
1279 * this state is visited exactly once for each RPC.
1280 */
1281static void
1282call_start(struct rpc_task *task)
1283{
1284 struct rpc_clnt *clnt = task->tk_client;
1285
Chuck Lever3748f1e2008-05-21 17:09:12 -04001286 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001287 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001288 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001289 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
1291 /* Increment call count */
1292 task->tk_msg.rpc_proc->p_count++;
1293 clnt->cl_stats->rpccnt++;
1294 task->tk_action = call_reserve;
1295}
1296
1297/*
1298 * 1. Reserve an RPC call slot
1299 */
1300static void
1301call_reserve(struct rpc_task *task)
1302{
Chuck Lever46121cf2007-01-31 12:14:08 -05001303 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 task->tk_status = 0;
1306 task->tk_action = call_reserveresult;
1307 xprt_reserve(task);
1308}
1309
Trond Myklebustba60eb22013-04-14 10:49:37 -04001310static void call_retry_reserve(struct rpc_task *task);
1311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312/*
1313 * 1b. Grok the result of xprt_reserve()
1314 */
1315static void
1316call_reserveresult(struct rpc_task *task)
1317{
1318 int status = task->tk_status;
1319
Chuck Lever46121cf2007-01-31 12:14:08 -05001320 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
1322 /*
1323 * After a call to xprt_reserve(), we must have either
1324 * a request slot or else an error status.
1325 */
1326 task->tk_status = 0;
1327 if (status >= 0) {
1328 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001329 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 return;
1331 }
1332
1333 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001334 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 rpc_exit(task, -EIO);
1336 return;
1337 }
1338
1339 /*
1340 * Even though there was an error, we may have acquired
1341 * a request slot somehow. Make sure not to leak it.
1342 */
1343 if (task->tk_rqstp) {
1344 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001345 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 xprt_release(task);
1347 }
1348
1349 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001350 case -ENOMEM:
1351 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001353 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 return;
1355 case -EIO: /* probably a shutdown */
1356 break;
1357 default:
1358 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001359 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 break;
1361 }
1362 rpc_exit(task, status);
1363}
1364
1365/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001366 * 1c. Retry reserving an RPC call slot
1367 */
1368static void
1369call_retry_reserve(struct rpc_task *task)
1370{
1371 dprint_status(task);
1372
1373 task->tk_status = 0;
1374 task->tk_action = call_reserveresult;
1375 xprt_retry_reserve(task);
1376}
1377
1378/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001379 * 2. Bind and/or refresh the credentials
1380 */
1381static void
1382call_refresh(struct rpc_task *task)
1383{
1384 dprint_status(task);
1385
1386 task->tk_action = call_refreshresult;
1387 task->tk_status = 0;
1388 task->tk_client->cl_stats->rpcauthrefresh++;
1389 rpcauth_refreshcred(task);
1390}
1391
1392/*
1393 * 2a. Process the results of a credential refresh
1394 */
1395static void
1396call_refreshresult(struct rpc_task *task)
1397{
1398 int status = task->tk_status;
1399
1400 dprint_status(task);
1401
1402 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001403 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001404 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001405 case 0:
1406 if (rpcauth_uptodatecred(task))
1407 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001408 return;
1409 case -ETIMEDOUT:
1410 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001411 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001412 case -EAGAIN:
1413 status = -EACCES;
1414 if (!task->tk_cred_retry)
1415 break;
1416 task->tk_cred_retry--;
1417 dprintk("RPC: %5u %s: retry refresh creds\n",
1418 task->tk_pid, __func__);
1419 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001420 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001421 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1422 task->tk_pid, __func__, status);
1423 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001424}
1425
1426/*
1427 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001428 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 */
1430static void
1431call_allocate(struct rpc_task *task)
1432{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001433 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001434 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001435 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001436 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Chuck Lever46121cf2007-01-31 12:14:08 -05001438 dprint_status(task);
1439
Chuck Lever2bea90d2007-03-29 16:47:53 -04001440 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001441 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001442
Chuck Lever02107142006-01-03 09:55:49 +01001443 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 return;
1445
Chuck Lever2bea90d2007-03-29 16:47:53 -04001446 if (proc->p_proc != 0) {
1447 BUG_ON(proc->p_arglen == 0);
1448 if (proc->p_decode != NULL)
1449 BUG_ON(proc->p_replen == 0);
1450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Chuck Lever2bea90d2007-03-29 16:47:53 -04001452 /*
1453 * Calculate the size (in quads) of the RPC call
1454 * and reply headers, and convert both values
1455 * to byte sizes.
1456 */
1457 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1458 req->rq_callsize <<= 2;
1459 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1460 req->rq_rcvsize <<= 2;
1461
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001462 req->rq_buffer = xprt->ops->buf_alloc(task,
1463 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001464 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001466
1467 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
Trond Myklebust5afa9132011-06-17 10:14:59 -04001469 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001470 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 rpc_delay(task, HZ>>4);
1472 return;
1473 }
1474
1475 rpc_exit(task, -ERESTARTSYS);
1476}
1477
Trond Myklebust940e3312005-11-09 21:45:24 -05001478static inline int
1479rpc_task_need_encode(struct rpc_task *task)
1480{
1481 return task->tk_rqstp->rq_snd_buf.len == 0;
1482}
1483
1484static inline void
1485rpc_task_force_reencode(struct rpc_task *task)
1486{
1487 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001488 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001489}
1490
Chuck Lever2bea90d2007-03-29 16:47:53 -04001491static inline void
1492rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1493{
1494 buf->head[0].iov_base = start;
1495 buf->head[0].iov_len = len;
1496 buf->tail[0].iov_len = 0;
1497 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001498 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001499 buf->len = 0;
1500 buf->buflen = len;
1501}
1502
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503/*
1504 * 3. Encode arguments of an RPC call
1505 */
1506static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001507rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001510 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001511 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Chuck Lever46121cf2007-01-31 12:14:08 -05001513 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Chuck Lever2bea90d2007-03-29 16:47:53 -04001515 rpc_xdr_buf_init(&req->rq_snd_buf,
1516 req->rq_buffer,
1517 req->rq_callsize);
1518 rpc_xdr_buf_init(&req->rq_rcv_buf,
1519 (char *)req->rq_buffer + req->rq_callsize,
1520 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Chuck Leverb0e1c572008-05-21 17:09:19 -04001522 p = rpc_encode_header(task);
1523 if (p == NULL) {
1524 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 rpc_exit(task, -EIO);
1526 return;
1527 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001528
1529 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001530 if (encode == NULL)
1531 return;
1532
1533 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1534 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535}
1536
1537/*
1538 * 4. Get the server port number if not yet set
1539 */
1540static void
1541call_bind(struct rpc_task *task)
1542{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001543 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
Chuck Lever46121cf2007-01-31 12:14:08 -05001545 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Chuck Leverda351872005-08-11 16:25:11 -04001547 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001548 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001549 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001550 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001551 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 }
1553}
1554
1555/*
Chuck Leverda351872005-08-11 16:25:11 -04001556 * 4a. Sort out bind result
1557 */
1558static void
1559call_bind_status(struct rpc_task *task)
1560{
Chuck Lever906462a2007-09-11 18:00:47 -04001561 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001562
1563 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001564 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001565 task->tk_status = 0;
1566 task->tk_action = call_connect;
1567 return;
1568 }
1569
Steve Dickson5753cba2012-02-06 10:08:08 -05001570 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001571 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001572 case -ENOMEM:
1573 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1574 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001575 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001576 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001577 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1578 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001579 /* fail immediately if this is an RPC ping */
1580 if (task->tk_msg.rpc_proc->p_proc == 0) {
1581 status = -EOPNOTSUPP;
1582 break;
1583 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001584 if (task->tk_rebind_retry == 0)
1585 break;
1586 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001587 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001588 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001589 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001590 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001591 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001592 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001593 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001594 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001595 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001596 task->tk_pid);
1597 break;
1598 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001599 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001600 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001601 task->tk_status = 0;
1602 task->tk_action = call_bind;
1603 return;
Chuck Lever012da152009-12-03 15:58:56 -05001604 case -ECONNREFUSED: /* connection problems */
1605 case -ECONNRESET:
1606 case -ENOTCONN:
1607 case -EHOSTDOWN:
1608 case -EHOSTUNREACH:
1609 case -ENETUNREACH:
1610 case -EPIPE:
1611 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1612 task->tk_pid, task->tk_status);
1613 if (!RPC_IS_SOFTCONN(task)) {
1614 rpc_delay(task, 5*HZ);
1615 goto retry_timeout;
1616 }
1617 status = task->tk_status;
1618 break;
Chuck Leverda351872005-08-11 16:25:11 -04001619 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001620 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001621 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001622 }
1623
1624 rpc_exit(task, status);
1625 return;
1626
Trond Myklebustda458282006-08-31 15:44:52 -04001627retry_timeout:
1628 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001629}
1630
1631/*
1632 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 */
1634static void
1635call_connect(struct rpc_task *task)
1636{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001637 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Chuck Lever46121cf2007-01-31 12:14:08 -05001639 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001640 task->tk_pid, xprt,
1641 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Chuck Leverda351872005-08-11 16:25:11 -04001643 task->tk_action = call_transmit;
1644 if (!xprt_connected(xprt)) {
1645 task->tk_action = call_connect_status;
1646 if (task->tk_status < 0)
1647 return;
1648 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650}
1651
1652/*
Chuck Leverda351872005-08-11 16:25:11 -04001653 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 */
1655static void
1656call_connect_status(struct rpc_task *task)
1657{
1658 struct rpc_clnt *clnt = task->tk_client;
1659 int status = task->tk_status;
1660
Chuck Lever46121cf2007-01-31 12:14:08 -05001661 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001662
Steve Dickson5753cba2012-02-06 10:08:08 -05001663 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001665 /* if soft mounted, test if we've timed out */
1666 case -ETIMEDOUT:
1667 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001668 return;
1669 case -ECONNREFUSED:
1670 case -ECONNRESET:
1671 case -ENETUNREACH:
1672 if (RPC_IS_SOFTCONN(task))
1673 break;
1674 /* retry with existing socket, after a delay */
1675 case 0:
1676 case -EAGAIN:
1677 task->tk_status = 0;
1678 clnt->cl_stats->netreconn++;
1679 task->tk_action = call_transmit;
1680 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001682 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683}
1684
1685/*
1686 * 5. Transmit the RPC request, and wait for reply
1687 */
1688static void
1689call_transmit(struct rpc_task *task)
1690{
Chuck Lever46121cf2007-01-31 12:14:08 -05001691 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
1693 task->tk_action = call_status;
1694 if (task->tk_status < 0)
1695 return;
1696 task->tk_status = xprt_prepare_transmit(task);
1697 if (task->tk_status != 0)
1698 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001699 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001701 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001702 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001703 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001704 if (task->tk_status != 0) {
1705 /* Was the error nonfatal? */
1706 if (task->tk_status == -EAGAIN)
1707 rpc_delay(task, HZ >> 4);
1708 else
1709 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001710 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001711 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001712 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 xprt_transmit(task);
1714 if (task->tk_status < 0)
1715 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001716 /*
1717 * On success, ensure that we call xprt_end_transmit() before sleeping
1718 * in order to allow access to the socket to other RPC requests.
1719 */
1720 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001721 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001722 return;
1723 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001724 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001725}
1726
1727/*
1728 * 5a. Handle cleanup after a transmission
1729 */
1730static void
1731call_transmit_status(struct rpc_task *task)
1732{
1733 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001734
1735 /*
1736 * Common case: success. Force the compiler to put this
1737 * test first.
1738 */
1739 if (task->tk_status == 0) {
1740 xprt_end_transmit(task);
1741 rpc_task_force_reencode(task);
1742 return;
1743 }
1744
Trond Myklebust15f081c2009-03-11 14:37:57 -04001745 switch (task->tk_status) {
1746 case -EAGAIN:
1747 break;
1748 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001749 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001750 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001751 rpc_task_force_reencode(task);
1752 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001753 /*
1754 * Special cases: if we've been waiting on the
1755 * socket's write_space() callback, or if the
1756 * socket just returned a connection error,
1757 * then hold onto the transport lock.
1758 */
1759 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001760 case -EHOSTDOWN:
1761 case -EHOSTUNREACH:
1762 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001763 if (RPC_IS_SOFTCONN(task)) {
1764 xprt_end_transmit(task);
1765 rpc_exit(task, task->tk_status);
1766 break;
1767 }
1768 case -ECONNRESET:
1769 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001770 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001771 rpc_task_force_reencode(task);
1772 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773}
1774
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001775#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001776/*
1777 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1778 * addition, disconnect on connectivity errors.
1779 */
1780static void
1781call_bc_transmit(struct rpc_task *task)
1782{
1783 struct rpc_rqst *req = task->tk_rqstp;
1784
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001785 task->tk_status = xprt_prepare_transmit(task);
1786 if (task->tk_status == -EAGAIN) {
1787 /*
1788 * Could not reserve the transport. Try again after the
1789 * transport is released.
1790 */
1791 task->tk_status = 0;
1792 task->tk_action = call_bc_transmit;
1793 return;
1794 }
1795
1796 task->tk_action = rpc_exit_task;
1797 if (task->tk_status < 0) {
1798 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1799 "error: %d\n", task->tk_status);
1800 return;
1801 }
1802
1803 xprt_transmit(task);
1804 xprt_end_transmit(task);
1805 dprint_status(task);
1806 switch (task->tk_status) {
1807 case 0:
1808 /* Success */
1809 break;
1810 case -EHOSTDOWN:
1811 case -EHOSTUNREACH:
1812 case -ENETUNREACH:
1813 case -ETIMEDOUT:
1814 /*
1815 * Problem reaching the server. Disconnect and let the
1816 * forechannel reestablish the connection. The server will
1817 * have to retransmit the backchannel request and we'll
1818 * reprocess it. Since these ops are idempotent, there's no
1819 * need to cache our reply at this time.
1820 */
1821 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1822 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001823 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001824 req->rq_connect_cookie);
1825 break;
1826 default:
1827 /*
1828 * We were unable to reply and will have to drop the
1829 * request. The server should reconnect and retransmit.
1830 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001831 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001832 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1833 "error: %d\n", task->tk_status);
1834 break;
1835 }
1836 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1837}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001838#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001839
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840/*
1841 * 6. Sort out the RPC call status
1842 */
1843static void
1844call_status(struct rpc_task *task)
1845{
1846 struct rpc_clnt *clnt = task->tk_client;
1847 struct rpc_rqst *req = task->tk_rqstp;
1848 int status;
1849
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001850 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1851 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852
Chuck Lever46121cf2007-01-31 12:14:08 -05001853 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
1855 status = task->tk_status;
1856 if (status >= 0) {
1857 task->tk_action = call_decode;
1858 return;
1859 }
1860
Steve Dickson5753cba2012-02-06 10:08:08 -05001861 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 task->tk_status = 0;
1863 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001864 case -EHOSTDOWN:
1865 case -EHOSTUNREACH:
1866 case -ENETUNREACH:
1867 /*
1868 * Delay any retries for 3 seconds, then handle as if it
1869 * were a timeout.
1870 */
1871 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 case -ETIMEDOUT:
1873 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001874 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001875 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001876 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001878 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001880 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001881 rpc_delay(task, 3*HZ);
1882 case -EPIPE:
1883 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 task->tk_action = call_bind;
1885 break;
1886 case -EAGAIN:
1887 task->tk_action = call_transmit;
1888 break;
1889 case -EIO:
1890 /* shutdown or soft timeout */
1891 rpc_exit(task, status);
1892 break;
1893 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001894 if (clnt->cl_chatty)
1895 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 clnt->cl_protname, -status);
1897 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 }
1899}
1900
1901/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001902 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 * We do not release the request slot, so we keep using the
1904 * same XID for all retransmits.
1905 */
1906static void
1907call_timeout(struct rpc_task *task)
1908{
1909 struct rpc_clnt *clnt = task->tk_client;
1910
1911 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001912 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 goto retry;
1914 }
1915
Chuck Lever46121cf2007-01-31 12:14:08 -05001916 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001917 task->tk_timeouts++;
1918
Chuck Lever3a28bec2009-12-03 15:58:56 -05001919 if (RPC_IS_SOFTCONN(task)) {
1920 rpc_exit(task, -ETIMEDOUT);
1921 return;
1922 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001924 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001925 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001926 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001927 clnt->cl_protname,
1928 rcu_dereference(clnt->cl_xprt)->servername);
1929 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001930 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001931 if (task->tk_flags & RPC_TASK_TIMEOUT)
1932 rpc_exit(task, -ETIMEDOUT);
1933 else
1934 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 return;
1936 }
1937
Chuck Leverf518e35a2006-01-03 09:55:52 +01001938 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001940 if (clnt->cl_chatty) {
1941 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001942 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001943 clnt->cl_protname,
1944 rcu_dereference(clnt->cl_xprt)->servername);
1945 rcu_read_unlock();
1946 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001948 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001949 /*
1950 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1951 * event? RFC2203 requires the server to drop all such requests.
1952 */
1953 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954
1955retry:
1956 clnt->cl_stats->rpcretrans++;
1957 task->tk_action = call_bind;
1958 task->tk_status = 0;
1959}
1960
1961/*
1962 * 7. Decode the RPC reply
1963 */
1964static void
1965call_decode(struct rpc_task *task)
1966{
1967 struct rpc_clnt *clnt = task->tk_client;
1968 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001969 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001970 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
Vasily Averin726fd6a2011-06-01 16:23:59 +04001972 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
Chuck Leverf518e35a2006-01-03 09:55:52 +01001974 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001975 if (clnt->cl_chatty) {
1976 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001977 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001978 clnt->cl_protname,
1979 rcu_dereference(clnt->cl_xprt)->servername);
1980 rcu_read_unlock();
1981 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1983 }
1984
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001985 /*
1986 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001987 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001988 */
1989 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 req->rq_rcv_buf.len = req->rq_private_buf.len;
1991
1992 /* Check that the softirq receive buffer is valid */
1993 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1994 sizeof(req->rq_rcv_buf)) != 0);
1995
Trond Myklebust1e799b62008-03-21 16:19:41 -04001996 if (req->rq_rcv_buf.len < 12) {
1997 if (!RPC_IS_SOFT(task)) {
1998 task->tk_action = call_bind;
1999 clnt->cl_stats->rpcretrans++;
2000 goto out_retry;
2001 }
2002 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2003 clnt->cl_protname, task->tk_status);
2004 task->tk_action = call_timeout;
2005 goto out_retry;
2006 }
2007
Chuck Leverb0e1c572008-05-21 17:09:19 -04002008 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002009 if (IS_ERR(p)) {
2010 if (p == ERR_PTR(-EAGAIN))
2011 goto out_retry;
2012 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 }
2014
Trond Myklebustabbcf282006-01-03 09:55:03 +01002015 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002017 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2019 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002020 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002021 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2022 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 return;
2024out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002026 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002027 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002028 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002029 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002030 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002031 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033}
2034
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002035static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002036rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037{
2038 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002040 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
2042 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002043
Trond Myklebusta4f08352013-01-08 09:10:21 -05002044 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 *p++ = req->rq_xid; /* XID */
2046 *p++ = htonl(RPC_CALL); /* CALL */
2047 *p++ = htonl(RPC_VERSION); /* RPC version */
2048 *p++ = htonl(clnt->cl_prog); /* program number */
2049 *p++ = htonl(clnt->cl_vers); /* program version */
2050 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002051 p = rpcauth_marshcred(task, p);
2052 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2053 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054}
2055
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002056static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002057rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002059 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2061 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002062 __be32 *p = iov->iov_base;
2063 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 int error = -EACCES;
2065
David Howellse8896492006-08-24 15:44:19 -04002066 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2067 /* RFC-1014 says that the representation of XDR data must be a
2068 * multiple of four bytes
2069 * - if it isn't pointer subtraction in the NFS client may give
2070 * undefined results
2071 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002072 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002073 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002074 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002075 goto out_eio;
2076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 if ((len -= 3) < 0)
2078 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002080 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002082 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002083 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002084 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002086
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2088 if (--len < 0)
2089 goto out_overflow;
2090 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002091 case RPC_AUTH_ERROR:
2092 break;
2093 case RPC_MISMATCH:
2094 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2095 task->tk_pid, __func__);
2096 error = -EPROTONOSUPPORT;
2097 goto out_err;
2098 default:
2099 dprintk("RPC: %5u %s: RPC call rejected, "
2100 "unknown error: %x\n",
2101 task->tk_pid, __func__, n);
2102 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 }
2104 if (--len < 0)
2105 goto out_overflow;
2106 switch ((n = ntohl(*p++))) {
2107 case RPC_AUTH_REJECTEDCRED:
2108 case RPC_AUTH_REJECTEDVERF:
2109 case RPCSEC_GSS_CREDPROBLEM:
2110 case RPCSEC_GSS_CTXPROBLEM:
2111 if (!task->tk_cred_retry)
2112 break;
2113 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002114 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002115 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002117 /* Ensure we obtain a new XID! */
2118 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002119 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002120 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 case RPC_AUTH_BADCRED:
2122 case RPC_AUTH_BADVERF:
2123 /* possibly garbled cred/verf? */
2124 if (!task->tk_garb_retry)
2125 break;
2126 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002127 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002128 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002130 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002132 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002133 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002134 "authentication.\n",
2135 rcu_dereference(clnt->cl_xprt)->servername);
2136 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 break;
2138 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002139 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002140 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 error = -EIO;
2142 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002143 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002144 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 goto out_err;
2146 }
2147 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002148 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002149 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002150 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002152 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 if (len < 0)
2154 goto out_overflow;
2155 switch ((n = ntohl(*p++))) {
2156 case RPC_SUCCESS:
2157 return p;
2158 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002159 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2160 "by server %s\n", task->tk_pid, __func__,
2161 (unsigned int)clnt->cl_prog,
2162 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002163 error = -EPFNOSUPPORT;
2164 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002166 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2167 "by server %s\n", task->tk_pid, __func__,
2168 (unsigned int)clnt->cl_prog,
2169 (unsigned int)clnt->cl_vers,
2170 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002171 error = -EPROTONOSUPPORT;
2172 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002174 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002175 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002176 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002177 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002178 clnt->cl_prog, clnt->cl_vers,
2179 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002180 error = -EOPNOTSUPP;
2181 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002183 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002184 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 break; /* retry */
2186 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002187 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002188 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 /* Also retry */
2190 }
2191
Trond Myklebustabbcf282006-01-03 09:55:03 +01002192out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002193 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 if (task->tk_garb_retry) {
2195 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002196 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002197 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002199out_retry:
2200 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202out_eio:
2203 error = -EIO;
2204out_err:
2205 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002206 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002207 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002208 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002210 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002211 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002212 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002214
Chuck Lever9f06c712010-12-14 14:59:18 +00002215static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002216{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002217}
2218
Chuck Leverbf269552010-12-14 14:59:29 +00002219static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002220{
2221 return 0;
2222}
2223
2224static struct rpc_procinfo rpcproc_null = {
2225 .p_encode = rpcproc_encode_null,
2226 .p_decode = rpcproc_decode_null,
2227};
2228
Chuck Levercaabea82009-12-03 15:58:56 -05002229static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002230{
2231 struct rpc_message msg = {
2232 .rpc_proc = &rpcproc_null,
2233 };
2234 int err;
2235 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002236 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002237 put_rpccred(msg.rpc_cred);
2238 return err;
2239}
Trond Myklebust188fef12007-06-16 14:18:40 -04002240
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002241struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2242{
2243 struct rpc_message msg = {
2244 .rpc_proc = &rpcproc_null,
2245 .rpc_cred = cred,
2246 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002247 struct rpc_task_setup task_setup_data = {
2248 .rpc_client = clnt,
2249 .rpc_message = &msg,
2250 .callback_ops = &rpc_default_ops,
2251 .flags = flags,
2252 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002253 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002254}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002255EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002256
Trond Myklebust188fef12007-06-16 14:18:40 -04002257#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002258static void rpc_show_header(void)
2259{
Chuck Levercb3997b2008-05-21 17:09:41 -04002260 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2261 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002262}
2263
Chuck Lever38e886e2008-05-21 17:09:33 -04002264static void rpc_show_task(const struct rpc_clnt *clnt,
2265 const struct rpc_task *task)
2266{
2267 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002268
2269 if (RPC_IS_QUEUED(task))
2270 rpc_waitq = rpc_qname(task->tk_waitqueue);
2271
Joe Perchesb3bceda2010-12-21 10:52:24 -05002272 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 -04002273 task->tk_pid, task->tk_flags, task->tk_status,
2274 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2275 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002276 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002277}
2278
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002279void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002280{
2281 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002282 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002283 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002284 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002285
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002286 spin_lock(&sn->rpc_client_lock);
2287 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002288 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002289 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002290 if (!header) {
2291 rpc_show_header();
2292 header++;
2293 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002294 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002295 }
2296 spin_unlock(&clnt->cl_lock);
2297 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002298 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002299}
2300#endif