blob: f167d9c8d7dd95d7369a3f5ceda40878096d1834 [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);
275 old = clnt->cl_xprt;
276
277 if (!xprt_bound(xprt))
278 clnt->cl_autobind = 1;
279
280 clnt->cl_timeout = timeout;
281 rcu_assign_pointer(clnt->cl_xprt, xprt);
282 spin_unlock(&clnt->cl_lock);
283
284 return old;
285}
286
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400287static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
288{
289 clnt->cl_nodelen = strlen(nodename);
290 if (clnt->cl_nodelen > UNX_MAXNODENAME)
291 clnt->cl_nodelen = UNX_MAXNODENAME;
292 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
293}
294
Chuck Leverd746e542013-10-17 14:12:17 -0400295static int rpc_client_register(struct rpc_clnt *clnt,
296 rpc_authflavor_t pseudoflavor,
297 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400298{
Trond Myklebustc2190662013-08-26 19:23:04 -0400299 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400300 .pseudoflavor = pseudoflavor,
301 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400302 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400303 struct rpc_auth *auth;
304 struct net *net = rpc_net_ns(clnt);
305 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400306 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400307
308 pipefs_sb = rpc_get_sb_net(net);
309 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400310 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400311 if (err)
312 goto out;
313 }
314
Trond Myklebusteeee2452013-07-10 15:33:01 -0400315 rpc_register_client(clnt);
316 if (pipefs_sb)
317 rpc_put_sb_net(net);
318
Trond Myklebustc2190662013-08-26 19:23:04 -0400319 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400320 if (IS_ERR(auth)) {
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400322 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400323 err = PTR_ERR(auth);
324 goto err_auth;
325 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400326 return 0;
327err_auth:
328 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400329 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400330 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400331out:
332 if (pipefs_sb)
333 rpc_put_sb_net(net);
334 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335}
336
Trond Myklebust2f048db2013-09-04 21:51:44 -0400337static DEFINE_IDA(rpc_clids);
338
339static int rpc_alloc_clid(struct rpc_clnt *clnt)
340{
341 int clid;
342
343 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
344 if (clid < 0)
345 return clid;
346 clnt->cl_clid = clid;
347 return 0;
348}
349
350static void rpc_free_clid(struct rpc_clnt *clnt)
351{
352 ida_simple_remove(&rpc_clids, clnt->cl_clid);
353}
354
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400355static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
356 struct rpc_xprt *xprt,
357 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500359 const struct rpc_program *program = args->program;
360 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400361 struct rpc_clnt *clnt = NULL;
362 const struct rpc_timeout *timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400364
365 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500366 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500367 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Trond Myklebust4ada5392007-06-14 17:26:17 -0400369 err = rpciod_up();
370 if (err)
371 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500372
Trond Myklebustf05c1242013-04-05 14:13:21 -0400373 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500374 if (args->version >= program->nrvers)
375 goto out_err;
376 version = program->version[args->version];
377 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 goto out_err;
379
380 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700381 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 if (!clnt)
383 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400384 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Trond Myklebust2f048db2013-09-04 21:51:44 -0400386 err = rpc_alloc_clid(clnt);
387 if (err)
388 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 clnt->cl_procinfo = version->procs;
391 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300392 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500395 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400396 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500397 err = -ENOMEM;
398 if (clnt->cl_metrics == NULL)
399 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500400 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400401 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400402 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400404 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500405 if (args->timeout != NULL) {
406 memcpy(&clnt->cl_timeout_default, args->timeout,
407 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400408 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500409 }
410
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 rpc_clnt_set_transport(clnt, xprt, timeout);
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500414 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Trond Myklebust006abe82010-09-12 19:55:25 -0400416 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400419 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400420
Chuck Leverd746e542013-10-17 14:12:17 -0400421 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400422 if (err)
423 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400424 if (parent)
425 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return clnt;
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500429 rpc_free_iostats(clnt->cl_metrics);
430out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400431 rpc_free_clid(clnt);
432out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 kfree(clnt);
434out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400435 rpciod_down();
436out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400437 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return ERR_PTR(err);
439}
440
Ben Hutchings2c530402012-07-10 10:55:09 +0000441/**
Chuck Leverc2866762006-08-22 20:06:20 -0400442 * rpc_create - create an RPC client and transport with one call
443 * @args: rpc_clnt create argument structure
444 *
445 * Creates and initializes an RPC transport and an RPC client.
446 *
447 * It can ping the server in order to determine if it is up, and to see if
448 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
449 * this behavior so asynchronous tasks can also use rpc_create.
450 */
451struct rpc_clnt *rpc_create(struct rpc_create_args *args)
452{
453 struct rpc_xprt *xprt;
454 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400455 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400456 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400457 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200458 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200459 .dstaddr = args->address,
460 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500461 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300462 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200463 };
Chuck Lever510deb02007-12-10 14:56:24 -0500464 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400465
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400466 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
467 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400468 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
469 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400470 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400471 * If the caller chooses not to specify a hostname, whip
472 * up a string representation of the passed-in address.
473 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500474 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400475 struct sockaddr_un *sun =
476 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400477 struct sockaddr_in *sin =
478 (struct sockaddr_in *)args->address;
479 struct sockaddr_in6 *sin6 =
480 (struct sockaddr_in6 *)args->address;
481
Chuck Lever510deb02007-12-10 14:56:24 -0500482 servername[0] = '\0';
483 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400484 case AF_LOCAL:
485 snprintf(servername, sizeof(servername), "%s",
486 sun->sun_path);
487 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400488 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700489 snprintf(servername, sizeof(servername), "%pI4",
490 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500491 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400492 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700493 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400494 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500495 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500496 default:
497 /* caller wants default server name, but
498 * address family isn't recognized. */
499 return ERR_PTR(-EINVAL);
500 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500501 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400502 }
503
Chuck Lever510deb02007-12-10 14:56:24 -0500504 xprt = xprt_create_transport(&xprtargs);
505 if (IS_ERR(xprt))
506 return (struct rpc_clnt *)xprt;
507
Chuck Lever43780b82007-07-01 12:13:22 -0400508 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400509 * By default, kernel RPC client connects from a reserved port.
510 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
511 * but it is always enabled for rpciod, which handles the connect
512 * operation.
513 */
514 xprt->resvport = 1;
515 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
516 xprt->resvport = 0;
517
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400518 clnt = rpc_new_client(args, xprt, NULL);
Chuck Leverc2866762006-08-22 20:06:20 -0400519 if (IS_ERR(clnt))
520 return clnt;
521
522 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500523 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400524 if (err != 0) {
525 rpc_shutdown_client(clnt);
526 return ERR_PTR(err);
527 }
528 }
529
530 clnt->cl_softrtry = 1;
531 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
532 clnt->cl_softrtry = 0;
533
Chuck Leverc2866762006-08-22 20:06:20 -0400534 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
535 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500536 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
537 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400538 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
539 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400540
541 return clnt;
542}
Chuck Leverb86acd52006-08-22 20:06:22 -0400543EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545/*
546 * This function clones the RPC client structure. It allows us to share the
547 * same transport while varying parameters such as the authentication
548 * flavour.
549 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400550static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
551 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500553 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400554 struct rpc_clnt *new;
555 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Chuck Lever1b63a752012-09-14 17:23:52 -0400557 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500558 rcu_read_lock();
559 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
560 rcu_read_unlock();
561 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400562 goto out_err;
563 args->servername = xprt->servername;
564
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400565 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400566 if (IS_ERR(new)) {
567 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400568 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400569 }
570
Chuck Lever1b63a752012-09-14 17:23:52 -0400571 /* Turn off autobind on clones */
572 new->cl_autobind = 0;
573 new->cl_softrtry = clnt->cl_softrtry;
574 new->cl_discrtry = clnt->cl_discrtry;
575 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400577
Chuck Lever1b63a752012-09-14 17:23:52 -0400578out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800579 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500580 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
Chuck Lever1b63a752012-09-14 17:23:52 -0400582
583/**
584 * rpc_clone_client - Clone an RPC client structure
585 *
586 * @clnt: RPC client whose parameters are copied
587 *
588 * Returns a fresh RPC client or an ERR_PTR.
589 */
590struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
591{
592 struct rpc_create_args args = {
593 .program = clnt->cl_program,
594 .prognumber = clnt->cl_prog,
595 .version = clnt->cl_vers,
596 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400597 };
598 return __rpc_clone_client(&args, clnt);
599}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400600EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Chuck Leverba9b5842012-09-14 17:24:02 -0400602/**
603 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
604 *
605 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800606 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400607 *
608 * Returns a fresh RPC client or an ERR_PTR.
609 */
610struct rpc_clnt *
611rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
612{
613 struct rpc_create_args args = {
614 .program = clnt->cl_program,
615 .prognumber = clnt->cl_prog,
616 .version = clnt->cl_vers,
617 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400618 };
619 return __rpc_clone_client(&args, clnt);
620}
621EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
622
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400623/**
624 * rpc_switch_client_transport: switch the RPC transport on the fly
625 * @clnt: pointer to a struct rpc_clnt
626 * @args: pointer to the new transport arguments
627 * @timeout: pointer to the new timeout parameters
628 *
629 * This function allows the caller to switch the RPC transport for the
630 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
631 * server, for instance. It assumes that the caller has ensured that
632 * there are no active RPC tasks by using some form of locking.
633 *
634 * Returns zero if "clnt" is now using the new xprt. Otherwise a
635 * negative errno is returned, and "clnt" continues to use the old
636 * xprt.
637 */
638int rpc_switch_client_transport(struct rpc_clnt *clnt,
639 struct xprt_create *args,
640 const struct rpc_timeout *timeout)
641{
642 const struct rpc_timeout *old_timeo;
643 rpc_authflavor_t pseudoflavor;
644 struct rpc_xprt *xprt, *old;
645 struct rpc_clnt *parent;
646 int err;
647
648 xprt = xprt_create_transport(args);
649 if (IS_ERR(xprt)) {
650 dprintk("RPC: failed to create new xprt for clnt %p\n",
651 clnt);
652 return PTR_ERR(xprt);
653 }
654
655 pseudoflavor = clnt->cl_auth->au_flavor;
656
657 old_timeo = clnt->cl_timeout;
658 old = rpc_clnt_set_transport(clnt, xprt, timeout);
659
660 rpc_unregister_client(clnt);
661 __rpc_clnt_remove_pipedir(clnt);
662
663 /*
664 * A new transport was created. "clnt" therefore
665 * becomes the root of a new cl_parent tree. clnt's
666 * children, if it has any, still point to the old xprt.
667 */
668 parent = clnt->cl_parent;
669 clnt->cl_parent = clnt;
670
671 /*
672 * The old rpc_auth cache cannot be re-used. GSS
673 * contexts in particular are between a single
674 * client and server.
675 */
676 err = rpc_client_register(clnt, pseudoflavor, NULL);
677 if (err)
678 goto out_revert;
679
680 synchronize_rcu();
681 if (parent != clnt)
682 rpc_release_client(parent);
683 xprt_put(old);
684 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
685 return 0;
686
687out_revert:
688 rpc_clnt_set_transport(clnt, old, old_timeo);
689 clnt->cl_parent = parent;
690 rpc_client_register(clnt, pseudoflavor, NULL);
691 xprt_put(xprt);
692 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
693 return err;
694}
695EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400698 * Kill all tasks for the given client.
699 * XXX: kill their descendants as well?
700 */
701void rpc_killall_tasks(struct rpc_clnt *clnt)
702{
703 struct rpc_task *rovr;
704
705
706 if (list_empty(&clnt->cl_tasks))
707 return;
708 dprintk("RPC: killing all tasks for client %p\n", clnt);
709 /*
710 * Spin lock all_tasks to prevent changes...
711 */
712 spin_lock(&clnt->cl_lock);
713 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
714 if (!RPC_IS_ACTIVATED(rovr))
715 continue;
716 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
717 rovr->tk_flags |= RPC_TASK_KILLED;
718 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300719 if (RPC_IS_QUEUED(rovr))
720 rpc_wake_up_queued_task(rovr->tk_waitqueue,
721 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400722 }
723 }
724 spin_unlock(&clnt->cl_lock);
725}
726EXPORT_SYMBOL_GPL(rpc_killall_tasks);
727
728/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400730 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400732void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400734 might_sleep();
735
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500736 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400737 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500738 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Trond Myklebust34f52e32007-06-14 16:40:31 -0400740 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800742 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400743 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 }
745
Trond Myklebust4c402b42007-06-14 16:40:32 -0400746 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400748EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400751 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400753static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400754rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500756 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400757 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500758 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500759 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400760 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400761 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400762 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500763 rpc_free_iostats(clnt->cl_metrics);
764 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500765 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400766 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400767 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769}
770
771/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400772 * Free an RPC client
773 */
774static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400775rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400776{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400777 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400778 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400779 return;
780 }
781
782 /*
783 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
784 * release remaining GSS contexts. This mechanism ensures
785 * that it can do so safely.
786 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400787 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400788 rpcauth_release(clnt->cl_auth);
789 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400790 if (atomic_dec_and_test(&clnt->cl_count))
791 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400792}
793
794/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400795 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 */
797void
798rpc_release_client(struct rpc_clnt *clnt)
799{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400800 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Trond Myklebust34f52e32007-06-14 16:40:31 -0400802 if (list_empty(&clnt->cl_tasks))
803 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400804 if (atomic_dec_and_test(&clnt->cl_count))
805 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400806}
Simo Sorce1d658332012-05-25 18:09:55 -0400807EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400808
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000809/**
810 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800811 * @old: old rpc_client
812 * @program: rpc program to set
813 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000814 *
815 * Clones the rpc client and sets up a new RPC program. This is mainly
816 * of use for enabling different RPC programs to share the same transport.
817 * The Sun NFSv2/v3 ACL protocol can do this.
818 */
819struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500820 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400821 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000822{
Trond Myklebustf994c432012-11-01 12:14:14 -0400823 struct rpc_create_args args = {
824 .program = program,
825 .prognumber = program->number,
826 .version = vers,
827 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400828 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000829 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000830 int err;
831
Trond Myklebustf994c432012-11-01 12:14:14 -0400832 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000833 if (IS_ERR(clnt))
834 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500835 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000836 if (err != 0) {
837 rpc_shutdown_client(clnt);
838 clnt = ERR_PTR(err);
839 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800840out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000841 return clnt;
842}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400843EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000844
Trond Myklebust58f96122010-07-31 14:29:08 -0400845void rpc_task_release_client(struct rpc_task *task)
846{
847 struct rpc_clnt *clnt = task->tk_client;
848
849 if (clnt != NULL) {
850 /* Remove from client task list */
851 spin_lock(&clnt->cl_lock);
852 list_del(&task->tk_task);
853 spin_unlock(&clnt->cl_lock);
854 task->tk_client = NULL;
855
856 rpc_release_client(clnt);
857 }
858}
859
860static
861void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
862{
863 if (clnt != NULL) {
864 rpc_task_release_client(task);
865 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400866 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400867 if (clnt->cl_softrtry)
868 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400869 if (clnt->cl_noretranstimeo)
870 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700871 if (sk_memalloc_socks()) {
872 struct rpc_xprt *xprt;
873
874 rcu_read_lock();
875 xprt = rcu_dereference(clnt->cl_xprt);
876 if (xprt->swapper)
877 task->tk_flags |= RPC_TASK_SWAPPER;
878 rcu_read_unlock();
879 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400880 /* Add to the client's list of all tasks */
881 spin_lock(&clnt->cl_lock);
882 list_add_tail(&task->tk_task, &clnt->cl_tasks);
883 spin_unlock(&clnt->cl_lock);
884 }
885}
886
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000887void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
888{
889 rpc_task_release_client(task);
890 rpc_task_set_client(task, clnt);
891}
892EXPORT_SYMBOL_GPL(rpc_task_reset_client);
893
894
Trond Myklebust58f96122010-07-31 14:29:08 -0400895static void
896rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
897{
898 if (msg != NULL) {
899 task->tk_msg.rpc_proc = msg->rpc_proc;
900 task->tk_msg.rpc_argp = msg->rpc_argp;
901 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400902 if (msg->rpc_cred != NULL)
903 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400904 }
905}
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907/*
908 * Default callback for async RPC calls
909 */
910static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100911rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
913}
914
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100915static const struct rpc_call_ops rpc_default_ops = {
916 .rpc_call_done = rpc_default_callback,
917};
918
Trond Myklebustc970aa82007-07-14 15:39:59 -0400919/**
920 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
921 * @task_setup_data: pointer to task initialisation data
922 */
923struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400924{
Trond Myklebust19445b92010-04-16 16:41:10 -0400925 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400926
Trond Myklebust84115e12007-07-14 15:39:59 -0400927 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400928 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400929 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400930
Trond Myklebust58f96122010-07-31 14:29:08 -0400931 rpc_task_set_client(task, task_setup_data->rpc_client);
932 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
933
Trond Myklebust58f96122010-07-31 14:29:08 -0400934 if (task->tk_action == NULL)
935 rpc_call_start(task);
936
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400937 atomic_inc(&task->tk_count);
938 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400939out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400940 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400941}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400942EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400943
944/**
945 * rpc_call_sync - Perform a synchronous RPC call
946 * @clnt: pointer to RPC client
947 * @msg: RPC call parameters
948 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500950int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951{
952 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400953 struct rpc_task_setup task_setup_data = {
954 .rpc_client = clnt,
955 .rpc_message = msg,
956 .callback_ops = &rpc_default_ops,
957 .flags = flags,
958 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400959 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400961 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
962 if (flags & RPC_TASK_ASYNC) {
963 rpc_release_calldata(task_setup_data.callback_ops,
964 task_setup_data.callback_data);
965 return -EINVAL;
966 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Trond Myklebustc970aa82007-07-14 15:39:59 -0400968 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400969 if (IS_ERR(task))
970 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100971 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800972 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 return status;
974}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400975EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400977/**
978 * rpc_call_async - Perform an asynchronous RPC call
979 * @clnt: pointer to RPC client
980 * @msg: RPC call parameters
981 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800982 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400983 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 */
985int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500986rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100987 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988{
989 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400990 struct rpc_task_setup task_setup_data = {
991 .rpc_client = clnt,
992 .rpc_message = msg,
993 .callback_ops = tk_ops,
994 .callback_data = data,
995 .flags = flags|RPC_TASK_ASYNC,
996 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Trond Myklebustc970aa82007-07-14 15:39:59 -0400998 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400999 if (IS_ERR(task))
1000 return PTR_ERR(task);
1001 rpc_put_task(task);
1002 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001004EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001006#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001007/**
1008 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1009 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001010 * @req: RPC request
1011 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001012 */
1013struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001014 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001015{
1016 struct rpc_task *task;
1017 struct xdr_buf *xbufp = &req->rq_snd_buf;
1018 struct rpc_task_setup task_setup_data = {
1019 .callback_ops = tk_ops,
1020 };
1021
1022 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1023 /*
1024 * Create an rpc_task to send the data
1025 */
1026 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001027 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001028 xprt_free_bc_request(req);
1029 goto out;
1030 }
1031 task->tk_rqstp = req;
1032
1033 /*
1034 * Set up the xdr_buf length.
1035 * This also indicates that the buffer is XDR encoded already.
1036 */
1037 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1038 xbufp->tail[0].iov_len;
1039
1040 task->tk_action = call_bc_transmit;
1041 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001042 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001043 rpc_execute(task);
1044
1045out:
1046 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1047 return task;
1048}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001049#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001050
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001052rpc_call_start(struct rpc_task *task)
1053{
1054 task->tk_action = call_start;
1055}
1056EXPORT_SYMBOL_GPL(rpc_call_start);
1057
Chuck Levered394402006-08-22 20:06:17 -04001058/**
1059 * rpc_peeraddr - extract remote peer address from clnt's xprt
1060 * @clnt: RPC client structure
1061 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001062 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001063 *
1064 * Returns the number of bytes that are actually in the stored address.
1065 */
1066size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1067{
1068 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001069 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001070
Trond Myklebust2446ab62012-03-01 17:00:56 -05001071 rcu_read_lock();
1072 xprt = rcu_dereference(clnt->cl_xprt);
1073
1074 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001075 if (bytes > bufsize)
1076 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001077 memcpy(buf, &xprt->addr, bytes);
1078 rcu_read_unlock();
1079
1080 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001081}
Chuck Leverb86acd52006-08-22 20:06:22 -04001082EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001083
Chuck Leverf425eba2006-08-22 20:06:18 -04001084/**
1085 * rpc_peeraddr2str - return remote peer address in printable format
1086 * @clnt: RPC client structure
1087 * @format: address format
1088 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001089 * NB: the lifetime of the memory referenced by the returned pointer is
1090 * the same as the rpc_xprt itself. As long as the caller uses this
1091 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001092 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001093const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1094 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001095{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001096 struct rpc_xprt *xprt;
1097
1098 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001099
1100 if (xprt->address_strings[format] != NULL)
1101 return xprt->address_strings[format];
1102 else
1103 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001104}
Chuck Leverb86acd52006-08-22 20:06:22 -04001105EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001106
Chuck Lever2e738fd2012-03-01 17:01:14 -05001107static const struct sockaddr_in rpc_inaddr_loopback = {
1108 .sin_family = AF_INET,
1109 .sin_addr.s_addr = htonl(INADDR_ANY),
1110};
1111
1112static const struct sockaddr_in6 rpc_in6addr_loopback = {
1113 .sin6_family = AF_INET6,
1114 .sin6_addr = IN6ADDR_ANY_INIT,
1115};
1116
1117/*
1118 * Try a getsockname() on a connected datagram socket. Using a
1119 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1120 * This conserves the ephemeral port number space.
1121 *
1122 * Returns zero and fills in "buf" if successful; otherwise, a
1123 * negative errno is returned.
1124 */
1125static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1126 struct sockaddr *buf, int buflen)
1127{
1128 struct socket *sock;
1129 int err;
1130
1131 err = __sock_create(net, sap->sa_family,
1132 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1133 if (err < 0) {
1134 dprintk("RPC: can't create UDP socket (%d)\n", err);
1135 goto out;
1136 }
1137
1138 switch (sap->sa_family) {
1139 case AF_INET:
1140 err = kernel_bind(sock,
1141 (struct sockaddr *)&rpc_inaddr_loopback,
1142 sizeof(rpc_inaddr_loopback));
1143 break;
1144 case AF_INET6:
1145 err = kernel_bind(sock,
1146 (struct sockaddr *)&rpc_in6addr_loopback,
1147 sizeof(rpc_in6addr_loopback));
1148 break;
1149 default:
1150 err = -EAFNOSUPPORT;
1151 goto out;
1152 }
1153 if (err < 0) {
1154 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1155 goto out_release;
1156 }
1157
1158 err = kernel_connect(sock, sap, salen, 0);
1159 if (err < 0) {
1160 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1161 goto out_release;
1162 }
1163
1164 err = kernel_getsockname(sock, buf, &buflen);
1165 if (err < 0) {
1166 dprintk("RPC: getsockname failed (%d)\n", err);
1167 goto out_release;
1168 }
1169
1170 err = 0;
1171 if (buf->sa_family == AF_INET6) {
1172 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1173 sin6->sin6_scope_id = 0;
1174 }
1175 dprintk("RPC: %s succeeded\n", __func__);
1176
1177out_release:
1178 sock_release(sock);
1179out:
1180 return err;
1181}
1182
1183/*
1184 * Scraping a connected socket failed, so we don't have a useable
1185 * local address. Fallback: generate an address that will prevent
1186 * the server from calling us back.
1187 *
1188 * Returns zero and fills in "buf" if successful; otherwise, a
1189 * negative errno is returned.
1190 */
1191static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1192{
1193 switch (family) {
1194 case AF_INET:
1195 if (buflen < sizeof(rpc_inaddr_loopback))
1196 return -EINVAL;
1197 memcpy(buf, &rpc_inaddr_loopback,
1198 sizeof(rpc_inaddr_loopback));
1199 break;
1200 case AF_INET6:
1201 if (buflen < sizeof(rpc_in6addr_loopback))
1202 return -EINVAL;
1203 memcpy(buf, &rpc_in6addr_loopback,
1204 sizeof(rpc_in6addr_loopback));
1205 default:
1206 dprintk("RPC: %s: address family not supported\n",
1207 __func__);
1208 return -EAFNOSUPPORT;
1209 }
1210 dprintk("RPC: %s: succeeded\n", __func__);
1211 return 0;
1212}
1213
1214/**
1215 * rpc_localaddr - discover local endpoint address for an RPC client
1216 * @clnt: RPC client structure
1217 * @buf: target buffer
1218 * @buflen: size of target buffer, in bytes
1219 *
1220 * Returns zero and fills in "buf" and "buflen" if successful;
1221 * otherwise, a negative errno is returned.
1222 *
1223 * This works even if the underlying transport is not currently connected,
1224 * or if the upper layer never previously provided a source address.
1225 *
1226 * The result of this function call is transient: multiple calls in
1227 * succession may give different results, depending on how local
1228 * networking configuration changes over time.
1229 */
1230int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1231{
1232 struct sockaddr_storage address;
1233 struct sockaddr *sap = (struct sockaddr *)&address;
1234 struct rpc_xprt *xprt;
1235 struct net *net;
1236 size_t salen;
1237 int err;
1238
1239 rcu_read_lock();
1240 xprt = rcu_dereference(clnt->cl_xprt);
1241 salen = xprt->addrlen;
1242 memcpy(sap, &xprt->addr, salen);
1243 net = get_net(xprt->xprt_net);
1244 rcu_read_unlock();
1245
1246 rpc_set_port(sap, 0);
1247 err = rpc_sockname(net, sap, salen, buf, buflen);
1248 put_net(net);
1249 if (err != 0)
1250 /* Couldn't discover local address, return ANYADDR */
1251 return rpc_anyaddr(sap->sa_family, buf, buflen);
1252 return 0;
1253}
1254EXPORT_SYMBOL_GPL(rpc_localaddr);
1255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256void
1257rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1258{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001259 struct rpc_xprt *xprt;
1260
1261 rcu_read_lock();
1262 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001263 if (xprt->ops->set_buffer_size)
1264 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001265 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001267EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
Trond Myklebust2446ab62012-03-01 17:00:56 -05001269/**
1270 * rpc_protocol - Get transport protocol number for an RPC client
1271 * @clnt: RPC client to query
1272 *
1273 */
1274int rpc_protocol(struct rpc_clnt *clnt)
1275{
1276 int protocol;
1277
1278 rcu_read_lock();
1279 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1280 rcu_read_unlock();
1281 return protocol;
1282}
1283EXPORT_SYMBOL_GPL(rpc_protocol);
1284
1285/**
1286 * rpc_net_ns - Get the network namespace for this RPC client
1287 * @clnt: RPC client to query
1288 *
1289 */
1290struct net *rpc_net_ns(struct rpc_clnt *clnt)
1291{
1292 struct net *ret;
1293
1294 rcu_read_lock();
1295 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1296 rcu_read_unlock();
1297 return ret;
1298}
1299EXPORT_SYMBOL_GPL(rpc_net_ns);
1300
1301/**
1302 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1303 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 *
1305 * For stream transports, this is one RPC record fragment (see RFC
1306 * 1831), as we don't support multi-record requests yet. For datagram
1307 * transports, this is the size of an IP packet minus the IP, UDP, and
1308 * RPC header sizes.
1309 */
1310size_t rpc_max_payload(struct rpc_clnt *clnt)
1311{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001312 size_t ret;
1313
1314 rcu_read_lock();
1315 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1316 rcu_read_unlock();
1317 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318}
Chuck Leverb86acd52006-08-22 20:06:22 -04001319EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Chuck Lever35f5a422006-01-03 09:55:50 +01001321/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001322 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001323 * @clnt: RPC client to query
1324 */
1325unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1326{
1327 unsigned long ret;
1328
1329 rcu_read_lock();
1330 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1331 rcu_read_unlock();
1332 return ret;
1333}
1334EXPORT_SYMBOL_GPL(rpc_get_timeout);
1335
1336/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001337 * rpc_force_rebind - force transport to check that remote port is unchanged
1338 * @clnt: client to rebind
1339 *
1340 */
1341void rpc_force_rebind(struct rpc_clnt *clnt)
1342{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001343 if (clnt->cl_autobind) {
1344 rcu_read_lock();
1345 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1346 rcu_read_unlock();
1347 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001348}
Chuck Leverb86acd52006-08-22 20:06:22 -04001349EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001352 * Restart an (async) RPC call from the call_prepare state.
1353 * Usually called from within the exit handler.
1354 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001355int
Andy Adamsonaae20062009-04-01 09:22:40 -04001356rpc_restart_call_prepare(struct rpc_task *task)
1357{
1358 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001359 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001360 task->tk_action = call_start;
1361 if (task->tk_ops->rpc_call_prepare != NULL)
1362 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001363 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001364}
1365EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1366
1367/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 * Restart an (async) RPC call. Usually called from within the
1369 * exit handler.
1370 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001371int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372rpc_restart_call(struct rpc_task *task)
1373{
1374 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001375 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001377 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001379EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
Chuck Lever3748f1e2008-05-21 17:09:12 -04001381#ifdef RPC_DEBUG
1382static const char *rpc_proc_name(const struct rpc_task *task)
1383{
1384 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1385
1386 if (proc) {
1387 if (proc->p_name)
1388 return proc->p_name;
1389 else
1390 return "NULL";
1391 } else
1392 return "no proc";
1393}
1394#endif
1395
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396/*
1397 * 0. Initial state
1398 *
1399 * Other FSM states can be visited zero or more times, but
1400 * this state is visited exactly once for each RPC.
1401 */
1402static void
1403call_start(struct rpc_task *task)
1404{
1405 struct rpc_clnt *clnt = task->tk_client;
1406
Chuck Lever3748f1e2008-05-21 17:09:12 -04001407 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001408 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001409 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001410 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
1412 /* Increment call count */
1413 task->tk_msg.rpc_proc->p_count++;
1414 clnt->cl_stats->rpccnt++;
1415 task->tk_action = call_reserve;
1416}
1417
1418/*
1419 * 1. Reserve an RPC call slot
1420 */
1421static void
1422call_reserve(struct rpc_task *task)
1423{
Chuck Lever46121cf2007-01-31 12:14:08 -05001424 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 task->tk_status = 0;
1427 task->tk_action = call_reserveresult;
1428 xprt_reserve(task);
1429}
1430
Trond Myklebustba60eb22013-04-14 10:49:37 -04001431static void call_retry_reserve(struct rpc_task *task);
1432
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433/*
1434 * 1b. Grok the result of xprt_reserve()
1435 */
1436static void
1437call_reserveresult(struct rpc_task *task)
1438{
1439 int status = task->tk_status;
1440
Chuck Lever46121cf2007-01-31 12:14:08 -05001441 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
1443 /*
1444 * After a call to xprt_reserve(), we must have either
1445 * a request slot or else an error status.
1446 */
1447 task->tk_status = 0;
1448 if (status >= 0) {
1449 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001450 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 return;
1452 }
1453
1454 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001455 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 rpc_exit(task, -EIO);
1457 return;
1458 }
1459
1460 /*
1461 * Even though there was an error, we may have acquired
1462 * a request slot somehow. Make sure not to leak it.
1463 */
1464 if (task->tk_rqstp) {
1465 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001466 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 xprt_release(task);
1468 }
1469
1470 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001471 case -ENOMEM:
1472 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001474 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 return;
1476 case -EIO: /* probably a shutdown */
1477 break;
1478 default:
1479 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001480 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 break;
1482 }
1483 rpc_exit(task, status);
1484}
1485
1486/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001487 * 1c. Retry reserving an RPC call slot
1488 */
1489static void
1490call_retry_reserve(struct rpc_task *task)
1491{
1492 dprint_status(task);
1493
1494 task->tk_status = 0;
1495 task->tk_action = call_reserveresult;
1496 xprt_retry_reserve(task);
1497}
1498
1499/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001500 * 2. Bind and/or refresh the credentials
1501 */
1502static void
1503call_refresh(struct rpc_task *task)
1504{
1505 dprint_status(task);
1506
1507 task->tk_action = call_refreshresult;
1508 task->tk_status = 0;
1509 task->tk_client->cl_stats->rpcauthrefresh++;
1510 rpcauth_refreshcred(task);
1511}
1512
1513/*
1514 * 2a. Process the results of a credential refresh
1515 */
1516static void
1517call_refreshresult(struct rpc_task *task)
1518{
1519 int status = task->tk_status;
1520
1521 dprint_status(task);
1522
1523 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001524 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001525 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001526 case 0:
1527 if (rpcauth_uptodatecred(task))
1528 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001529 return;
1530 case -ETIMEDOUT:
1531 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001532 case -EAGAIN:
1533 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001534 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001535 if (!task->tk_cred_retry)
1536 break;
1537 task->tk_cred_retry--;
1538 dprintk("RPC: %5u %s: retry refresh creds\n",
1539 task->tk_pid, __func__);
1540 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001541 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001542 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1543 task->tk_pid, __func__, status);
1544 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001545}
1546
1547/*
1548 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001549 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 */
1551static void
1552call_allocate(struct rpc_task *task)
1553{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001554 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001555 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001556 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001557 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
Chuck Lever46121cf2007-01-31 12:14:08 -05001559 dprint_status(task);
1560
Chuck Lever2bea90d2007-03-29 16:47:53 -04001561 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001562 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001563
Chuck Lever02107142006-01-03 09:55:49 +01001564 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 return;
1566
Chuck Lever2bea90d2007-03-29 16:47:53 -04001567 if (proc->p_proc != 0) {
1568 BUG_ON(proc->p_arglen == 0);
1569 if (proc->p_decode != NULL)
1570 BUG_ON(proc->p_replen == 0);
1571 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Chuck Lever2bea90d2007-03-29 16:47:53 -04001573 /*
1574 * Calculate the size (in quads) of the RPC call
1575 * and reply headers, and convert both values
1576 * to byte sizes.
1577 */
1578 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1579 req->rq_callsize <<= 2;
1580 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1581 req->rq_rcvsize <<= 2;
1582
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001583 req->rq_buffer = xprt->ops->buf_alloc(task,
1584 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001585 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001587
1588 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
Trond Myklebust5afa9132011-06-17 10:14:59 -04001590 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001591 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 rpc_delay(task, HZ>>4);
1593 return;
1594 }
1595
1596 rpc_exit(task, -ERESTARTSYS);
1597}
1598
Trond Myklebust940e3312005-11-09 21:45:24 -05001599static inline int
1600rpc_task_need_encode(struct rpc_task *task)
1601{
1602 return task->tk_rqstp->rq_snd_buf.len == 0;
1603}
1604
1605static inline void
1606rpc_task_force_reencode(struct rpc_task *task)
1607{
1608 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001609 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001610}
1611
Chuck Lever2bea90d2007-03-29 16:47:53 -04001612static inline void
1613rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1614{
1615 buf->head[0].iov_base = start;
1616 buf->head[0].iov_len = len;
1617 buf->tail[0].iov_len = 0;
1618 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001619 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001620 buf->len = 0;
1621 buf->buflen = len;
1622}
1623
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624/*
1625 * 3. Encode arguments of an RPC call
1626 */
1627static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001628rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001631 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001632 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Chuck Lever46121cf2007-01-31 12:14:08 -05001634 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635
Chuck Lever2bea90d2007-03-29 16:47:53 -04001636 rpc_xdr_buf_init(&req->rq_snd_buf,
1637 req->rq_buffer,
1638 req->rq_callsize);
1639 rpc_xdr_buf_init(&req->rq_rcv_buf,
1640 (char *)req->rq_buffer + req->rq_callsize,
1641 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Chuck Leverb0e1c572008-05-21 17:09:19 -04001643 p = rpc_encode_header(task);
1644 if (p == NULL) {
1645 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 rpc_exit(task, -EIO);
1647 return;
1648 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001649
1650 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001651 if (encode == NULL)
1652 return;
1653
1654 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1655 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656}
1657
1658/*
1659 * 4. Get the server port number if not yet set
1660 */
1661static void
1662call_bind(struct rpc_task *task)
1663{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001664 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Chuck Lever46121cf2007-01-31 12:14:08 -05001666 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
Chuck Leverda351872005-08-11 16:25:11 -04001668 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001669 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001670 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001671 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001672 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 }
1674}
1675
1676/*
Chuck Leverda351872005-08-11 16:25:11 -04001677 * 4a. Sort out bind result
1678 */
1679static void
1680call_bind_status(struct rpc_task *task)
1681{
Chuck Lever906462a2007-09-11 18:00:47 -04001682 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001683
1684 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001685 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001686 task->tk_status = 0;
1687 task->tk_action = call_connect;
1688 return;
1689 }
1690
Steve Dickson5753cba2012-02-06 10:08:08 -05001691 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001692 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001693 case -ENOMEM:
1694 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1695 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001696 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001697 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001698 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1699 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001700 /* fail immediately if this is an RPC ping */
1701 if (task->tk_msg.rpc_proc->p_proc == 0) {
1702 status = -EOPNOTSUPP;
1703 break;
1704 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001705 if (task->tk_rebind_retry == 0)
1706 break;
1707 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001708 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001709 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001710 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001711 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001712 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001713 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001714 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001715 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001716 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001717 task->tk_pid);
1718 break;
1719 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001720 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001721 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001722 task->tk_status = 0;
1723 task->tk_action = call_bind;
1724 return;
Chuck Lever012da152009-12-03 15:58:56 -05001725 case -ECONNREFUSED: /* connection problems */
1726 case -ECONNRESET:
1727 case -ENOTCONN:
1728 case -EHOSTDOWN:
1729 case -EHOSTUNREACH:
1730 case -ENETUNREACH:
1731 case -EPIPE:
1732 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1733 task->tk_pid, task->tk_status);
1734 if (!RPC_IS_SOFTCONN(task)) {
1735 rpc_delay(task, 5*HZ);
1736 goto retry_timeout;
1737 }
1738 status = task->tk_status;
1739 break;
Chuck Leverda351872005-08-11 16:25:11 -04001740 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001741 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001742 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001743 }
1744
1745 rpc_exit(task, status);
1746 return;
1747
Trond Myklebustda458282006-08-31 15:44:52 -04001748retry_timeout:
1749 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001750}
1751
1752/*
1753 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 */
1755static void
1756call_connect(struct rpc_task *task)
1757{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001758 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
Chuck Lever46121cf2007-01-31 12:14:08 -05001760 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001761 task->tk_pid, xprt,
1762 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Chuck Leverda351872005-08-11 16:25:11 -04001764 task->tk_action = call_transmit;
1765 if (!xprt_connected(xprt)) {
1766 task->tk_action = call_connect_status;
1767 if (task->tk_status < 0)
1768 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001769 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1770 rpc_exit(task, -ENOTCONN);
1771 return;
1772 }
Chuck Leverda351872005-08-11 16:25:11 -04001773 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775}
1776
1777/*
Chuck Leverda351872005-08-11 16:25:11 -04001778 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 */
1780static void
1781call_connect_status(struct rpc_task *task)
1782{
1783 struct rpc_clnt *clnt = task->tk_client;
1784 int status = task->tk_status;
1785
Chuck Lever46121cf2007-01-31 12:14:08 -05001786 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001787
Steve Dickson5753cba2012-02-06 10:08:08 -05001788 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001789 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001791 /* if soft mounted, test if we've timed out */
1792 case -ETIMEDOUT:
1793 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001794 return;
1795 case -ECONNREFUSED:
1796 case -ECONNRESET:
1797 case -ENETUNREACH:
Trond Myklebust561ec162013-09-26 15:22:45 -04001798 /* retry with existing socket, after a delay */
1799 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001800 if (RPC_IS_SOFTCONN(task))
1801 break;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001802 case -EAGAIN:
Trond Myklebust561ec162013-09-26 15:22:45 -04001803 task->tk_action = call_bind;
1804 return;
1805 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001806 clnt->cl_stats->netreconn++;
1807 task->tk_action = call_transmit;
1808 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001810 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811}
1812
1813/*
1814 * 5. Transmit the RPC request, and wait for reply
1815 */
1816static void
1817call_transmit(struct rpc_task *task)
1818{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001819 int is_retrans = RPC_WAS_SENT(task);
1820
Chuck Lever46121cf2007-01-31 12:14:08 -05001821 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823 task->tk_action = call_status;
1824 if (task->tk_status < 0)
1825 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001826 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001828 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001830 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001831 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001832 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001833 if (task->tk_status != 0) {
1834 /* Was the error nonfatal? */
1835 if (task->tk_status == -EAGAIN)
1836 rpc_delay(task, HZ >> 4);
1837 else
1838 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001839 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001840 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001841 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 xprt_transmit(task);
1843 if (task->tk_status < 0)
1844 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001845 if (is_retrans)
1846 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001847 /*
1848 * On success, ensure that we call xprt_end_transmit() before sleeping
1849 * in order to allow access to the socket to other RPC requests.
1850 */
1851 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001852 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001853 return;
1854 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001855 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001856}
1857
1858/*
1859 * 5a. Handle cleanup after a transmission
1860 */
1861static void
1862call_transmit_status(struct rpc_task *task)
1863{
1864 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001865
1866 /*
1867 * Common case: success. Force the compiler to put this
1868 * test first.
1869 */
1870 if (task->tk_status == 0) {
1871 xprt_end_transmit(task);
1872 rpc_task_force_reencode(task);
1873 return;
1874 }
1875
Trond Myklebust15f081c2009-03-11 14:37:57 -04001876 switch (task->tk_status) {
1877 case -EAGAIN:
1878 break;
1879 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001880 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001881 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001882 rpc_task_force_reencode(task);
1883 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001884 /*
1885 * Special cases: if we've been waiting on the
1886 * socket's write_space() callback, or if the
1887 * socket just returned a connection error,
1888 * then hold onto the transport lock.
1889 */
1890 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001891 case -EHOSTDOWN:
1892 case -EHOSTUNREACH:
1893 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001894 if (RPC_IS_SOFTCONN(task)) {
1895 xprt_end_transmit(task);
1896 rpc_exit(task, task->tk_status);
1897 break;
1898 }
1899 case -ECONNRESET:
1900 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001901 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001902 rpc_task_force_reencode(task);
1903 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904}
1905
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001906#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001907/*
1908 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1909 * addition, disconnect on connectivity errors.
1910 */
1911static void
1912call_bc_transmit(struct rpc_task *task)
1913{
1914 struct rpc_rqst *req = task->tk_rqstp;
1915
Trond Myklebust90051ea2013-09-25 12:17:18 -04001916 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001917 /*
1918 * Could not reserve the transport. Try again after the
1919 * transport is released.
1920 */
1921 task->tk_status = 0;
1922 task->tk_action = call_bc_transmit;
1923 return;
1924 }
1925
1926 task->tk_action = rpc_exit_task;
1927 if (task->tk_status < 0) {
1928 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1929 "error: %d\n", task->tk_status);
1930 return;
1931 }
1932
1933 xprt_transmit(task);
1934 xprt_end_transmit(task);
1935 dprint_status(task);
1936 switch (task->tk_status) {
1937 case 0:
1938 /* Success */
1939 break;
1940 case -EHOSTDOWN:
1941 case -EHOSTUNREACH:
1942 case -ENETUNREACH:
1943 case -ETIMEDOUT:
1944 /*
1945 * Problem reaching the server. Disconnect and let the
1946 * forechannel reestablish the connection. The server will
1947 * have to retransmit the backchannel request and we'll
1948 * reprocess it. Since these ops are idempotent, there's no
1949 * need to cache our reply at this time.
1950 */
1951 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1952 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001953 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001954 req->rq_connect_cookie);
1955 break;
1956 default:
1957 /*
1958 * We were unable to reply and will have to drop the
1959 * request. The server should reconnect and retransmit.
1960 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001961 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001962 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1963 "error: %d\n", task->tk_status);
1964 break;
1965 }
1966 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1967}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001968#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970/*
1971 * 6. Sort out the RPC call status
1972 */
1973static void
1974call_status(struct rpc_task *task)
1975{
1976 struct rpc_clnt *clnt = task->tk_client;
1977 struct rpc_rqst *req = task->tk_rqstp;
1978 int status;
1979
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001980 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1981 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982
Chuck Lever46121cf2007-01-31 12:14:08 -05001983 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
1985 status = task->tk_status;
1986 if (status >= 0) {
1987 task->tk_action = call_decode;
1988 return;
1989 }
1990
Steve Dickson5753cba2012-02-06 10:08:08 -05001991 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 task->tk_status = 0;
1993 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001994 case -EHOSTDOWN:
1995 case -EHOSTUNREACH:
1996 case -ENETUNREACH:
1997 /*
1998 * Delay any retries for 3 seconds, then handle as if it
1999 * were a timeout.
2000 */
2001 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 case -ETIMEDOUT:
2003 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002004 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2005 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002006 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002007 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04002009 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002011 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04002012 rpc_delay(task, 3*HZ);
2013 case -EPIPE:
2014 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 task->tk_action = call_bind;
2016 break;
2017 case -EAGAIN:
2018 task->tk_action = call_transmit;
2019 break;
2020 case -EIO:
2021 /* shutdown or soft timeout */
2022 rpc_exit(task, status);
2023 break;
2024 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002025 if (clnt->cl_chatty)
2026 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002027 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 }
2030}
2031
2032/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002033 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 * We do not release the request slot, so we keep using the
2035 * same XID for all retransmits.
2036 */
2037static void
2038call_timeout(struct rpc_task *task)
2039{
2040 struct rpc_clnt *clnt = task->tk_client;
2041
2042 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002043 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 goto retry;
2045 }
2046
Chuck Lever46121cf2007-01-31 12:14:08 -05002047 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002048 task->tk_timeouts++;
2049
Chuck Lever3a28bec2009-12-03 15:58:56 -05002050 if (RPC_IS_SOFTCONN(task)) {
2051 rpc_exit(task, -ETIMEDOUT);
2052 return;
2053 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002055 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002056 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002057 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002058 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002059 rcu_dereference(clnt->cl_xprt)->servername);
2060 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07002061 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002062 if (task->tk_flags & RPC_TASK_TIMEOUT)
2063 rpc_exit(task, -ETIMEDOUT);
2064 else
2065 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 return;
2067 }
2068
Chuck Leverf518e35a2006-01-03 09:55:52 +01002069 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002071 if (clnt->cl_chatty) {
2072 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002073 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002074 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002075 rcu_dereference(clnt->cl_xprt)->servername);
2076 rcu_read_unlock();
2077 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002079 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002080 /*
2081 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2082 * event? RFC2203 requires the server to drop all such requests.
2083 */
2084 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
2086retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 task->tk_action = call_bind;
2088 task->tk_status = 0;
2089}
2090
2091/*
2092 * 7. Decode the RPC reply
2093 */
2094static void
2095call_decode(struct rpc_task *task)
2096{
2097 struct rpc_clnt *clnt = task->tk_client;
2098 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002099 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002100 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101
Vasily Averin726fd6a2011-06-01 16:23:59 +04002102 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
Chuck Leverf518e35a2006-01-03 09:55:52 +01002104 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002105 if (clnt->cl_chatty) {
2106 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002107 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002108 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002109 rcu_dereference(clnt->cl_xprt)->servername);
2110 rcu_read_unlock();
2111 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2113 }
2114
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002115 /*
2116 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002117 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002118 */
2119 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 req->rq_rcv_buf.len = req->rq_private_buf.len;
2121
2122 /* Check that the softirq receive buffer is valid */
2123 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2124 sizeof(req->rq_rcv_buf)) != 0);
2125
Trond Myklebust1e799b62008-03-21 16:19:41 -04002126 if (req->rq_rcv_buf.len < 12) {
2127 if (!RPC_IS_SOFT(task)) {
2128 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002129 goto out_retry;
2130 }
2131 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002132 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002133 task->tk_action = call_timeout;
2134 goto out_retry;
2135 }
2136
Chuck Leverb0e1c572008-05-21 17:09:19 -04002137 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002138 if (IS_ERR(p)) {
2139 if (p == ERR_PTR(-EAGAIN))
2140 goto out_retry;
2141 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 }
2143
Trond Myklebustabbcf282006-01-03 09:55:03 +01002144 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002146 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2148 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002149 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002150 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2151 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 return;
2153out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002155 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002156 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002157 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002158 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002159 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002160 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002161 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162}
2163
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002164static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002165rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166{
2167 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002169 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
2171 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002172
Trond Myklebusta4f08352013-01-08 09:10:21 -05002173 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 *p++ = req->rq_xid; /* XID */
2175 *p++ = htonl(RPC_CALL); /* CALL */
2176 *p++ = htonl(RPC_VERSION); /* RPC version */
2177 *p++ = htonl(clnt->cl_prog); /* program number */
2178 *p++ = htonl(clnt->cl_vers); /* program version */
2179 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002180 p = rpcauth_marshcred(task, p);
2181 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2182 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183}
2184
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002185static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002186rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002188 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2190 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002191 __be32 *p = iov->iov_base;
2192 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 int error = -EACCES;
2194
David Howellse8896492006-08-24 15:44:19 -04002195 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2196 /* RFC-1014 says that the representation of XDR data must be a
2197 * multiple of four bytes
2198 * - if it isn't pointer subtraction in the NFS client may give
2199 * undefined results
2200 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002201 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002202 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002203 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002204 error = -EIO;
2205 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 if ((len -= 3) < 0)
2208 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002210 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002212 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002213 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002214 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002215 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002217
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2219 if (--len < 0)
2220 goto out_overflow;
2221 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002222 case RPC_AUTH_ERROR:
2223 break;
2224 case RPC_MISMATCH:
2225 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2226 task->tk_pid, __func__);
2227 error = -EPROTONOSUPPORT;
2228 goto out_err;
2229 default:
2230 dprintk("RPC: %5u %s: RPC call rejected, "
2231 "unknown error: %x\n",
2232 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002233 error = -EIO;
2234 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 }
2236 if (--len < 0)
2237 goto out_overflow;
2238 switch ((n = ntohl(*p++))) {
2239 case RPC_AUTH_REJECTEDCRED:
2240 case RPC_AUTH_REJECTEDVERF:
2241 case RPCSEC_GSS_CREDPROBLEM:
2242 case RPCSEC_GSS_CTXPROBLEM:
2243 if (!task->tk_cred_retry)
2244 break;
2245 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002246 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002247 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002249 /* Ensure we obtain a new XID! */
2250 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002251 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002252 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 case RPC_AUTH_BADCRED:
2254 case RPC_AUTH_BADVERF:
2255 /* possibly garbled cred/verf? */
2256 if (!task->tk_garb_retry)
2257 break;
2258 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002259 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002260 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002262 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002264 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002265 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002266 "authentication.\n",
2267 rcu_dereference(clnt->cl_xprt)->servername);
2268 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 break;
2270 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002271 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002272 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 error = -EIO;
2274 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002275 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002276 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 goto out_err;
2278 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002279 p = rpcauth_checkverf(task, p);
2280 if (IS_ERR(p)) {
2281 error = PTR_ERR(p);
2282 dprintk("RPC: %5u %s: auth check failed with %d\n",
2283 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002284 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002286 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 if (len < 0)
2288 goto out_overflow;
2289 switch ((n = ntohl(*p++))) {
2290 case RPC_SUCCESS:
2291 return p;
2292 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002293 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2294 "by server %s\n", task->tk_pid, __func__,
2295 (unsigned int)clnt->cl_prog,
2296 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002297 error = -EPFNOSUPPORT;
2298 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002300 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2301 "by server %s\n", task->tk_pid, __func__,
2302 (unsigned int)clnt->cl_prog,
2303 (unsigned int)clnt->cl_vers,
2304 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002305 error = -EPROTONOSUPPORT;
2306 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002308 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002309 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002310 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002311 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002312 clnt->cl_prog, clnt->cl_vers,
2313 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002314 error = -EOPNOTSUPP;
2315 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002317 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002318 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 break; /* retry */
2320 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002321 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002322 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 /* Also retry */
2324 }
2325
Trond Myklebustabbcf282006-01-03 09:55:03 +01002326out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002327 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 if (task->tk_garb_retry) {
2329 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002330 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002331 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002333out_retry:
2334 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336out_err:
2337 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002338 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002339 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002340 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002342 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002343 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002344 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002346
Chuck Lever9f06c712010-12-14 14:59:18 +00002347static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002348{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002349}
2350
Chuck Leverbf269552010-12-14 14:59:29 +00002351static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002352{
2353 return 0;
2354}
2355
2356static struct rpc_procinfo rpcproc_null = {
2357 .p_encode = rpcproc_encode_null,
2358 .p_decode = rpcproc_decode_null,
2359};
2360
Chuck Levercaabea82009-12-03 15:58:56 -05002361static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002362{
2363 struct rpc_message msg = {
2364 .rpc_proc = &rpcproc_null,
2365 };
2366 int err;
2367 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002368 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002369 put_rpccred(msg.rpc_cred);
2370 return err;
2371}
Trond Myklebust188fef12007-06-16 14:18:40 -04002372
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002373struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2374{
2375 struct rpc_message msg = {
2376 .rpc_proc = &rpcproc_null,
2377 .rpc_cred = cred,
2378 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002379 struct rpc_task_setup task_setup_data = {
2380 .rpc_client = clnt,
2381 .rpc_message = &msg,
2382 .callback_ops = &rpc_default_ops,
2383 .flags = flags,
2384 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002385 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002386}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002387EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002388
Trond Myklebust188fef12007-06-16 14:18:40 -04002389#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002390static void rpc_show_header(void)
2391{
Chuck Levercb3997b2008-05-21 17:09:41 -04002392 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2393 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002394}
2395
Chuck Lever38e886e2008-05-21 17:09:33 -04002396static void rpc_show_task(const struct rpc_clnt *clnt,
2397 const struct rpc_task *task)
2398{
2399 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002400
2401 if (RPC_IS_QUEUED(task))
2402 rpc_waitq = rpc_qname(task->tk_waitqueue);
2403
Joe Perchesb3bceda2010-12-21 10:52:24 -05002404 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 -04002405 task->tk_pid, task->tk_flags, task->tk_status,
2406 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002407 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002408 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002409}
2410
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002411void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002412{
2413 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002414 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002415 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002416 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002417
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002418 spin_lock(&sn->rpc_client_lock);
2419 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002420 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002421 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002422 if (!header) {
2423 rpc_show_header();
2424 header++;
2425 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002426 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002427 }
2428 spin_unlock(&clnt->cl_lock);
2429 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002430 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002431}
2432#endif