blob: 759b78b056a77679de85014c21c3ccd8e996e22d [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>
Trond Myklebust40b00b6b2013-10-17 14:12:23 -040028#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050034#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050037#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050039#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040040#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050041#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040043#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040044#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#ifdef RPC_DEBUG
47# define RPCDBG_FACILITY RPCDBG_CALL
48#endif
49
Chuck Lever46121cf2007-01-31 12:14:08 -050050#define dprint_status(t) \
51 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080052 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050053
Trond Myklebust188fef12007-06-16 14:18:40 -040054/*
55 * All RPC clients are linked into this list
56 */
Trond Myklebust188fef12007-06-16 14:18:40 -040057
Linus Torvalds1da177e2005-04-16 15:20:36 -070058static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
59
60
61static void call_start(struct rpc_task *task);
62static void call_reserve(struct rpc_task *task);
63static void call_reserveresult(struct rpc_task *task);
64static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065static void call_decode(struct rpc_task *task);
66static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040067static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040069#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040070static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040071#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050073static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074static void call_refresh(struct rpc_task *task);
75static void call_refreshresult(struct rpc_task *task);
76static void call_timeout(struct rpc_task *task);
77static void call_connect(struct rpc_task *task);
78static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Chuck Leverb0e1c572008-05-21 17:09:19 -040080static __be32 *rpc_encode_header(struct rpc_task *task);
81static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050082static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040083
Trond Myklebust188fef12007-06-16 14:18:40 -040084static void rpc_register_client(struct rpc_clnt *clnt)
85{
Trond Myklebust2446ab62012-03-01 17:00:56 -050086 struct net *net = rpc_net_ns(clnt);
87 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040088
89 spin_lock(&sn->rpc_client_lock);
90 list_add(&clnt->cl_clients, &sn->all_clients);
91 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040092}
93
94static void rpc_unregister_client(struct rpc_clnt *clnt)
95{
Trond Myklebust2446ab62012-03-01 17:00:56 -050096 struct net *net = rpc_net_ns(clnt);
97 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040098
99 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400100 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400101 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400102}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400104static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
105{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400106 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400107}
108
109static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
110{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500111 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400113
Trond Myklebust2446ab62012-03-01 17:00:56 -0500114 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500117 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119}
120
121static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400122 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
Trond Myklebustf1345852005-09-23 11:08:25 -0400124 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400125 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400126 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400127 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400129 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400130 if (dir == NULL) {
131 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400132 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400133 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400134 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400135 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400136 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400137 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 if (!IS_ERR(dentry))
139 break;
Al Viroa95e6912013-07-14 16:43:54 +0400140 if (dentry == ERR_PTR(-EEXIST))
141 continue;
142 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
143 " %s/%s, error %ld\n",
144 dir_name, name, PTR_ERR(dentry));
145 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400146 }
147 dput(dir);
148 return dentry;
149}
150
151static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400152rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400153{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400154 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400155
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400156 if (clnt->cl_program->pipe_dir_name != NULL) {
157 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
158 if (IS_ERR(dentry))
159 return PTR_ERR(dentry);
160 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400161 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162}
163
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400164static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400165{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400166 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400167 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400168
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400169 switch (event) {
170 case RPC_PIPEFS_MOUNT:
171 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
172 return 1;
173 if (atomic_read(&clnt->cl_count) == 0)
174 return 1;
175 break;
176 case RPC_PIPEFS_UMOUNT:
177 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
178 return 1;
179 break;
180 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400181 return 0;
182}
183
184static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
185 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400186{
187 struct dentry *dentry;
188 int err = 0;
189
190 switch (event) {
191 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400192 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400193 if (!dentry)
194 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 if (IS_ERR(dentry))
196 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400197 break;
198 case RPC_PIPEFS_UMOUNT:
199 __rpc_clnt_remove_pipedir(clnt);
200 break;
201 default:
202 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
203 return -ENOTSUPP;
204 }
205 return err;
206}
207
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400208static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
209 struct super_block *sb)
210{
211 int error = 0;
212
213 for (;; clnt = clnt->cl_parent) {
214 if (!rpc_clnt_skip_event(clnt, event))
215 error = __rpc_clnt_handle_event(clnt, event, sb);
216 if (error || clnt == clnt->cl_parent)
217 break;
218 }
219 return error;
220}
221
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400222static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
223{
224 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
225 struct rpc_clnt *clnt;
226
227 spin_lock(&sn->rpc_client_lock);
228 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400229 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400231 spin_unlock(&sn->rpc_client_lock);
232 return clnt;
233 }
234 spin_unlock(&sn->rpc_client_lock);
235 return NULL;
236}
237
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400238static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
239 void *ptr)
240{
241 struct super_block *sb = ptr;
242 struct rpc_clnt *clnt;
243 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400245 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400246 error = __rpc_pipefs_event(clnt, event, sb);
247 if (error)
248 break;
249 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400250 return error;
251}
252
253static struct notifier_block rpc_clients_block = {
254 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400255 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400256};
257
258int rpc_clients_notifier_register(void)
259{
260 return rpc_pipefs_notifier_register(&rpc_clients_block);
261}
262
263void rpc_clients_notifier_unregister(void)
264{
265 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
266}
267
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400268static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
269 struct rpc_xprt *xprt,
270 const struct rpc_timeout *timeout)
271{
272 struct rpc_xprt *old;
273
274 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400275 old = rcu_dereference_protected(clnt->cl_xprt,
276 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400277
278 if (!xprt_bound(xprt))
279 clnt->cl_autobind = 1;
280
281 clnt->cl_timeout = timeout;
282 rcu_assign_pointer(clnt->cl_xprt, xprt);
283 spin_unlock(&clnt->cl_lock);
284
285 return old;
286}
287
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400288static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
289{
290 clnt->cl_nodelen = strlen(nodename);
291 if (clnt->cl_nodelen > UNX_MAXNODENAME)
292 clnt->cl_nodelen = UNX_MAXNODENAME;
293 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
294}
295
Chuck Leverd746e542013-10-17 14:12:17 -0400296static int rpc_client_register(struct rpc_clnt *clnt,
297 rpc_authflavor_t pseudoflavor,
298 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400299{
Trond Myklebustc2190662013-08-26 19:23:04 -0400300 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400301 .pseudoflavor = pseudoflavor,
302 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400303 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400304 struct rpc_auth *auth;
305 struct net *net = rpc_net_ns(clnt);
306 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400307 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400308
309 pipefs_sb = rpc_get_sb_net(net);
310 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400311 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400312 if (err)
313 goto out;
314 }
315
Trond Myklebusteeee2452013-07-10 15:33:01 -0400316 rpc_register_client(clnt);
317 if (pipefs_sb)
318 rpc_put_sb_net(net);
319
Trond Myklebustc2190662013-08-26 19:23:04 -0400320 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400321 if (IS_ERR(auth)) {
322 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400323 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400324 err = PTR_ERR(auth);
325 goto err_auth;
326 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400327 return 0;
328err_auth:
329 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400330 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400331 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400332out:
333 if (pipefs_sb)
334 rpc_put_sb_net(net);
335 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400336}
337
Trond Myklebust2f048db2013-09-04 21:51:44 -0400338static DEFINE_IDA(rpc_clids);
339
340static int rpc_alloc_clid(struct rpc_clnt *clnt)
341{
342 int clid;
343
344 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
345 if (clid < 0)
346 return clid;
347 clnt->cl_clid = clid;
348 return 0;
349}
350
351static void rpc_free_clid(struct rpc_clnt *clnt)
352{
353 ida_simple_remove(&rpc_clids, clnt->cl_clid);
354}
355
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400356static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
357 struct rpc_xprt *xprt,
358 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500360 const struct rpc_program *program = args->program;
361 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400362 struct rpc_clnt *clnt = NULL;
363 const struct rpc_timeout *timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400365
366 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500367 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500368 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Trond Myklebust4ada5392007-06-14 17:26:17 -0400370 err = rpciod_up();
371 if (err)
372 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500373
Trond Myklebustf05c1242013-04-05 14:13:21 -0400374 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500375 if (args->version >= program->nrvers)
376 goto out_err;
377 version = program->version[args->version];
378 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 goto out_err;
380
381 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700382 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 if (!clnt)
384 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400385 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Trond Myklebust2f048db2013-09-04 21:51:44 -0400387 err = rpc_alloc_clid(clnt);
388 if (err)
389 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 clnt->cl_procinfo = version->procs;
392 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300393 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500396 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400397 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500398 err = -ENOMEM;
399 if (clnt->cl_metrics == NULL)
400 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500401 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400402 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400403 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400405 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500406 if (args->timeout != NULL) {
407 memcpy(&clnt->cl_timeout_default, args->timeout,
408 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400409 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500410 }
411
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400412 rpc_clnt_set_transport(clnt, xprt, timeout);
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500415 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
Trond Myklebust006abe82010-09-12 19:55:25 -0400417 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400418
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400420 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400421
Chuck Leverd746e542013-10-17 14:12:17 -0400422 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400423 if (err)
424 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400425 if (parent)
426 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 return clnt;
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500430 rpc_free_iostats(clnt->cl_metrics);
431out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400432 rpc_free_clid(clnt);
433out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 kfree(clnt);
435out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400436 rpciod_down();
437out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400438 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 return ERR_PTR(err);
440}
441
Ben Hutchings2c530402012-07-10 10:55:09 +0000442/**
Chuck Leverc2866762006-08-22 20:06:20 -0400443 * rpc_create - create an RPC client and transport with one call
444 * @args: rpc_clnt create argument structure
445 *
446 * Creates and initializes an RPC transport and an RPC client.
447 *
448 * It can ping the server in order to determine if it is up, and to see if
449 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
450 * this behavior so asynchronous tasks can also use rpc_create.
451 */
452struct rpc_clnt *rpc_create(struct rpc_create_args *args)
453{
454 struct rpc_xprt *xprt;
455 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400456 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400457 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400458 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200459 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200460 .dstaddr = args->address,
461 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500462 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300463 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200464 };
Chuck Lever510deb02007-12-10 14:56:24 -0500465 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400466
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400467 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
468 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400469 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
470 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400471 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400472 * If the caller chooses not to specify a hostname, whip
473 * up a string representation of the passed-in address.
474 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500475 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400476 struct sockaddr_un *sun =
477 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400478 struct sockaddr_in *sin =
479 (struct sockaddr_in *)args->address;
480 struct sockaddr_in6 *sin6 =
481 (struct sockaddr_in6 *)args->address;
482
Chuck Lever510deb02007-12-10 14:56:24 -0500483 servername[0] = '\0';
484 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400485 case AF_LOCAL:
486 snprintf(servername, sizeof(servername), "%s",
487 sun->sun_path);
488 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400489 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700490 snprintf(servername, sizeof(servername), "%pI4",
491 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500492 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400493 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700494 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400495 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500496 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500497 default:
498 /* caller wants default server name, but
499 * address family isn't recognized. */
500 return ERR_PTR(-EINVAL);
501 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500502 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400503 }
504
Chuck Lever510deb02007-12-10 14:56:24 -0500505 xprt = xprt_create_transport(&xprtargs);
506 if (IS_ERR(xprt))
507 return (struct rpc_clnt *)xprt;
508
Chuck Lever43780b82007-07-01 12:13:22 -0400509 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400510 * By default, kernel RPC client connects from a reserved port.
511 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
512 * but it is always enabled for rpciod, which handles the connect
513 * operation.
514 */
515 xprt->resvport = 1;
516 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
517 xprt->resvport = 0;
518
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400519 clnt = rpc_new_client(args, xprt, NULL);
Chuck Leverc2866762006-08-22 20:06:20 -0400520 if (IS_ERR(clnt))
521 return clnt;
522
523 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500524 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400525 if (err != 0) {
526 rpc_shutdown_client(clnt);
527 return ERR_PTR(err);
528 }
529 }
530
531 clnt->cl_softrtry = 1;
532 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
533 clnt->cl_softrtry = 0;
534
Chuck Leverc2866762006-08-22 20:06:20 -0400535 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
536 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500537 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
538 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400539 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
540 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400541
542 return clnt;
543}
Chuck Leverb86acd52006-08-22 20:06:22 -0400544EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546/*
547 * This function clones the RPC client structure. It allows us to share the
548 * same transport while varying parameters such as the authentication
549 * flavour.
550 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400551static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
552 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500554 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400555 struct rpc_clnt *new;
556 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Chuck Lever1b63a752012-09-14 17:23:52 -0400558 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500559 rcu_read_lock();
560 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
561 rcu_read_unlock();
562 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400563 goto out_err;
564 args->servername = xprt->servername;
565
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400566 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400567 if (IS_ERR(new)) {
568 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400569 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400570 }
571
Chuck Lever1b63a752012-09-14 17:23:52 -0400572 /* Turn off autobind on clones */
573 new->cl_autobind = 0;
574 new->cl_softrtry = clnt->cl_softrtry;
575 new->cl_discrtry = clnt->cl_discrtry;
576 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400578
Chuck Lever1b63a752012-09-14 17:23:52 -0400579out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800580 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500581 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}
Chuck Lever1b63a752012-09-14 17:23:52 -0400583
584/**
585 * rpc_clone_client - Clone an RPC client structure
586 *
587 * @clnt: RPC client whose parameters are copied
588 *
589 * Returns a fresh RPC client or an ERR_PTR.
590 */
591struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
592{
593 struct rpc_create_args args = {
594 .program = clnt->cl_program,
595 .prognumber = clnt->cl_prog,
596 .version = clnt->cl_vers,
597 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400598 };
599 return __rpc_clone_client(&args, clnt);
600}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400601EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Chuck Leverba9b5842012-09-14 17:24:02 -0400603/**
604 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
605 *
606 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800607 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400608 *
609 * Returns a fresh RPC client or an ERR_PTR.
610 */
611struct rpc_clnt *
612rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
613{
614 struct rpc_create_args args = {
615 .program = clnt->cl_program,
616 .prognumber = clnt->cl_prog,
617 .version = clnt->cl_vers,
618 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400619 };
620 return __rpc_clone_client(&args, clnt);
621}
622EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
623
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400624/**
625 * rpc_switch_client_transport: switch the RPC transport on the fly
626 * @clnt: pointer to a struct rpc_clnt
627 * @args: pointer to the new transport arguments
628 * @timeout: pointer to the new timeout parameters
629 *
630 * This function allows the caller to switch the RPC transport for the
631 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
632 * server, for instance. It assumes that the caller has ensured that
633 * there are no active RPC tasks by using some form of locking.
634 *
635 * Returns zero if "clnt" is now using the new xprt. Otherwise a
636 * negative errno is returned, and "clnt" continues to use the old
637 * xprt.
638 */
639int rpc_switch_client_transport(struct rpc_clnt *clnt,
640 struct xprt_create *args,
641 const struct rpc_timeout *timeout)
642{
643 const struct rpc_timeout *old_timeo;
644 rpc_authflavor_t pseudoflavor;
645 struct rpc_xprt *xprt, *old;
646 struct rpc_clnt *parent;
647 int err;
648
649 xprt = xprt_create_transport(args);
650 if (IS_ERR(xprt)) {
651 dprintk("RPC: failed to create new xprt for clnt %p\n",
652 clnt);
653 return PTR_ERR(xprt);
654 }
655
656 pseudoflavor = clnt->cl_auth->au_flavor;
657
658 old_timeo = clnt->cl_timeout;
659 old = rpc_clnt_set_transport(clnt, xprt, timeout);
660
661 rpc_unregister_client(clnt);
662 __rpc_clnt_remove_pipedir(clnt);
663
664 /*
665 * A new transport was created. "clnt" therefore
666 * becomes the root of a new cl_parent tree. clnt's
667 * children, if it has any, still point to the old xprt.
668 */
669 parent = clnt->cl_parent;
670 clnt->cl_parent = clnt;
671
672 /*
673 * The old rpc_auth cache cannot be re-used. GSS
674 * contexts in particular are between a single
675 * client and server.
676 */
677 err = rpc_client_register(clnt, pseudoflavor, NULL);
678 if (err)
679 goto out_revert;
680
681 synchronize_rcu();
682 if (parent != clnt)
683 rpc_release_client(parent);
684 xprt_put(old);
685 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
686 return 0;
687
688out_revert:
689 rpc_clnt_set_transport(clnt, old, old_timeo);
690 clnt->cl_parent = parent;
691 rpc_client_register(clnt, pseudoflavor, NULL);
692 xprt_put(xprt);
693 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
694 return err;
695}
696EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
697
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400699 * Kill all tasks for the given client.
700 * XXX: kill their descendants as well?
701 */
702void rpc_killall_tasks(struct rpc_clnt *clnt)
703{
704 struct rpc_task *rovr;
705
706
707 if (list_empty(&clnt->cl_tasks))
708 return;
709 dprintk("RPC: killing all tasks for client %p\n", clnt);
710 /*
711 * Spin lock all_tasks to prevent changes...
712 */
713 spin_lock(&clnt->cl_lock);
714 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
715 if (!RPC_IS_ACTIVATED(rovr))
716 continue;
717 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
718 rovr->tk_flags |= RPC_TASK_KILLED;
719 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300720 if (RPC_IS_QUEUED(rovr))
721 rpc_wake_up_queued_task(rovr->tk_waitqueue,
722 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400723 }
724 }
725 spin_unlock(&clnt->cl_lock);
726}
727EXPORT_SYMBOL_GPL(rpc_killall_tasks);
728
729/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400731 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400733void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400735 might_sleep();
736
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500737 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400738 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500739 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
Trond Myklebust34f52e32007-06-14 16:40:31 -0400741 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800743 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400744 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 }
746
Trond Myklebust4c402b42007-06-14 16:40:32 -0400747 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400749EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
751/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400752 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400754static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400755rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500757 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400758 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500759 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500760 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400761 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400762 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400763 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500764 rpc_free_iostats(clnt->cl_metrics);
765 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500766 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400767 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400768 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770}
771
772/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400773 * Free an RPC client
774 */
775static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400776rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400777{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400778 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400779 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400780 return;
781 }
782
783 /*
784 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
785 * release remaining GSS contexts. This mechanism ensures
786 * that it can do so safely.
787 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400788 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400789 rpcauth_release(clnt->cl_auth);
790 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400791 if (atomic_dec_and_test(&clnt->cl_count))
792 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400793}
794
795/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400796 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 */
798void
799rpc_release_client(struct rpc_clnt *clnt)
800{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400801 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Trond Myklebust34f52e32007-06-14 16:40:31 -0400803 if (list_empty(&clnt->cl_tasks))
804 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400805 if (atomic_dec_and_test(&clnt->cl_count))
806 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400807}
Simo Sorce1d658332012-05-25 18:09:55 -0400808EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400809
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000810/**
811 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800812 * @old: old rpc_client
813 * @program: rpc program to set
814 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000815 *
816 * Clones the rpc client and sets up a new RPC program. This is mainly
817 * of use for enabling different RPC programs to share the same transport.
818 * The Sun NFSv2/v3 ACL protocol can do this.
819 */
820struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500821 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400822 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000823{
Trond Myklebustf994c432012-11-01 12:14:14 -0400824 struct rpc_create_args args = {
825 .program = program,
826 .prognumber = program->number,
827 .version = vers,
828 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400829 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000830 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000831 int err;
832
Trond Myklebustf994c432012-11-01 12:14:14 -0400833 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000834 if (IS_ERR(clnt))
835 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500836 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000837 if (err != 0) {
838 rpc_shutdown_client(clnt);
839 clnt = ERR_PTR(err);
840 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800841out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000842 return clnt;
843}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400844EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000845
Trond Myklebust58f96122010-07-31 14:29:08 -0400846void rpc_task_release_client(struct rpc_task *task)
847{
848 struct rpc_clnt *clnt = task->tk_client;
849
850 if (clnt != NULL) {
851 /* Remove from client task list */
852 spin_lock(&clnt->cl_lock);
853 list_del(&task->tk_task);
854 spin_unlock(&clnt->cl_lock);
855 task->tk_client = NULL;
856
857 rpc_release_client(clnt);
858 }
859}
860
861static
862void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
863{
864 if (clnt != NULL) {
865 rpc_task_release_client(task);
866 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400867 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400868 if (clnt->cl_softrtry)
869 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400870 if (clnt->cl_noretranstimeo)
871 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700872 if (sk_memalloc_socks()) {
873 struct rpc_xprt *xprt;
874
875 rcu_read_lock();
876 xprt = rcu_dereference(clnt->cl_xprt);
877 if (xprt->swapper)
878 task->tk_flags |= RPC_TASK_SWAPPER;
879 rcu_read_unlock();
880 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400881 /* Add to the client's list of all tasks */
882 spin_lock(&clnt->cl_lock);
883 list_add_tail(&task->tk_task, &clnt->cl_tasks);
884 spin_unlock(&clnt->cl_lock);
885 }
886}
887
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000888void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
889{
890 rpc_task_release_client(task);
891 rpc_task_set_client(task, clnt);
892}
893EXPORT_SYMBOL_GPL(rpc_task_reset_client);
894
895
Trond Myklebust58f96122010-07-31 14:29:08 -0400896static void
897rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
898{
899 if (msg != NULL) {
900 task->tk_msg.rpc_proc = msg->rpc_proc;
901 task->tk_msg.rpc_argp = msg->rpc_argp;
902 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400903 if (msg->rpc_cred != NULL)
904 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400905 }
906}
907
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908/*
909 * Default callback for async RPC calls
910 */
911static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100912rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
914}
915
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100916static const struct rpc_call_ops rpc_default_ops = {
917 .rpc_call_done = rpc_default_callback,
918};
919
Trond Myklebustc970aa82007-07-14 15:39:59 -0400920/**
921 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
922 * @task_setup_data: pointer to task initialisation data
923 */
924struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400925{
Trond Myklebust19445b92010-04-16 16:41:10 -0400926 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400927
Trond Myklebust84115e12007-07-14 15:39:59 -0400928 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400929 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400930 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400931
Trond Myklebust58f96122010-07-31 14:29:08 -0400932 rpc_task_set_client(task, task_setup_data->rpc_client);
933 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
934
Trond Myklebust58f96122010-07-31 14:29:08 -0400935 if (task->tk_action == NULL)
936 rpc_call_start(task);
937
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400938 atomic_inc(&task->tk_count);
939 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400940out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400941 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400942}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400943EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400944
945/**
946 * rpc_call_sync - Perform a synchronous RPC call
947 * @clnt: pointer to RPC client
948 * @msg: RPC call parameters
949 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500951int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952{
953 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400954 struct rpc_task_setup task_setup_data = {
955 .rpc_client = clnt,
956 .rpc_message = msg,
957 .callback_ops = &rpc_default_ops,
958 .flags = flags,
959 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400960 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400962 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
963 if (flags & RPC_TASK_ASYNC) {
964 rpc_release_calldata(task_setup_data.callback_ops,
965 task_setup_data.callback_data);
966 return -EINVAL;
967 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
Trond Myklebustc970aa82007-07-14 15:39:59 -0400969 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400970 if (IS_ERR(task))
971 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100972 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800973 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 return status;
975}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400976EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400978/**
979 * rpc_call_async - Perform an asynchronous RPC call
980 * @clnt: pointer to RPC client
981 * @msg: RPC call parameters
982 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800983 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400984 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 */
986int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500987rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100988 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989{
990 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400991 struct rpc_task_setup task_setup_data = {
992 .rpc_client = clnt,
993 .rpc_message = msg,
994 .callback_ops = tk_ops,
995 .callback_data = data,
996 .flags = flags|RPC_TASK_ASYNC,
997 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Trond Myklebustc970aa82007-07-14 15:39:59 -0400999 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001000 if (IS_ERR(task))
1001 return PTR_ERR(task);
1002 rpc_put_task(task);
1003 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001005EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001007#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001008/**
1009 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1010 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001011 * @req: RPC request
1012 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001013 */
1014struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001015 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001016{
1017 struct rpc_task *task;
1018 struct xdr_buf *xbufp = &req->rq_snd_buf;
1019 struct rpc_task_setup task_setup_data = {
1020 .callback_ops = tk_ops,
1021 };
1022
1023 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1024 /*
1025 * Create an rpc_task to send the data
1026 */
1027 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001028 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001029 xprt_free_bc_request(req);
1030 goto out;
1031 }
1032 task->tk_rqstp = req;
1033
1034 /*
1035 * Set up the xdr_buf length.
1036 * This also indicates that the buffer is XDR encoded already.
1037 */
1038 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1039 xbufp->tail[0].iov_len;
1040
1041 task->tk_action = call_bc_transmit;
1042 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001043 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001044 rpc_execute(task);
1045
1046out:
1047 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1048 return task;
1049}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001050#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001051
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001053rpc_call_start(struct rpc_task *task)
1054{
1055 task->tk_action = call_start;
1056}
1057EXPORT_SYMBOL_GPL(rpc_call_start);
1058
Chuck Levered394402006-08-22 20:06:17 -04001059/**
1060 * rpc_peeraddr - extract remote peer address from clnt's xprt
1061 * @clnt: RPC client structure
1062 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001063 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001064 *
1065 * Returns the number of bytes that are actually in the stored address.
1066 */
1067size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1068{
1069 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001070 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001071
Trond Myklebust2446ab62012-03-01 17:00:56 -05001072 rcu_read_lock();
1073 xprt = rcu_dereference(clnt->cl_xprt);
1074
1075 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001076 if (bytes > bufsize)
1077 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001078 memcpy(buf, &xprt->addr, bytes);
1079 rcu_read_unlock();
1080
1081 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001082}
Chuck Leverb86acd52006-08-22 20:06:22 -04001083EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001084
Chuck Leverf425eba2006-08-22 20:06:18 -04001085/**
1086 * rpc_peeraddr2str - return remote peer address in printable format
1087 * @clnt: RPC client structure
1088 * @format: address format
1089 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001090 * NB: the lifetime of the memory referenced by the returned pointer is
1091 * the same as the rpc_xprt itself. As long as the caller uses this
1092 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001093 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001094const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1095 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001096{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001097 struct rpc_xprt *xprt;
1098
1099 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001100
1101 if (xprt->address_strings[format] != NULL)
1102 return xprt->address_strings[format];
1103 else
1104 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001105}
Chuck Leverb86acd52006-08-22 20:06:22 -04001106EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001107
Chuck Lever2e738fd2012-03-01 17:01:14 -05001108static const struct sockaddr_in rpc_inaddr_loopback = {
1109 .sin_family = AF_INET,
1110 .sin_addr.s_addr = htonl(INADDR_ANY),
1111};
1112
1113static const struct sockaddr_in6 rpc_in6addr_loopback = {
1114 .sin6_family = AF_INET6,
1115 .sin6_addr = IN6ADDR_ANY_INIT,
1116};
1117
1118/*
1119 * Try a getsockname() on a connected datagram socket. Using a
1120 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1121 * This conserves the ephemeral port number space.
1122 *
1123 * Returns zero and fills in "buf" if successful; otherwise, a
1124 * negative errno is returned.
1125 */
1126static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1127 struct sockaddr *buf, int buflen)
1128{
1129 struct socket *sock;
1130 int err;
1131
1132 err = __sock_create(net, sap->sa_family,
1133 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1134 if (err < 0) {
1135 dprintk("RPC: can't create UDP socket (%d)\n", err);
1136 goto out;
1137 }
1138
1139 switch (sap->sa_family) {
1140 case AF_INET:
1141 err = kernel_bind(sock,
1142 (struct sockaddr *)&rpc_inaddr_loopback,
1143 sizeof(rpc_inaddr_loopback));
1144 break;
1145 case AF_INET6:
1146 err = kernel_bind(sock,
1147 (struct sockaddr *)&rpc_in6addr_loopback,
1148 sizeof(rpc_in6addr_loopback));
1149 break;
1150 default:
1151 err = -EAFNOSUPPORT;
1152 goto out;
1153 }
1154 if (err < 0) {
1155 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1156 goto out_release;
1157 }
1158
1159 err = kernel_connect(sock, sap, salen, 0);
1160 if (err < 0) {
1161 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1162 goto out_release;
1163 }
1164
1165 err = kernel_getsockname(sock, buf, &buflen);
1166 if (err < 0) {
1167 dprintk("RPC: getsockname failed (%d)\n", err);
1168 goto out_release;
1169 }
1170
1171 err = 0;
1172 if (buf->sa_family == AF_INET6) {
1173 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1174 sin6->sin6_scope_id = 0;
1175 }
1176 dprintk("RPC: %s succeeded\n", __func__);
1177
1178out_release:
1179 sock_release(sock);
1180out:
1181 return err;
1182}
1183
1184/*
1185 * Scraping a connected socket failed, so we don't have a useable
1186 * local address. Fallback: generate an address that will prevent
1187 * the server from calling us back.
1188 *
1189 * Returns zero and fills in "buf" if successful; otherwise, a
1190 * negative errno is returned.
1191 */
1192static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1193{
1194 switch (family) {
1195 case AF_INET:
1196 if (buflen < sizeof(rpc_inaddr_loopback))
1197 return -EINVAL;
1198 memcpy(buf, &rpc_inaddr_loopback,
1199 sizeof(rpc_inaddr_loopback));
1200 break;
1201 case AF_INET6:
1202 if (buflen < sizeof(rpc_in6addr_loopback))
1203 return -EINVAL;
1204 memcpy(buf, &rpc_in6addr_loopback,
1205 sizeof(rpc_in6addr_loopback));
1206 default:
1207 dprintk("RPC: %s: address family not supported\n",
1208 __func__);
1209 return -EAFNOSUPPORT;
1210 }
1211 dprintk("RPC: %s: succeeded\n", __func__);
1212 return 0;
1213}
1214
1215/**
1216 * rpc_localaddr - discover local endpoint address for an RPC client
1217 * @clnt: RPC client structure
1218 * @buf: target buffer
1219 * @buflen: size of target buffer, in bytes
1220 *
1221 * Returns zero and fills in "buf" and "buflen" if successful;
1222 * otherwise, a negative errno is returned.
1223 *
1224 * This works even if the underlying transport is not currently connected,
1225 * or if the upper layer never previously provided a source address.
1226 *
1227 * The result of this function call is transient: multiple calls in
1228 * succession may give different results, depending on how local
1229 * networking configuration changes over time.
1230 */
1231int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1232{
1233 struct sockaddr_storage address;
1234 struct sockaddr *sap = (struct sockaddr *)&address;
1235 struct rpc_xprt *xprt;
1236 struct net *net;
1237 size_t salen;
1238 int err;
1239
1240 rcu_read_lock();
1241 xprt = rcu_dereference(clnt->cl_xprt);
1242 salen = xprt->addrlen;
1243 memcpy(sap, &xprt->addr, salen);
1244 net = get_net(xprt->xprt_net);
1245 rcu_read_unlock();
1246
1247 rpc_set_port(sap, 0);
1248 err = rpc_sockname(net, sap, salen, buf, buflen);
1249 put_net(net);
1250 if (err != 0)
1251 /* Couldn't discover local address, return ANYADDR */
1252 return rpc_anyaddr(sap->sa_family, buf, buflen);
1253 return 0;
1254}
1255EXPORT_SYMBOL_GPL(rpc_localaddr);
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257void
1258rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1259{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001260 struct rpc_xprt *xprt;
1261
1262 rcu_read_lock();
1263 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001264 if (xprt->ops->set_buffer_size)
1265 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001266 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001268EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Trond Myklebust2446ab62012-03-01 17:00:56 -05001270/**
1271 * rpc_protocol - Get transport protocol number for an RPC client
1272 * @clnt: RPC client to query
1273 *
1274 */
1275int rpc_protocol(struct rpc_clnt *clnt)
1276{
1277 int protocol;
1278
1279 rcu_read_lock();
1280 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1281 rcu_read_unlock();
1282 return protocol;
1283}
1284EXPORT_SYMBOL_GPL(rpc_protocol);
1285
1286/**
1287 * rpc_net_ns - Get the network namespace for this RPC client
1288 * @clnt: RPC client to query
1289 *
1290 */
1291struct net *rpc_net_ns(struct rpc_clnt *clnt)
1292{
1293 struct net *ret;
1294
1295 rcu_read_lock();
1296 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1297 rcu_read_unlock();
1298 return ret;
1299}
1300EXPORT_SYMBOL_GPL(rpc_net_ns);
1301
1302/**
1303 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1304 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 *
1306 * For stream transports, this is one RPC record fragment (see RFC
1307 * 1831), as we don't support multi-record requests yet. For datagram
1308 * transports, this is the size of an IP packet minus the IP, UDP, and
1309 * RPC header sizes.
1310 */
1311size_t rpc_max_payload(struct rpc_clnt *clnt)
1312{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001313 size_t ret;
1314
1315 rcu_read_lock();
1316 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1317 rcu_read_unlock();
1318 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319}
Chuck Leverb86acd52006-08-22 20:06:22 -04001320EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
Chuck Lever35f5a422006-01-03 09:55:50 +01001322/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001323 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001324 * @clnt: RPC client to query
1325 */
1326unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1327{
1328 unsigned long ret;
1329
1330 rcu_read_lock();
1331 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1332 rcu_read_unlock();
1333 return ret;
1334}
1335EXPORT_SYMBOL_GPL(rpc_get_timeout);
1336
1337/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001338 * rpc_force_rebind - force transport to check that remote port is unchanged
1339 * @clnt: client to rebind
1340 *
1341 */
1342void rpc_force_rebind(struct rpc_clnt *clnt)
1343{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001344 if (clnt->cl_autobind) {
1345 rcu_read_lock();
1346 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1347 rcu_read_unlock();
1348 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001349}
Chuck Leverb86acd52006-08-22 20:06:22 -04001350EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001353 * Restart an (async) RPC call from the call_prepare state.
1354 * Usually called from within the exit handler.
1355 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001356int
Andy Adamsonaae20062009-04-01 09:22:40 -04001357rpc_restart_call_prepare(struct rpc_task *task)
1358{
1359 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001360 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001361 task->tk_action = call_start;
1362 if (task->tk_ops->rpc_call_prepare != NULL)
1363 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001364 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001365}
1366EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1367
1368/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 * Restart an (async) RPC call. Usually called from within the
1370 * exit handler.
1371 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001372int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373rpc_restart_call(struct rpc_task *task)
1374{
1375 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001376 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001378 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001380EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
Chuck Lever3748f1e2008-05-21 17:09:12 -04001382#ifdef RPC_DEBUG
1383static const char *rpc_proc_name(const struct rpc_task *task)
1384{
1385 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1386
1387 if (proc) {
1388 if (proc->p_name)
1389 return proc->p_name;
1390 else
1391 return "NULL";
1392 } else
1393 return "no proc";
1394}
1395#endif
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397/*
1398 * 0. Initial state
1399 *
1400 * Other FSM states can be visited zero or more times, but
1401 * this state is visited exactly once for each RPC.
1402 */
1403static void
1404call_start(struct rpc_task *task)
1405{
1406 struct rpc_clnt *clnt = task->tk_client;
1407
Chuck Lever3748f1e2008-05-21 17:09:12 -04001408 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001409 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001410 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001411 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
1413 /* Increment call count */
1414 task->tk_msg.rpc_proc->p_count++;
1415 clnt->cl_stats->rpccnt++;
1416 task->tk_action = call_reserve;
1417}
1418
1419/*
1420 * 1. Reserve an RPC call slot
1421 */
1422static void
1423call_reserve(struct rpc_task *task)
1424{
Chuck Lever46121cf2007-01-31 12:14:08 -05001425 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 task->tk_status = 0;
1428 task->tk_action = call_reserveresult;
1429 xprt_reserve(task);
1430}
1431
Trond Myklebustba60eb22013-04-14 10:49:37 -04001432static void call_retry_reserve(struct rpc_task *task);
1433
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434/*
1435 * 1b. Grok the result of xprt_reserve()
1436 */
1437static void
1438call_reserveresult(struct rpc_task *task)
1439{
1440 int status = task->tk_status;
1441
Chuck Lever46121cf2007-01-31 12:14:08 -05001442 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
1444 /*
1445 * After a call to xprt_reserve(), we must have either
1446 * a request slot or else an error status.
1447 */
1448 task->tk_status = 0;
1449 if (status >= 0) {
1450 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001451 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 return;
1453 }
1454
1455 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001456 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 rpc_exit(task, -EIO);
1458 return;
1459 }
1460
1461 /*
1462 * Even though there was an error, we may have acquired
1463 * a request slot somehow. Make sure not to leak it.
1464 */
1465 if (task->tk_rqstp) {
1466 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001467 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 xprt_release(task);
1469 }
1470
1471 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001472 case -ENOMEM:
1473 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001475 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 return;
1477 case -EIO: /* probably a shutdown */
1478 break;
1479 default:
1480 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001481 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 break;
1483 }
1484 rpc_exit(task, status);
1485}
1486
1487/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001488 * 1c. Retry reserving an RPC call slot
1489 */
1490static void
1491call_retry_reserve(struct rpc_task *task)
1492{
1493 dprint_status(task);
1494
1495 task->tk_status = 0;
1496 task->tk_action = call_reserveresult;
1497 xprt_retry_reserve(task);
1498}
1499
1500/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001501 * 2. Bind and/or refresh the credentials
1502 */
1503static void
1504call_refresh(struct rpc_task *task)
1505{
1506 dprint_status(task);
1507
1508 task->tk_action = call_refreshresult;
1509 task->tk_status = 0;
1510 task->tk_client->cl_stats->rpcauthrefresh++;
1511 rpcauth_refreshcred(task);
1512}
1513
1514/*
1515 * 2a. Process the results of a credential refresh
1516 */
1517static void
1518call_refreshresult(struct rpc_task *task)
1519{
1520 int status = task->tk_status;
1521
1522 dprint_status(task);
1523
1524 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001525 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001526 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001527 case 0:
1528 if (rpcauth_uptodatecred(task))
1529 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001530 return;
1531 case -ETIMEDOUT:
1532 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001533 case -EAGAIN:
1534 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001535 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001536 if (!task->tk_cred_retry)
1537 break;
1538 task->tk_cred_retry--;
1539 dprintk("RPC: %5u %s: retry refresh creds\n",
1540 task->tk_pid, __func__);
1541 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001542 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001543 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1544 task->tk_pid, __func__, status);
1545 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001546}
1547
1548/*
1549 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001550 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 */
1552static void
1553call_allocate(struct rpc_task *task)
1554{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001555 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001556 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001557 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001558 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Chuck Lever46121cf2007-01-31 12:14:08 -05001560 dprint_status(task);
1561
Chuck Lever2bea90d2007-03-29 16:47:53 -04001562 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001563 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001564
Chuck Lever02107142006-01-03 09:55:49 +01001565 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 return;
1567
Chuck Lever2bea90d2007-03-29 16:47:53 -04001568 if (proc->p_proc != 0) {
1569 BUG_ON(proc->p_arglen == 0);
1570 if (proc->p_decode != NULL)
1571 BUG_ON(proc->p_replen == 0);
1572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Chuck Lever2bea90d2007-03-29 16:47:53 -04001574 /*
1575 * Calculate the size (in quads) of the RPC call
1576 * and reply headers, and convert both values
1577 * to byte sizes.
1578 */
1579 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1580 req->rq_callsize <<= 2;
1581 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1582 req->rq_rcvsize <<= 2;
1583
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001584 req->rq_buffer = xprt->ops->buf_alloc(task,
1585 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001586 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001588
1589 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
Trond Myklebust5afa9132011-06-17 10:14:59 -04001591 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001592 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 rpc_delay(task, HZ>>4);
1594 return;
1595 }
1596
1597 rpc_exit(task, -ERESTARTSYS);
1598}
1599
Trond Myklebust940e3312005-11-09 21:45:24 -05001600static inline int
1601rpc_task_need_encode(struct rpc_task *task)
1602{
1603 return task->tk_rqstp->rq_snd_buf.len == 0;
1604}
1605
1606static inline void
1607rpc_task_force_reencode(struct rpc_task *task)
1608{
1609 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001610 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001611}
1612
Chuck Lever2bea90d2007-03-29 16:47:53 -04001613static inline void
1614rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1615{
1616 buf->head[0].iov_base = start;
1617 buf->head[0].iov_len = len;
1618 buf->tail[0].iov_len = 0;
1619 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001620 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001621 buf->len = 0;
1622 buf->buflen = len;
1623}
1624
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625/*
1626 * 3. Encode arguments of an RPC call
1627 */
1628static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001629rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001632 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001633 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
Chuck Lever46121cf2007-01-31 12:14:08 -05001635 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
Chuck Lever2bea90d2007-03-29 16:47:53 -04001637 rpc_xdr_buf_init(&req->rq_snd_buf,
1638 req->rq_buffer,
1639 req->rq_callsize);
1640 rpc_xdr_buf_init(&req->rq_rcv_buf,
1641 (char *)req->rq_buffer + req->rq_callsize,
1642 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Chuck Leverb0e1c572008-05-21 17:09:19 -04001644 p = rpc_encode_header(task);
1645 if (p == NULL) {
1646 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 rpc_exit(task, -EIO);
1648 return;
1649 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001650
1651 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001652 if (encode == NULL)
1653 return;
1654
1655 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1656 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657}
1658
1659/*
1660 * 4. Get the server port number if not yet set
1661 */
1662static void
1663call_bind(struct rpc_task *task)
1664{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001665 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Chuck Lever46121cf2007-01-31 12:14:08 -05001667 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
Chuck Leverda351872005-08-11 16:25:11 -04001669 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001670 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001671 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001672 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001673 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 }
1675}
1676
1677/*
Chuck Leverda351872005-08-11 16:25:11 -04001678 * 4a. Sort out bind result
1679 */
1680static void
1681call_bind_status(struct rpc_task *task)
1682{
Chuck Lever906462a2007-09-11 18:00:47 -04001683 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001684
1685 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001686 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001687 task->tk_status = 0;
1688 task->tk_action = call_connect;
1689 return;
1690 }
1691
Steve Dickson5753cba2012-02-06 10:08:08 -05001692 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001693 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001694 case -ENOMEM:
1695 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1696 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001697 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001698 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001699 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1700 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001701 /* fail immediately if this is an RPC ping */
1702 if (task->tk_msg.rpc_proc->p_proc == 0) {
1703 status = -EOPNOTSUPP;
1704 break;
1705 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001706 if (task->tk_rebind_retry == 0)
1707 break;
1708 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001709 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001710 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001711 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001712 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001713 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001714 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001715 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001716 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001717 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001718 task->tk_pid);
1719 break;
1720 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001721 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001722 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001723 task->tk_status = 0;
1724 task->tk_action = call_bind;
1725 return;
Chuck Lever012da152009-12-03 15:58:56 -05001726 case -ECONNREFUSED: /* connection problems */
1727 case -ECONNRESET:
1728 case -ENOTCONN:
1729 case -EHOSTDOWN:
1730 case -EHOSTUNREACH:
1731 case -ENETUNREACH:
1732 case -EPIPE:
1733 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1734 task->tk_pid, task->tk_status);
1735 if (!RPC_IS_SOFTCONN(task)) {
1736 rpc_delay(task, 5*HZ);
1737 goto retry_timeout;
1738 }
1739 status = task->tk_status;
1740 break;
Chuck Leverda351872005-08-11 16:25:11 -04001741 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001742 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001743 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001744 }
1745
1746 rpc_exit(task, status);
1747 return;
1748
Trond Myklebustda458282006-08-31 15:44:52 -04001749retry_timeout:
1750 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001751}
1752
1753/*
1754 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 */
1756static void
1757call_connect(struct rpc_task *task)
1758{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001759 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
Chuck Lever46121cf2007-01-31 12:14:08 -05001761 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001762 task->tk_pid, xprt,
1763 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Chuck Leverda351872005-08-11 16:25:11 -04001765 task->tk_action = call_transmit;
1766 if (!xprt_connected(xprt)) {
1767 task->tk_action = call_connect_status;
1768 if (task->tk_status < 0)
1769 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001770 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1771 rpc_exit(task, -ENOTCONN);
1772 return;
1773 }
Chuck Leverda351872005-08-11 16:25:11 -04001774 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776}
1777
1778/*
Chuck Leverda351872005-08-11 16:25:11 -04001779 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 */
1781static void
1782call_connect_status(struct rpc_task *task)
1783{
1784 struct rpc_clnt *clnt = task->tk_client;
1785 int status = task->tk_status;
1786
Chuck Lever46121cf2007-01-31 12:14:08 -05001787 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001788
Steve Dickson5753cba2012-02-06 10:08:08 -05001789 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001790 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001792 /* if soft mounted, test if we've timed out */
1793 case -ETIMEDOUT:
1794 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001795 return;
1796 case -ECONNREFUSED:
1797 case -ECONNRESET:
1798 case -ENETUNREACH:
Trond Myklebust561ec162013-09-26 15:22:45 -04001799 /* retry with existing socket, after a delay */
1800 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001801 if (RPC_IS_SOFTCONN(task))
1802 break;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001803 case -EAGAIN:
Trond Myklebust561ec162013-09-26 15:22:45 -04001804 task->tk_action = call_bind;
1805 return;
1806 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001807 clnt->cl_stats->netreconn++;
1808 task->tk_action = call_transmit;
1809 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001811 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812}
1813
1814/*
1815 * 5. Transmit the RPC request, and wait for reply
1816 */
1817static void
1818call_transmit(struct rpc_task *task)
1819{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001820 int is_retrans = RPC_WAS_SENT(task);
1821
Chuck Lever46121cf2007-01-31 12:14:08 -05001822 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823
1824 task->tk_action = call_status;
1825 if (task->tk_status < 0)
1826 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001827 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001829 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001831 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001832 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001833 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001834 if (task->tk_status != 0) {
1835 /* Was the error nonfatal? */
1836 if (task->tk_status == -EAGAIN)
1837 rpc_delay(task, HZ >> 4);
1838 else
1839 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001840 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001841 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001842 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 xprt_transmit(task);
1844 if (task->tk_status < 0)
1845 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001846 if (is_retrans)
1847 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001848 /*
1849 * On success, ensure that we call xprt_end_transmit() before sleeping
1850 * in order to allow access to the socket to other RPC requests.
1851 */
1852 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001853 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001854 return;
1855 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001856 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001857}
1858
1859/*
1860 * 5a. Handle cleanup after a transmission
1861 */
1862static void
1863call_transmit_status(struct rpc_task *task)
1864{
1865 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001866
1867 /*
1868 * Common case: success. Force the compiler to put this
1869 * test first.
1870 */
1871 if (task->tk_status == 0) {
1872 xprt_end_transmit(task);
1873 rpc_task_force_reencode(task);
1874 return;
1875 }
1876
Trond Myklebust15f081c2009-03-11 14:37:57 -04001877 switch (task->tk_status) {
1878 case -EAGAIN:
1879 break;
1880 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001881 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001882 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001883 rpc_task_force_reencode(task);
1884 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001885 /*
1886 * Special cases: if we've been waiting on the
1887 * socket's write_space() callback, or if the
1888 * socket just returned a connection error,
1889 * then hold onto the transport lock.
1890 */
1891 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001892 case -EHOSTDOWN:
1893 case -EHOSTUNREACH:
1894 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001895 if (RPC_IS_SOFTCONN(task)) {
1896 xprt_end_transmit(task);
1897 rpc_exit(task, task->tk_status);
1898 break;
1899 }
1900 case -ECONNRESET:
1901 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001902 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001903 rpc_task_force_reencode(task);
1904 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905}
1906
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001907#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001908/*
1909 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1910 * addition, disconnect on connectivity errors.
1911 */
1912static void
1913call_bc_transmit(struct rpc_task *task)
1914{
1915 struct rpc_rqst *req = task->tk_rqstp;
1916
Trond Myklebust90051ea2013-09-25 12:17:18 -04001917 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001918 /*
1919 * Could not reserve the transport. Try again after the
1920 * transport is released.
1921 */
1922 task->tk_status = 0;
1923 task->tk_action = call_bc_transmit;
1924 return;
1925 }
1926
1927 task->tk_action = rpc_exit_task;
1928 if (task->tk_status < 0) {
1929 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1930 "error: %d\n", task->tk_status);
1931 return;
1932 }
1933
1934 xprt_transmit(task);
1935 xprt_end_transmit(task);
1936 dprint_status(task);
1937 switch (task->tk_status) {
1938 case 0:
1939 /* Success */
1940 break;
1941 case -EHOSTDOWN:
1942 case -EHOSTUNREACH:
1943 case -ENETUNREACH:
1944 case -ETIMEDOUT:
1945 /*
1946 * Problem reaching the server. Disconnect and let the
1947 * forechannel reestablish the connection. The server will
1948 * have to retransmit the backchannel request and we'll
1949 * reprocess it. Since these ops are idempotent, there's no
1950 * need to cache our reply at this time.
1951 */
1952 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1953 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001954 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001955 req->rq_connect_cookie);
1956 break;
1957 default:
1958 /*
1959 * We were unable to reply and will have to drop the
1960 * request. The server should reconnect and retransmit.
1961 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001962 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001963 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1964 "error: %d\n", task->tk_status);
1965 break;
1966 }
1967 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1968}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001969#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001970
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971/*
1972 * 6. Sort out the RPC call status
1973 */
1974static void
1975call_status(struct rpc_task *task)
1976{
1977 struct rpc_clnt *clnt = task->tk_client;
1978 struct rpc_rqst *req = task->tk_rqstp;
1979 int status;
1980
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001981 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1982 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Chuck Lever46121cf2007-01-31 12:14:08 -05001984 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985
1986 status = task->tk_status;
1987 if (status >= 0) {
1988 task->tk_action = call_decode;
1989 return;
1990 }
1991
Steve Dickson5753cba2012-02-06 10:08:08 -05001992 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 task->tk_status = 0;
1994 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001995 case -EHOSTDOWN:
1996 case -EHOSTUNREACH:
1997 case -ENETUNREACH:
1998 /*
1999 * Delay any retries for 3 seconds, then handle as if it
2000 * were a timeout.
2001 */
2002 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 case -ETIMEDOUT:
2004 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002005 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2006 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002007 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002008 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04002010 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002012 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04002013 rpc_delay(task, 3*HZ);
2014 case -EPIPE:
2015 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 task->tk_action = call_bind;
2017 break;
2018 case -EAGAIN:
2019 task->tk_action = call_transmit;
2020 break;
2021 case -EIO:
2022 /* shutdown or soft timeout */
2023 rpc_exit(task, status);
2024 break;
2025 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002026 if (clnt->cl_chatty)
2027 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002028 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 }
2031}
2032
2033/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002034 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 * We do not release the request slot, so we keep using the
2036 * same XID for all retransmits.
2037 */
2038static void
2039call_timeout(struct rpc_task *task)
2040{
2041 struct rpc_clnt *clnt = task->tk_client;
2042
2043 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002044 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 goto retry;
2046 }
2047
Chuck Lever46121cf2007-01-31 12:14:08 -05002048 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002049 task->tk_timeouts++;
2050
Chuck Lever3a28bec2009-12-03 15:58:56 -05002051 if (RPC_IS_SOFTCONN(task)) {
2052 rpc_exit(task, -ETIMEDOUT);
2053 return;
2054 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002056 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002057 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002058 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002059 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002060 rcu_dereference(clnt->cl_xprt)->servername);
2061 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07002062 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002063 if (task->tk_flags & RPC_TASK_TIMEOUT)
2064 rpc_exit(task, -ETIMEDOUT);
2065 else
2066 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 return;
2068 }
2069
Chuck Leverf518e35a2006-01-03 09:55:52 +01002070 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002072 if (clnt->cl_chatty) {
2073 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002074 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002075 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002076 rcu_dereference(clnt->cl_xprt)->servername);
2077 rcu_read_unlock();
2078 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002080 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002081 /*
2082 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2083 * event? RFC2203 requires the server to drop all such requests.
2084 */
2085 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086
2087retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 task->tk_action = call_bind;
2089 task->tk_status = 0;
2090}
2091
2092/*
2093 * 7. Decode the RPC reply
2094 */
2095static void
2096call_decode(struct rpc_task *task)
2097{
2098 struct rpc_clnt *clnt = task->tk_client;
2099 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002100 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002101 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Vasily Averin726fd6a2011-06-01 16:23:59 +04002103 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
Chuck Leverf518e35a2006-01-03 09:55:52 +01002105 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002106 if (clnt->cl_chatty) {
2107 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002108 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002109 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002110 rcu_dereference(clnt->cl_xprt)->servername);
2111 rcu_read_unlock();
2112 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2114 }
2115
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002116 /*
2117 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002118 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002119 */
2120 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 req->rq_rcv_buf.len = req->rq_private_buf.len;
2122
2123 /* Check that the softirq receive buffer is valid */
2124 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2125 sizeof(req->rq_rcv_buf)) != 0);
2126
Trond Myklebust1e799b62008-03-21 16:19:41 -04002127 if (req->rq_rcv_buf.len < 12) {
2128 if (!RPC_IS_SOFT(task)) {
2129 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002130 goto out_retry;
2131 }
2132 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002133 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002134 task->tk_action = call_timeout;
2135 goto out_retry;
2136 }
2137
Chuck Leverb0e1c572008-05-21 17:09:19 -04002138 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002139 if (IS_ERR(p)) {
2140 if (p == ERR_PTR(-EAGAIN))
2141 goto out_retry;
2142 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 }
2144
Trond Myklebustabbcf282006-01-03 09:55:03 +01002145 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002147 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2149 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002150 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002151 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2152 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 return;
2154out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002156 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002157 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002158 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002159 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002160 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002161 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002162 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163}
2164
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002165static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002166rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167{
2168 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002170 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171
2172 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002173
Trond Myklebusta4f08352013-01-08 09:10:21 -05002174 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 *p++ = req->rq_xid; /* XID */
2176 *p++ = htonl(RPC_CALL); /* CALL */
2177 *p++ = htonl(RPC_VERSION); /* RPC version */
2178 *p++ = htonl(clnt->cl_prog); /* program number */
2179 *p++ = htonl(clnt->cl_vers); /* program version */
2180 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002181 p = rpcauth_marshcred(task, p);
2182 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2183 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184}
2185
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002186static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002187rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002189 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2191 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002192 __be32 *p = iov->iov_base;
2193 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 int error = -EACCES;
2195
David Howellse8896492006-08-24 15:44:19 -04002196 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2197 /* RFC-1014 says that the representation of XDR data must be a
2198 * multiple of four bytes
2199 * - if it isn't pointer subtraction in the NFS client may give
2200 * undefined results
2201 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002202 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002203 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002204 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002205 error = -EIO;
2206 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 if ((len -= 3) < 0)
2209 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002211 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002213 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002214 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002215 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002216 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002218
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2220 if (--len < 0)
2221 goto out_overflow;
2222 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002223 case RPC_AUTH_ERROR:
2224 break;
2225 case RPC_MISMATCH:
2226 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2227 task->tk_pid, __func__);
2228 error = -EPROTONOSUPPORT;
2229 goto out_err;
2230 default:
2231 dprintk("RPC: %5u %s: RPC call rejected, "
2232 "unknown error: %x\n",
2233 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002234 error = -EIO;
2235 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 }
2237 if (--len < 0)
2238 goto out_overflow;
2239 switch ((n = ntohl(*p++))) {
2240 case RPC_AUTH_REJECTEDCRED:
2241 case RPC_AUTH_REJECTEDVERF:
2242 case RPCSEC_GSS_CREDPROBLEM:
2243 case RPCSEC_GSS_CTXPROBLEM:
2244 if (!task->tk_cred_retry)
2245 break;
2246 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002247 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002248 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002250 /* Ensure we obtain a new XID! */
2251 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002252 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002253 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 case RPC_AUTH_BADCRED:
2255 case RPC_AUTH_BADVERF:
2256 /* possibly garbled cred/verf? */
2257 if (!task->tk_garb_retry)
2258 break;
2259 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002260 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002261 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002263 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002265 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002266 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002267 "authentication.\n",
2268 rcu_dereference(clnt->cl_xprt)->servername);
2269 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 break;
2271 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002272 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002273 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 error = -EIO;
2275 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002276 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002277 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 goto out_err;
2279 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002280 p = rpcauth_checkverf(task, p);
2281 if (IS_ERR(p)) {
2282 error = PTR_ERR(p);
2283 dprintk("RPC: %5u %s: auth check failed with %d\n",
2284 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002285 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002287 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 if (len < 0)
2289 goto out_overflow;
2290 switch ((n = ntohl(*p++))) {
2291 case RPC_SUCCESS:
2292 return p;
2293 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002294 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2295 "by server %s\n", task->tk_pid, __func__,
2296 (unsigned int)clnt->cl_prog,
2297 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002298 error = -EPFNOSUPPORT;
2299 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002301 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2302 "by server %s\n", task->tk_pid, __func__,
2303 (unsigned int)clnt->cl_prog,
2304 (unsigned int)clnt->cl_vers,
2305 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002306 error = -EPROTONOSUPPORT;
2307 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002309 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002310 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002311 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002312 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002313 clnt->cl_prog, clnt->cl_vers,
2314 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002315 error = -EOPNOTSUPP;
2316 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002318 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002319 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 break; /* retry */
2321 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002322 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002323 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 /* Also retry */
2325 }
2326
Trond Myklebustabbcf282006-01-03 09:55:03 +01002327out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002328 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 if (task->tk_garb_retry) {
2330 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002331 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002332 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002334out_retry:
2335 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337out_err:
2338 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002339 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002340 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002341 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002343 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002344 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002345 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002347
Chuck Lever9f06c712010-12-14 14:59:18 +00002348static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002349{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002350}
2351
Chuck Leverbf269552010-12-14 14:59:29 +00002352static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002353{
2354 return 0;
2355}
2356
2357static struct rpc_procinfo rpcproc_null = {
2358 .p_encode = rpcproc_encode_null,
2359 .p_decode = rpcproc_decode_null,
2360};
2361
Chuck Levercaabea82009-12-03 15:58:56 -05002362static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002363{
2364 struct rpc_message msg = {
2365 .rpc_proc = &rpcproc_null,
2366 };
2367 int err;
2368 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002369 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002370 put_rpccred(msg.rpc_cred);
2371 return err;
2372}
Trond Myklebust188fef12007-06-16 14:18:40 -04002373
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002374struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2375{
2376 struct rpc_message msg = {
2377 .rpc_proc = &rpcproc_null,
2378 .rpc_cred = cred,
2379 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002380 struct rpc_task_setup task_setup_data = {
2381 .rpc_client = clnt,
2382 .rpc_message = &msg,
2383 .callback_ops = &rpc_default_ops,
2384 .flags = flags,
2385 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002386 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002387}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002388EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002389
Trond Myklebust188fef12007-06-16 14:18:40 -04002390#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002391static void rpc_show_header(void)
2392{
Chuck Levercb3997b2008-05-21 17:09:41 -04002393 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2394 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002395}
2396
Chuck Lever38e886e2008-05-21 17:09:33 -04002397static void rpc_show_task(const struct rpc_clnt *clnt,
2398 const struct rpc_task *task)
2399{
2400 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002401
2402 if (RPC_IS_QUEUED(task))
2403 rpc_waitq = rpc_qname(task->tk_waitqueue);
2404
Joe Perchesb3bceda2010-12-21 10:52:24 -05002405 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 -04002406 task->tk_pid, task->tk_flags, task->tk_status,
2407 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002408 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002409 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002410}
2411
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002412void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002413{
2414 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002415 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002416 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002417 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002418
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002419 spin_lock(&sn->rpc_client_lock);
2420 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002421 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002422 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002423 if (!header) {
2424 rpc_show_header();
2425 header++;
2426 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002427 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002428 }
2429 spin_unlock(&clnt->cl_lock);
2430 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002431 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002432}
2433#endif