blob: 488ddeed9363db71e1b5a80df4863a464345cb20 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
159 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
179 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400191 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400192 if (!dentry)
193 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400194 if (IS_ERR(dentry))
195 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400207static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
209{
210 int error = 0;
211
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
216 break;
217 }
218 return error;
219}
220
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400221static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222{
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
225
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400228 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 spin_unlock(&sn->rpc_client_lock);
231 return clnt;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return NULL;
235}
236
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400237static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
238 void *ptr)
239{
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
242 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400243
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400245 error = __rpc_pipefs_event(clnt, event, sb);
246 if (error)
247 break;
248 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249 return error;
250}
251
252static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400267static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
268 struct rpc_xprt *xprt,
269 const struct rpc_timeout *timeout)
270{
271 struct rpc_xprt *old;
272
273 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400274 old = rcu_dereference_protected(clnt->cl_xprt,
275 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400276
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
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800441struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
442 struct rpc_xprt *xprt)
443{
444 struct rpc_clnt *clnt = NULL;
445
446 clnt = rpc_new_client(args, xprt, NULL);
447 if (IS_ERR(clnt))
448 return clnt;
449
450 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
451 int err = rpc_ping(clnt);
452 if (err != 0) {
453 rpc_shutdown_client(clnt);
454 return ERR_PTR(err);
455 }
456 }
457
458 clnt->cl_softrtry = 1;
459 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
460 clnt->cl_softrtry = 0;
461
462 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
463 clnt->cl_autobind = 1;
464 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
465 clnt->cl_discrtry = 1;
466 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
467 clnt->cl_chatty = 1;
468
469 return clnt;
470}
471EXPORT_SYMBOL_GPL(rpc_create_xprt);
472
Ben Hutchings2c530402012-07-10 10:55:09 +0000473/**
Chuck Leverc2866762006-08-22 20:06:20 -0400474 * rpc_create - create an RPC client and transport with one call
475 * @args: rpc_clnt create argument structure
476 *
477 * Creates and initializes an RPC transport and an RPC client.
478 *
479 * It can ping the server in order to determine if it is up, and to see if
480 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
481 * this behavior so asynchronous tasks can also use rpc_create.
482 */
483struct rpc_clnt *rpc_create(struct rpc_create_args *args)
484{
485 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400486 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400487 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400488 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200489 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200490 .dstaddr = args->address,
491 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500492 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300493 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200494 };
Chuck Lever510deb02007-12-10 14:56:24 -0500495 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400496
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400497 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
498 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400499 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
500 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400501 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400502 * If the caller chooses not to specify a hostname, whip
503 * up a string representation of the passed-in address.
504 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500505 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400506 struct sockaddr_un *sun =
507 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400508 struct sockaddr_in *sin =
509 (struct sockaddr_in *)args->address;
510 struct sockaddr_in6 *sin6 =
511 (struct sockaddr_in6 *)args->address;
512
Chuck Lever510deb02007-12-10 14:56:24 -0500513 servername[0] = '\0';
514 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400515 case AF_LOCAL:
516 snprintf(servername, sizeof(servername), "%s",
517 sun->sun_path);
518 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400519 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700520 snprintf(servername, sizeof(servername), "%pI4",
521 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500522 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400523 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700524 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400525 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500526 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500527 default:
528 /* caller wants default server name, but
529 * address family isn't recognized. */
530 return ERR_PTR(-EINVAL);
531 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500532 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400533 }
534
Chuck Lever510deb02007-12-10 14:56:24 -0500535 xprt = xprt_create_transport(&xprtargs);
536 if (IS_ERR(xprt))
537 return (struct rpc_clnt *)xprt;
538
Chuck Lever43780b82007-07-01 12:13:22 -0400539 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400540 * By default, kernel RPC client connects from a reserved port.
541 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
542 * but it is always enabled for rpciod, which handles the connect
543 * operation.
544 */
545 xprt->resvport = 1;
546 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
547 xprt->resvport = 0;
548
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800549 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400550}
Chuck Leverb86acd52006-08-22 20:06:22 -0400551EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553/*
554 * This function clones the RPC client structure. It allows us to share the
555 * same transport while varying parameters such as the authentication
556 * flavour.
557 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400558static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
559 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500561 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400562 struct rpc_clnt *new;
563 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
Chuck Lever1b63a752012-09-14 17:23:52 -0400565 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500566 rcu_read_lock();
567 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
568 rcu_read_unlock();
569 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400570 goto out_err;
571 args->servername = xprt->servername;
572
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400573 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400574 if (IS_ERR(new)) {
575 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400576 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400577 }
578
Chuck Lever1b63a752012-09-14 17:23:52 -0400579 /* Turn off autobind on clones */
580 new->cl_autobind = 0;
581 new->cl_softrtry = clnt->cl_softrtry;
582 new->cl_discrtry = clnt->cl_discrtry;
583 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400585
Chuck Lever1b63a752012-09-14 17:23:52 -0400586out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800587 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500588 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589}
Chuck Lever1b63a752012-09-14 17:23:52 -0400590
591/**
592 * rpc_clone_client - Clone an RPC client structure
593 *
594 * @clnt: RPC client whose parameters are copied
595 *
596 * Returns a fresh RPC client or an ERR_PTR.
597 */
598struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
599{
600 struct rpc_create_args args = {
601 .program = clnt->cl_program,
602 .prognumber = clnt->cl_prog,
603 .version = clnt->cl_vers,
604 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400605 };
606 return __rpc_clone_client(&args, clnt);
607}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400608EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Chuck Leverba9b5842012-09-14 17:24:02 -0400610/**
611 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
612 *
613 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800614 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400615 *
616 * Returns a fresh RPC client or an ERR_PTR.
617 */
618struct rpc_clnt *
619rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
620{
621 struct rpc_create_args args = {
622 .program = clnt->cl_program,
623 .prognumber = clnt->cl_prog,
624 .version = clnt->cl_vers,
625 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400626 };
627 return __rpc_clone_client(&args, clnt);
628}
629EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
630
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400631/**
632 * rpc_switch_client_transport: switch the RPC transport on the fly
633 * @clnt: pointer to a struct rpc_clnt
634 * @args: pointer to the new transport arguments
635 * @timeout: pointer to the new timeout parameters
636 *
637 * This function allows the caller to switch the RPC transport for the
638 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
639 * server, for instance. It assumes that the caller has ensured that
640 * there are no active RPC tasks by using some form of locking.
641 *
642 * Returns zero if "clnt" is now using the new xprt. Otherwise a
643 * negative errno is returned, and "clnt" continues to use the old
644 * xprt.
645 */
646int rpc_switch_client_transport(struct rpc_clnt *clnt,
647 struct xprt_create *args,
648 const struct rpc_timeout *timeout)
649{
650 const struct rpc_timeout *old_timeo;
651 rpc_authflavor_t pseudoflavor;
652 struct rpc_xprt *xprt, *old;
653 struct rpc_clnt *parent;
654 int err;
655
656 xprt = xprt_create_transport(args);
657 if (IS_ERR(xprt)) {
658 dprintk("RPC: failed to create new xprt for clnt %p\n",
659 clnt);
660 return PTR_ERR(xprt);
661 }
662
663 pseudoflavor = clnt->cl_auth->au_flavor;
664
665 old_timeo = clnt->cl_timeout;
666 old = rpc_clnt_set_transport(clnt, xprt, timeout);
667
668 rpc_unregister_client(clnt);
669 __rpc_clnt_remove_pipedir(clnt);
670
671 /*
672 * A new transport was created. "clnt" therefore
673 * becomes the root of a new cl_parent tree. clnt's
674 * children, if it has any, still point to the old xprt.
675 */
676 parent = clnt->cl_parent;
677 clnt->cl_parent = clnt;
678
679 /*
680 * The old rpc_auth cache cannot be re-used. GSS
681 * contexts in particular are between a single
682 * client and server.
683 */
684 err = rpc_client_register(clnt, pseudoflavor, NULL);
685 if (err)
686 goto out_revert;
687
688 synchronize_rcu();
689 if (parent != clnt)
690 rpc_release_client(parent);
691 xprt_put(old);
692 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
693 return 0;
694
695out_revert:
696 rpc_clnt_set_transport(clnt, old, old_timeo);
697 clnt->cl_parent = parent;
698 rpc_client_register(clnt, pseudoflavor, NULL);
699 xprt_put(xprt);
700 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
701 return err;
702}
703EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400706 * Kill all tasks for the given client.
707 * XXX: kill their descendants as well?
708 */
709void rpc_killall_tasks(struct rpc_clnt *clnt)
710{
711 struct rpc_task *rovr;
712
713
714 if (list_empty(&clnt->cl_tasks))
715 return;
716 dprintk("RPC: killing all tasks for client %p\n", clnt);
717 /*
718 * Spin lock all_tasks to prevent changes...
719 */
720 spin_lock(&clnt->cl_lock);
721 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
722 if (!RPC_IS_ACTIVATED(rovr))
723 continue;
724 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
725 rovr->tk_flags |= RPC_TASK_KILLED;
726 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300727 if (RPC_IS_QUEUED(rovr))
728 rpc_wake_up_queued_task(rovr->tk_waitqueue,
729 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400730 }
731 }
732 spin_unlock(&clnt->cl_lock);
733}
734EXPORT_SYMBOL_GPL(rpc_killall_tasks);
735
736/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400738 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400740void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400742 might_sleep();
743
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500744 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400745 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500746 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Trond Myklebust34f52e32007-06-14 16:40:31 -0400748 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800750 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400751 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
753
Trond Myklebust4c402b42007-06-14 16:40:32 -0400754 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400756EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
758/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400759 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500761static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400762rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500764 struct rpc_clnt *parent = NULL;
765
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500766 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400767 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500768 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500769 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500770 parent = clnt->cl_parent;
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400771 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400772 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500773 rpc_free_iostats(clnt->cl_metrics);
774 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500775 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400776 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400777 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500779 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780}
781
782/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400783 * Free an RPC client
784 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500785static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400786rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400787{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500788 if (clnt->cl_auth == NULL)
789 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400790
791 /*
792 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
793 * release remaining GSS contexts. This mechanism ensures
794 * that it can do so safely.
795 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400796 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400797 rpcauth_release(clnt->cl_auth);
798 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400799 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500800 return rpc_free_client(clnt);
801 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400802}
803
804/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400805 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 */
807void
808rpc_release_client(struct rpc_clnt *clnt)
809{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400810 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Trond Myklebustd07ba842013-11-12 17:24:36 -0500812 do {
813 if (list_empty(&clnt->cl_tasks))
814 wake_up(&destroy_wait);
815 if (!atomic_dec_and_test(&clnt->cl_count))
816 break;
817 clnt = rpc_free_auth(clnt);
818 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400819}
Simo Sorce1d658332012-05-25 18:09:55 -0400820EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400821
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000822/**
823 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800824 * @old: old rpc_client
825 * @program: rpc program to set
826 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000827 *
828 * Clones the rpc client and sets up a new RPC program. This is mainly
829 * of use for enabling different RPC programs to share the same transport.
830 * The Sun NFSv2/v3 ACL protocol can do this.
831 */
832struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500833 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400834 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000835{
Trond Myklebustf994c432012-11-01 12:14:14 -0400836 struct rpc_create_args args = {
837 .program = program,
838 .prognumber = program->number,
839 .version = vers,
840 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400841 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000842 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000843 int err;
844
Trond Myklebustf994c432012-11-01 12:14:14 -0400845 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000846 if (IS_ERR(clnt))
847 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500848 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000849 if (err != 0) {
850 rpc_shutdown_client(clnt);
851 clnt = ERR_PTR(err);
852 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800853out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000854 return clnt;
855}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400856EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000857
Trond Myklebust58f96122010-07-31 14:29:08 -0400858void rpc_task_release_client(struct rpc_task *task)
859{
860 struct rpc_clnt *clnt = task->tk_client;
861
862 if (clnt != NULL) {
863 /* Remove from client task list */
864 spin_lock(&clnt->cl_lock);
865 list_del(&task->tk_task);
866 spin_unlock(&clnt->cl_lock);
867 task->tk_client = NULL;
868
869 rpc_release_client(clnt);
870 }
871}
872
873static
874void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
875{
876 if (clnt != NULL) {
877 rpc_task_release_client(task);
878 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400879 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400880 if (clnt->cl_softrtry)
881 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400882 if (clnt->cl_noretranstimeo)
883 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700884 if (sk_memalloc_socks()) {
885 struct rpc_xprt *xprt;
886
887 rcu_read_lock();
888 xprt = rcu_dereference(clnt->cl_xprt);
889 if (xprt->swapper)
890 task->tk_flags |= RPC_TASK_SWAPPER;
891 rcu_read_unlock();
892 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400893 /* Add to the client's list of all tasks */
894 spin_lock(&clnt->cl_lock);
895 list_add_tail(&task->tk_task, &clnt->cl_tasks);
896 spin_unlock(&clnt->cl_lock);
897 }
898}
899
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000900void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
901{
902 rpc_task_release_client(task);
903 rpc_task_set_client(task, clnt);
904}
905EXPORT_SYMBOL_GPL(rpc_task_reset_client);
906
907
Trond Myklebust58f96122010-07-31 14:29:08 -0400908static void
909rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
910{
911 if (msg != NULL) {
912 task->tk_msg.rpc_proc = msg->rpc_proc;
913 task->tk_msg.rpc_argp = msg->rpc_argp;
914 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400915 if (msg->rpc_cred != NULL)
916 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400917 }
918}
919
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920/*
921 * Default callback for async RPC calls
922 */
923static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100924rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925{
926}
927
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100928static const struct rpc_call_ops rpc_default_ops = {
929 .rpc_call_done = rpc_default_callback,
930};
931
Trond Myklebustc970aa82007-07-14 15:39:59 -0400932/**
933 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
934 * @task_setup_data: pointer to task initialisation data
935 */
936struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400937{
Trond Myklebust19445b92010-04-16 16:41:10 -0400938 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400939
Trond Myklebust84115e12007-07-14 15:39:59 -0400940 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400941 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400942 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400943
Trond Myklebust58f96122010-07-31 14:29:08 -0400944 rpc_task_set_client(task, task_setup_data->rpc_client);
945 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
946
Trond Myklebust58f96122010-07-31 14:29:08 -0400947 if (task->tk_action == NULL)
948 rpc_call_start(task);
949
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400950 atomic_inc(&task->tk_count);
951 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400952out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400953 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400954}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400955EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400956
957/**
958 * rpc_call_sync - Perform a synchronous RPC call
959 * @clnt: pointer to RPC client
960 * @msg: RPC call parameters
961 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500963int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964{
965 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400966 struct rpc_task_setup task_setup_data = {
967 .rpc_client = clnt,
968 .rpc_message = msg,
969 .callback_ops = &rpc_default_ops,
970 .flags = flags,
971 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400972 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400974 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
975 if (flags & RPC_TASK_ASYNC) {
976 rpc_release_calldata(task_setup_data.callback_ops,
977 task_setup_data.callback_data);
978 return -EINVAL;
979 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980
Trond Myklebustc970aa82007-07-14 15:39:59 -0400981 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400982 if (IS_ERR(task))
983 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100984 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800985 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 return status;
987}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400988EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400990/**
991 * rpc_call_async - Perform an asynchronous RPC call
992 * @clnt: pointer to RPC client
993 * @msg: RPC call parameters
994 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800995 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400996 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 */
998int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500999rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001000 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001{
1002 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001003 struct rpc_task_setup task_setup_data = {
1004 .rpc_client = clnt,
1005 .rpc_message = msg,
1006 .callback_ops = tk_ops,
1007 .callback_data = data,
1008 .flags = flags|RPC_TASK_ASYNC,
1009 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Trond Myklebustc970aa82007-07-14 15:39:59 -04001011 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001012 if (IS_ERR(task))
1013 return PTR_ERR(task);
1014 rpc_put_task(task);
1015 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001017EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001019#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001020/**
1021 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1022 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001023 * @req: RPC request
1024 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001025 */
1026struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001027 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001028{
1029 struct rpc_task *task;
1030 struct xdr_buf *xbufp = &req->rq_snd_buf;
1031 struct rpc_task_setup task_setup_data = {
1032 .callback_ops = tk_ops,
1033 };
1034
1035 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1036 /*
1037 * Create an rpc_task to send the data
1038 */
1039 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001040 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001041 xprt_free_bc_request(req);
1042 goto out;
1043 }
1044 task->tk_rqstp = req;
1045
1046 /*
1047 * Set up the xdr_buf length.
1048 * This also indicates that the buffer is XDR encoded already.
1049 */
1050 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1051 xbufp->tail[0].iov_len;
1052
1053 task->tk_action = call_bc_transmit;
1054 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001055 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001056 rpc_execute(task);
1057
1058out:
1059 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1060 return task;
1061}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001062#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001063
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001065rpc_call_start(struct rpc_task *task)
1066{
1067 task->tk_action = call_start;
1068}
1069EXPORT_SYMBOL_GPL(rpc_call_start);
1070
Chuck Levered394402006-08-22 20:06:17 -04001071/**
1072 * rpc_peeraddr - extract remote peer address from clnt's xprt
1073 * @clnt: RPC client structure
1074 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001075 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001076 *
1077 * Returns the number of bytes that are actually in the stored address.
1078 */
1079size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1080{
1081 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001082 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001083
Trond Myklebust2446ab62012-03-01 17:00:56 -05001084 rcu_read_lock();
1085 xprt = rcu_dereference(clnt->cl_xprt);
1086
1087 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001088 if (bytes > bufsize)
1089 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001090 memcpy(buf, &xprt->addr, bytes);
1091 rcu_read_unlock();
1092
1093 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001094}
Chuck Leverb86acd52006-08-22 20:06:22 -04001095EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001096
Chuck Leverf425eba2006-08-22 20:06:18 -04001097/**
1098 * rpc_peeraddr2str - return remote peer address in printable format
1099 * @clnt: RPC client structure
1100 * @format: address format
1101 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001102 * NB: the lifetime of the memory referenced by the returned pointer is
1103 * the same as the rpc_xprt itself. As long as the caller uses this
1104 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001105 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001106const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1107 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001108{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001109 struct rpc_xprt *xprt;
1110
1111 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001112
1113 if (xprt->address_strings[format] != NULL)
1114 return xprt->address_strings[format];
1115 else
1116 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001117}
Chuck Leverb86acd52006-08-22 20:06:22 -04001118EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001119
Chuck Lever2e738fd2012-03-01 17:01:14 -05001120static const struct sockaddr_in rpc_inaddr_loopback = {
1121 .sin_family = AF_INET,
1122 .sin_addr.s_addr = htonl(INADDR_ANY),
1123};
1124
1125static const struct sockaddr_in6 rpc_in6addr_loopback = {
1126 .sin6_family = AF_INET6,
1127 .sin6_addr = IN6ADDR_ANY_INIT,
1128};
1129
1130/*
1131 * Try a getsockname() on a connected datagram socket. Using a
1132 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1133 * This conserves the ephemeral port number space.
1134 *
1135 * Returns zero and fills in "buf" if successful; otherwise, a
1136 * negative errno is returned.
1137 */
1138static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1139 struct sockaddr *buf, int buflen)
1140{
1141 struct socket *sock;
1142 int err;
1143
1144 err = __sock_create(net, sap->sa_family,
1145 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1146 if (err < 0) {
1147 dprintk("RPC: can't create UDP socket (%d)\n", err);
1148 goto out;
1149 }
1150
1151 switch (sap->sa_family) {
1152 case AF_INET:
1153 err = kernel_bind(sock,
1154 (struct sockaddr *)&rpc_inaddr_loopback,
1155 sizeof(rpc_inaddr_loopback));
1156 break;
1157 case AF_INET6:
1158 err = kernel_bind(sock,
1159 (struct sockaddr *)&rpc_in6addr_loopback,
1160 sizeof(rpc_in6addr_loopback));
1161 break;
1162 default:
1163 err = -EAFNOSUPPORT;
1164 goto out;
1165 }
1166 if (err < 0) {
1167 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1168 goto out_release;
1169 }
1170
1171 err = kernel_connect(sock, sap, salen, 0);
1172 if (err < 0) {
1173 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1174 goto out_release;
1175 }
1176
1177 err = kernel_getsockname(sock, buf, &buflen);
1178 if (err < 0) {
1179 dprintk("RPC: getsockname failed (%d)\n", err);
1180 goto out_release;
1181 }
1182
1183 err = 0;
1184 if (buf->sa_family == AF_INET6) {
1185 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1186 sin6->sin6_scope_id = 0;
1187 }
1188 dprintk("RPC: %s succeeded\n", __func__);
1189
1190out_release:
1191 sock_release(sock);
1192out:
1193 return err;
1194}
1195
1196/*
1197 * Scraping a connected socket failed, so we don't have a useable
1198 * local address. Fallback: generate an address that will prevent
1199 * the server from calling us back.
1200 *
1201 * Returns zero and fills in "buf" if successful; otherwise, a
1202 * negative errno is returned.
1203 */
1204static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1205{
1206 switch (family) {
1207 case AF_INET:
1208 if (buflen < sizeof(rpc_inaddr_loopback))
1209 return -EINVAL;
1210 memcpy(buf, &rpc_inaddr_loopback,
1211 sizeof(rpc_inaddr_loopback));
1212 break;
1213 case AF_INET6:
1214 if (buflen < sizeof(rpc_in6addr_loopback))
1215 return -EINVAL;
1216 memcpy(buf, &rpc_in6addr_loopback,
1217 sizeof(rpc_in6addr_loopback));
1218 default:
1219 dprintk("RPC: %s: address family not supported\n",
1220 __func__);
1221 return -EAFNOSUPPORT;
1222 }
1223 dprintk("RPC: %s: succeeded\n", __func__);
1224 return 0;
1225}
1226
1227/**
1228 * rpc_localaddr - discover local endpoint address for an RPC client
1229 * @clnt: RPC client structure
1230 * @buf: target buffer
1231 * @buflen: size of target buffer, in bytes
1232 *
1233 * Returns zero and fills in "buf" and "buflen" if successful;
1234 * otherwise, a negative errno is returned.
1235 *
1236 * This works even if the underlying transport is not currently connected,
1237 * or if the upper layer never previously provided a source address.
1238 *
1239 * The result of this function call is transient: multiple calls in
1240 * succession may give different results, depending on how local
1241 * networking configuration changes over time.
1242 */
1243int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1244{
1245 struct sockaddr_storage address;
1246 struct sockaddr *sap = (struct sockaddr *)&address;
1247 struct rpc_xprt *xprt;
1248 struct net *net;
1249 size_t salen;
1250 int err;
1251
1252 rcu_read_lock();
1253 xprt = rcu_dereference(clnt->cl_xprt);
1254 salen = xprt->addrlen;
1255 memcpy(sap, &xprt->addr, salen);
1256 net = get_net(xprt->xprt_net);
1257 rcu_read_unlock();
1258
1259 rpc_set_port(sap, 0);
1260 err = rpc_sockname(net, sap, salen, buf, buflen);
1261 put_net(net);
1262 if (err != 0)
1263 /* Couldn't discover local address, return ANYADDR */
1264 return rpc_anyaddr(sap->sa_family, buf, buflen);
1265 return 0;
1266}
1267EXPORT_SYMBOL_GPL(rpc_localaddr);
1268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269void
1270rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1271{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001272 struct rpc_xprt *xprt;
1273
1274 rcu_read_lock();
1275 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001276 if (xprt->ops->set_buffer_size)
1277 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001278 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001280EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
Trond Myklebust2446ab62012-03-01 17:00:56 -05001282/**
1283 * rpc_protocol - Get transport protocol number for an RPC client
1284 * @clnt: RPC client to query
1285 *
1286 */
1287int rpc_protocol(struct rpc_clnt *clnt)
1288{
1289 int protocol;
1290
1291 rcu_read_lock();
1292 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1293 rcu_read_unlock();
1294 return protocol;
1295}
1296EXPORT_SYMBOL_GPL(rpc_protocol);
1297
1298/**
1299 * rpc_net_ns - Get the network namespace for this RPC client
1300 * @clnt: RPC client to query
1301 *
1302 */
1303struct net *rpc_net_ns(struct rpc_clnt *clnt)
1304{
1305 struct net *ret;
1306
1307 rcu_read_lock();
1308 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1309 rcu_read_unlock();
1310 return ret;
1311}
1312EXPORT_SYMBOL_GPL(rpc_net_ns);
1313
1314/**
1315 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1316 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 *
1318 * For stream transports, this is one RPC record fragment (see RFC
1319 * 1831), as we don't support multi-record requests yet. For datagram
1320 * transports, this is the size of an IP packet minus the IP, UDP, and
1321 * RPC header sizes.
1322 */
1323size_t rpc_max_payload(struct rpc_clnt *clnt)
1324{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001325 size_t ret;
1326
1327 rcu_read_lock();
1328 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1329 rcu_read_unlock();
1330 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331}
Chuck Leverb86acd52006-08-22 20:06:22 -04001332EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Chuck Lever35f5a422006-01-03 09:55:50 +01001334/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001335 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001336 * @clnt: RPC client to query
1337 */
1338unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1339{
1340 unsigned long ret;
1341
1342 rcu_read_lock();
1343 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1344 rcu_read_unlock();
1345 return ret;
1346}
1347EXPORT_SYMBOL_GPL(rpc_get_timeout);
1348
1349/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001350 * rpc_force_rebind - force transport to check that remote port is unchanged
1351 * @clnt: client to rebind
1352 *
1353 */
1354void rpc_force_rebind(struct rpc_clnt *clnt)
1355{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001356 if (clnt->cl_autobind) {
1357 rcu_read_lock();
1358 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1359 rcu_read_unlock();
1360 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001361}
Chuck Leverb86acd52006-08-22 20:06:22 -04001362EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001365 * Restart an (async) RPC call from the call_prepare state.
1366 * Usually called from within the exit handler.
1367 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001368int
Andy Adamsonaae20062009-04-01 09:22:40 -04001369rpc_restart_call_prepare(struct rpc_task *task)
1370{
1371 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001372 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001373 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001374 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001375 if (task->tk_ops->rpc_call_prepare != NULL)
1376 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001377 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001378}
1379EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1380
1381/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 * Restart an (async) RPC call. Usually called from within the
1383 * exit handler.
1384 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001385int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386rpc_restart_call(struct rpc_task *task)
1387{
1388 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001389 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001391 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001392 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001394EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Chuck Lever3748f1e2008-05-21 17:09:12 -04001396#ifdef RPC_DEBUG
1397static const char *rpc_proc_name(const struct rpc_task *task)
1398{
1399 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1400
1401 if (proc) {
1402 if (proc->p_name)
1403 return proc->p_name;
1404 else
1405 return "NULL";
1406 } else
1407 return "no proc";
1408}
1409#endif
1410
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411/*
1412 * 0. Initial state
1413 *
1414 * Other FSM states can be visited zero or more times, but
1415 * this state is visited exactly once for each RPC.
1416 */
1417static void
1418call_start(struct rpc_task *task)
1419{
1420 struct rpc_clnt *clnt = task->tk_client;
1421
Chuck Lever3748f1e2008-05-21 17:09:12 -04001422 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001423 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001424 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001425 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427 /* Increment call count */
1428 task->tk_msg.rpc_proc->p_count++;
1429 clnt->cl_stats->rpccnt++;
1430 task->tk_action = call_reserve;
1431}
1432
1433/*
1434 * 1. Reserve an RPC call slot
1435 */
1436static void
1437call_reserve(struct rpc_task *task)
1438{
Chuck Lever46121cf2007-01-31 12:14:08 -05001439 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 task->tk_status = 0;
1442 task->tk_action = call_reserveresult;
1443 xprt_reserve(task);
1444}
1445
Trond Myklebustba60eb22013-04-14 10:49:37 -04001446static void call_retry_reserve(struct rpc_task *task);
1447
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448/*
1449 * 1b. Grok the result of xprt_reserve()
1450 */
1451static void
1452call_reserveresult(struct rpc_task *task)
1453{
1454 int status = task->tk_status;
1455
Chuck Lever46121cf2007-01-31 12:14:08 -05001456 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
1458 /*
1459 * After a call to xprt_reserve(), we must have either
1460 * a request slot or else an error status.
1461 */
1462 task->tk_status = 0;
1463 if (status >= 0) {
1464 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001465 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 return;
1467 }
1468
1469 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001470 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 rpc_exit(task, -EIO);
1472 return;
1473 }
1474
1475 /*
1476 * Even though there was an error, we may have acquired
1477 * a request slot somehow. Make sure not to leak it.
1478 */
1479 if (task->tk_rqstp) {
1480 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001481 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 xprt_release(task);
1483 }
1484
1485 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001486 case -ENOMEM:
1487 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001489 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 return;
1491 case -EIO: /* probably a shutdown */
1492 break;
1493 default:
1494 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001495 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 break;
1497 }
1498 rpc_exit(task, status);
1499}
1500
1501/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001502 * 1c. Retry reserving an RPC call slot
1503 */
1504static void
1505call_retry_reserve(struct rpc_task *task)
1506{
1507 dprint_status(task);
1508
1509 task->tk_status = 0;
1510 task->tk_action = call_reserveresult;
1511 xprt_retry_reserve(task);
1512}
1513
1514/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001515 * 2. Bind and/or refresh the credentials
1516 */
1517static void
1518call_refresh(struct rpc_task *task)
1519{
1520 dprint_status(task);
1521
1522 task->tk_action = call_refreshresult;
1523 task->tk_status = 0;
1524 task->tk_client->cl_stats->rpcauthrefresh++;
1525 rpcauth_refreshcred(task);
1526}
1527
1528/*
1529 * 2a. Process the results of a credential refresh
1530 */
1531static void
1532call_refreshresult(struct rpc_task *task)
1533{
1534 int status = task->tk_status;
1535
1536 dprint_status(task);
1537
1538 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001539 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001540 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001541 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001542 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001543 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001544 return;
1545 }
1546 /* Use rate-limiting and a max number of retries if refresh
1547 * had status 0 but failed to update the cred.
1548 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001549 case -ETIMEDOUT:
1550 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001551 case -EAGAIN:
1552 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001553 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001554 if (!task->tk_cred_retry)
1555 break;
1556 task->tk_cred_retry--;
1557 dprintk("RPC: %5u %s: retry refresh creds\n",
1558 task->tk_pid, __func__);
1559 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001560 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001561 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1562 task->tk_pid, __func__, status);
1563 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001564}
1565
1566/*
1567 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001568 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 */
1570static void
1571call_allocate(struct rpc_task *task)
1572{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001573 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001574 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001575 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001576 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
Chuck Lever46121cf2007-01-31 12:14:08 -05001578 dprint_status(task);
1579
Chuck Lever2bea90d2007-03-29 16:47:53 -04001580 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001581 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001582
Chuck Lever02107142006-01-03 09:55:49 +01001583 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 return;
1585
Chuck Lever2bea90d2007-03-29 16:47:53 -04001586 if (proc->p_proc != 0) {
1587 BUG_ON(proc->p_arglen == 0);
1588 if (proc->p_decode != NULL)
1589 BUG_ON(proc->p_replen == 0);
1590 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Chuck Lever2bea90d2007-03-29 16:47:53 -04001592 /*
1593 * Calculate the size (in quads) of the RPC call
1594 * and reply headers, and convert both values
1595 * to byte sizes.
1596 */
1597 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1598 req->rq_callsize <<= 2;
1599 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1600 req->rq_rcvsize <<= 2;
1601
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001602 req->rq_buffer = xprt->ops->buf_alloc(task,
1603 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001604 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001606
1607 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
Trond Myklebust5afa9132011-06-17 10:14:59 -04001609 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001610 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 rpc_delay(task, HZ>>4);
1612 return;
1613 }
1614
1615 rpc_exit(task, -ERESTARTSYS);
1616}
1617
Trond Myklebust940e3312005-11-09 21:45:24 -05001618static inline int
1619rpc_task_need_encode(struct rpc_task *task)
1620{
1621 return task->tk_rqstp->rq_snd_buf.len == 0;
1622}
1623
1624static inline void
1625rpc_task_force_reencode(struct rpc_task *task)
1626{
1627 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001628 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001629}
1630
Chuck Lever2bea90d2007-03-29 16:47:53 -04001631static inline void
1632rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1633{
1634 buf->head[0].iov_base = start;
1635 buf->head[0].iov_len = len;
1636 buf->tail[0].iov_len = 0;
1637 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001638 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001639 buf->len = 0;
1640 buf->buflen = len;
1641}
1642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643/*
1644 * 3. Encode arguments of an RPC call
1645 */
1646static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001647rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001650 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001651 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Chuck Lever46121cf2007-01-31 12:14:08 -05001653 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Chuck Lever2bea90d2007-03-29 16:47:53 -04001655 rpc_xdr_buf_init(&req->rq_snd_buf,
1656 req->rq_buffer,
1657 req->rq_callsize);
1658 rpc_xdr_buf_init(&req->rq_rcv_buf,
1659 (char *)req->rq_buffer + req->rq_callsize,
1660 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
Chuck Leverb0e1c572008-05-21 17:09:19 -04001662 p = rpc_encode_header(task);
1663 if (p == NULL) {
1664 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 rpc_exit(task, -EIO);
1666 return;
1667 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001668
1669 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001670 if (encode == NULL)
1671 return;
1672
1673 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1674 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675}
1676
1677/*
1678 * 4. Get the server port number if not yet set
1679 */
1680static void
1681call_bind(struct rpc_task *task)
1682{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001683 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
Chuck Lever46121cf2007-01-31 12:14:08 -05001685 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
Chuck Leverda351872005-08-11 16:25:11 -04001687 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001688 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001689 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001690 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001691 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 }
1693}
1694
1695/*
Chuck Leverda351872005-08-11 16:25:11 -04001696 * 4a. Sort out bind result
1697 */
1698static void
1699call_bind_status(struct rpc_task *task)
1700{
Chuck Lever906462a2007-09-11 18:00:47 -04001701 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001702
1703 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001704 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001705 task->tk_status = 0;
1706 task->tk_action = call_connect;
1707 return;
1708 }
1709
Steve Dickson5753cba2012-02-06 10:08:08 -05001710 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001711 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001712 case -ENOMEM:
1713 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1714 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001715 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001716 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001717 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1718 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001719 /* fail immediately if this is an RPC ping */
1720 if (task->tk_msg.rpc_proc->p_proc == 0) {
1721 status = -EOPNOTSUPP;
1722 break;
1723 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001724 if (task->tk_rebind_retry == 0)
1725 break;
1726 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001727 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001728 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001729 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001730 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001731 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001732 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001733 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001734 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001735 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001736 task->tk_pid);
1737 break;
1738 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001739 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001740 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001741 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001742 case -ECONNREFUSED: /* connection problems */
1743 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001744 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001745 case -ENOTCONN:
1746 case -EHOSTDOWN:
1747 case -EHOSTUNREACH:
1748 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001749 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001750 case -EPIPE:
1751 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1752 task->tk_pid, task->tk_status);
1753 if (!RPC_IS_SOFTCONN(task)) {
1754 rpc_delay(task, 5*HZ);
1755 goto retry_timeout;
1756 }
1757 status = task->tk_status;
1758 break;
Chuck Leverda351872005-08-11 16:25:11 -04001759 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001760 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001761 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001762 }
1763
1764 rpc_exit(task, status);
1765 return;
1766
Trond Myklebustda458282006-08-31 15:44:52 -04001767retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001768 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001769 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001770}
1771
1772/*
1773 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 */
1775static void
1776call_connect(struct rpc_task *task)
1777{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001778 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Chuck Lever46121cf2007-01-31 12:14:08 -05001780 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001781 task->tk_pid, xprt,
1782 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Chuck Leverda351872005-08-11 16:25:11 -04001784 task->tk_action = call_transmit;
1785 if (!xprt_connected(xprt)) {
1786 task->tk_action = call_connect_status;
1787 if (task->tk_status < 0)
1788 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001789 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1790 rpc_exit(task, -ENOTCONN);
1791 return;
1792 }
Chuck Leverda351872005-08-11 16:25:11 -04001793 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795}
1796
1797/*
Chuck Leverda351872005-08-11 16:25:11 -04001798 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 */
1800static void
1801call_connect_status(struct rpc_task *task)
1802{
1803 struct rpc_clnt *clnt = task->tk_client;
1804 int status = task->tk_status;
1805
Chuck Lever46121cf2007-01-31 12:14:08 -05001806 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001807
Steve Dickson5753cba2012-02-06 10:08:08 -05001808 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001809 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001811 case -ECONNREFUSED:
1812 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001813 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001814 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001815 case -EHOSTUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001816 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001817 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001818 if (RPC_IS_SOFTCONN(task))
1819 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001820 /* retry with existing socket, after a delay */
1821 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001822 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001823 /* Check for timeouts before looping back to call_bind */
1824 case -ETIMEDOUT:
1825 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001826 return;
1827 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001828 clnt->cl_stats->netreconn++;
1829 task->tk_action = call_transmit;
1830 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001832 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833}
1834
1835/*
1836 * 5. Transmit the RPC request, and wait for reply
1837 */
1838static void
1839call_transmit(struct rpc_task *task)
1840{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001841 int is_retrans = RPC_WAS_SENT(task);
1842
Chuck Lever46121cf2007-01-31 12:14:08 -05001843 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
1845 task->tk_action = call_status;
1846 if (task->tk_status < 0)
1847 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001848 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001850 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001852 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001853 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001854 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001855 if (task->tk_status != 0) {
1856 /* Was the error nonfatal? */
1857 if (task->tk_status == -EAGAIN)
1858 rpc_delay(task, HZ >> 4);
1859 else
1860 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001861 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001862 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001863 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 xprt_transmit(task);
1865 if (task->tk_status < 0)
1866 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001867 if (is_retrans)
1868 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001869 /*
1870 * On success, ensure that we call xprt_end_transmit() before sleeping
1871 * in order to allow access to the socket to other RPC requests.
1872 */
1873 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001874 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001875 return;
1876 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001877 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001878}
1879
1880/*
1881 * 5a. Handle cleanup after a transmission
1882 */
1883static void
1884call_transmit_status(struct rpc_task *task)
1885{
1886 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001887
1888 /*
1889 * Common case: success. Force the compiler to put this
1890 * test first.
1891 */
1892 if (task->tk_status == 0) {
1893 xprt_end_transmit(task);
1894 rpc_task_force_reencode(task);
1895 return;
1896 }
1897
Trond Myklebust15f081c2009-03-11 14:37:57 -04001898 switch (task->tk_status) {
1899 case -EAGAIN:
1900 break;
1901 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001902 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001903 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001904 rpc_task_force_reencode(task);
1905 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001906 /*
1907 * Special cases: if we've been waiting on the
1908 * socket's write_space() callback, or if the
1909 * socket just returned a connection error,
1910 * then hold onto the transport lock.
1911 */
1912 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001913 case -EHOSTDOWN:
1914 case -EHOSTUNREACH:
1915 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001916 if (RPC_IS_SOFTCONN(task)) {
1917 xprt_end_transmit(task);
1918 rpc_exit(task, task->tk_status);
1919 break;
1920 }
1921 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001922 case -ECONNABORTED:
Chuck Lever09a21c42009-12-03 15:58:56 -05001923 case -ENOTCONN:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001924 case -ENOBUFS:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001925 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001926 rpc_task_force_reencode(task);
1927 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928}
1929
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001930#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001931/*
1932 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1933 * addition, disconnect on connectivity errors.
1934 */
1935static void
1936call_bc_transmit(struct rpc_task *task)
1937{
1938 struct rpc_rqst *req = task->tk_rqstp;
1939
Trond Myklebust90051ea2013-09-25 12:17:18 -04001940 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001941 /*
1942 * Could not reserve the transport. Try again after the
1943 * transport is released.
1944 */
1945 task->tk_status = 0;
1946 task->tk_action = call_bc_transmit;
1947 return;
1948 }
1949
1950 task->tk_action = rpc_exit_task;
1951 if (task->tk_status < 0) {
1952 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1953 "error: %d\n", task->tk_status);
1954 return;
1955 }
1956
1957 xprt_transmit(task);
1958 xprt_end_transmit(task);
1959 dprint_status(task);
1960 switch (task->tk_status) {
1961 case 0:
1962 /* Success */
1963 break;
1964 case -EHOSTDOWN:
1965 case -EHOSTUNREACH:
1966 case -ENETUNREACH:
1967 case -ETIMEDOUT:
1968 /*
1969 * Problem reaching the server. Disconnect and let the
1970 * forechannel reestablish the connection. The server will
1971 * have to retransmit the backchannel request and we'll
1972 * reprocess it. Since these ops are idempotent, there's no
1973 * need to cache our reply at this time.
1974 */
1975 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1976 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001977 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001978 req->rq_connect_cookie);
1979 break;
1980 default:
1981 /*
1982 * We were unable to reply and will have to drop the
1983 * request. The server should reconnect and retransmit.
1984 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001985 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001986 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1987 "error: %d\n", task->tk_status);
1988 break;
1989 }
1990 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1991}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001992#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001993
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994/*
1995 * 6. Sort out the RPC call status
1996 */
1997static void
1998call_status(struct rpc_task *task)
1999{
2000 struct rpc_clnt *clnt = task->tk_client;
2001 struct rpc_rqst *req = task->tk_rqstp;
2002 int status;
2003
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002004 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2005 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Chuck Lever46121cf2007-01-31 12:14:08 -05002007 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
2009 status = task->tk_status;
2010 if (status >= 0) {
2011 task->tk_action = call_decode;
2012 return;
2013 }
2014
Steve Dickson5753cba2012-02-06 10:08:08 -05002015 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 task->tk_status = 0;
2017 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002018 case -EHOSTDOWN:
2019 case -EHOSTUNREACH:
2020 case -ENETUNREACH:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002021 if (RPC_IS_SOFTCONN(task)) {
2022 rpc_exit(task, status);
2023 break;
2024 }
Trond Myklebust76303992006-08-30 14:32:49 -04002025 /*
2026 * Delay any retries for 3 seconds, then handle as if it
2027 * were a timeout.
2028 */
2029 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 case -ETIMEDOUT:
2031 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002032 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2033 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002034 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002035 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 break;
2037 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002038 case -ECONNRESET:
2039 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002040 rpc_force_rebind(clnt);
Trond Myklebust3601c4a2014-06-30 13:42:19 -04002041 case -ENOBUFS:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002042 rpc_delay(task, 3*HZ);
2043 case -EPIPE:
2044 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 task->tk_action = call_bind;
2046 break;
2047 case -EAGAIN:
2048 task->tk_action = call_transmit;
2049 break;
2050 case -EIO:
2051 /* shutdown or soft timeout */
2052 rpc_exit(task, status);
2053 break;
2054 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002055 if (clnt->cl_chatty)
2056 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002057 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 }
2060}
2061
2062/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002063 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 * We do not release the request slot, so we keep using the
2065 * same XID for all retransmits.
2066 */
2067static void
2068call_timeout(struct rpc_task *task)
2069{
2070 struct rpc_clnt *clnt = task->tk_client;
2071
2072 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002073 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 goto retry;
2075 }
2076
Chuck Lever46121cf2007-01-31 12:14:08 -05002077 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002078 task->tk_timeouts++;
2079
Chuck Lever3a28bec2009-12-03 15:58:56 -05002080 if (RPC_IS_SOFTCONN(task)) {
2081 rpc_exit(task, -ETIMEDOUT);
2082 return;
2083 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002085 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002086 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002087 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002088 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002089 rcu_dereference(clnt->cl_xprt)->servername);
2090 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07002091 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002092 if (task->tk_flags & RPC_TASK_TIMEOUT)
2093 rpc_exit(task, -ETIMEDOUT);
2094 else
2095 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 return;
2097 }
2098
Chuck Leverf518e35a2006-01-03 09:55:52 +01002099 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002101 if (clnt->cl_chatty) {
2102 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002103 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002104 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002105 rcu_dereference(clnt->cl_xprt)->servername);
2106 rcu_read_unlock();
2107 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002109 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002110 /*
2111 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2112 * event? RFC2203 requires the server to drop all such requests.
2113 */
2114 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
2116retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 task->tk_action = call_bind;
2118 task->tk_status = 0;
2119}
2120
2121/*
2122 * 7. Decode the RPC reply
2123 */
2124static void
2125call_decode(struct rpc_task *task)
2126{
2127 struct rpc_clnt *clnt = task->tk_client;
2128 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002129 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002130 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
Vasily Averin726fd6a2011-06-01 16:23:59 +04002132 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
Chuck Leverf518e35a2006-01-03 09:55:52 +01002134 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002135 if (clnt->cl_chatty) {
2136 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002137 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002138 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002139 rcu_dereference(clnt->cl_xprt)->servername);
2140 rcu_read_unlock();
2141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2143 }
2144
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002145 /*
2146 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002147 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002148 */
2149 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 req->rq_rcv_buf.len = req->rq_private_buf.len;
2151
2152 /* Check that the softirq receive buffer is valid */
2153 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2154 sizeof(req->rq_rcv_buf)) != 0);
2155
Trond Myklebust1e799b62008-03-21 16:19:41 -04002156 if (req->rq_rcv_buf.len < 12) {
2157 if (!RPC_IS_SOFT(task)) {
2158 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002159 goto out_retry;
2160 }
2161 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002162 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002163 task->tk_action = call_timeout;
2164 goto out_retry;
2165 }
2166
Chuck Leverb0e1c572008-05-21 17:09:19 -04002167 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002168 if (IS_ERR(p)) {
2169 if (p == ERR_PTR(-EAGAIN))
2170 goto out_retry;
2171 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 }
2173
Trond Myklebustabbcf282006-01-03 09:55:03 +01002174 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002176 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2178 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002179 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002180 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2181 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 return;
2183out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002185 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002186 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002187 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002188 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002189 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002190 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192}
2193
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002194static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002195rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196{
2197 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002199 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002202
Trond Myklebusta4f08352013-01-08 09:10:21 -05002203 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 *p++ = req->rq_xid; /* XID */
2205 *p++ = htonl(RPC_CALL); /* CALL */
2206 *p++ = htonl(RPC_VERSION); /* RPC version */
2207 *p++ = htonl(clnt->cl_prog); /* program number */
2208 *p++ = htonl(clnt->cl_vers); /* program version */
2209 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002210 p = rpcauth_marshcred(task, p);
2211 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2212 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213}
2214
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002215static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002216rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002218 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2220 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002221 __be32 *p = iov->iov_base;
2222 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 int error = -EACCES;
2224
David Howellse8896492006-08-24 15:44:19 -04002225 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2226 /* RFC-1014 says that the representation of XDR data must be a
2227 * multiple of four bytes
2228 * - if it isn't pointer subtraction in the NFS client may give
2229 * undefined results
2230 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002231 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002232 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002233 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002234 error = -EIO;
2235 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 if ((len -= 3) < 0)
2238 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002240 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002242 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002243 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002244 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002245 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002247
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2249 if (--len < 0)
2250 goto out_overflow;
2251 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002252 case RPC_AUTH_ERROR:
2253 break;
2254 case RPC_MISMATCH:
2255 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2256 task->tk_pid, __func__);
2257 error = -EPROTONOSUPPORT;
2258 goto out_err;
2259 default:
2260 dprintk("RPC: %5u %s: RPC call rejected, "
2261 "unknown error: %x\n",
2262 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002263 error = -EIO;
2264 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 }
2266 if (--len < 0)
2267 goto out_overflow;
2268 switch ((n = ntohl(*p++))) {
2269 case RPC_AUTH_REJECTEDCRED:
2270 case RPC_AUTH_REJECTEDVERF:
2271 case RPCSEC_GSS_CREDPROBLEM:
2272 case RPCSEC_GSS_CTXPROBLEM:
2273 if (!task->tk_cred_retry)
2274 break;
2275 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002276 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002277 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002279 /* Ensure we obtain a new XID! */
2280 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002281 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002282 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 case RPC_AUTH_BADCRED:
2284 case RPC_AUTH_BADVERF:
2285 /* possibly garbled cred/verf? */
2286 if (!task->tk_garb_retry)
2287 break;
2288 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002289 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002290 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002292 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002294 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002295 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002296 "authentication.\n",
2297 rcu_dereference(clnt->cl_xprt)->servername);
2298 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 break;
2300 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002301 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002302 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 error = -EIO;
2304 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002305 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002306 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 goto out_err;
2308 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002309 p = rpcauth_checkverf(task, p);
2310 if (IS_ERR(p)) {
2311 error = PTR_ERR(p);
2312 dprintk("RPC: %5u %s: auth check failed with %d\n",
2313 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002314 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002316 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 if (len < 0)
2318 goto out_overflow;
2319 switch ((n = ntohl(*p++))) {
2320 case RPC_SUCCESS:
2321 return p;
2322 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002323 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2324 "by server %s\n", task->tk_pid, __func__,
2325 (unsigned int)clnt->cl_prog,
2326 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002327 error = -EPFNOSUPPORT;
2328 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002330 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2331 "by server %s\n", task->tk_pid, __func__,
2332 (unsigned int)clnt->cl_prog,
2333 (unsigned int)clnt->cl_vers,
2334 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002335 error = -EPROTONOSUPPORT;
2336 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002338 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002339 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002340 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002341 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002342 clnt->cl_prog, clnt->cl_vers,
2343 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002344 error = -EOPNOTSUPP;
2345 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002347 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002348 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 break; /* retry */
2350 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002351 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002352 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 /* Also retry */
2354 }
2355
Trond Myklebustabbcf282006-01-03 09:55:03 +01002356out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002357 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 if (task->tk_garb_retry) {
2359 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002360 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002361 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002363out_retry:
2364 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366out_err:
2367 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002368 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002369 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002370 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002372 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002373 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002374 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002376
Chuck Lever9f06c712010-12-14 14:59:18 +00002377static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002378{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002379}
2380
Chuck Leverbf269552010-12-14 14:59:29 +00002381static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002382{
2383 return 0;
2384}
2385
2386static struct rpc_procinfo rpcproc_null = {
2387 .p_encode = rpcproc_encode_null,
2388 .p_decode = rpcproc_decode_null,
2389};
2390
Chuck Levercaabea82009-12-03 15:58:56 -05002391static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002392{
2393 struct rpc_message msg = {
2394 .rpc_proc = &rpcproc_null,
2395 };
2396 int err;
2397 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002398 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002399 put_rpccred(msg.rpc_cred);
2400 return err;
2401}
Trond Myklebust188fef12007-06-16 14:18:40 -04002402
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002403struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2404{
2405 struct rpc_message msg = {
2406 .rpc_proc = &rpcproc_null,
2407 .rpc_cred = cred,
2408 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002409 struct rpc_task_setup task_setup_data = {
2410 .rpc_client = clnt,
2411 .rpc_message = &msg,
2412 .callback_ops = &rpc_default_ops,
2413 .flags = flags,
2414 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002415 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002416}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002417EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002418
Trond Myklebust188fef12007-06-16 14:18:40 -04002419#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002420static void rpc_show_header(void)
2421{
Chuck Levercb3997b2008-05-21 17:09:41 -04002422 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2423 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002424}
2425
Chuck Lever38e886e2008-05-21 17:09:33 -04002426static void rpc_show_task(const struct rpc_clnt *clnt,
2427 const struct rpc_task *task)
2428{
2429 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002430
2431 if (RPC_IS_QUEUED(task))
2432 rpc_waitq = rpc_qname(task->tk_waitqueue);
2433
Joe Perchesb3bceda2010-12-21 10:52:24 -05002434 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 -04002435 task->tk_pid, task->tk_flags, task->tk_status,
2436 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002437 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002438 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002439}
2440
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002441void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002442{
2443 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002444 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002445 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002446 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002447
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002448 spin_lock(&sn->rpc_client_lock);
2449 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002450 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002451 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002452 if (!header) {
2453 rpc_show_header();
2454 header++;
2455 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002456 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002457 }
2458 spin_unlock(&clnt->cl_lock);
2459 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002460 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002461}
2462#endif