blob: 74f6a704e37418cc9b8d4a9b6679f3dd8825da21 [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];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400134 if (dir == NULL) {
135 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400136 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400137 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400139 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400141 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400142 if (!IS_ERR(dentry))
143 break;
Al Viroa95e6912013-07-14 16:43:54 +0400144 if (dentry == ERR_PTR(-EEXIST))
145 continue;
146 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
147 " %s/%s, error %ld\n",
148 dir_name, name, PTR_ERR(dentry));
149 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400150 }
151 dput(dir);
152 return dentry;
153}
154
155static int
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400156rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name,
157 struct super_block *pipefs_sb)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400158{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400159 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400160
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400161 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 if (dir_name == NULL)
163 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400164 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400165 if (IS_ERR(dentry))
166 return PTR_ERR(dentry);
167 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400168 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
170
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400171static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
172{
173 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
174 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
175 return 1;
Stanislav Kinsbursky4f6bb242013-06-24 11:52:59 +0400176 if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
177 return 1;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400178 return 0;
179}
180
181static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
182 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400183{
184 struct dentry *dentry;
185 int err = 0;
186
187 switch (event) {
188 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400189 dentry = rpc_setup_pipedir_sb(sb, clnt,
190 clnt->cl_program->pipe_dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400191 if (!dentry)
192 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400193 if (IS_ERR(dentry))
194 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400195 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 if (clnt->cl_auth->au_ops->pipes_create) {
197 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
198 if (err)
199 __rpc_clnt_remove_pipedir(clnt);
200 }
201 break;
202 case RPC_PIPEFS_UMOUNT:
203 __rpc_clnt_remove_pipedir(clnt);
204 break;
205 default:
206 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
207 return -ENOTSUPP;
208 }
209 return err;
210}
211
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400212static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
213 struct super_block *sb)
214{
215 int error = 0;
216
217 for (;; clnt = clnt->cl_parent) {
218 if (!rpc_clnt_skip_event(clnt, event))
219 error = __rpc_clnt_handle_event(clnt, event, sb);
220 if (error || clnt == clnt->cl_parent)
221 break;
222 }
223 return error;
224}
225
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400226static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
227{
228 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
229 struct rpc_clnt *clnt;
230
231 spin_lock(&sn->rpc_client_lock);
232 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400233 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300234 continue;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400235 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400236 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400237 spin_unlock(&sn->rpc_client_lock);
238 return clnt;
239 }
240 spin_unlock(&sn->rpc_client_lock);
241 return NULL;
242}
243
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
245 void *ptr)
246{
247 struct super_block *sb = ptr;
248 struct rpc_clnt *clnt;
249 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400250
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400251 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400252 error = __rpc_pipefs_event(clnt, event, sb);
253 if (error)
254 break;
255 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400256 return error;
257}
258
259static struct notifier_block rpc_clients_block = {
260 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400261 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400262};
263
264int rpc_clients_notifier_register(void)
265{
266 return rpc_pipefs_notifier_register(&rpc_clients_block);
267}
268
269void rpc_clients_notifier_unregister(void)
270{
271 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
272}
273
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400274static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
275{
276 clnt->cl_nodelen = strlen(nodename);
277 if (clnt->cl_nodelen > UNX_MAXNODENAME)
278 clnt->cl_nodelen = UNX_MAXNODENAME;
279 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
280}
281
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400282static int rpc_client_register(const struct rpc_create_args *args,
283 struct rpc_clnt *clnt)
284{
285 const struct rpc_program *program = args->program;
286 struct rpc_auth *auth;
287 struct net *net = rpc_net_ns(clnt);
288 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400289 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400290
291 pipefs_sb = rpc_get_sb_net(net);
292 if (pipefs_sb) {
293 err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
294 if (err)
295 goto out;
296 }
297
Trond Myklebusteeee2452013-07-10 15:33:01 -0400298 rpc_register_client(clnt);
299 if (pipefs_sb)
300 rpc_put_sb_net(net);
301
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400302 auth = rpcauth_create(args->authflavor, clnt);
303 if (IS_ERR(auth)) {
304 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
305 args->authflavor);
306 err = PTR_ERR(auth);
307 goto err_auth;
308 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400309 return 0;
310err_auth:
311 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400312 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400313 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400314out:
315 if (pipefs_sb)
316 rpc_put_sb_net(net);
317 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400318}
319
Trond Myklebust698b6d02007-12-20 16:03:53 -0500320static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500322 const struct rpc_program *program = args->program;
323 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 struct rpc_clnt *clnt = NULL;
325 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400326
327 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500328 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500329 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Trond Myklebust4ada5392007-06-14 17:26:17 -0400331 err = rpciod_up();
332 if (err)
333 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500334
Trond Myklebustf05c1242013-04-05 14:13:21 -0400335 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500336 if (args->version >= program->nrvers)
337 goto out_err;
338 version = program->version[args->version];
339 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 goto out_err;
341
342 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700343 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 if (!clnt)
345 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 clnt->cl_parent = clnt;
347
Trond Myklebust2446ab62012-03-01 17:00:56 -0500348 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 clnt->cl_procinfo = version->procs;
350 clnt->cl_maxproc = version->nrprocs;
351 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300352 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500355 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500356 err = -ENOMEM;
357 if (clnt->cl_metrics == NULL)
358 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500359 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400360 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400361 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Trond Myklebust2446ab62012-03-01 17:00:56 -0500363 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 clnt->cl_autobind = 1;
365
Trond Myklebustba7392b2007-12-20 16:03:55 -0500366 clnt->cl_timeout = xprt->timeout;
367 if (args->timeout != NULL) {
368 memcpy(&clnt->cl_timeout_default, args->timeout,
369 sizeof(clnt->cl_timeout_default));
370 clnt->cl_timeout = &clnt->cl_timeout_default;
371 }
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500374 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500375 clnt->cl_principal = NULL;
376 if (args->client_name) {
377 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
378 if (!clnt->cl_principal)
379 goto out_no_principal;
380 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Trond Myklebust006abe82010-09-12 19:55:25 -0400382 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400385 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400386
387 err = rpc_client_register(args, clnt);
388 if (err)
389 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 return clnt;
391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500393 kfree(clnt->cl_principal);
394out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500395 rpc_free_iostats(clnt->cl_metrics);
396out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 kfree(clnt);
398out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400399 rpciod_down();
400out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400401 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 return ERR_PTR(err);
403}
404
Ben Hutchings2c530402012-07-10 10:55:09 +0000405/**
Chuck Leverc2866762006-08-22 20:06:20 -0400406 * rpc_create - create an RPC client and transport with one call
407 * @args: rpc_clnt create argument structure
408 *
409 * Creates and initializes an RPC transport and an RPC client.
410 *
411 * It can ping the server in order to determine if it is up, and to see if
412 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
413 * this behavior so asynchronous tasks can also use rpc_create.
414 */
415struct rpc_clnt *rpc_create(struct rpc_create_args *args)
416{
417 struct rpc_xprt *xprt;
418 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400419 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400420 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400421 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200422 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200423 .dstaddr = args->address,
424 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500425 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300426 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200427 };
Chuck Lever510deb02007-12-10 14:56:24 -0500428 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400429
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400430 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
431 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400432 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
433 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400434 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400435 * If the caller chooses not to specify a hostname, whip
436 * up a string representation of the passed-in address.
437 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500438 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400439 struct sockaddr_un *sun =
440 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400441 struct sockaddr_in *sin =
442 (struct sockaddr_in *)args->address;
443 struct sockaddr_in6 *sin6 =
444 (struct sockaddr_in6 *)args->address;
445
Chuck Lever510deb02007-12-10 14:56:24 -0500446 servername[0] = '\0';
447 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400448 case AF_LOCAL:
449 snprintf(servername, sizeof(servername), "%s",
450 sun->sun_path);
451 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400452 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700453 snprintf(servername, sizeof(servername), "%pI4",
454 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500455 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400456 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700457 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400458 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500459 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500460 default:
461 /* caller wants default server name, but
462 * address family isn't recognized. */
463 return ERR_PTR(-EINVAL);
464 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500465 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400466 }
467
Chuck Lever510deb02007-12-10 14:56:24 -0500468 xprt = xprt_create_transport(&xprtargs);
469 if (IS_ERR(xprt))
470 return (struct rpc_clnt *)xprt;
471
Chuck Lever43780b82007-07-01 12:13:22 -0400472 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400473 * By default, kernel RPC client connects from a reserved port.
474 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
475 * but it is always enabled for rpciod, which handles the connect
476 * operation.
477 */
478 xprt->resvport = 1;
479 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
480 xprt->resvport = 0;
481
Trond Myklebust698b6d02007-12-20 16:03:53 -0500482 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400483 if (IS_ERR(clnt))
484 return clnt;
485
486 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500487 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400488 if (err != 0) {
489 rpc_shutdown_client(clnt);
490 return ERR_PTR(err);
491 }
492 }
493
494 clnt->cl_softrtry = 1;
495 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
496 clnt->cl_softrtry = 0;
497
Chuck Leverc2866762006-08-22 20:06:20 -0400498 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
499 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500500 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
501 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400502 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
503 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400504
505 return clnt;
506}
Chuck Leverb86acd52006-08-22 20:06:22 -0400507EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509/*
510 * This function clones the RPC client structure. It allows us to share the
511 * same transport while varying parameters such as the authentication
512 * flavour.
513 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400514static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
515 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500517 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400518 struct rpc_clnt *new;
519 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Chuck Lever1b63a752012-09-14 17:23:52 -0400521 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500522 rcu_read_lock();
523 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
524 rcu_read_unlock();
525 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400526 goto out_err;
527 args->servername = xprt->servername;
528
529 new = rpc_new_client(args, xprt);
530 if (IS_ERR(new)) {
531 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400532 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400533 }
534
Trond Myklebust006abe82010-09-12 19:55:25 -0400535 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400536 new->cl_parent = clnt;
537
538 /* Turn off autobind on clones */
539 new->cl_autobind = 0;
540 new->cl_softrtry = clnt->cl_softrtry;
541 new->cl_discrtry = clnt->cl_discrtry;
542 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400544
Chuck Lever1b63a752012-09-14 17:23:52 -0400545out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800546 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500547 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548}
Chuck Lever1b63a752012-09-14 17:23:52 -0400549
550/**
551 * rpc_clone_client - Clone an RPC client structure
552 *
553 * @clnt: RPC client whose parameters are copied
554 *
555 * Returns a fresh RPC client or an ERR_PTR.
556 */
557struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
558{
559 struct rpc_create_args args = {
560 .program = clnt->cl_program,
561 .prognumber = clnt->cl_prog,
562 .version = clnt->cl_vers,
563 .authflavor = clnt->cl_auth->au_flavor,
564 .client_name = clnt->cl_principal,
565 };
566 return __rpc_clone_client(&args, clnt);
567}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400568EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
Chuck Leverba9b5842012-09-14 17:24:02 -0400570/**
571 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
572 *
573 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800574 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400575 *
576 * Returns a fresh RPC client or an ERR_PTR.
577 */
578struct rpc_clnt *
579rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
580{
581 struct rpc_create_args args = {
582 .program = clnt->cl_program,
583 .prognumber = clnt->cl_prog,
584 .version = clnt->cl_vers,
585 .authflavor = flavor,
586 .client_name = clnt->cl_principal,
587 };
588 return __rpc_clone_client(&args, clnt);
589}
590EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400593 * Kill all tasks for the given client.
594 * XXX: kill their descendants as well?
595 */
596void rpc_killall_tasks(struct rpc_clnt *clnt)
597{
598 struct rpc_task *rovr;
599
600
601 if (list_empty(&clnt->cl_tasks))
602 return;
603 dprintk("RPC: killing all tasks for client %p\n", clnt);
604 /*
605 * Spin lock all_tasks to prevent changes...
606 */
607 spin_lock(&clnt->cl_lock);
608 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
609 if (!RPC_IS_ACTIVATED(rovr))
610 continue;
611 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
612 rovr->tk_flags |= RPC_TASK_KILLED;
613 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300614 if (RPC_IS_QUEUED(rovr))
615 rpc_wake_up_queued_task(rovr->tk_waitqueue,
616 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400617 }
618 }
619 spin_unlock(&clnt->cl_lock);
620}
621EXPORT_SYMBOL_GPL(rpc_killall_tasks);
622
623/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400625 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400627void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400629 might_sleep();
630
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500631 dprintk_rcu("RPC: shutting down %s client for %s\n",
632 clnt->cl_protname,
633 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Trond Myklebust34f52e32007-06-14 16:40:31 -0400635 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800637 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400638 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 }
640
Trond Myklebust4c402b42007-06-14 16:40:32 -0400641 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400643EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
645/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400646 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400648static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400649rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500651 dprintk_rcu("RPC: destroying %s client for %s\n",
652 clnt->cl_protname,
653 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500654 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400655 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400656 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400657 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500658 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500659 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500660 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500661 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400662 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664}
665
666/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400667 * Free an RPC client
668 */
669static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400670rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400671{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400672 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400673 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400674 return;
675 }
676
677 /*
678 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
679 * release remaining GSS contexts. This mechanism ensures
680 * that it can do so safely.
681 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400682 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400683 rpcauth_release(clnt->cl_auth);
684 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400685 if (atomic_dec_and_test(&clnt->cl_count))
686 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400687}
688
689/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400690 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 */
692void
693rpc_release_client(struct rpc_clnt *clnt)
694{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400695 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
Trond Myklebust34f52e32007-06-14 16:40:31 -0400697 if (list_empty(&clnt->cl_tasks))
698 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400699 if (atomic_dec_and_test(&clnt->cl_count))
700 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400701}
Simo Sorce1d658332012-05-25 18:09:55 -0400702EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400703
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000704/**
705 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800706 * @old: old rpc_client
707 * @program: rpc program to set
708 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000709 *
710 * Clones the rpc client and sets up a new RPC program. This is mainly
711 * of use for enabling different RPC programs to share the same transport.
712 * The Sun NFSv2/v3 ACL protocol can do this.
713 */
714struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500715 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400716 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000717{
Trond Myklebustf994c432012-11-01 12:14:14 -0400718 struct rpc_create_args args = {
719 .program = program,
720 .prognumber = program->number,
721 .version = vers,
722 .authflavor = old->cl_auth->au_flavor,
723 .client_name = old->cl_principal,
724 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000725 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000726 int err;
727
Trond Myklebustf994c432012-11-01 12:14:14 -0400728 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000729 if (IS_ERR(clnt))
730 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500731 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000732 if (err != 0) {
733 rpc_shutdown_client(clnt);
734 clnt = ERR_PTR(err);
735 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800736out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000737 return clnt;
738}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400739EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000740
Trond Myklebust58f96122010-07-31 14:29:08 -0400741void rpc_task_release_client(struct rpc_task *task)
742{
743 struct rpc_clnt *clnt = task->tk_client;
744
745 if (clnt != NULL) {
746 /* Remove from client task list */
747 spin_lock(&clnt->cl_lock);
748 list_del(&task->tk_task);
749 spin_unlock(&clnt->cl_lock);
750 task->tk_client = NULL;
751
752 rpc_release_client(clnt);
753 }
754}
755
756static
757void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
758{
759 if (clnt != NULL) {
760 rpc_task_release_client(task);
761 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400762 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400763 if (clnt->cl_softrtry)
764 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700765 if (sk_memalloc_socks()) {
766 struct rpc_xprt *xprt;
767
768 rcu_read_lock();
769 xprt = rcu_dereference(clnt->cl_xprt);
770 if (xprt->swapper)
771 task->tk_flags |= RPC_TASK_SWAPPER;
772 rcu_read_unlock();
773 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400774 /* Add to the client's list of all tasks */
775 spin_lock(&clnt->cl_lock);
776 list_add_tail(&task->tk_task, &clnt->cl_tasks);
777 spin_unlock(&clnt->cl_lock);
778 }
779}
780
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000781void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
782{
783 rpc_task_release_client(task);
784 rpc_task_set_client(task, clnt);
785}
786EXPORT_SYMBOL_GPL(rpc_task_reset_client);
787
788
Trond Myklebust58f96122010-07-31 14:29:08 -0400789static void
790rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
791{
792 if (msg != NULL) {
793 task->tk_msg.rpc_proc = msg->rpc_proc;
794 task->tk_msg.rpc_argp = msg->rpc_argp;
795 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400796 if (msg->rpc_cred != NULL)
797 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400798 }
799}
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801/*
802 * Default callback for async RPC calls
803 */
804static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100805rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806{
807}
808
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100809static const struct rpc_call_ops rpc_default_ops = {
810 .rpc_call_done = rpc_default_callback,
811};
812
Trond Myklebustc970aa82007-07-14 15:39:59 -0400813/**
814 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
815 * @task_setup_data: pointer to task initialisation data
816 */
817struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400818{
Trond Myklebust19445b92010-04-16 16:41:10 -0400819 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400820
Trond Myklebust84115e12007-07-14 15:39:59 -0400821 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400822 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400823 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400824
Trond Myklebust58f96122010-07-31 14:29:08 -0400825 rpc_task_set_client(task, task_setup_data->rpc_client);
826 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
827
Trond Myklebust58f96122010-07-31 14:29:08 -0400828 if (task->tk_action == NULL)
829 rpc_call_start(task);
830
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400831 atomic_inc(&task->tk_count);
832 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400833out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400834 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400835}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400836EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400837
838/**
839 * rpc_call_sync - Perform a synchronous RPC call
840 * @clnt: pointer to RPC client
841 * @msg: RPC call parameters
842 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500844int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
846 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400847 struct rpc_task_setup task_setup_data = {
848 .rpc_client = clnt,
849 .rpc_message = msg,
850 .callback_ops = &rpc_default_ops,
851 .flags = flags,
852 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400853 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400855 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
856 if (flags & RPC_TASK_ASYNC) {
857 rpc_release_calldata(task_setup_data.callback_ops,
858 task_setup_data.callback_data);
859 return -EINVAL;
860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Trond Myklebustc970aa82007-07-14 15:39:59 -0400862 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400863 if (IS_ERR(task))
864 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100865 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800866 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 return status;
868}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400869EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400871/**
872 * rpc_call_async - Perform an asynchronous RPC call
873 * @clnt: pointer to RPC client
874 * @msg: RPC call parameters
875 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800876 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400877 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 */
879int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500880rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100881 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882{
883 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400884 struct rpc_task_setup task_setup_data = {
885 .rpc_client = clnt,
886 .rpc_message = msg,
887 .callback_ops = tk_ops,
888 .callback_data = data,
889 .flags = flags|RPC_TASK_ASYNC,
890 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
Trond Myklebustc970aa82007-07-14 15:39:59 -0400892 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400893 if (IS_ERR(task))
894 return PTR_ERR(task);
895 rpc_put_task(task);
896 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400898EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400900#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400901/**
902 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
903 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400904 * @req: RPC request
905 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400906 */
907struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400908 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400909{
910 struct rpc_task *task;
911 struct xdr_buf *xbufp = &req->rq_snd_buf;
912 struct rpc_task_setup task_setup_data = {
913 .callback_ops = tk_ops,
914 };
915
916 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
917 /*
918 * Create an rpc_task to send the data
919 */
920 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400921 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400922 xprt_free_bc_request(req);
923 goto out;
924 }
925 task->tk_rqstp = req;
926
927 /*
928 * Set up the xdr_buf length.
929 * This also indicates that the buffer is XDR encoded already.
930 */
931 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
932 xbufp->tail[0].iov_len;
933
934 task->tk_action = call_bc_transmit;
935 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400936 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400937 rpc_execute(task);
938
939out:
940 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
941 return task;
942}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400943#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400944
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400946rpc_call_start(struct rpc_task *task)
947{
948 task->tk_action = call_start;
949}
950EXPORT_SYMBOL_GPL(rpc_call_start);
951
Chuck Levered394402006-08-22 20:06:17 -0400952/**
953 * rpc_peeraddr - extract remote peer address from clnt's xprt
954 * @clnt: RPC client structure
955 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800956 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400957 *
958 * Returns the number of bytes that are actually in the stored address.
959 */
960size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
961{
962 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500963 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400964
Trond Myklebust2446ab62012-03-01 17:00:56 -0500965 rcu_read_lock();
966 xprt = rcu_dereference(clnt->cl_xprt);
967
968 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400969 if (bytes > bufsize)
970 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500971 memcpy(buf, &xprt->addr, bytes);
972 rcu_read_unlock();
973
974 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400975}
Chuck Leverb86acd52006-08-22 20:06:22 -0400976EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400977
Chuck Leverf425eba2006-08-22 20:06:18 -0400978/**
979 * rpc_peeraddr2str - return remote peer address in printable format
980 * @clnt: RPC client structure
981 * @format: address format
982 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500983 * NB: the lifetime of the memory referenced by the returned pointer is
984 * the same as the rpc_xprt itself. As long as the caller uses this
985 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400986 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500987const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
988 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400989{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500990 struct rpc_xprt *xprt;
991
992 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500993
994 if (xprt->address_strings[format] != NULL)
995 return xprt->address_strings[format];
996 else
997 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400998}
Chuck Leverb86acd52006-08-22 20:06:22 -0400999EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001000
Chuck Lever2e738fd2012-03-01 17:01:14 -05001001static const struct sockaddr_in rpc_inaddr_loopback = {
1002 .sin_family = AF_INET,
1003 .sin_addr.s_addr = htonl(INADDR_ANY),
1004};
1005
1006static const struct sockaddr_in6 rpc_in6addr_loopback = {
1007 .sin6_family = AF_INET6,
1008 .sin6_addr = IN6ADDR_ANY_INIT,
1009};
1010
1011/*
1012 * Try a getsockname() on a connected datagram socket. Using a
1013 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1014 * This conserves the ephemeral port number space.
1015 *
1016 * Returns zero and fills in "buf" if successful; otherwise, a
1017 * negative errno is returned.
1018 */
1019static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1020 struct sockaddr *buf, int buflen)
1021{
1022 struct socket *sock;
1023 int err;
1024
1025 err = __sock_create(net, sap->sa_family,
1026 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1027 if (err < 0) {
1028 dprintk("RPC: can't create UDP socket (%d)\n", err);
1029 goto out;
1030 }
1031
1032 switch (sap->sa_family) {
1033 case AF_INET:
1034 err = kernel_bind(sock,
1035 (struct sockaddr *)&rpc_inaddr_loopback,
1036 sizeof(rpc_inaddr_loopback));
1037 break;
1038 case AF_INET6:
1039 err = kernel_bind(sock,
1040 (struct sockaddr *)&rpc_in6addr_loopback,
1041 sizeof(rpc_in6addr_loopback));
1042 break;
1043 default:
1044 err = -EAFNOSUPPORT;
1045 goto out;
1046 }
1047 if (err < 0) {
1048 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1049 goto out_release;
1050 }
1051
1052 err = kernel_connect(sock, sap, salen, 0);
1053 if (err < 0) {
1054 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1055 goto out_release;
1056 }
1057
1058 err = kernel_getsockname(sock, buf, &buflen);
1059 if (err < 0) {
1060 dprintk("RPC: getsockname failed (%d)\n", err);
1061 goto out_release;
1062 }
1063
1064 err = 0;
1065 if (buf->sa_family == AF_INET6) {
1066 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1067 sin6->sin6_scope_id = 0;
1068 }
1069 dprintk("RPC: %s succeeded\n", __func__);
1070
1071out_release:
1072 sock_release(sock);
1073out:
1074 return err;
1075}
1076
1077/*
1078 * Scraping a connected socket failed, so we don't have a useable
1079 * local address. Fallback: generate an address that will prevent
1080 * the server from calling us back.
1081 *
1082 * Returns zero and fills in "buf" if successful; otherwise, a
1083 * negative errno is returned.
1084 */
1085static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1086{
1087 switch (family) {
1088 case AF_INET:
1089 if (buflen < sizeof(rpc_inaddr_loopback))
1090 return -EINVAL;
1091 memcpy(buf, &rpc_inaddr_loopback,
1092 sizeof(rpc_inaddr_loopback));
1093 break;
1094 case AF_INET6:
1095 if (buflen < sizeof(rpc_in6addr_loopback))
1096 return -EINVAL;
1097 memcpy(buf, &rpc_in6addr_loopback,
1098 sizeof(rpc_in6addr_loopback));
1099 default:
1100 dprintk("RPC: %s: address family not supported\n",
1101 __func__);
1102 return -EAFNOSUPPORT;
1103 }
1104 dprintk("RPC: %s: succeeded\n", __func__);
1105 return 0;
1106}
1107
1108/**
1109 * rpc_localaddr - discover local endpoint address for an RPC client
1110 * @clnt: RPC client structure
1111 * @buf: target buffer
1112 * @buflen: size of target buffer, in bytes
1113 *
1114 * Returns zero and fills in "buf" and "buflen" if successful;
1115 * otherwise, a negative errno is returned.
1116 *
1117 * This works even if the underlying transport is not currently connected,
1118 * or if the upper layer never previously provided a source address.
1119 *
1120 * The result of this function call is transient: multiple calls in
1121 * succession may give different results, depending on how local
1122 * networking configuration changes over time.
1123 */
1124int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1125{
1126 struct sockaddr_storage address;
1127 struct sockaddr *sap = (struct sockaddr *)&address;
1128 struct rpc_xprt *xprt;
1129 struct net *net;
1130 size_t salen;
1131 int err;
1132
1133 rcu_read_lock();
1134 xprt = rcu_dereference(clnt->cl_xprt);
1135 salen = xprt->addrlen;
1136 memcpy(sap, &xprt->addr, salen);
1137 net = get_net(xprt->xprt_net);
1138 rcu_read_unlock();
1139
1140 rpc_set_port(sap, 0);
1141 err = rpc_sockname(net, sap, salen, buf, buflen);
1142 put_net(net);
1143 if (err != 0)
1144 /* Couldn't discover local address, return ANYADDR */
1145 return rpc_anyaddr(sap->sa_family, buf, buflen);
1146 return 0;
1147}
1148EXPORT_SYMBOL_GPL(rpc_localaddr);
1149
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150void
1151rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1152{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001153 struct rpc_xprt *xprt;
1154
1155 rcu_read_lock();
1156 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001157 if (xprt->ops->set_buffer_size)
1158 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001159 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001161EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
Trond Myklebust2446ab62012-03-01 17:00:56 -05001163/**
1164 * rpc_protocol - Get transport protocol number for an RPC client
1165 * @clnt: RPC client to query
1166 *
1167 */
1168int rpc_protocol(struct rpc_clnt *clnt)
1169{
1170 int protocol;
1171
1172 rcu_read_lock();
1173 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1174 rcu_read_unlock();
1175 return protocol;
1176}
1177EXPORT_SYMBOL_GPL(rpc_protocol);
1178
1179/**
1180 * rpc_net_ns - Get the network namespace for this RPC client
1181 * @clnt: RPC client to query
1182 *
1183 */
1184struct net *rpc_net_ns(struct rpc_clnt *clnt)
1185{
1186 struct net *ret;
1187
1188 rcu_read_lock();
1189 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1190 rcu_read_unlock();
1191 return ret;
1192}
1193EXPORT_SYMBOL_GPL(rpc_net_ns);
1194
1195/**
1196 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1197 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 *
1199 * For stream transports, this is one RPC record fragment (see RFC
1200 * 1831), as we don't support multi-record requests yet. For datagram
1201 * transports, this is the size of an IP packet minus the IP, UDP, and
1202 * RPC header sizes.
1203 */
1204size_t rpc_max_payload(struct rpc_clnt *clnt)
1205{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001206 size_t ret;
1207
1208 rcu_read_lock();
1209 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1210 rcu_read_unlock();
1211 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212}
Chuck Leverb86acd52006-08-22 20:06:22 -04001213EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
Chuck Lever35f5a422006-01-03 09:55:50 +01001215/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001216 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001217 * @clnt: RPC client to query
1218 */
1219unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1220{
1221 unsigned long ret;
1222
1223 rcu_read_lock();
1224 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1225 rcu_read_unlock();
1226 return ret;
1227}
1228EXPORT_SYMBOL_GPL(rpc_get_timeout);
1229
1230/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001231 * rpc_force_rebind - force transport to check that remote port is unchanged
1232 * @clnt: client to rebind
1233 *
1234 */
1235void rpc_force_rebind(struct rpc_clnt *clnt)
1236{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001237 if (clnt->cl_autobind) {
1238 rcu_read_lock();
1239 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1240 rcu_read_unlock();
1241 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001242}
Chuck Leverb86acd52006-08-22 20:06:22 -04001243EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001244
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001246 * Restart an (async) RPC call from the call_prepare state.
1247 * Usually called from within the exit handler.
1248 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001249int
Andy Adamsonaae20062009-04-01 09:22:40 -04001250rpc_restart_call_prepare(struct rpc_task *task)
1251{
1252 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001253 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001254 task->tk_action = call_start;
1255 if (task->tk_ops->rpc_call_prepare != NULL)
1256 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001257 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001258}
1259EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1260
1261/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 * Restart an (async) RPC call. Usually called from within the
1263 * exit handler.
1264 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001265int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266rpc_restart_call(struct rpc_task *task)
1267{
1268 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001269 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001271 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001273EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274
Chuck Lever3748f1e2008-05-21 17:09:12 -04001275#ifdef RPC_DEBUG
1276static const char *rpc_proc_name(const struct rpc_task *task)
1277{
1278 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1279
1280 if (proc) {
1281 if (proc->p_name)
1282 return proc->p_name;
1283 else
1284 return "NULL";
1285 } else
1286 return "no proc";
1287}
1288#endif
1289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290/*
1291 * 0. Initial state
1292 *
1293 * Other FSM states can be visited zero or more times, but
1294 * this state is visited exactly once for each RPC.
1295 */
1296static void
1297call_start(struct rpc_task *task)
1298{
1299 struct rpc_clnt *clnt = task->tk_client;
1300
Chuck Lever3748f1e2008-05-21 17:09:12 -04001301 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001302 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001303 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001304 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305
1306 /* Increment call count */
1307 task->tk_msg.rpc_proc->p_count++;
1308 clnt->cl_stats->rpccnt++;
1309 task->tk_action = call_reserve;
1310}
1311
1312/*
1313 * 1. Reserve an RPC call slot
1314 */
1315static void
1316call_reserve(struct rpc_task *task)
1317{
Chuck Lever46121cf2007-01-31 12:14:08 -05001318 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 task->tk_status = 0;
1321 task->tk_action = call_reserveresult;
1322 xprt_reserve(task);
1323}
1324
Trond Myklebustba60eb22013-04-14 10:49:37 -04001325static void call_retry_reserve(struct rpc_task *task);
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327/*
1328 * 1b. Grok the result of xprt_reserve()
1329 */
1330static void
1331call_reserveresult(struct rpc_task *task)
1332{
1333 int status = task->tk_status;
1334
Chuck Lever46121cf2007-01-31 12:14:08 -05001335 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
1337 /*
1338 * After a call to xprt_reserve(), we must have either
1339 * a request slot or else an error status.
1340 */
1341 task->tk_status = 0;
1342 if (status >= 0) {
1343 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001344 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 return;
1346 }
1347
1348 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001349 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 rpc_exit(task, -EIO);
1351 return;
1352 }
1353
1354 /*
1355 * Even though there was an error, we may have acquired
1356 * a request slot somehow. Make sure not to leak it.
1357 */
1358 if (task->tk_rqstp) {
1359 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001360 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 xprt_release(task);
1362 }
1363
1364 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001365 case -ENOMEM:
1366 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001368 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 return;
1370 case -EIO: /* probably a shutdown */
1371 break;
1372 default:
1373 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001374 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 break;
1376 }
1377 rpc_exit(task, status);
1378}
1379
1380/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001381 * 1c. Retry reserving an RPC call slot
1382 */
1383static void
1384call_retry_reserve(struct rpc_task *task)
1385{
1386 dprint_status(task);
1387
1388 task->tk_status = 0;
1389 task->tk_action = call_reserveresult;
1390 xprt_retry_reserve(task);
1391}
1392
1393/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001394 * 2. Bind and/or refresh the credentials
1395 */
1396static void
1397call_refresh(struct rpc_task *task)
1398{
1399 dprint_status(task);
1400
1401 task->tk_action = call_refreshresult;
1402 task->tk_status = 0;
1403 task->tk_client->cl_stats->rpcauthrefresh++;
1404 rpcauth_refreshcred(task);
1405}
1406
1407/*
1408 * 2a. Process the results of a credential refresh
1409 */
1410static void
1411call_refreshresult(struct rpc_task *task)
1412{
1413 int status = task->tk_status;
1414
1415 dprint_status(task);
1416
1417 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001418 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001419 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001420 case 0:
1421 if (rpcauth_uptodatecred(task))
1422 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001423 return;
1424 case -ETIMEDOUT:
1425 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001426 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001427 case -EAGAIN:
1428 status = -EACCES;
1429 if (!task->tk_cred_retry)
1430 break;
1431 task->tk_cred_retry--;
1432 dprintk("RPC: %5u %s: retry refresh creds\n",
1433 task->tk_pid, __func__);
1434 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001435 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001436 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1437 task->tk_pid, __func__, status);
1438 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001439}
1440
1441/*
1442 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001443 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 */
1445static void
1446call_allocate(struct rpc_task *task)
1447{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001448 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001449 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001450 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001451 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452
Chuck Lever46121cf2007-01-31 12:14:08 -05001453 dprint_status(task);
1454
Chuck Lever2bea90d2007-03-29 16:47:53 -04001455 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001456 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001457
Chuck Lever02107142006-01-03 09:55:49 +01001458 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 return;
1460
Chuck Lever2bea90d2007-03-29 16:47:53 -04001461 if (proc->p_proc != 0) {
1462 BUG_ON(proc->p_arglen == 0);
1463 if (proc->p_decode != NULL)
1464 BUG_ON(proc->p_replen == 0);
1465 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Chuck Lever2bea90d2007-03-29 16:47:53 -04001467 /*
1468 * Calculate the size (in quads) of the RPC call
1469 * and reply headers, and convert both values
1470 * to byte sizes.
1471 */
1472 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1473 req->rq_callsize <<= 2;
1474 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1475 req->rq_rcvsize <<= 2;
1476
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001477 req->rq_buffer = xprt->ops->buf_alloc(task,
1478 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001479 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001481
1482 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
Trond Myklebust5afa91332011-06-17 10:14:59 -04001484 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001485 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 rpc_delay(task, HZ>>4);
1487 return;
1488 }
1489
1490 rpc_exit(task, -ERESTARTSYS);
1491}
1492
Trond Myklebust940e3312005-11-09 21:45:24 -05001493static inline int
1494rpc_task_need_encode(struct rpc_task *task)
1495{
1496 return task->tk_rqstp->rq_snd_buf.len == 0;
1497}
1498
1499static inline void
1500rpc_task_force_reencode(struct rpc_task *task)
1501{
1502 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001503 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001504}
1505
Chuck Lever2bea90d2007-03-29 16:47:53 -04001506static inline void
1507rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1508{
1509 buf->head[0].iov_base = start;
1510 buf->head[0].iov_len = len;
1511 buf->tail[0].iov_len = 0;
1512 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001513 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001514 buf->len = 0;
1515 buf->buflen = len;
1516}
1517
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518/*
1519 * 3. Encode arguments of an RPC call
1520 */
1521static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001522rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001525 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001526 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Chuck Lever46121cf2007-01-31 12:14:08 -05001528 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Chuck Lever2bea90d2007-03-29 16:47:53 -04001530 rpc_xdr_buf_init(&req->rq_snd_buf,
1531 req->rq_buffer,
1532 req->rq_callsize);
1533 rpc_xdr_buf_init(&req->rq_rcv_buf,
1534 (char *)req->rq_buffer + req->rq_callsize,
1535 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Chuck Leverb0e1c572008-05-21 17:09:19 -04001537 p = rpc_encode_header(task);
1538 if (p == NULL) {
1539 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 rpc_exit(task, -EIO);
1541 return;
1542 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001543
1544 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001545 if (encode == NULL)
1546 return;
1547
1548 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1549 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550}
1551
1552/*
1553 * 4. Get the server port number if not yet set
1554 */
1555static void
1556call_bind(struct rpc_task *task)
1557{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001558 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Chuck Lever46121cf2007-01-31 12:14:08 -05001560 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Chuck Leverda351872005-08-11 16:25:11 -04001562 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001563 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001564 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001565 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001566 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 }
1568}
1569
1570/*
Chuck Leverda351872005-08-11 16:25:11 -04001571 * 4a. Sort out bind result
1572 */
1573static void
1574call_bind_status(struct rpc_task *task)
1575{
Chuck Lever906462a2007-09-11 18:00:47 -04001576 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001577
1578 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001579 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001580 task->tk_status = 0;
1581 task->tk_action = call_connect;
1582 return;
1583 }
1584
Steve Dickson5753cba2012-02-06 10:08:08 -05001585 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001586 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001587 case -ENOMEM:
1588 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1589 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001590 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001591 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001592 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1593 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001594 /* fail immediately if this is an RPC ping */
1595 if (task->tk_msg.rpc_proc->p_proc == 0) {
1596 status = -EOPNOTSUPP;
1597 break;
1598 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001599 if (task->tk_rebind_retry == 0)
1600 break;
1601 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001602 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001603 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001604 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001605 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001606 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001607 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001608 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001609 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001610 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001611 task->tk_pid);
1612 break;
1613 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001614 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001615 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001616 task->tk_status = 0;
1617 task->tk_action = call_bind;
1618 return;
Chuck Lever012da152009-12-03 15:58:56 -05001619 case -ECONNREFUSED: /* connection problems */
1620 case -ECONNRESET:
1621 case -ENOTCONN:
1622 case -EHOSTDOWN:
1623 case -EHOSTUNREACH:
1624 case -ENETUNREACH:
1625 case -EPIPE:
1626 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1627 task->tk_pid, task->tk_status);
1628 if (!RPC_IS_SOFTCONN(task)) {
1629 rpc_delay(task, 5*HZ);
1630 goto retry_timeout;
1631 }
1632 status = task->tk_status;
1633 break;
Chuck Leverda351872005-08-11 16:25:11 -04001634 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001635 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001636 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001637 }
1638
1639 rpc_exit(task, status);
1640 return;
1641
Trond Myklebustda458282006-08-31 15:44:52 -04001642retry_timeout:
1643 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001644}
1645
1646/*
1647 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 */
1649static void
1650call_connect(struct rpc_task *task)
1651{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001652 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653
Chuck Lever46121cf2007-01-31 12:14:08 -05001654 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001655 task->tk_pid, xprt,
1656 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Chuck Leverda351872005-08-11 16:25:11 -04001658 task->tk_action = call_transmit;
1659 if (!xprt_connected(xprt)) {
1660 task->tk_action = call_connect_status;
1661 if (task->tk_status < 0)
1662 return;
1663 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665}
1666
1667/*
Chuck Leverda351872005-08-11 16:25:11 -04001668 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 */
1670static void
1671call_connect_status(struct rpc_task *task)
1672{
1673 struct rpc_clnt *clnt = task->tk_client;
1674 int status = task->tk_status;
1675
Chuck Lever46121cf2007-01-31 12:14:08 -05001676 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001677
Steve Dickson5753cba2012-02-06 10:08:08 -05001678 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001680 /* if soft mounted, test if we've timed out */
1681 case -ETIMEDOUT:
1682 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001683 return;
1684 case -ECONNREFUSED:
1685 case -ECONNRESET:
1686 case -ENETUNREACH:
1687 if (RPC_IS_SOFTCONN(task))
1688 break;
1689 /* retry with existing socket, after a delay */
1690 case 0:
1691 case -EAGAIN:
1692 task->tk_status = 0;
1693 clnt->cl_stats->netreconn++;
1694 task->tk_action = call_transmit;
1695 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001697 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698}
1699
1700/*
1701 * 5. Transmit the RPC request, and wait for reply
1702 */
1703static void
1704call_transmit(struct rpc_task *task)
1705{
Chuck Lever46121cf2007-01-31 12:14:08 -05001706 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
1708 task->tk_action = call_status;
1709 if (task->tk_status < 0)
1710 return;
1711 task->tk_status = xprt_prepare_transmit(task);
1712 if (task->tk_status != 0)
1713 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001714 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001716 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001717 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001718 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001719 if (task->tk_status != 0) {
1720 /* Was the error nonfatal? */
1721 if (task->tk_status == -EAGAIN)
1722 rpc_delay(task, HZ >> 4);
1723 else
1724 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001725 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001726 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001727 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 xprt_transmit(task);
1729 if (task->tk_status < 0)
1730 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001731 /*
1732 * On success, ensure that we call xprt_end_transmit() before sleeping
1733 * in order to allow access to the socket to other RPC requests.
1734 */
1735 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001736 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001737 return;
1738 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001739 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001740}
1741
1742/*
1743 * 5a. Handle cleanup after a transmission
1744 */
1745static void
1746call_transmit_status(struct rpc_task *task)
1747{
1748 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001749
1750 /*
1751 * Common case: success. Force the compiler to put this
1752 * test first.
1753 */
1754 if (task->tk_status == 0) {
1755 xprt_end_transmit(task);
1756 rpc_task_force_reencode(task);
1757 return;
1758 }
1759
Trond Myklebust15f081c2009-03-11 14:37:57 -04001760 switch (task->tk_status) {
1761 case -EAGAIN:
1762 break;
1763 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001764 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001765 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001766 rpc_task_force_reencode(task);
1767 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001768 /*
1769 * Special cases: if we've been waiting on the
1770 * socket's write_space() callback, or if the
1771 * socket just returned a connection error,
1772 * then hold onto the transport lock.
1773 */
1774 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001775 case -EHOSTDOWN:
1776 case -EHOSTUNREACH:
1777 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001778 if (RPC_IS_SOFTCONN(task)) {
1779 xprt_end_transmit(task);
1780 rpc_exit(task, task->tk_status);
1781 break;
1782 }
1783 case -ECONNRESET:
1784 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001785 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001786 rpc_task_force_reencode(task);
1787 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
1789
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001790#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001791/*
1792 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1793 * addition, disconnect on connectivity errors.
1794 */
1795static void
1796call_bc_transmit(struct rpc_task *task)
1797{
1798 struct rpc_rqst *req = task->tk_rqstp;
1799
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001800 task->tk_status = xprt_prepare_transmit(task);
1801 if (task->tk_status == -EAGAIN) {
1802 /*
1803 * Could not reserve the transport. Try again after the
1804 * transport is released.
1805 */
1806 task->tk_status = 0;
1807 task->tk_action = call_bc_transmit;
1808 return;
1809 }
1810
1811 task->tk_action = rpc_exit_task;
1812 if (task->tk_status < 0) {
1813 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1814 "error: %d\n", task->tk_status);
1815 return;
1816 }
1817
1818 xprt_transmit(task);
1819 xprt_end_transmit(task);
1820 dprint_status(task);
1821 switch (task->tk_status) {
1822 case 0:
1823 /* Success */
1824 break;
1825 case -EHOSTDOWN:
1826 case -EHOSTUNREACH:
1827 case -ENETUNREACH:
1828 case -ETIMEDOUT:
1829 /*
1830 * Problem reaching the server. Disconnect and let the
1831 * forechannel reestablish the connection. The server will
1832 * have to retransmit the backchannel request and we'll
1833 * reprocess it. Since these ops are idempotent, there's no
1834 * need to cache our reply at this time.
1835 */
1836 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1837 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001838 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001839 req->rq_connect_cookie);
1840 break;
1841 default:
1842 /*
1843 * We were unable to reply and will have to drop the
1844 * request. The server should reconnect and retransmit.
1845 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001846 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001847 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1848 "error: %d\n", task->tk_status);
1849 break;
1850 }
1851 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1852}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001853#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001854
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855/*
1856 * 6. Sort out the RPC call status
1857 */
1858static void
1859call_status(struct rpc_task *task)
1860{
1861 struct rpc_clnt *clnt = task->tk_client;
1862 struct rpc_rqst *req = task->tk_rqstp;
1863 int status;
1864
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001865 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1866 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867
Chuck Lever46121cf2007-01-31 12:14:08 -05001868 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
1870 status = task->tk_status;
1871 if (status >= 0) {
1872 task->tk_action = call_decode;
1873 return;
1874 }
1875
Steve Dickson5753cba2012-02-06 10:08:08 -05001876 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 task->tk_status = 0;
1878 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001879 case -EHOSTDOWN:
1880 case -EHOSTUNREACH:
1881 case -ENETUNREACH:
1882 /*
1883 * Delay any retries for 3 seconds, then handle as if it
1884 * were a timeout.
1885 */
1886 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 case -ETIMEDOUT:
1888 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001889 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001890 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001891 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001893 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001895 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001896 rpc_delay(task, 3*HZ);
1897 case -EPIPE:
1898 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 task->tk_action = call_bind;
1900 break;
1901 case -EAGAIN:
1902 task->tk_action = call_transmit;
1903 break;
1904 case -EIO:
1905 /* shutdown or soft timeout */
1906 rpc_exit(task, status);
1907 break;
1908 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001909 if (clnt->cl_chatty)
1910 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 clnt->cl_protname, -status);
1912 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 }
1914}
1915
1916/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001917 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 * We do not release the request slot, so we keep using the
1919 * same XID for all retransmits.
1920 */
1921static void
1922call_timeout(struct rpc_task *task)
1923{
1924 struct rpc_clnt *clnt = task->tk_client;
1925
1926 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001927 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 goto retry;
1929 }
1930
Chuck Lever46121cf2007-01-31 12:14:08 -05001931 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001932 task->tk_timeouts++;
1933
Chuck Lever3a28bec2009-12-03 15:58:56 -05001934 if (RPC_IS_SOFTCONN(task)) {
1935 rpc_exit(task, -ETIMEDOUT);
1936 return;
1937 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001939 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001940 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001941 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001942 clnt->cl_protname,
1943 rcu_dereference(clnt->cl_xprt)->servername);
1944 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001945 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001946 if (task->tk_flags & RPC_TASK_TIMEOUT)
1947 rpc_exit(task, -ETIMEDOUT);
1948 else
1949 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 return;
1951 }
1952
Chuck Leverf518e35a2006-01-03 09:55:52 +01001953 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001955 if (clnt->cl_chatty) {
1956 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001957 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001958 clnt->cl_protname,
1959 rcu_dereference(clnt->cl_xprt)->servername);
1960 rcu_read_unlock();
1961 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001963 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001964 /*
1965 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1966 * event? RFC2203 requires the server to drop all such requests.
1967 */
1968 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
1970retry:
1971 clnt->cl_stats->rpcretrans++;
1972 task->tk_action = call_bind;
1973 task->tk_status = 0;
1974}
1975
1976/*
1977 * 7. Decode the RPC reply
1978 */
1979static void
1980call_decode(struct rpc_task *task)
1981{
1982 struct rpc_clnt *clnt = task->tk_client;
1983 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001984 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001985 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986
Vasily Averin726fd6a2011-06-01 16:23:59 +04001987 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988
Chuck Leverf518e35a2006-01-03 09:55:52 +01001989 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001990 if (clnt->cl_chatty) {
1991 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001992 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001993 clnt->cl_protname,
1994 rcu_dereference(clnt->cl_xprt)->servername);
1995 rcu_read_unlock();
1996 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1998 }
1999
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002000 /*
2001 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002002 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002003 */
2004 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 req->rq_rcv_buf.len = req->rq_private_buf.len;
2006
2007 /* Check that the softirq receive buffer is valid */
2008 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2009 sizeof(req->rq_rcv_buf)) != 0);
2010
Trond Myklebust1e799b62008-03-21 16:19:41 -04002011 if (req->rq_rcv_buf.len < 12) {
2012 if (!RPC_IS_SOFT(task)) {
2013 task->tk_action = call_bind;
2014 clnt->cl_stats->rpcretrans++;
2015 goto out_retry;
2016 }
2017 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2018 clnt->cl_protname, task->tk_status);
2019 task->tk_action = call_timeout;
2020 goto out_retry;
2021 }
2022
Chuck Leverb0e1c572008-05-21 17:09:19 -04002023 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002024 if (IS_ERR(p)) {
2025 if (p == ERR_PTR(-EAGAIN))
2026 goto out_retry;
2027 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 }
2029
Trond Myklebustabbcf282006-01-03 09:55:03 +01002030 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002032 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2034 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002035 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002036 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2037 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 return;
2039out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002041 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002042 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002043 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002044 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002045 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002046 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002047 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048}
2049
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002050static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002051rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052{
2053 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002055 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056
2057 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002058
Trond Myklebusta4f08352013-01-08 09:10:21 -05002059 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 *p++ = req->rq_xid; /* XID */
2061 *p++ = htonl(RPC_CALL); /* CALL */
2062 *p++ = htonl(RPC_VERSION); /* RPC version */
2063 *p++ = htonl(clnt->cl_prog); /* program number */
2064 *p++ = htonl(clnt->cl_vers); /* program version */
2065 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002066 p = rpcauth_marshcred(task, p);
2067 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2068 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069}
2070
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002071static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002072rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002074 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2076 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002077 __be32 *p = iov->iov_base;
2078 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 int error = -EACCES;
2080
David Howellse8896492006-08-24 15:44:19 -04002081 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2082 /* RFC-1014 says that the representation of XDR data must be a
2083 * multiple of four bytes
2084 * - if it isn't pointer subtraction in the NFS client may give
2085 * undefined results
2086 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002087 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002088 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002089 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002090 goto out_eio;
2091 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 if ((len -= 3) < 0)
2093 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002095 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002097 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002098 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002099 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002101
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2103 if (--len < 0)
2104 goto out_overflow;
2105 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002106 case RPC_AUTH_ERROR:
2107 break;
2108 case RPC_MISMATCH:
2109 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2110 task->tk_pid, __func__);
2111 error = -EPROTONOSUPPORT;
2112 goto out_err;
2113 default:
2114 dprintk("RPC: %5u %s: RPC call rejected, "
2115 "unknown error: %x\n",
2116 task->tk_pid, __func__, n);
2117 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 }
2119 if (--len < 0)
2120 goto out_overflow;
2121 switch ((n = ntohl(*p++))) {
2122 case RPC_AUTH_REJECTEDCRED:
2123 case RPC_AUTH_REJECTEDVERF:
2124 case RPCSEC_GSS_CREDPROBLEM:
2125 case RPCSEC_GSS_CTXPROBLEM:
2126 if (!task->tk_cred_retry)
2127 break;
2128 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002129 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002130 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002132 /* Ensure we obtain a new XID! */
2133 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002134 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002135 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 case RPC_AUTH_BADCRED:
2137 case RPC_AUTH_BADVERF:
2138 /* possibly garbled cred/verf? */
2139 if (!task->tk_garb_retry)
2140 break;
2141 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002142 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002143 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002145 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002147 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002148 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002149 "authentication.\n",
2150 rcu_dereference(clnt->cl_xprt)->servername);
2151 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 break;
2153 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002154 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002155 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 error = -EIO;
2157 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002158 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002159 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 goto out_err;
2161 }
2162 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002163 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002164 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002165 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002167 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 if (len < 0)
2169 goto out_overflow;
2170 switch ((n = ntohl(*p++))) {
2171 case RPC_SUCCESS:
2172 return p;
2173 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002174 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2175 "by server %s\n", task->tk_pid, __func__,
2176 (unsigned int)clnt->cl_prog,
2177 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002178 error = -EPFNOSUPPORT;
2179 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002181 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2182 "by server %s\n", task->tk_pid, __func__,
2183 (unsigned int)clnt->cl_prog,
2184 (unsigned int)clnt->cl_vers,
2185 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002186 error = -EPROTONOSUPPORT;
2187 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002189 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002190 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002191 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002192 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002193 clnt->cl_prog, clnt->cl_vers,
2194 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002195 error = -EOPNOTSUPP;
2196 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002198 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002199 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 break; /* retry */
2201 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002202 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002203 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 /* Also retry */
2205 }
2206
Trond Myklebustabbcf282006-01-03 09:55:03 +01002207out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002208 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 if (task->tk_garb_retry) {
2210 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002211 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002212 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002214out_retry:
2215 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217out_eio:
2218 error = -EIO;
2219out_err:
2220 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002221 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002222 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002223 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002225 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002226 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002227 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002229
Chuck Lever9f06c712010-12-14 14:59:18 +00002230static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002231{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002232}
2233
Chuck Leverbf269552010-12-14 14:59:29 +00002234static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002235{
2236 return 0;
2237}
2238
2239static struct rpc_procinfo rpcproc_null = {
2240 .p_encode = rpcproc_encode_null,
2241 .p_decode = rpcproc_decode_null,
2242};
2243
Chuck Levercaabea82009-12-03 15:58:56 -05002244static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002245{
2246 struct rpc_message msg = {
2247 .rpc_proc = &rpcproc_null,
2248 };
2249 int err;
2250 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002251 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002252 put_rpccred(msg.rpc_cred);
2253 return err;
2254}
Trond Myklebust188fef12007-06-16 14:18:40 -04002255
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002256struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2257{
2258 struct rpc_message msg = {
2259 .rpc_proc = &rpcproc_null,
2260 .rpc_cred = cred,
2261 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002262 struct rpc_task_setup task_setup_data = {
2263 .rpc_client = clnt,
2264 .rpc_message = &msg,
2265 .callback_ops = &rpc_default_ops,
2266 .flags = flags,
2267 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002268 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002269}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002270EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002271
Trond Myklebust188fef12007-06-16 14:18:40 -04002272#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002273static void rpc_show_header(void)
2274{
Chuck Levercb3997b2008-05-21 17:09:41 -04002275 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2276 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002277}
2278
Chuck Lever38e886e2008-05-21 17:09:33 -04002279static void rpc_show_task(const struct rpc_clnt *clnt,
2280 const struct rpc_task *task)
2281{
2282 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002283
2284 if (RPC_IS_QUEUED(task))
2285 rpc_waitq = rpc_qname(task->tk_waitqueue);
2286
Joe Perchesb3bceda2010-12-21 10:52:24 -05002287 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 -04002288 task->tk_pid, task->tk_flags, task->tk_status,
2289 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2290 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002291 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002292}
2293
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002294void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002295{
2296 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002297 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002298 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002299 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002300
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002301 spin_lock(&sn->rpc_client_lock);
2302 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002303 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002304 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002305 if (!header) {
2306 rpc_show_header();
2307 header++;
2308 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002309 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002310 }
2311 spin_unlock(&clnt->cl_lock);
2312 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002313 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002314}
2315#endif