blob: 0edada973434e4df883f63a85173f4a7a1de0885 [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
Ben Hutchings2c530402012-07-10 10:55:09 +0000441/**
Chuck Leverc2866762006-08-22 20:06:20 -0400442 * rpc_create - create an RPC client and transport with one call
443 * @args: rpc_clnt create argument structure
444 *
445 * Creates and initializes an RPC transport and an RPC client.
446 *
447 * It can ping the server in order to determine if it is up, and to see if
448 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
449 * this behavior so asynchronous tasks can also use rpc_create.
450 */
451struct rpc_clnt *rpc_create(struct rpc_create_args *args)
452{
453 struct rpc_xprt *xprt;
454 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400455 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400456 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400457 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200458 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200459 .dstaddr = args->address,
460 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500461 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300462 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200463 };
Chuck Lever510deb02007-12-10 14:56:24 -0500464 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400465
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400466 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
467 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400468 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
469 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400470 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400471 * If the caller chooses not to specify a hostname, whip
472 * up a string representation of the passed-in address.
473 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500474 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400475 struct sockaddr_un *sun =
476 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400477 struct sockaddr_in *sin =
478 (struct sockaddr_in *)args->address;
479 struct sockaddr_in6 *sin6 =
480 (struct sockaddr_in6 *)args->address;
481
Chuck Lever510deb02007-12-10 14:56:24 -0500482 servername[0] = '\0';
483 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400484 case AF_LOCAL:
485 snprintf(servername, sizeof(servername), "%s",
486 sun->sun_path);
487 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400488 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700489 snprintf(servername, sizeof(servername), "%pI4",
490 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500491 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400492 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700493 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400494 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500495 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500496 default:
497 /* caller wants default server name, but
498 * address family isn't recognized. */
499 return ERR_PTR(-EINVAL);
500 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500501 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400502 }
503
Chuck Lever510deb02007-12-10 14:56:24 -0500504 xprt = xprt_create_transport(&xprtargs);
505 if (IS_ERR(xprt))
506 return (struct rpc_clnt *)xprt;
507
Chuck Lever43780b82007-07-01 12:13:22 -0400508 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400509 * By default, kernel RPC client connects from a reserved port.
510 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
511 * but it is always enabled for rpciod, which handles the connect
512 * operation.
513 */
514 xprt->resvport = 1;
515 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
516 xprt->resvport = 0;
517
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400518 clnt = rpc_new_client(args, xprt, NULL);
Chuck Leverc2866762006-08-22 20:06:20 -0400519 if (IS_ERR(clnt))
520 return clnt;
521
522 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500523 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400524 if (err != 0) {
525 rpc_shutdown_client(clnt);
526 return ERR_PTR(err);
527 }
528 }
529
530 clnt->cl_softrtry = 1;
531 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
532 clnt->cl_softrtry = 0;
533
Chuck Leverc2866762006-08-22 20:06:20 -0400534 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
535 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500536 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
537 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400538 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
539 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400540
541 return clnt;
542}
Chuck Leverb86acd52006-08-22 20:06:22 -0400543EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545/*
546 * This function clones the RPC client structure. It allows us to share the
547 * same transport while varying parameters such as the authentication
548 * flavour.
549 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400550static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
551 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500553 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400554 struct rpc_clnt *new;
555 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Chuck Lever1b63a752012-09-14 17:23:52 -0400557 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500558 rcu_read_lock();
559 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
560 rcu_read_unlock();
561 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400562 goto out_err;
563 args->servername = xprt->servername;
564
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400565 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400566 if (IS_ERR(new)) {
567 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400568 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400569 }
570
Chuck Lever1b63a752012-09-14 17:23:52 -0400571 /* Turn off autobind on clones */
572 new->cl_autobind = 0;
573 new->cl_softrtry = clnt->cl_softrtry;
574 new->cl_discrtry = clnt->cl_discrtry;
575 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400577
Chuck Lever1b63a752012-09-14 17:23:52 -0400578out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800579 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500580 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
Chuck Lever1b63a752012-09-14 17:23:52 -0400582
583/**
584 * rpc_clone_client - Clone an RPC client structure
585 *
586 * @clnt: RPC client whose parameters are copied
587 *
588 * Returns a fresh RPC client or an ERR_PTR.
589 */
590struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
591{
592 struct rpc_create_args args = {
593 .program = clnt->cl_program,
594 .prognumber = clnt->cl_prog,
595 .version = clnt->cl_vers,
596 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400597 };
598 return __rpc_clone_client(&args, clnt);
599}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400600EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Chuck Leverba9b5842012-09-14 17:24:02 -0400602/**
603 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
604 *
605 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800606 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400607 *
608 * Returns a fresh RPC client or an ERR_PTR.
609 */
610struct rpc_clnt *
611rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
612{
613 struct rpc_create_args args = {
614 .program = clnt->cl_program,
615 .prognumber = clnt->cl_prog,
616 .version = clnt->cl_vers,
617 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400618 };
619 return __rpc_clone_client(&args, clnt);
620}
621EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
622
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400623/**
624 * rpc_switch_client_transport: switch the RPC transport on the fly
625 * @clnt: pointer to a struct rpc_clnt
626 * @args: pointer to the new transport arguments
627 * @timeout: pointer to the new timeout parameters
628 *
629 * This function allows the caller to switch the RPC transport for the
630 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
631 * server, for instance. It assumes that the caller has ensured that
632 * there are no active RPC tasks by using some form of locking.
633 *
634 * Returns zero if "clnt" is now using the new xprt. Otherwise a
635 * negative errno is returned, and "clnt" continues to use the old
636 * xprt.
637 */
638int rpc_switch_client_transport(struct rpc_clnt *clnt,
639 struct xprt_create *args,
640 const struct rpc_timeout *timeout)
641{
642 const struct rpc_timeout *old_timeo;
643 rpc_authflavor_t pseudoflavor;
644 struct rpc_xprt *xprt, *old;
645 struct rpc_clnt *parent;
646 int err;
647
648 xprt = xprt_create_transport(args);
649 if (IS_ERR(xprt)) {
650 dprintk("RPC: failed to create new xprt for clnt %p\n",
651 clnt);
652 return PTR_ERR(xprt);
653 }
654
655 pseudoflavor = clnt->cl_auth->au_flavor;
656
657 old_timeo = clnt->cl_timeout;
658 old = rpc_clnt_set_transport(clnt, xprt, timeout);
659
660 rpc_unregister_client(clnt);
661 __rpc_clnt_remove_pipedir(clnt);
662
663 /*
664 * A new transport was created. "clnt" therefore
665 * becomes the root of a new cl_parent tree. clnt's
666 * children, if it has any, still point to the old xprt.
667 */
668 parent = clnt->cl_parent;
669 clnt->cl_parent = clnt;
670
671 /*
672 * The old rpc_auth cache cannot be re-used. GSS
673 * contexts in particular are between a single
674 * client and server.
675 */
676 err = rpc_client_register(clnt, pseudoflavor, NULL);
677 if (err)
678 goto out_revert;
679
680 synchronize_rcu();
681 if (parent != clnt)
682 rpc_release_client(parent);
683 xprt_put(old);
684 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
685 return 0;
686
687out_revert:
688 rpc_clnt_set_transport(clnt, old, old_timeo);
689 clnt->cl_parent = parent;
690 rpc_client_register(clnt, pseudoflavor, NULL);
691 xprt_put(xprt);
692 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
693 return err;
694}
695EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400698 * Kill all tasks for the given client.
699 * XXX: kill their descendants as well?
700 */
701void rpc_killall_tasks(struct rpc_clnt *clnt)
702{
703 struct rpc_task *rovr;
704
705
706 if (list_empty(&clnt->cl_tasks))
707 return;
708 dprintk("RPC: killing all tasks for client %p\n", clnt);
709 /*
710 * Spin lock all_tasks to prevent changes...
711 */
712 spin_lock(&clnt->cl_lock);
713 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
714 if (!RPC_IS_ACTIVATED(rovr))
715 continue;
716 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
717 rovr->tk_flags |= RPC_TASK_KILLED;
718 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300719 if (RPC_IS_QUEUED(rovr))
720 rpc_wake_up_queued_task(rovr->tk_waitqueue,
721 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400722 }
723 }
724 spin_unlock(&clnt->cl_lock);
725}
726EXPORT_SYMBOL_GPL(rpc_killall_tasks);
727
728/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400730 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400732void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400734 might_sleep();
735
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500736 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400737 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500738 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Trond Myklebust34f52e32007-06-14 16:40:31 -0400740 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800742 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400743 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 }
745
Trond Myklebust4c402b42007-06-14 16:40:32 -0400746 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400748EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400751 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500753static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400754rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500756 struct rpc_clnt *parent = NULL;
757
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500758 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400759 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500760 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500761 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500762 parent = clnt->cl_parent;
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400763 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400764 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500765 rpc_free_iostats(clnt->cl_metrics);
766 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500767 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400768 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400769 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500771 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773
774/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400775 * Free an RPC client
776 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500777static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400778rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400779{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500780 if (clnt->cl_auth == NULL)
781 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400782
783 /*
784 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
785 * release remaining GSS contexts. This mechanism ensures
786 * that it can do so safely.
787 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400788 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400789 rpcauth_release(clnt->cl_auth);
790 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400791 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500792 return rpc_free_client(clnt);
793 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400794}
795
796/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400797 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 */
799void
800rpc_release_client(struct rpc_clnt *clnt)
801{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400802 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Trond Myklebustd07ba842013-11-12 17:24:36 -0500804 do {
805 if (list_empty(&clnt->cl_tasks))
806 wake_up(&destroy_wait);
807 if (!atomic_dec_and_test(&clnt->cl_count))
808 break;
809 clnt = rpc_free_auth(clnt);
810 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400811}
Simo Sorce1d658332012-05-25 18:09:55 -0400812EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400813
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000814/**
815 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800816 * @old: old rpc_client
817 * @program: rpc program to set
818 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000819 *
820 * Clones the rpc client and sets up a new RPC program. This is mainly
821 * of use for enabling different RPC programs to share the same transport.
822 * The Sun NFSv2/v3 ACL protocol can do this.
823 */
824struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500825 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400826 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000827{
Trond Myklebustf994c432012-11-01 12:14:14 -0400828 struct rpc_create_args args = {
829 .program = program,
830 .prognumber = program->number,
831 .version = vers,
832 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400833 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000834 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000835 int err;
836
Trond Myklebustf994c432012-11-01 12:14:14 -0400837 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000838 if (IS_ERR(clnt))
839 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500840 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000841 if (err != 0) {
842 rpc_shutdown_client(clnt);
843 clnt = ERR_PTR(err);
844 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800845out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000846 return clnt;
847}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400848EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000849
Trond Myklebust58f96122010-07-31 14:29:08 -0400850void rpc_task_release_client(struct rpc_task *task)
851{
852 struct rpc_clnt *clnt = task->tk_client;
853
854 if (clnt != NULL) {
855 /* Remove from client task list */
856 spin_lock(&clnt->cl_lock);
857 list_del(&task->tk_task);
858 spin_unlock(&clnt->cl_lock);
859 task->tk_client = NULL;
860
861 rpc_release_client(clnt);
862 }
863}
864
865static
866void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
867{
868 if (clnt != NULL) {
869 rpc_task_release_client(task);
870 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400871 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400872 if (clnt->cl_softrtry)
873 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400874 if (clnt->cl_noretranstimeo)
875 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700876 if (sk_memalloc_socks()) {
877 struct rpc_xprt *xprt;
878
879 rcu_read_lock();
880 xprt = rcu_dereference(clnt->cl_xprt);
881 if (xprt->swapper)
882 task->tk_flags |= RPC_TASK_SWAPPER;
883 rcu_read_unlock();
884 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400885 /* Add to the client's list of all tasks */
886 spin_lock(&clnt->cl_lock);
887 list_add_tail(&task->tk_task, &clnt->cl_tasks);
888 spin_unlock(&clnt->cl_lock);
889 }
890}
891
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000892void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
893{
894 rpc_task_release_client(task);
895 rpc_task_set_client(task, clnt);
896}
897EXPORT_SYMBOL_GPL(rpc_task_reset_client);
898
899
Trond Myklebust58f96122010-07-31 14:29:08 -0400900static void
901rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
902{
903 if (msg != NULL) {
904 task->tk_msg.rpc_proc = msg->rpc_proc;
905 task->tk_msg.rpc_argp = msg->rpc_argp;
906 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400907 if (msg->rpc_cred != NULL)
908 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400909 }
910}
911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912/*
913 * Default callback for async RPC calls
914 */
915static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100916rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917{
918}
919
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100920static const struct rpc_call_ops rpc_default_ops = {
921 .rpc_call_done = rpc_default_callback,
922};
923
Trond Myklebustc970aa82007-07-14 15:39:59 -0400924/**
925 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
926 * @task_setup_data: pointer to task initialisation data
927 */
928struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400929{
Trond Myklebust19445b92010-04-16 16:41:10 -0400930 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400931
Trond Myklebust84115e12007-07-14 15:39:59 -0400932 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400933 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400934 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400935
Trond Myklebust58f96122010-07-31 14:29:08 -0400936 rpc_task_set_client(task, task_setup_data->rpc_client);
937 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
938
Trond Myklebust58f96122010-07-31 14:29:08 -0400939 if (task->tk_action == NULL)
940 rpc_call_start(task);
941
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400942 atomic_inc(&task->tk_count);
943 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400944out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400945 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400946}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400947EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400948
949/**
950 * rpc_call_sync - Perform a synchronous RPC call
951 * @clnt: pointer to RPC client
952 * @msg: RPC call parameters
953 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500955int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
957 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400958 struct rpc_task_setup task_setup_data = {
959 .rpc_client = clnt,
960 .rpc_message = msg,
961 .callback_ops = &rpc_default_ops,
962 .flags = flags,
963 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400964 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400966 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
967 if (flags & RPC_TASK_ASYNC) {
968 rpc_release_calldata(task_setup_data.callback_ops,
969 task_setup_data.callback_data);
970 return -EINVAL;
971 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Trond Myklebustc970aa82007-07-14 15:39:59 -0400973 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400974 if (IS_ERR(task))
975 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100976 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800977 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 return status;
979}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400980EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400982/**
983 * rpc_call_async - Perform an asynchronous RPC call
984 * @clnt: pointer to RPC client
985 * @msg: RPC call parameters
986 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800987 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400988 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 */
990int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500991rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100992 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993{
994 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400995 struct rpc_task_setup task_setup_data = {
996 .rpc_client = clnt,
997 .rpc_message = msg,
998 .callback_ops = tk_ops,
999 .callback_data = data,
1000 .flags = flags|RPC_TASK_ASYNC,
1001 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
Trond Myklebustc970aa82007-07-14 15:39:59 -04001003 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001004 if (IS_ERR(task))
1005 return PTR_ERR(task);
1006 rpc_put_task(task);
1007 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001009EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001011#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001012/**
1013 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1014 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001015 * @req: RPC request
1016 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001017 */
1018struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001019 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001020{
1021 struct rpc_task *task;
1022 struct xdr_buf *xbufp = &req->rq_snd_buf;
1023 struct rpc_task_setup task_setup_data = {
1024 .callback_ops = tk_ops,
1025 };
1026
1027 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1028 /*
1029 * Create an rpc_task to send the data
1030 */
1031 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001032 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001033 xprt_free_bc_request(req);
1034 goto out;
1035 }
1036 task->tk_rqstp = req;
1037
1038 /*
1039 * Set up the xdr_buf length.
1040 * This also indicates that the buffer is XDR encoded already.
1041 */
1042 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1043 xbufp->tail[0].iov_len;
1044
1045 task->tk_action = call_bc_transmit;
1046 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001047 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001048 rpc_execute(task);
1049
1050out:
1051 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1052 return task;
1053}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001054#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001055
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001057rpc_call_start(struct rpc_task *task)
1058{
1059 task->tk_action = call_start;
1060}
1061EXPORT_SYMBOL_GPL(rpc_call_start);
1062
Chuck Levered394402006-08-22 20:06:17 -04001063/**
1064 * rpc_peeraddr - extract remote peer address from clnt's xprt
1065 * @clnt: RPC client structure
1066 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001067 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001068 *
1069 * Returns the number of bytes that are actually in the stored address.
1070 */
1071size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1072{
1073 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001074 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001075
Trond Myklebust2446ab62012-03-01 17:00:56 -05001076 rcu_read_lock();
1077 xprt = rcu_dereference(clnt->cl_xprt);
1078
1079 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001080 if (bytes > bufsize)
1081 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001082 memcpy(buf, &xprt->addr, bytes);
1083 rcu_read_unlock();
1084
1085 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001086}
Chuck Leverb86acd52006-08-22 20:06:22 -04001087EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001088
Chuck Leverf425eba2006-08-22 20:06:18 -04001089/**
1090 * rpc_peeraddr2str - return remote peer address in printable format
1091 * @clnt: RPC client structure
1092 * @format: address format
1093 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001094 * NB: the lifetime of the memory referenced by the returned pointer is
1095 * the same as the rpc_xprt itself. As long as the caller uses this
1096 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001097 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001098const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1099 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001100{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001101 struct rpc_xprt *xprt;
1102
1103 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001104
1105 if (xprt->address_strings[format] != NULL)
1106 return xprt->address_strings[format];
1107 else
1108 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001109}
Chuck Leverb86acd52006-08-22 20:06:22 -04001110EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001111
Chuck Lever2e738fd2012-03-01 17:01:14 -05001112static const struct sockaddr_in rpc_inaddr_loopback = {
1113 .sin_family = AF_INET,
1114 .sin_addr.s_addr = htonl(INADDR_ANY),
1115};
1116
1117static const struct sockaddr_in6 rpc_in6addr_loopback = {
1118 .sin6_family = AF_INET6,
1119 .sin6_addr = IN6ADDR_ANY_INIT,
1120};
1121
1122/*
1123 * Try a getsockname() on a connected datagram socket. Using a
1124 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1125 * This conserves the ephemeral port number space.
1126 *
1127 * Returns zero and fills in "buf" if successful; otherwise, a
1128 * negative errno is returned.
1129 */
1130static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1131 struct sockaddr *buf, int buflen)
1132{
1133 struct socket *sock;
1134 int err;
1135
1136 err = __sock_create(net, sap->sa_family,
1137 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1138 if (err < 0) {
1139 dprintk("RPC: can't create UDP socket (%d)\n", err);
1140 goto out;
1141 }
1142
1143 switch (sap->sa_family) {
1144 case AF_INET:
1145 err = kernel_bind(sock,
1146 (struct sockaddr *)&rpc_inaddr_loopback,
1147 sizeof(rpc_inaddr_loopback));
1148 break;
1149 case AF_INET6:
1150 err = kernel_bind(sock,
1151 (struct sockaddr *)&rpc_in6addr_loopback,
1152 sizeof(rpc_in6addr_loopback));
1153 break;
1154 default:
1155 err = -EAFNOSUPPORT;
1156 goto out;
1157 }
1158 if (err < 0) {
1159 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1160 goto out_release;
1161 }
1162
1163 err = kernel_connect(sock, sap, salen, 0);
1164 if (err < 0) {
1165 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1166 goto out_release;
1167 }
1168
1169 err = kernel_getsockname(sock, buf, &buflen);
1170 if (err < 0) {
1171 dprintk("RPC: getsockname failed (%d)\n", err);
1172 goto out_release;
1173 }
1174
1175 err = 0;
1176 if (buf->sa_family == AF_INET6) {
1177 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1178 sin6->sin6_scope_id = 0;
1179 }
1180 dprintk("RPC: %s succeeded\n", __func__);
1181
1182out_release:
1183 sock_release(sock);
1184out:
1185 return err;
1186}
1187
1188/*
1189 * Scraping a connected socket failed, so we don't have a useable
1190 * local address. Fallback: generate an address that will prevent
1191 * the server from calling us back.
1192 *
1193 * Returns zero and fills in "buf" if successful; otherwise, a
1194 * negative errno is returned.
1195 */
1196static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1197{
1198 switch (family) {
1199 case AF_INET:
1200 if (buflen < sizeof(rpc_inaddr_loopback))
1201 return -EINVAL;
1202 memcpy(buf, &rpc_inaddr_loopback,
1203 sizeof(rpc_inaddr_loopback));
1204 break;
1205 case AF_INET6:
1206 if (buflen < sizeof(rpc_in6addr_loopback))
1207 return -EINVAL;
1208 memcpy(buf, &rpc_in6addr_loopback,
1209 sizeof(rpc_in6addr_loopback));
1210 default:
1211 dprintk("RPC: %s: address family not supported\n",
1212 __func__);
1213 return -EAFNOSUPPORT;
1214 }
1215 dprintk("RPC: %s: succeeded\n", __func__);
1216 return 0;
1217}
1218
1219/**
1220 * rpc_localaddr - discover local endpoint address for an RPC client
1221 * @clnt: RPC client structure
1222 * @buf: target buffer
1223 * @buflen: size of target buffer, in bytes
1224 *
1225 * Returns zero and fills in "buf" and "buflen" if successful;
1226 * otherwise, a negative errno is returned.
1227 *
1228 * This works even if the underlying transport is not currently connected,
1229 * or if the upper layer never previously provided a source address.
1230 *
1231 * The result of this function call is transient: multiple calls in
1232 * succession may give different results, depending on how local
1233 * networking configuration changes over time.
1234 */
1235int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1236{
1237 struct sockaddr_storage address;
1238 struct sockaddr *sap = (struct sockaddr *)&address;
1239 struct rpc_xprt *xprt;
1240 struct net *net;
1241 size_t salen;
1242 int err;
1243
1244 rcu_read_lock();
1245 xprt = rcu_dereference(clnt->cl_xprt);
1246 salen = xprt->addrlen;
1247 memcpy(sap, &xprt->addr, salen);
1248 net = get_net(xprt->xprt_net);
1249 rcu_read_unlock();
1250
1251 rpc_set_port(sap, 0);
1252 err = rpc_sockname(net, sap, salen, buf, buflen);
1253 put_net(net);
1254 if (err != 0)
1255 /* Couldn't discover local address, return ANYADDR */
1256 return rpc_anyaddr(sap->sa_family, buf, buflen);
1257 return 0;
1258}
1259EXPORT_SYMBOL_GPL(rpc_localaddr);
1260
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261void
1262rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1263{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001264 struct rpc_xprt *xprt;
1265
1266 rcu_read_lock();
1267 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001268 if (xprt->ops->set_buffer_size)
1269 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001270 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001272EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273
Trond Myklebust2446ab62012-03-01 17:00:56 -05001274/**
1275 * rpc_protocol - Get transport protocol number for an RPC client
1276 * @clnt: RPC client to query
1277 *
1278 */
1279int rpc_protocol(struct rpc_clnt *clnt)
1280{
1281 int protocol;
1282
1283 rcu_read_lock();
1284 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1285 rcu_read_unlock();
1286 return protocol;
1287}
1288EXPORT_SYMBOL_GPL(rpc_protocol);
1289
1290/**
1291 * rpc_net_ns - Get the network namespace for this RPC client
1292 * @clnt: RPC client to query
1293 *
1294 */
1295struct net *rpc_net_ns(struct rpc_clnt *clnt)
1296{
1297 struct net *ret;
1298
1299 rcu_read_lock();
1300 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1301 rcu_read_unlock();
1302 return ret;
1303}
1304EXPORT_SYMBOL_GPL(rpc_net_ns);
1305
1306/**
1307 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1308 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 *
1310 * For stream transports, this is one RPC record fragment (see RFC
1311 * 1831), as we don't support multi-record requests yet. For datagram
1312 * transports, this is the size of an IP packet minus the IP, UDP, and
1313 * RPC header sizes.
1314 */
1315size_t rpc_max_payload(struct rpc_clnt *clnt)
1316{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001317 size_t ret;
1318
1319 rcu_read_lock();
1320 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1321 rcu_read_unlock();
1322 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323}
Chuck Leverb86acd52006-08-22 20:06:22 -04001324EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Chuck Lever35f5a422006-01-03 09:55:50 +01001326/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001327 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001328 * @clnt: RPC client to query
1329 */
1330unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1331{
1332 unsigned long ret;
1333
1334 rcu_read_lock();
1335 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1336 rcu_read_unlock();
1337 return ret;
1338}
1339EXPORT_SYMBOL_GPL(rpc_get_timeout);
1340
1341/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001342 * rpc_force_rebind - force transport to check that remote port is unchanged
1343 * @clnt: client to rebind
1344 *
1345 */
1346void rpc_force_rebind(struct rpc_clnt *clnt)
1347{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001348 if (clnt->cl_autobind) {
1349 rcu_read_lock();
1350 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1351 rcu_read_unlock();
1352 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001353}
Chuck Leverb86acd52006-08-22 20:06:22 -04001354EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001357 * Restart an (async) RPC call from the call_prepare state.
1358 * Usually called from within the exit handler.
1359 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001360int
Andy Adamsonaae20062009-04-01 09:22:40 -04001361rpc_restart_call_prepare(struct rpc_task *task)
1362{
1363 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001364 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001365 task->tk_action = call_start;
1366 if (task->tk_ops->rpc_call_prepare != NULL)
1367 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001368 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001369}
1370EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1371
1372/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 * Restart an (async) RPC call. Usually called from within the
1374 * exit handler.
1375 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001376int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377rpc_restart_call(struct rpc_task *task)
1378{
1379 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001380 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001382 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001384EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Chuck Lever3748f1e2008-05-21 17:09:12 -04001386#ifdef RPC_DEBUG
1387static const char *rpc_proc_name(const struct rpc_task *task)
1388{
1389 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1390
1391 if (proc) {
1392 if (proc->p_name)
1393 return proc->p_name;
1394 else
1395 return "NULL";
1396 } else
1397 return "no proc";
1398}
1399#endif
1400
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401/*
1402 * 0. Initial state
1403 *
1404 * Other FSM states can be visited zero or more times, but
1405 * this state is visited exactly once for each RPC.
1406 */
1407static void
1408call_start(struct rpc_task *task)
1409{
1410 struct rpc_clnt *clnt = task->tk_client;
1411
Chuck Lever3748f1e2008-05-21 17:09:12 -04001412 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001413 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001414 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001415 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
1417 /* Increment call count */
1418 task->tk_msg.rpc_proc->p_count++;
1419 clnt->cl_stats->rpccnt++;
1420 task->tk_action = call_reserve;
1421}
1422
1423/*
1424 * 1. Reserve an RPC call slot
1425 */
1426static void
1427call_reserve(struct rpc_task *task)
1428{
Chuck Lever46121cf2007-01-31 12:14:08 -05001429 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 task->tk_status = 0;
1432 task->tk_action = call_reserveresult;
1433 xprt_reserve(task);
1434}
1435
Trond Myklebustba60eb22013-04-14 10:49:37 -04001436static void call_retry_reserve(struct rpc_task *task);
1437
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438/*
1439 * 1b. Grok the result of xprt_reserve()
1440 */
1441static void
1442call_reserveresult(struct rpc_task *task)
1443{
1444 int status = task->tk_status;
1445
Chuck Lever46121cf2007-01-31 12:14:08 -05001446 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447
1448 /*
1449 * After a call to xprt_reserve(), we must have either
1450 * a request slot or else an error status.
1451 */
1452 task->tk_status = 0;
1453 if (status >= 0) {
1454 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001455 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 return;
1457 }
1458
1459 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001460 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 rpc_exit(task, -EIO);
1462 return;
1463 }
1464
1465 /*
1466 * Even though there was an error, we may have acquired
1467 * a request slot somehow. Make sure not to leak it.
1468 */
1469 if (task->tk_rqstp) {
1470 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001471 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 xprt_release(task);
1473 }
1474
1475 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001476 case -ENOMEM:
1477 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001479 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 return;
1481 case -EIO: /* probably a shutdown */
1482 break;
1483 default:
1484 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001485 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 break;
1487 }
1488 rpc_exit(task, status);
1489}
1490
1491/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001492 * 1c. Retry reserving an RPC call slot
1493 */
1494static void
1495call_retry_reserve(struct rpc_task *task)
1496{
1497 dprint_status(task);
1498
1499 task->tk_status = 0;
1500 task->tk_action = call_reserveresult;
1501 xprt_retry_reserve(task);
1502}
1503
1504/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001505 * 2. Bind and/or refresh the credentials
1506 */
1507static void
1508call_refresh(struct rpc_task *task)
1509{
1510 dprint_status(task);
1511
1512 task->tk_action = call_refreshresult;
1513 task->tk_status = 0;
1514 task->tk_client->cl_stats->rpcauthrefresh++;
1515 rpcauth_refreshcred(task);
1516}
1517
1518/*
1519 * 2a. Process the results of a credential refresh
1520 */
1521static void
1522call_refreshresult(struct rpc_task *task)
1523{
1524 int status = task->tk_status;
1525
1526 dprint_status(task);
1527
1528 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001529 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001530 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001531 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001532 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001533 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001534 return;
1535 }
1536 /* Use rate-limiting and a max number of retries if refresh
1537 * had status 0 but failed to update the cred.
1538 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001539 case -ETIMEDOUT:
1540 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001541 case -EAGAIN:
1542 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001543 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001544 if (!task->tk_cred_retry)
1545 break;
1546 task->tk_cred_retry--;
1547 dprintk("RPC: %5u %s: retry refresh creds\n",
1548 task->tk_pid, __func__);
1549 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001550 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001551 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1552 task->tk_pid, __func__, status);
1553 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001554}
1555
1556/*
1557 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001558 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 */
1560static void
1561call_allocate(struct rpc_task *task)
1562{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001563 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001564 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001565 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001566 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Chuck Lever46121cf2007-01-31 12:14:08 -05001568 dprint_status(task);
1569
Chuck Lever2bea90d2007-03-29 16:47:53 -04001570 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001571 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001572
Chuck Lever02107142006-01-03 09:55:49 +01001573 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 return;
1575
Chuck Lever2bea90d2007-03-29 16:47:53 -04001576 if (proc->p_proc != 0) {
1577 BUG_ON(proc->p_arglen == 0);
1578 if (proc->p_decode != NULL)
1579 BUG_ON(proc->p_replen == 0);
1580 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Chuck Lever2bea90d2007-03-29 16:47:53 -04001582 /*
1583 * Calculate the size (in quads) of the RPC call
1584 * and reply headers, and convert both values
1585 * to byte sizes.
1586 */
1587 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1588 req->rq_callsize <<= 2;
1589 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1590 req->rq_rcvsize <<= 2;
1591
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001592 req->rq_buffer = xprt->ops->buf_alloc(task,
1593 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001594 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001596
1597 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Trond Myklebust5afa9132011-06-17 10:14:59 -04001599 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001600 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 rpc_delay(task, HZ>>4);
1602 return;
1603 }
1604
1605 rpc_exit(task, -ERESTARTSYS);
1606}
1607
Trond Myklebust940e3312005-11-09 21:45:24 -05001608static inline int
1609rpc_task_need_encode(struct rpc_task *task)
1610{
1611 return task->tk_rqstp->rq_snd_buf.len == 0;
1612}
1613
1614static inline void
1615rpc_task_force_reencode(struct rpc_task *task)
1616{
1617 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001618 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001619}
1620
Chuck Lever2bea90d2007-03-29 16:47:53 -04001621static inline void
1622rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1623{
1624 buf->head[0].iov_base = start;
1625 buf->head[0].iov_len = len;
1626 buf->tail[0].iov_len = 0;
1627 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001628 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001629 buf->len = 0;
1630 buf->buflen = len;
1631}
1632
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633/*
1634 * 3. Encode arguments of an RPC call
1635 */
1636static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001637rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001640 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001641 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Chuck Lever46121cf2007-01-31 12:14:08 -05001643 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644
Chuck Lever2bea90d2007-03-29 16:47:53 -04001645 rpc_xdr_buf_init(&req->rq_snd_buf,
1646 req->rq_buffer,
1647 req->rq_callsize);
1648 rpc_xdr_buf_init(&req->rq_rcv_buf,
1649 (char *)req->rq_buffer + req->rq_callsize,
1650 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
Chuck Leverb0e1c572008-05-21 17:09:19 -04001652 p = rpc_encode_header(task);
1653 if (p == NULL) {
1654 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 rpc_exit(task, -EIO);
1656 return;
1657 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001658
1659 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001660 if (encode == NULL)
1661 return;
1662
1663 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1664 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665}
1666
1667/*
1668 * 4. Get the server port number if not yet set
1669 */
1670static void
1671call_bind(struct rpc_task *task)
1672{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001673 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674
Chuck Lever46121cf2007-01-31 12:14:08 -05001675 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Chuck Leverda351872005-08-11 16:25:11 -04001677 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001678 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001679 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001680 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001681 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 }
1683}
1684
1685/*
Chuck Leverda351872005-08-11 16:25:11 -04001686 * 4a. Sort out bind result
1687 */
1688static void
1689call_bind_status(struct rpc_task *task)
1690{
Chuck Lever906462a2007-09-11 18:00:47 -04001691 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001692
1693 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001694 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001695 task->tk_status = 0;
1696 task->tk_action = call_connect;
1697 return;
1698 }
1699
Steve Dickson5753cba2012-02-06 10:08:08 -05001700 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001701 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001702 case -ENOMEM:
1703 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1704 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001705 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001706 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001707 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1708 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001709 /* fail immediately if this is an RPC ping */
1710 if (task->tk_msg.rpc_proc->p_proc == 0) {
1711 status = -EOPNOTSUPP;
1712 break;
1713 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001714 if (task->tk_rebind_retry == 0)
1715 break;
1716 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001717 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001718 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001719 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001720 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001721 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001722 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001723 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001724 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001725 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001726 task->tk_pid);
1727 break;
1728 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001729 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001730 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001731 task->tk_status = 0;
1732 task->tk_action = call_bind;
1733 return;
Chuck Lever012da152009-12-03 15:58:56 -05001734 case -ECONNREFUSED: /* connection problems */
1735 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001736 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001737 case -ENOTCONN:
1738 case -EHOSTDOWN:
1739 case -EHOSTUNREACH:
1740 case -ENETUNREACH:
1741 case -EPIPE:
1742 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1743 task->tk_pid, task->tk_status);
1744 if (!RPC_IS_SOFTCONN(task)) {
1745 rpc_delay(task, 5*HZ);
1746 goto retry_timeout;
1747 }
1748 status = task->tk_status;
1749 break;
Chuck Leverda351872005-08-11 16:25:11 -04001750 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001751 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001752 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001753 }
1754
1755 rpc_exit(task, status);
1756 return;
1757
Trond Myklebustda458282006-08-31 15:44:52 -04001758retry_timeout:
1759 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001760}
1761
1762/*
1763 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 */
1765static void
1766call_connect(struct rpc_task *task)
1767{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001768 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Chuck Lever46121cf2007-01-31 12:14:08 -05001770 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001771 task->tk_pid, xprt,
1772 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Chuck Leverda351872005-08-11 16:25:11 -04001774 task->tk_action = call_transmit;
1775 if (!xprt_connected(xprt)) {
1776 task->tk_action = call_connect_status;
1777 if (task->tk_status < 0)
1778 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001779 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1780 rpc_exit(task, -ENOTCONN);
1781 return;
1782 }
Chuck Leverda351872005-08-11 16:25:11 -04001783 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785}
1786
1787/*
Chuck Leverda351872005-08-11 16:25:11 -04001788 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 */
1790static void
1791call_connect_status(struct rpc_task *task)
1792{
1793 struct rpc_clnt *clnt = task->tk_client;
1794 int status = task->tk_status;
1795
Chuck Lever46121cf2007-01-31 12:14:08 -05001796 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001797
Steve Dickson5753cba2012-02-06 10:08:08 -05001798 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001799 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001801 /* if soft mounted, test if we've timed out */
1802 case -ETIMEDOUT:
1803 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001804 return;
1805 case -ECONNREFUSED:
1806 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001807 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001808 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001809 case -EHOSTUNREACH:
Trond Myklebust561ec162013-09-26 15:22:45 -04001810 /* retry with existing socket, after a delay */
1811 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001812 if (RPC_IS_SOFTCONN(task))
1813 break;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001814 case -EAGAIN:
Trond Myklebust561ec162013-09-26 15:22:45 -04001815 task->tk_action = call_bind;
1816 return;
1817 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001818 clnt->cl_stats->netreconn++;
1819 task->tk_action = call_transmit;
1820 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001822 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823}
1824
1825/*
1826 * 5. Transmit the RPC request, and wait for reply
1827 */
1828static void
1829call_transmit(struct rpc_task *task)
1830{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001831 int is_retrans = RPC_WAS_SENT(task);
1832
Chuck Lever46121cf2007-01-31 12:14:08 -05001833 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834
1835 task->tk_action = call_status;
1836 if (task->tk_status < 0)
1837 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001838 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001840 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001842 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001843 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001844 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001845 if (task->tk_status != 0) {
1846 /* Was the error nonfatal? */
1847 if (task->tk_status == -EAGAIN)
1848 rpc_delay(task, HZ >> 4);
1849 else
1850 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001851 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001852 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001853 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 xprt_transmit(task);
1855 if (task->tk_status < 0)
1856 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001857 if (is_retrans)
1858 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001859 /*
1860 * On success, ensure that we call xprt_end_transmit() before sleeping
1861 * in order to allow access to the socket to other RPC requests.
1862 */
1863 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001864 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001865 return;
1866 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001867 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001868}
1869
1870/*
1871 * 5a. Handle cleanup after a transmission
1872 */
1873static void
1874call_transmit_status(struct rpc_task *task)
1875{
1876 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001877
1878 /*
1879 * Common case: success. Force the compiler to put this
1880 * test first.
1881 */
1882 if (task->tk_status == 0) {
1883 xprt_end_transmit(task);
1884 rpc_task_force_reencode(task);
1885 return;
1886 }
1887
Trond Myklebust15f081c2009-03-11 14:37:57 -04001888 switch (task->tk_status) {
1889 case -EAGAIN:
1890 break;
1891 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001892 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001893 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001894 rpc_task_force_reencode(task);
1895 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001896 /*
1897 * Special cases: if we've been waiting on the
1898 * socket's write_space() callback, or if the
1899 * socket just returned a connection error,
1900 * then hold onto the transport lock.
1901 */
1902 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001903 case -EHOSTDOWN:
1904 case -EHOSTUNREACH:
1905 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001906 if (RPC_IS_SOFTCONN(task)) {
1907 xprt_end_transmit(task);
1908 rpc_exit(task, task->tk_status);
1909 break;
1910 }
1911 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001912 case -ECONNABORTED:
Chuck Lever09a21c42009-12-03 15:58:56 -05001913 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001914 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001915 rpc_task_force_reencode(task);
1916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917}
1918
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001919#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001920/*
1921 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1922 * addition, disconnect on connectivity errors.
1923 */
1924static void
1925call_bc_transmit(struct rpc_task *task)
1926{
1927 struct rpc_rqst *req = task->tk_rqstp;
1928
Trond Myklebust90051ea2013-09-25 12:17:18 -04001929 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001930 /*
1931 * Could not reserve the transport. Try again after the
1932 * transport is released.
1933 */
1934 task->tk_status = 0;
1935 task->tk_action = call_bc_transmit;
1936 return;
1937 }
1938
1939 task->tk_action = rpc_exit_task;
1940 if (task->tk_status < 0) {
1941 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1942 "error: %d\n", task->tk_status);
1943 return;
1944 }
1945
1946 xprt_transmit(task);
1947 xprt_end_transmit(task);
1948 dprint_status(task);
1949 switch (task->tk_status) {
1950 case 0:
1951 /* Success */
1952 break;
1953 case -EHOSTDOWN:
1954 case -EHOSTUNREACH:
1955 case -ENETUNREACH:
1956 case -ETIMEDOUT:
1957 /*
1958 * Problem reaching the server. Disconnect and let the
1959 * forechannel reestablish the connection. The server will
1960 * have to retransmit the backchannel request and we'll
1961 * reprocess it. Since these ops are idempotent, there's no
1962 * need to cache our reply at this time.
1963 */
1964 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1965 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001966 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001967 req->rq_connect_cookie);
1968 break;
1969 default:
1970 /*
1971 * We were unable to reply and will have to drop the
1972 * request. The server should reconnect and retransmit.
1973 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001974 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001975 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1976 "error: %d\n", task->tk_status);
1977 break;
1978 }
1979 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1980}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001981#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001982
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983/*
1984 * 6. Sort out the RPC call status
1985 */
1986static void
1987call_status(struct rpc_task *task)
1988{
1989 struct rpc_clnt *clnt = task->tk_client;
1990 struct rpc_rqst *req = task->tk_rqstp;
1991 int status;
1992
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001993 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1994 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995
Chuck Lever46121cf2007-01-31 12:14:08 -05001996 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
1998 status = task->tk_status;
1999 if (status >= 0) {
2000 task->tk_action = call_decode;
2001 return;
2002 }
2003
Steve Dickson5753cba2012-02-06 10:08:08 -05002004 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 task->tk_status = 0;
2006 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002007 case -EHOSTDOWN:
2008 case -EHOSTUNREACH:
2009 case -ENETUNREACH:
2010 /*
2011 * Delay any retries for 3 seconds, then handle as if it
2012 * were a timeout.
2013 */
2014 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 case -ETIMEDOUT:
2016 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002017 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2018 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002019 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002020 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 break;
2022 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002023 case -ECONNRESET:
2024 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002025 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04002026 rpc_delay(task, 3*HZ);
2027 case -EPIPE:
2028 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 task->tk_action = call_bind;
2030 break;
2031 case -EAGAIN:
2032 task->tk_action = call_transmit;
2033 break;
2034 case -EIO:
2035 /* shutdown or soft timeout */
2036 rpc_exit(task, status);
2037 break;
2038 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002039 if (clnt->cl_chatty)
2040 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002041 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 }
2044}
2045
2046/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002047 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 * We do not release the request slot, so we keep using the
2049 * same XID for all retransmits.
2050 */
2051static void
2052call_timeout(struct rpc_task *task)
2053{
2054 struct rpc_clnt *clnt = task->tk_client;
2055
2056 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002057 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 goto retry;
2059 }
2060
Chuck Lever46121cf2007-01-31 12:14:08 -05002061 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002062 task->tk_timeouts++;
2063
Chuck Lever3a28bec2009-12-03 15:58:56 -05002064 if (RPC_IS_SOFTCONN(task)) {
2065 rpc_exit(task, -ETIMEDOUT);
2066 return;
2067 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002069 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002070 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002071 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002072 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002073 rcu_dereference(clnt->cl_xprt)->servername);
2074 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07002075 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002076 if (task->tk_flags & RPC_TASK_TIMEOUT)
2077 rpc_exit(task, -ETIMEDOUT);
2078 else
2079 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 return;
2081 }
2082
Chuck Leverf518e35a2006-01-03 09:55:52 +01002083 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002085 if (clnt->cl_chatty) {
2086 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002087 printk(KERN_NOTICE "%s: server %s not responding, still trying\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();
2091 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002093 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002094 /*
2095 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2096 * event? RFC2203 requires the server to drop all such requests.
2097 */
2098 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
2100retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 task->tk_action = call_bind;
2102 task->tk_status = 0;
2103}
2104
2105/*
2106 * 7. Decode the RPC reply
2107 */
2108static void
2109call_decode(struct rpc_task *task)
2110{
2111 struct rpc_clnt *clnt = task->tk_client;
2112 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002113 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002114 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
Vasily Averin726fd6a2011-06-01 16:23:59 +04002116 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117
Chuck Leverf518e35a2006-01-03 09:55:52 +01002118 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002119 if (clnt->cl_chatty) {
2120 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002121 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002122 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002123 rcu_dereference(clnt->cl_xprt)->servername);
2124 rcu_read_unlock();
2125 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2127 }
2128
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002129 /*
2130 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002131 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002132 */
2133 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 req->rq_rcv_buf.len = req->rq_private_buf.len;
2135
2136 /* Check that the softirq receive buffer is valid */
2137 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2138 sizeof(req->rq_rcv_buf)) != 0);
2139
Trond Myklebust1e799b62008-03-21 16:19:41 -04002140 if (req->rq_rcv_buf.len < 12) {
2141 if (!RPC_IS_SOFT(task)) {
2142 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002143 goto out_retry;
2144 }
2145 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002146 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002147 task->tk_action = call_timeout;
2148 goto out_retry;
2149 }
2150
Chuck Leverb0e1c572008-05-21 17:09:19 -04002151 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002152 if (IS_ERR(p)) {
2153 if (p == ERR_PTR(-EAGAIN))
2154 goto out_retry;
2155 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 }
2157
Trond Myklebustabbcf282006-01-03 09:55:03 +01002158 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002160 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2162 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002163 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002164 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2165 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 return;
2167out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002169 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002170 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002171 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002172 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002173 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002174 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002175 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176}
2177
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002178static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002179rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180{
2181 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002183 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
2185 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002186
Trond Myklebusta4f08352013-01-08 09:10:21 -05002187 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 *p++ = req->rq_xid; /* XID */
2189 *p++ = htonl(RPC_CALL); /* CALL */
2190 *p++ = htonl(RPC_VERSION); /* RPC version */
2191 *p++ = htonl(clnt->cl_prog); /* program number */
2192 *p++ = htonl(clnt->cl_vers); /* program version */
2193 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002194 p = rpcauth_marshcred(task, p);
2195 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2196 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197}
2198
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002199static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002200rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002202 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2204 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002205 __be32 *p = iov->iov_base;
2206 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 int error = -EACCES;
2208
David Howellse8896492006-08-24 15:44:19 -04002209 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2210 /* RFC-1014 says that the representation of XDR data must be a
2211 * multiple of four bytes
2212 * - if it isn't pointer subtraction in the NFS client may give
2213 * undefined results
2214 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002215 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002216 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002217 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002218 error = -EIO;
2219 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002220 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 if ((len -= 3) < 0)
2222 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002224 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002226 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002227 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002228 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002229 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002231
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2233 if (--len < 0)
2234 goto out_overflow;
2235 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002236 case RPC_AUTH_ERROR:
2237 break;
2238 case RPC_MISMATCH:
2239 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2240 task->tk_pid, __func__);
2241 error = -EPROTONOSUPPORT;
2242 goto out_err;
2243 default:
2244 dprintk("RPC: %5u %s: RPC call rejected, "
2245 "unknown error: %x\n",
2246 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002247 error = -EIO;
2248 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 }
2250 if (--len < 0)
2251 goto out_overflow;
2252 switch ((n = ntohl(*p++))) {
2253 case RPC_AUTH_REJECTEDCRED:
2254 case RPC_AUTH_REJECTEDVERF:
2255 case RPCSEC_GSS_CREDPROBLEM:
2256 case RPCSEC_GSS_CTXPROBLEM:
2257 if (!task->tk_cred_retry)
2258 break;
2259 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002260 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002261 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002263 /* Ensure we obtain a new XID! */
2264 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002265 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002266 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 case RPC_AUTH_BADCRED:
2268 case RPC_AUTH_BADVERF:
2269 /* possibly garbled cred/verf? */
2270 if (!task->tk_garb_retry)
2271 break;
2272 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002273 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002274 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002276 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002278 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002279 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002280 "authentication.\n",
2281 rcu_dereference(clnt->cl_xprt)->servername);
2282 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 break;
2284 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002285 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002286 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 error = -EIO;
2288 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002289 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002290 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 goto out_err;
2292 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002293 p = rpcauth_checkverf(task, p);
2294 if (IS_ERR(p)) {
2295 error = PTR_ERR(p);
2296 dprintk("RPC: %5u %s: auth check failed with %d\n",
2297 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002298 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002300 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 if (len < 0)
2302 goto out_overflow;
2303 switch ((n = ntohl(*p++))) {
2304 case RPC_SUCCESS:
2305 return p;
2306 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002307 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2308 "by server %s\n", task->tk_pid, __func__,
2309 (unsigned int)clnt->cl_prog,
2310 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002311 error = -EPFNOSUPPORT;
2312 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002314 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2315 "by server %s\n", task->tk_pid, __func__,
2316 (unsigned int)clnt->cl_prog,
2317 (unsigned int)clnt->cl_vers,
2318 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002319 error = -EPROTONOSUPPORT;
2320 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002322 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002323 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002324 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002325 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002326 clnt->cl_prog, clnt->cl_vers,
2327 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002328 error = -EOPNOTSUPP;
2329 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002331 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002332 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 break; /* retry */
2334 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002335 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002336 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 /* Also retry */
2338 }
2339
Trond Myklebustabbcf282006-01-03 09:55:03 +01002340out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002341 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 if (task->tk_garb_retry) {
2343 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002344 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002345 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002347out_retry:
2348 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350out_err:
2351 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002352 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002353 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002354 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002356 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002357 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002358 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002360
Chuck Lever9f06c712010-12-14 14:59:18 +00002361static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002362{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002363}
2364
Chuck Leverbf269552010-12-14 14:59:29 +00002365static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002366{
2367 return 0;
2368}
2369
2370static struct rpc_procinfo rpcproc_null = {
2371 .p_encode = rpcproc_encode_null,
2372 .p_decode = rpcproc_decode_null,
2373};
2374
Chuck Levercaabea82009-12-03 15:58:56 -05002375static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002376{
2377 struct rpc_message msg = {
2378 .rpc_proc = &rpcproc_null,
2379 };
2380 int err;
2381 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002382 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002383 put_rpccred(msg.rpc_cred);
2384 return err;
2385}
Trond Myklebust188fef12007-06-16 14:18:40 -04002386
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002387struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2388{
2389 struct rpc_message msg = {
2390 .rpc_proc = &rpcproc_null,
2391 .rpc_cred = cred,
2392 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002393 struct rpc_task_setup task_setup_data = {
2394 .rpc_client = clnt,
2395 .rpc_message = &msg,
2396 .callback_ops = &rpc_default_ops,
2397 .flags = flags,
2398 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002399 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002400}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002401EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002402
Trond Myklebust188fef12007-06-16 14:18:40 -04002403#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002404static void rpc_show_header(void)
2405{
Chuck Levercb3997b2008-05-21 17:09:41 -04002406 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2407 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002408}
2409
Chuck Lever38e886e2008-05-21 17:09:33 -04002410static void rpc_show_task(const struct rpc_clnt *clnt,
2411 const struct rpc_task *task)
2412{
2413 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002414
2415 if (RPC_IS_QUEUED(task))
2416 rpc_waitq = rpc_qname(task->tk_waitqueue);
2417
Joe Perchesb3bceda2010-12-21 10:52:24 -05002418 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 -04002419 task->tk_pid, task->tk_flags, task->tk_status,
2420 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002421 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002422 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002423}
2424
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002425void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002426{
2427 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002428 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002429 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002430 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002431
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002432 spin_lock(&sn->rpc_client_lock);
2433 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002434 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002435 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002436 if (!header) {
2437 rpc_show_header();
2438 header++;
2439 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002440 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002441 }
2442 spin_unlock(&clnt->cl_lock);
2443 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002444 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002445}
2446#endif