blob: f0339ae9bf37efe9bf30acecd3639ae092c27fd0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400108 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400109 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400110 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500115 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117
Trond Myklebust2446ab62012-03-01 17:00:56 -0500118 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400120 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500121 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500126 struct rpc_clnt *clnt,
127 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Trond Myklebustf1345852005-09-23 11:08:25 -0400129 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400130 char name[15];
Linus Torvalds26fe5752012-05-10 13:14:12 -0700131 struct qstr q = { .name = name };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400132 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int error;
134
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400136 if (dir == NULL) {
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400139 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 for (;;) {
141 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
142 name[sizeof(name) - 1] = '\0';
143 q.hash = full_name_hash(q.name, q.len);
144 dentry = rpc_create_client_dir(dir, &q, clnt);
145 if (!IS_ERR(dentry))
146 break;
147 error = PTR_ERR(dentry);
148 if (error != -EEXIST) {
149 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name, name, error);
152 break;
153 }
154 }
155 dput(dir);
156 return dentry;
157}
158
159static int
Stanislav Kinsbursky38481602013-06-24 11:52:38 +0400160rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name,
161 struct super_block *pipefs_sb)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400162{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400163 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400164
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400165 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 if (dir_name == NULL)
167 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400168 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400169 if (IS_ERR(dentry))
170 return PTR_ERR(dentry);
171 clnt->cl_dentry = dentry;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400172 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173}
174
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400175static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
176{
177 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
178 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
179 return 1;
Stanislav Kinsbursky4f6bb242013-06-24 11:52:59 +0400180 if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
181 return 1;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400182 return 0;
183}
184
185static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
186 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400187{
188 struct dentry *dentry;
189 int err = 0;
190
191 switch (event) {
192 case RPC_PIPEFS_MOUNT:
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400193 dentry = rpc_setup_pipedir_sb(sb, clnt,
194 clnt->cl_program->pipe_dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400195 if (!dentry)
196 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400197 if (IS_ERR(dentry))
198 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400199 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400200 if (clnt->cl_auth->au_ops->pipes_create) {
201 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
202 if (err)
203 __rpc_clnt_remove_pipedir(clnt);
204 }
205 break;
206 case RPC_PIPEFS_UMOUNT:
207 __rpc_clnt_remove_pipedir(clnt);
208 break;
209 default:
210 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
211 return -ENOTSUPP;
212 }
213 return err;
214}
215
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400216static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
217 struct super_block *sb)
218{
219 int error = 0;
220
221 for (;; clnt = clnt->cl_parent) {
222 if (!rpc_clnt_skip_event(clnt, event))
223 error = __rpc_clnt_handle_event(clnt, event, sb);
224 if (error || clnt == clnt->cl_parent)
225 break;
226 }
227 return error;
228}
229
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
231{
232 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
233 struct rpc_clnt *clnt;
234
235 spin_lock(&sn->rpc_client_lock);
236 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsbursky7aab4492012-04-20 18:19:18 +0400237 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskycd6c5962012-12-17 20:18:52 +0300238 continue;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400239 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400240 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400241 spin_unlock(&sn->rpc_client_lock);
242 return clnt;
243 }
244 spin_unlock(&sn->rpc_client_lock);
245 return NULL;
246}
247
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400248static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
249 void *ptr)
250{
251 struct super_block *sb = ptr;
252 struct rpc_clnt *clnt;
253 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400254
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400255 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400256 error = __rpc_pipefs_event(clnt, event, sb);
257 if (error)
258 break;
259 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400260 return error;
261}
262
263static struct notifier_block rpc_clients_block = {
264 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400265 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400266};
267
268int rpc_clients_notifier_register(void)
269{
270 return rpc_pipefs_notifier_register(&rpc_clients_block);
271}
272
273void rpc_clients_notifier_unregister(void)
274{
275 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
276}
277
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400278static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
279{
280 clnt->cl_nodelen = strlen(nodename);
281 if (clnt->cl_nodelen > UNX_MAXNODENAME)
282 clnt->cl_nodelen = UNX_MAXNODENAME;
283 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
284}
285
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400286static int rpc_client_register(const struct rpc_create_args *args,
287 struct rpc_clnt *clnt)
288{
289 const struct rpc_program *program = args->program;
290 struct rpc_auth *auth;
291 struct net *net = rpc_net_ns(clnt);
292 struct super_block *pipefs_sb;
293 int err = 0;
294
295 pipefs_sb = rpc_get_sb_net(net);
296 if (pipefs_sb) {
297 err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
298 if (err)
299 goto out;
300 }
301
302 auth = rpcauth_create(args->authflavor, clnt);
303 if (IS_ERR(auth)) {
304 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
305 args->authflavor);
306 err = PTR_ERR(auth);
307 goto err_auth;
308 }
309
310 rpc_register_client(clnt);
311out:
312 if (pipefs_sb)
313 rpc_put_sb_net(net);
314 return err;
315
316err_auth:
317 __rpc_clnt_remove_pipedir(clnt);
318 goto out;
319}
320
Trond Myklebust698b6d02007-12-20 16:03:53 -0500321static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500323 const struct rpc_program *program = args->program;
324 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 struct rpc_clnt *clnt = NULL;
326 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400327
328 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500329 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500330 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Trond Myklebust4ada5392007-06-14 17:26:17 -0400332 err = rpciod_up();
333 if (err)
334 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500335
Trond Myklebustf05c1242013-04-05 14:13:21 -0400336 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500337 if (args->version >= program->nrvers)
338 goto out_err;
339 version = program->version[args->version];
340 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 goto out_err;
342
343 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700344 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 if (!clnt)
346 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 clnt->cl_parent = clnt;
348
Trond Myklebust2446ab62012-03-01 17:00:56 -0500349 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 clnt->cl_procinfo = version->procs;
351 clnt->cl_maxproc = version->nrprocs;
352 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300353 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500356 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500357 err = -ENOMEM;
358 if (clnt->cl_metrics == NULL)
359 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500360 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400361 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400362 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Trond Myklebust2446ab62012-03-01 17:00:56 -0500364 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 clnt->cl_autobind = 1;
366
Trond Myklebustba7392b2007-12-20 16:03:55 -0500367 clnt->cl_timeout = xprt->timeout;
368 if (args->timeout != NULL) {
369 memcpy(&clnt->cl_timeout_default, args->timeout,
370 sizeof(clnt->cl_timeout_default));
371 clnt->cl_timeout = &clnt->cl_timeout_default;
372 }
373
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500375 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500376 clnt->cl_principal = NULL;
377 if (args->client_name) {
378 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
379 if (!clnt->cl_principal)
380 goto out_no_principal;
381 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Trond Myklebust006abe82010-09-12 19:55:25 -0400383 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400386 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400387
388 err = rpc_client_register(args, clnt);
389 if (err)
390 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 return clnt;
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500394 kfree(clnt->cl_principal);
395out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500396 rpc_free_iostats(clnt->cl_metrics);
397out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 kfree(clnt);
399out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400400 rpciod_down();
401out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400402 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 return ERR_PTR(err);
404}
405
Ben Hutchings2c530402012-07-10 10:55:09 +0000406/**
Chuck Leverc2866762006-08-22 20:06:20 -0400407 * rpc_create - create an RPC client and transport with one call
408 * @args: rpc_clnt create argument structure
409 *
410 * Creates and initializes an RPC transport and an RPC client.
411 *
412 * It can ping the server in order to determine if it is up, and to see if
413 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
414 * this behavior so asynchronous tasks can also use rpc_create.
415 */
416struct rpc_clnt *rpc_create(struct rpc_create_args *args)
417{
418 struct rpc_xprt *xprt;
419 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400420 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400421 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400422 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200423 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200424 .dstaddr = args->address,
425 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500426 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300427 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200428 };
Chuck Lever510deb02007-12-10 14:56:24 -0500429 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400430
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400431 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
432 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400433 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
434 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400435 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400436 * If the caller chooses not to specify a hostname, whip
437 * up a string representation of the passed-in address.
438 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500439 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400440 struct sockaddr_un *sun =
441 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400442 struct sockaddr_in *sin =
443 (struct sockaddr_in *)args->address;
444 struct sockaddr_in6 *sin6 =
445 (struct sockaddr_in6 *)args->address;
446
Chuck Lever510deb02007-12-10 14:56:24 -0500447 servername[0] = '\0';
448 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400449 case AF_LOCAL:
450 snprintf(servername, sizeof(servername), "%s",
451 sun->sun_path);
452 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400453 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700454 snprintf(servername, sizeof(servername), "%pI4",
455 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500456 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400457 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700458 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400459 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500460 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500461 default:
462 /* caller wants default server name, but
463 * address family isn't recognized. */
464 return ERR_PTR(-EINVAL);
465 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500466 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400467 }
468
Chuck Lever510deb02007-12-10 14:56:24 -0500469 xprt = xprt_create_transport(&xprtargs);
470 if (IS_ERR(xprt))
471 return (struct rpc_clnt *)xprt;
472
Chuck Lever43780b82007-07-01 12:13:22 -0400473 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400474 * By default, kernel RPC client connects from a reserved port.
475 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
476 * but it is always enabled for rpciod, which handles the connect
477 * operation.
478 */
479 xprt->resvport = 1;
480 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
481 xprt->resvport = 0;
482
Trond Myklebust698b6d02007-12-20 16:03:53 -0500483 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400484 if (IS_ERR(clnt))
485 return clnt;
486
487 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500488 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400489 if (err != 0) {
490 rpc_shutdown_client(clnt);
491 return ERR_PTR(err);
492 }
493 }
494
495 clnt->cl_softrtry = 1;
496 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
497 clnt->cl_softrtry = 0;
498
Chuck Leverc2866762006-08-22 20:06:20 -0400499 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
500 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500501 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
502 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400503 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
504 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400505
506 return clnt;
507}
Chuck Leverb86acd52006-08-22 20:06:22 -0400508EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510/*
511 * This function clones the RPC client structure. It allows us to share the
512 * same transport while varying parameters such as the authentication
513 * flavour.
514 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400515static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
516 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500518 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400519 struct rpc_clnt *new;
520 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
Chuck Lever1b63a752012-09-14 17:23:52 -0400522 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500523 rcu_read_lock();
524 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
525 rcu_read_unlock();
526 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400527 goto out_err;
528 args->servername = xprt->servername;
529
530 new = rpc_new_client(args, xprt);
531 if (IS_ERR(new)) {
532 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400533 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400534 }
535
Trond Myklebust006abe82010-09-12 19:55:25 -0400536 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400537 new->cl_parent = clnt;
538
539 /* Turn off autobind on clones */
540 new->cl_autobind = 0;
541 new->cl_softrtry = clnt->cl_softrtry;
542 new->cl_discrtry = clnt->cl_discrtry;
543 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400545
Chuck Lever1b63a752012-09-14 17:23:52 -0400546out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800547 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500548 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549}
Chuck Lever1b63a752012-09-14 17:23:52 -0400550
551/**
552 * rpc_clone_client - Clone an RPC client structure
553 *
554 * @clnt: RPC client whose parameters are copied
555 *
556 * Returns a fresh RPC client or an ERR_PTR.
557 */
558struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
559{
560 struct rpc_create_args args = {
561 .program = clnt->cl_program,
562 .prognumber = clnt->cl_prog,
563 .version = clnt->cl_vers,
564 .authflavor = clnt->cl_auth->au_flavor,
565 .client_name = clnt->cl_principal,
566 };
567 return __rpc_clone_client(&args, clnt);
568}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400569EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Chuck Leverba9b5842012-09-14 17:24:02 -0400571/**
572 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
573 *
574 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800575 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400576 *
577 * Returns a fresh RPC client or an ERR_PTR.
578 */
579struct rpc_clnt *
580rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
581{
582 struct rpc_create_args args = {
583 .program = clnt->cl_program,
584 .prognumber = clnt->cl_prog,
585 .version = clnt->cl_vers,
586 .authflavor = flavor,
587 .client_name = clnt->cl_principal,
588 };
589 return __rpc_clone_client(&args, clnt);
590}
591EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400594 * Kill all tasks for the given client.
595 * XXX: kill their descendants as well?
596 */
597void rpc_killall_tasks(struct rpc_clnt *clnt)
598{
599 struct rpc_task *rovr;
600
601
602 if (list_empty(&clnt->cl_tasks))
603 return;
604 dprintk("RPC: killing all tasks for client %p\n", clnt);
605 /*
606 * Spin lock all_tasks to prevent changes...
607 */
608 spin_lock(&clnt->cl_lock);
609 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
610 if (!RPC_IS_ACTIVATED(rovr))
611 continue;
612 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
613 rovr->tk_flags |= RPC_TASK_KILLED;
614 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300615 if (RPC_IS_QUEUED(rovr))
616 rpc_wake_up_queued_task(rovr->tk_waitqueue,
617 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400618 }
619 }
620 spin_unlock(&clnt->cl_lock);
621}
622EXPORT_SYMBOL_GPL(rpc_killall_tasks);
623
624/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400626 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400628void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400630 might_sleep();
631
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500632 dprintk_rcu("RPC: shutting down %s client for %s\n",
633 clnt->cl_protname,
634 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Trond Myklebust34f52e32007-06-14 16:40:31 -0400636 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800638 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400639 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 }
641
Trond Myklebust4c402b42007-06-14 16:40:32 -0400642 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400644EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
646/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400647 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400649static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400650rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500652 dprintk_rcu("RPC: destroying %s client for %s\n",
653 clnt->cl_protname,
654 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500655 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400656 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400657 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400658 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500659 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500660 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500661 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500662 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400663 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666
667/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400668 * Free an RPC client
669 */
670static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400671rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400672{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400673 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400674 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400675 return;
676 }
677
678 /*
679 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
680 * release remaining GSS contexts. This mechanism ensures
681 * that it can do so safely.
682 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400683 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400684 rpcauth_release(clnt->cl_auth);
685 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400686 if (atomic_dec_and_test(&clnt->cl_count))
687 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400688}
689
690/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400691 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 */
693void
694rpc_release_client(struct rpc_clnt *clnt)
695{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400696 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Trond Myklebust34f52e32007-06-14 16:40:31 -0400698 if (list_empty(&clnt->cl_tasks))
699 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400700 if (atomic_dec_and_test(&clnt->cl_count))
701 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400702}
Simo Sorce1d658332012-05-25 18:09:55 -0400703EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400704
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000705/**
706 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800707 * @old: old rpc_client
708 * @program: rpc program to set
709 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000710 *
711 * Clones the rpc client and sets up a new RPC program. This is mainly
712 * of use for enabling different RPC programs to share the same transport.
713 * The Sun NFSv2/v3 ACL protocol can do this.
714 */
715struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500716 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400717 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000718{
Trond Myklebustf994c432012-11-01 12:14:14 -0400719 struct rpc_create_args args = {
720 .program = program,
721 .prognumber = program->number,
722 .version = vers,
723 .authflavor = old->cl_auth->au_flavor,
724 .client_name = old->cl_principal,
725 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000726 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000727 int err;
728
Trond Myklebustf994c432012-11-01 12:14:14 -0400729 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000730 if (IS_ERR(clnt))
731 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500732 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000733 if (err != 0) {
734 rpc_shutdown_client(clnt);
735 clnt = ERR_PTR(err);
736 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800737out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000738 return clnt;
739}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400740EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000741
Trond Myklebust58f96122010-07-31 14:29:08 -0400742void rpc_task_release_client(struct rpc_task *task)
743{
744 struct rpc_clnt *clnt = task->tk_client;
745
746 if (clnt != NULL) {
747 /* Remove from client task list */
748 spin_lock(&clnt->cl_lock);
749 list_del(&task->tk_task);
750 spin_unlock(&clnt->cl_lock);
751 task->tk_client = NULL;
752
753 rpc_release_client(clnt);
754 }
755}
756
757static
758void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
759{
760 if (clnt != NULL) {
761 rpc_task_release_client(task);
762 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400763 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400764 if (clnt->cl_softrtry)
765 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700766 if (sk_memalloc_socks()) {
767 struct rpc_xprt *xprt;
768
769 rcu_read_lock();
770 xprt = rcu_dereference(clnt->cl_xprt);
771 if (xprt->swapper)
772 task->tk_flags |= RPC_TASK_SWAPPER;
773 rcu_read_unlock();
774 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400775 /* Add to the client's list of all tasks */
776 spin_lock(&clnt->cl_lock);
777 list_add_tail(&task->tk_task, &clnt->cl_tasks);
778 spin_unlock(&clnt->cl_lock);
779 }
780}
781
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000782void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
783{
784 rpc_task_release_client(task);
785 rpc_task_set_client(task, clnt);
786}
787EXPORT_SYMBOL_GPL(rpc_task_reset_client);
788
789
Trond Myklebust58f96122010-07-31 14:29:08 -0400790static void
791rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
792{
793 if (msg != NULL) {
794 task->tk_msg.rpc_proc = msg->rpc_proc;
795 task->tk_msg.rpc_argp = msg->rpc_argp;
796 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400797 if (msg->rpc_cred != NULL)
798 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400799 }
800}
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802/*
803 * Default callback for async RPC calls
804 */
805static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100806rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
808}
809
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100810static const struct rpc_call_ops rpc_default_ops = {
811 .rpc_call_done = rpc_default_callback,
812};
813
Trond Myklebustc970aa82007-07-14 15:39:59 -0400814/**
815 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
816 * @task_setup_data: pointer to task initialisation data
817 */
818struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400819{
Trond Myklebust19445b92010-04-16 16:41:10 -0400820 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400821
Trond Myklebust84115e12007-07-14 15:39:59 -0400822 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400823 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400824 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400825
Trond Myklebust58f96122010-07-31 14:29:08 -0400826 rpc_task_set_client(task, task_setup_data->rpc_client);
827 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
828
Trond Myklebust58f96122010-07-31 14:29:08 -0400829 if (task->tk_action == NULL)
830 rpc_call_start(task);
831
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400832 atomic_inc(&task->tk_count);
833 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400834out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400835 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400836}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400837EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400838
839/**
840 * rpc_call_sync - Perform a synchronous RPC call
841 * @clnt: pointer to RPC client
842 * @msg: RPC call parameters
843 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500845int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846{
847 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400848 struct rpc_task_setup task_setup_data = {
849 .rpc_client = clnt,
850 .rpc_message = msg,
851 .callback_ops = &rpc_default_ops,
852 .flags = flags,
853 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400854 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400856 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
857 if (flags & RPC_TASK_ASYNC) {
858 rpc_release_calldata(task_setup_data.callback_ops,
859 task_setup_data.callback_data);
860 return -EINVAL;
861 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Trond Myklebustc970aa82007-07-14 15:39:59 -0400863 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400864 if (IS_ERR(task))
865 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100866 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800867 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 return status;
869}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400870EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400872/**
873 * rpc_call_async - Perform an asynchronous RPC call
874 * @clnt: pointer to RPC client
875 * @msg: RPC call parameters
876 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800877 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400878 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 */
880int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500881rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100882 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883{
884 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400885 struct rpc_task_setup task_setup_data = {
886 .rpc_client = clnt,
887 .rpc_message = msg,
888 .callback_ops = tk_ops,
889 .callback_data = data,
890 .flags = flags|RPC_TASK_ASYNC,
891 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Trond Myklebustc970aa82007-07-14 15:39:59 -0400893 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400894 if (IS_ERR(task))
895 return PTR_ERR(task);
896 rpc_put_task(task);
897 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400899EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400901#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400902/**
903 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
904 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400905 * @req: RPC request
906 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400907 */
908struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400909 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400910{
911 struct rpc_task *task;
912 struct xdr_buf *xbufp = &req->rq_snd_buf;
913 struct rpc_task_setup task_setup_data = {
914 .callback_ops = tk_ops,
915 };
916
917 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
918 /*
919 * Create an rpc_task to send the data
920 */
921 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400922 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400923 xprt_free_bc_request(req);
924 goto out;
925 }
926 task->tk_rqstp = req;
927
928 /*
929 * Set up the xdr_buf length.
930 * This also indicates that the buffer is XDR encoded already.
931 */
932 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
933 xbufp->tail[0].iov_len;
934
935 task->tk_action = call_bc_transmit;
936 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400937 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400938 rpc_execute(task);
939
940out:
941 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
942 return task;
943}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400944#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400945
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400947rpc_call_start(struct rpc_task *task)
948{
949 task->tk_action = call_start;
950}
951EXPORT_SYMBOL_GPL(rpc_call_start);
952
Chuck Levered394402006-08-22 20:06:17 -0400953/**
954 * rpc_peeraddr - extract remote peer address from clnt's xprt
955 * @clnt: RPC client structure
956 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800957 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400958 *
959 * Returns the number of bytes that are actually in the stored address.
960 */
961size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
962{
963 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500964 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400965
Trond Myklebust2446ab62012-03-01 17:00:56 -0500966 rcu_read_lock();
967 xprt = rcu_dereference(clnt->cl_xprt);
968
969 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400970 if (bytes > bufsize)
971 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500972 memcpy(buf, &xprt->addr, bytes);
973 rcu_read_unlock();
974
975 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400976}
Chuck Leverb86acd52006-08-22 20:06:22 -0400977EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400978
Chuck Leverf425eba2006-08-22 20:06:18 -0400979/**
980 * rpc_peeraddr2str - return remote peer address in printable format
981 * @clnt: RPC client structure
982 * @format: address format
983 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500984 * NB: the lifetime of the memory referenced by the returned pointer is
985 * the same as the rpc_xprt itself. As long as the caller uses this
986 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400987 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500988const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
989 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400990{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500991 struct rpc_xprt *xprt;
992
993 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500994
995 if (xprt->address_strings[format] != NULL)
996 return xprt->address_strings[format];
997 else
998 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400999}
Chuck Leverb86acd52006-08-22 20:06:22 -04001000EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001001
Chuck Lever2e738fd2012-03-01 17:01:14 -05001002static const struct sockaddr_in rpc_inaddr_loopback = {
1003 .sin_family = AF_INET,
1004 .sin_addr.s_addr = htonl(INADDR_ANY),
1005};
1006
1007static const struct sockaddr_in6 rpc_in6addr_loopback = {
1008 .sin6_family = AF_INET6,
1009 .sin6_addr = IN6ADDR_ANY_INIT,
1010};
1011
1012/*
1013 * Try a getsockname() on a connected datagram socket. Using a
1014 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1015 * This conserves the ephemeral port number space.
1016 *
1017 * Returns zero and fills in "buf" if successful; otherwise, a
1018 * negative errno is returned.
1019 */
1020static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1021 struct sockaddr *buf, int buflen)
1022{
1023 struct socket *sock;
1024 int err;
1025
1026 err = __sock_create(net, sap->sa_family,
1027 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1028 if (err < 0) {
1029 dprintk("RPC: can't create UDP socket (%d)\n", err);
1030 goto out;
1031 }
1032
1033 switch (sap->sa_family) {
1034 case AF_INET:
1035 err = kernel_bind(sock,
1036 (struct sockaddr *)&rpc_inaddr_loopback,
1037 sizeof(rpc_inaddr_loopback));
1038 break;
1039 case AF_INET6:
1040 err = kernel_bind(sock,
1041 (struct sockaddr *)&rpc_in6addr_loopback,
1042 sizeof(rpc_in6addr_loopback));
1043 break;
1044 default:
1045 err = -EAFNOSUPPORT;
1046 goto out;
1047 }
1048 if (err < 0) {
1049 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1050 goto out_release;
1051 }
1052
1053 err = kernel_connect(sock, sap, salen, 0);
1054 if (err < 0) {
1055 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1056 goto out_release;
1057 }
1058
1059 err = kernel_getsockname(sock, buf, &buflen);
1060 if (err < 0) {
1061 dprintk("RPC: getsockname failed (%d)\n", err);
1062 goto out_release;
1063 }
1064
1065 err = 0;
1066 if (buf->sa_family == AF_INET6) {
1067 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1068 sin6->sin6_scope_id = 0;
1069 }
1070 dprintk("RPC: %s succeeded\n", __func__);
1071
1072out_release:
1073 sock_release(sock);
1074out:
1075 return err;
1076}
1077
1078/*
1079 * Scraping a connected socket failed, so we don't have a useable
1080 * local address. Fallback: generate an address that will prevent
1081 * the server from calling us back.
1082 *
1083 * Returns zero and fills in "buf" if successful; otherwise, a
1084 * negative errno is returned.
1085 */
1086static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1087{
1088 switch (family) {
1089 case AF_INET:
1090 if (buflen < sizeof(rpc_inaddr_loopback))
1091 return -EINVAL;
1092 memcpy(buf, &rpc_inaddr_loopback,
1093 sizeof(rpc_inaddr_loopback));
1094 break;
1095 case AF_INET6:
1096 if (buflen < sizeof(rpc_in6addr_loopback))
1097 return -EINVAL;
1098 memcpy(buf, &rpc_in6addr_loopback,
1099 sizeof(rpc_in6addr_loopback));
1100 default:
1101 dprintk("RPC: %s: address family not supported\n",
1102 __func__);
1103 return -EAFNOSUPPORT;
1104 }
1105 dprintk("RPC: %s: succeeded\n", __func__);
1106 return 0;
1107}
1108
1109/**
1110 * rpc_localaddr - discover local endpoint address for an RPC client
1111 * @clnt: RPC client structure
1112 * @buf: target buffer
1113 * @buflen: size of target buffer, in bytes
1114 *
1115 * Returns zero and fills in "buf" and "buflen" if successful;
1116 * otherwise, a negative errno is returned.
1117 *
1118 * This works even if the underlying transport is not currently connected,
1119 * or if the upper layer never previously provided a source address.
1120 *
1121 * The result of this function call is transient: multiple calls in
1122 * succession may give different results, depending on how local
1123 * networking configuration changes over time.
1124 */
1125int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1126{
1127 struct sockaddr_storage address;
1128 struct sockaddr *sap = (struct sockaddr *)&address;
1129 struct rpc_xprt *xprt;
1130 struct net *net;
1131 size_t salen;
1132 int err;
1133
1134 rcu_read_lock();
1135 xprt = rcu_dereference(clnt->cl_xprt);
1136 salen = xprt->addrlen;
1137 memcpy(sap, &xprt->addr, salen);
1138 net = get_net(xprt->xprt_net);
1139 rcu_read_unlock();
1140
1141 rpc_set_port(sap, 0);
1142 err = rpc_sockname(net, sap, salen, buf, buflen);
1143 put_net(net);
1144 if (err != 0)
1145 /* Couldn't discover local address, return ANYADDR */
1146 return rpc_anyaddr(sap->sa_family, buf, buflen);
1147 return 0;
1148}
1149EXPORT_SYMBOL_GPL(rpc_localaddr);
1150
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151void
1152rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1153{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001154 struct rpc_xprt *xprt;
1155
1156 rcu_read_lock();
1157 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001158 if (xprt->ops->set_buffer_size)
1159 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001160 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001162EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
Trond Myklebust2446ab62012-03-01 17:00:56 -05001164/**
1165 * rpc_protocol - Get transport protocol number for an RPC client
1166 * @clnt: RPC client to query
1167 *
1168 */
1169int rpc_protocol(struct rpc_clnt *clnt)
1170{
1171 int protocol;
1172
1173 rcu_read_lock();
1174 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1175 rcu_read_unlock();
1176 return protocol;
1177}
1178EXPORT_SYMBOL_GPL(rpc_protocol);
1179
1180/**
1181 * rpc_net_ns - Get the network namespace for this RPC client
1182 * @clnt: RPC client to query
1183 *
1184 */
1185struct net *rpc_net_ns(struct rpc_clnt *clnt)
1186{
1187 struct net *ret;
1188
1189 rcu_read_lock();
1190 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1191 rcu_read_unlock();
1192 return ret;
1193}
1194EXPORT_SYMBOL_GPL(rpc_net_ns);
1195
1196/**
1197 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1198 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 *
1200 * For stream transports, this is one RPC record fragment (see RFC
1201 * 1831), as we don't support multi-record requests yet. For datagram
1202 * transports, this is the size of an IP packet minus the IP, UDP, and
1203 * RPC header sizes.
1204 */
1205size_t rpc_max_payload(struct rpc_clnt *clnt)
1206{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001207 size_t ret;
1208
1209 rcu_read_lock();
1210 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1211 rcu_read_unlock();
1212 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213}
Chuck Leverb86acd52006-08-22 20:06:22 -04001214EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Chuck Lever35f5a422006-01-03 09:55:50 +01001216/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001217 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001218 * @clnt: RPC client to query
1219 */
1220unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1221{
1222 unsigned long ret;
1223
1224 rcu_read_lock();
1225 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1226 rcu_read_unlock();
1227 return ret;
1228}
1229EXPORT_SYMBOL_GPL(rpc_get_timeout);
1230
1231/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001232 * rpc_force_rebind - force transport to check that remote port is unchanged
1233 * @clnt: client to rebind
1234 *
1235 */
1236void rpc_force_rebind(struct rpc_clnt *clnt)
1237{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001238 if (clnt->cl_autobind) {
1239 rcu_read_lock();
1240 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1241 rcu_read_unlock();
1242 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001243}
Chuck Leverb86acd52006-08-22 20:06:22 -04001244EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001247 * Restart an (async) RPC call from the call_prepare state.
1248 * Usually called from within the exit handler.
1249 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001250int
Andy Adamsonaae20062009-04-01 09:22:40 -04001251rpc_restart_call_prepare(struct rpc_task *task)
1252{
1253 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001254 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001255 task->tk_action = call_start;
1256 if (task->tk_ops->rpc_call_prepare != NULL)
1257 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001258 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001259}
1260EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1261
1262/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 * Restart an (async) RPC call. Usually called from within the
1264 * exit handler.
1265 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001266int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267rpc_restart_call(struct rpc_task *task)
1268{
1269 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001270 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001272 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001274EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
Chuck Lever3748f1e2008-05-21 17:09:12 -04001276#ifdef RPC_DEBUG
1277static const char *rpc_proc_name(const struct rpc_task *task)
1278{
1279 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1280
1281 if (proc) {
1282 if (proc->p_name)
1283 return proc->p_name;
1284 else
1285 return "NULL";
1286 } else
1287 return "no proc";
1288}
1289#endif
1290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291/*
1292 * 0. Initial state
1293 *
1294 * Other FSM states can be visited zero or more times, but
1295 * this state is visited exactly once for each RPC.
1296 */
1297static void
1298call_start(struct rpc_task *task)
1299{
1300 struct rpc_clnt *clnt = task->tk_client;
1301
Chuck Lever3748f1e2008-05-21 17:09:12 -04001302 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -05001303 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001304 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001305 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
1307 /* Increment call count */
1308 task->tk_msg.rpc_proc->p_count++;
1309 clnt->cl_stats->rpccnt++;
1310 task->tk_action = call_reserve;
1311}
1312
1313/*
1314 * 1. Reserve an RPC call slot
1315 */
1316static void
1317call_reserve(struct rpc_task *task)
1318{
Chuck Lever46121cf2007-01-31 12:14:08 -05001319 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 task->tk_status = 0;
1322 task->tk_action = call_reserveresult;
1323 xprt_reserve(task);
1324}
1325
Trond Myklebustba60eb22013-04-14 10:49:37 -04001326static void call_retry_reserve(struct rpc_task *task);
1327
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328/*
1329 * 1b. Grok the result of xprt_reserve()
1330 */
1331static void
1332call_reserveresult(struct rpc_task *task)
1333{
1334 int status = task->tk_status;
1335
Chuck Lever46121cf2007-01-31 12:14:08 -05001336 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
1338 /*
1339 * After a call to xprt_reserve(), we must have either
1340 * a request slot or else an error status.
1341 */
1342 task->tk_status = 0;
1343 if (status >= 0) {
1344 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001345 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 return;
1347 }
1348
1349 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001350 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 rpc_exit(task, -EIO);
1352 return;
1353 }
1354
1355 /*
1356 * Even though there was an error, we may have acquired
1357 * a request slot somehow. Make sure not to leak it.
1358 */
1359 if (task->tk_rqstp) {
1360 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001361 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 xprt_release(task);
1363 }
1364
1365 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001366 case -ENOMEM:
1367 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001369 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 return;
1371 case -EIO: /* probably a shutdown */
1372 break;
1373 default:
1374 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001375 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 break;
1377 }
1378 rpc_exit(task, status);
1379}
1380
1381/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001382 * 1c. Retry reserving an RPC call slot
1383 */
1384static void
1385call_retry_reserve(struct rpc_task *task)
1386{
1387 dprint_status(task);
1388
1389 task->tk_status = 0;
1390 task->tk_action = call_reserveresult;
1391 xprt_retry_reserve(task);
1392}
1393
1394/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001395 * 2. Bind and/or refresh the credentials
1396 */
1397static void
1398call_refresh(struct rpc_task *task)
1399{
1400 dprint_status(task);
1401
1402 task->tk_action = call_refreshresult;
1403 task->tk_status = 0;
1404 task->tk_client->cl_stats->rpcauthrefresh++;
1405 rpcauth_refreshcred(task);
1406}
1407
1408/*
1409 * 2a. Process the results of a credential refresh
1410 */
1411static void
1412call_refreshresult(struct rpc_task *task)
1413{
1414 int status = task->tk_status;
1415
1416 dprint_status(task);
1417
1418 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001419 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001420 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001421 case 0:
1422 if (rpcauth_uptodatecred(task))
1423 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001424 return;
1425 case -ETIMEDOUT:
1426 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001427 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001428 case -EAGAIN:
1429 status = -EACCES;
1430 if (!task->tk_cred_retry)
1431 break;
1432 task->tk_cred_retry--;
1433 dprintk("RPC: %5u %s: retry refresh creds\n",
1434 task->tk_pid, __func__);
1435 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001436 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001437 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1438 task->tk_pid, __func__, status);
1439 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001440}
1441
1442/*
1443 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001444 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 */
1446static void
1447call_allocate(struct rpc_task *task)
1448{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001449 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001450 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001451 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001452 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Chuck Lever46121cf2007-01-31 12:14:08 -05001454 dprint_status(task);
1455
Chuck Lever2bea90d2007-03-29 16:47:53 -04001456 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001457 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001458
Chuck Lever02107142006-01-03 09:55:49 +01001459 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 return;
1461
Chuck Lever2bea90d2007-03-29 16:47:53 -04001462 if (proc->p_proc != 0) {
1463 BUG_ON(proc->p_arglen == 0);
1464 if (proc->p_decode != NULL)
1465 BUG_ON(proc->p_replen == 0);
1466 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
Chuck Lever2bea90d2007-03-29 16:47:53 -04001468 /*
1469 * Calculate the size (in quads) of the RPC call
1470 * and reply headers, and convert both values
1471 * to byte sizes.
1472 */
1473 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1474 req->rq_callsize <<= 2;
1475 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1476 req->rq_rcvsize <<= 2;
1477
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001478 req->rq_buffer = xprt->ops->buf_alloc(task,
1479 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001480 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001482
1483 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Trond Myklebust5afa9132011-06-17 10:14:59 -04001485 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001486 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 rpc_delay(task, HZ>>4);
1488 return;
1489 }
1490
1491 rpc_exit(task, -ERESTARTSYS);
1492}
1493
Trond Myklebust940e3312005-11-09 21:45:24 -05001494static inline int
1495rpc_task_need_encode(struct rpc_task *task)
1496{
1497 return task->tk_rqstp->rq_snd_buf.len == 0;
1498}
1499
1500static inline void
1501rpc_task_force_reencode(struct rpc_task *task)
1502{
1503 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001504 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001505}
1506
Chuck Lever2bea90d2007-03-29 16:47:53 -04001507static inline void
1508rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1509{
1510 buf->head[0].iov_base = start;
1511 buf->head[0].iov_len = len;
1512 buf->tail[0].iov_len = 0;
1513 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001514 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001515 buf->len = 0;
1516 buf->buflen = len;
1517}
1518
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519/*
1520 * 3. Encode arguments of an RPC call
1521 */
1522static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001523rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001526 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001527 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Chuck Lever46121cf2007-01-31 12:14:08 -05001529 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Chuck Lever2bea90d2007-03-29 16:47:53 -04001531 rpc_xdr_buf_init(&req->rq_snd_buf,
1532 req->rq_buffer,
1533 req->rq_callsize);
1534 rpc_xdr_buf_init(&req->rq_rcv_buf,
1535 (char *)req->rq_buffer + req->rq_callsize,
1536 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
Chuck Leverb0e1c572008-05-21 17:09:19 -04001538 p = rpc_encode_header(task);
1539 if (p == NULL) {
1540 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 rpc_exit(task, -EIO);
1542 return;
1543 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001544
1545 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001546 if (encode == NULL)
1547 return;
1548
1549 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1550 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551}
1552
1553/*
1554 * 4. Get the server port number if not yet set
1555 */
1556static void
1557call_bind(struct rpc_task *task)
1558{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001559 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Chuck Lever46121cf2007-01-31 12:14:08 -05001561 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Chuck Leverda351872005-08-11 16:25:11 -04001563 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001564 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001565 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001566 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001567 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 }
1569}
1570
1571/*
Chuck Leverda351872005-08-11 16:25:11 -04001572 * 4a. Sort out bind result
1573 */
1574static void
1575call_bind_status(struct rpc_task *task)
1576{
Chuck Lever906462a2007-09-11 18:00:47 -04001577 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001578
1579 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001580 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001581 task->tk_status = 0;
1582 task->tk_action = call_connect;
1583 return;
1584 }
1585
Steve Dickson5753cba2012-02-06 10:08:08 -05001586 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001587 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001588 case -ENOMEM:
1589 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1590 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001591 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001592 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001593 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1594 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001595 /* fail immediately if this is an RPC ping */
1596 if (task->tk_msg.rpc_proc->p_proc == 0) {
1597 status = -EOPNOTSUPP;
1598 break;
1599 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001600 if (task->tk_rebind_retry == 0)
1601 break;
1602 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001603 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001604 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001605 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001606 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001607 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001608 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001609 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001610 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001611 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001612 task->tk_pid);
1613 break;
1614 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001615 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001616 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001617 task->tk_status = 0;
1618 task->tk_action = call_bind;
1619 return;
Chuck Lever012da152009-12-03 15:58:56 -05001620 case -ECONNREFUSED: /* connection problems */
1621 case -ECONNRESET:
1622 case -ENOTCONN:
1623 case -EHOSTDOWN:
1624 case -EHOSTUNREACH:
1625 case -ENETUNREACH:
1626 case -EPIPE:
1627 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1628 task->tk_pid, task->tk_status);
1629 if (!RPC_IS_SOFTCONN(task)) {
1630 rpc_delay(task, 5*HZ);
1631 goto retry_timeout;
1632 }
1633 status = task->tk_status;
1634 break;
Chuck Leverda351872005-08-11 16:25:11 -04001635 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001636 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001637 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001638 }
1639
1640 rpc_exit(task, status);
1641 return;
1642
Trond Myklebustda458282006-08-31 15:44:52 -04001643retry_timeout:
1644 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001645}
1646
1647/*
1648 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 */
1650static void
1651call_connect(struct rpc_task *task)
1652{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001653 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
Chuck Lever46121cf2007-01-31 12:14:08 -05001655 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001656 task->tk_pid, xprt,
1657 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Chuck Leverda351872005-08-11 16:25:11 -04001659 task->tk_action = call_transmit;
1660 if (!xprt_connected(xprt)) {
1661 task->tk_action = call_connect_status;
1662 if (task->tk_status < 0)
1663 return;
1664 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666}
1667
1668/*
Chuck Leverda351872005-08-11 16:25:11 -04001669 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 */
1671static void
1672call_connect_status(struct rpc_task *task)
1673{
1674 struct rpc_clnt *clnt = task->tk_client;
1675 int status = task->tk_status;
1676
Chuck Lever46121cf2007-01-31 12:14:08 -05001677 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001678
Steve Dickson5753cba2012-02-06 10:08:08 -05001679 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001681 /* if soft mounted, test if we've timed out */
1682 case -ETIMEDOUT:
1683 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001684 return;
1685 case -ECONNREFUSED:
1686 case -ECONNRESET:
1687 case -ENETUNREACH:
1688 if (RPC_IS_SOFTCONN(task))
1689 break;
1690 /* retry with existing socket, after a delay */
1691 case 0:
1692 case -EAGAIN:
1693 task->tk_status = 0;
1694 clnt->cl_stats->netreconn++;
1695 task->tk_action = call_transmit;
1696 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001698 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699}
1700
1701/*
1702 * 5. Transmit the RPC request, and wait for reply
1703 */
1704static void
1705call_transmit(struct rpc_task *task)
1706{
Chuck Lever46121cf2007-01-31 12:14:08 -05001707 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
1709 task->tk_action = call_status;
1710 if (task->tk_status < 0)
1711 return;
1712 task->tk_status = xprt_prepare_transmit(task);
1713 if (task->tk_status != 0)
1714 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001715 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001717 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001718 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001719 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001720 if (task->tk_status != 0) {
1721 /* Was the error nonfatal? */
1722 if (task->tk_status == -EAGAIN)
1723 rpc_delay(task, HZ >> 4);
1724 else
1725 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001726 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001727 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001728 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 xprt_transmit(task);
1730 if (task->tk_status < 0)
1731 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001732 /*
1733 * On success, ensure that we call xprt_end_transmit() before sleeping
1734 * in order to allow access to the socket to other RPC requests.
1735 */
1736 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001737 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001738 return;
1739 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001740 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001741}
1742
1743/*
1744 * 5a. Handle cleanup after a transmission
1745 */
1746static void
1747call_transmit_status(struct rpc_task *task)
1748{
1749 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001750
1751 /*
1752 * Common case: success. Force the compiler to put this
1753 * test first.
1754 */
1755 if (task->tk_status == 0) {
1756 xprt_end_transmit(task);
1757 rpc_task_force_reencode(task);
1758 return;
1759 }
1760
Trond Myklebust15f081c2009-03-11 14:37:57 -04001761 switch (task->tk_status) {
1762 case -EAGAIN:
1763 break;
1764 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001765 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001766 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001767 rpc_task_force_reencode(task);
1768 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001769 /*
1770 * Special cases: if we've been waiting on the
1771 * socket's write_space() callback, or if the
1772 * socket just returned a connection error,
1773 * then hold onto the transport lock.
1774 */
1775 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001776 case -EHOSTDOWN:
1777 case -EHOSTUNREACH:
1778 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001779 if (RPC_IS_SOFTCONN(task)) {
1780 xprt_end_transmit(task);
1781 rpc_exit(task, task->tk_status);
1782 break;
1783 }
1784 case -ECONNRESET:
1785 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001786 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001787 rpc_task_force_reencode(task);
1788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789}
1790
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001791#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001792/*
1793 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1794 * addition, disconnect on connectivity errors.
1795 */
1796static void
1797call_bc_transmit(struct rpc_task *task)
1798{
1799 struct rpc_rqst *req = task->tk_rqstp;
1800
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001801 task->tk_status = xprt_prepare_transmit(task);
1802 if (task->tk_status == -EAGAIN) {
1803 /*
1804 * Could not reserve the transport. Try again after the
1805 * transport is released.
1806 */
1807 task->tk_status = 0;
1808 task->tk_action = call_bc_transmit;
1809 return;
1810 }
1811
1812 task->tk_action = rpc_exit_task;
1813 if (task->tk_status < 0) {
1814 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1815 "error: %d\n", task->tk_status);
1816 return;
1817 }
1818
1819 xprt_transmit(task);
1820 xprt_end_transmit(task);
1821 dprint_status(task);
1822 switch (task->tk_status) {
1823 case 0:
1824 /* Success */
1825 break;
1826 case -EHOSTDOWN:
1827 case -EHOSTUNREACH:
1828 case -ENETUNREACH:
1829 case -ETIMEDOUT:
1830 /*
1831 * Problem reaching the server. Disconnect and let the
1832 * forechannel reestablish the connection. The server will
1833 * have to retransmit the backchannel request and we'll
1834 * reprocess it. Since these ops are idempotent, there's no
1835 * need to cache our reply at this time.
1836 */
1837 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1838 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001839 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001840 req->rq_connect_cookie);
1841 break;
1842 default:
1843 /*
1844 * We were unable to reply and will have to drop the
1845 * request. The server should reconnect and retransmit.
1846 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001847 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001848 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1849 "error: %d\n", task->tk_status);
1850 break;
1851 }
1852 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1853}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001854#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001855
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856/*
1857 * 6. Sort out the RPC call status
1858 */
1859static void
1860call_status(struct rpc_task *task)
1861{
1862 struct rpc_clnt *clnt = task->tk_client;
1863 struct rpc_rqst *req = task->tk_rqstp;
1864 int status;
1865
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001866 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1867 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
Chuck Lever46121cf2007-01-31 12:14:08 -05001869 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
1871 status = task->tk_status;
1872 if (status >= 0) {
1873 task->tk_action = call_decode;
1874 return;
1875 }
1876
Steve Dickson5753cba2012-02-06 10:08:08 -05001877 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 task->tk_status = 0;
1879 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001880 case -EHOSTDOWN:
1881 case -EHOSTUNREACH:
1882 case -ENETUNREACH:
1883 /*
1884 * Delay any retries for 3 seconds, then handle as if it
1885 * were a timeout.
1886 */
1887 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 case -ETIMEDOUT:
1889 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001890 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001891 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001892 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001894 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001896 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001897 rpc_delay(task, 3*HZ);
1898 case -EPIPE:
1899 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 task->tk_action = call_bind;
1901 break;
1902 case -EAGAIN:
1903 task->tk_action = call_transmit;
1904 break;
1905 case -EIO:
1906 /* shutdown or soft timeout */
1907 rpc_exit(task, status);
1908 break;
1909 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001910 if (clnt->cl_chatty)
1911 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 clnt->cl_protname, -status);
1913 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 }
1915}
1916
1917/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001918 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 * We do not release the request slot, so we keep using the
1920 * same XID for all retransmits.
1921 */
1922static void
1923call_timeout(struct rpc_task *task)
1924{
1925 struct rpc_clnt *clnt = task->tk_client;
1926
1927 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001928 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 goto retry;
1930 }
1931
Chuck Lever46121cf2007-01-31 12:14:08 -05001932 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001933 task->tk_timeouts++;
1934
Chuck Lever3a28bec2009-12-03 15:58:56 -05001935 if (RPC_IS_SOFTCONN(task)) {
1936 rpc_exit(task, -ETIMEDOUT);
1937 return;
1938 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001940 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001941 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001942 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001943 clnt->cl_protname,
1944 rcu_dereference(clnt->cl_xprt)->servername);
1945 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001946 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001947 if (task->tk_flags & RPC_TASK_TIMEOUT)
1948 rpc_exit(task, -ETIMEDOUT);
1949 else
1950 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 return;
1952 }
1953
Chuck Leverf518e35a2006-01-03 09:55:52 +01001954 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001956 if (clnt->cl_chatty) {
1957 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001958 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001959 clnt->cl_protname,
1960 rcu_dereference(clnt->cl_xprt)->servername);
1961 rcu_read_unlock();
1962 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001964 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001965 /*
1966 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1967 * event? RFC2203 requires the server to drop all such requests.
1968 */
1969 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
1971retry:
1972 clnt->cl_stats->rpcretrans++;
1973 task->tk_action = call_bind;
1974 task->tk_status = 0;
1975}
1976
1977/*
1978 * 7. Decode the RPC reply
1979 */
1980static void
1981call_decode(struct rpc_task *task)
1982{
1983 struct rpc_clnt *clnt = task->tk_client;
1984 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001985 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001986 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
Vasily Averin726fd6a2011-06-01 16:23:59 +04001988 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
Chuck Leverf518e35a2006-01-03 09:55:52 +01001990 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001991 if (clnt->cl_chatty) {
1992 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001993 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001994 clnt->cl_protname,
1995 rcu_dereference(clnt->cl_xprt)->servername);
1996 rcu_read_unlock();
1997 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1999 }
2000
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002001 /*
2002 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002003 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002004 */
2005 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 req->rq_rcv_buf.len = req->rq_private_buf.len;
2007
2008 /* Check that the softirq receive buffer is valid */
2009 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2010 sizeof(req->rq_rcv_buf)) != 0);
2011
Trond Myklebust1e799b62008-03-21 16:19:41 -04002012 if (req->rq_rcv_buf.len < 12) {
2013 if (!RPC_IS_SOFT(task)) {
2014 task->tk_action = call_bind;
2015 clnt->cl_stats->rpcretrans++;
2016 goto out_retry;
2017 }
2018 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2019 clnt->cl_protname, task->tk_status);
2020 task->tk_action = call_timeout;
2021 goto out_retry;
2022 }
2023
Chuck Leverb0e1c572008-05-21 17:09:19 -04002024 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002025 if (IS_ERR(p)) {
2026 if (p == ERR_PTR(-EAGAIN))
2027 goto out_retry;
2028 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 }
2030
Trond Myklebustabbcf282006-01-03 09:55:03 +01002031 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002033 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2035 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002036 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002037 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2038 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 return;
2040out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002042 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002043 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002044 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002045 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002046 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002047 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002048 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049}
2050
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002051static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002052rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053{
2054 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002056 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057
2058 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002059
Trond Myklebusta4f08352013-01-08 09:10:21 -05002060 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 *p++ = req->rq_xid; /* XID */
2062 *p++ = htonl(RPC_CALL); /* CALL */
2063 *p++ = htonl(RPC_VERSION); /* RPC version */
2064 *p++ = htonl(clnt->cl_prog); /* program number */
2065 *p++ = htonl(clnt->cl_vers); /* program version */
2066 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002067 p = rpcauth_marshcred(task, p);
2068 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2069 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070}
2071
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002072static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002073rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002075 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2077 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002078 __be32 *p = iov->iov_base;
2079 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 int error = -EACCES;
2081
David Howellse8896492006-08-24 15:44:19 -04002082 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2083 /* RFC-1014 says that the representation of XDR data must be a
2084 * multiple of four bytes
2085 * - if it isn't pointer subtraction in the NFS client may give
2086 * undefined results
2087 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002088 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002089 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002090 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002091 goto out_eio;
2092 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 if ((len -= 3) < 0)
2094 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002096 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002098 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002099 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002100 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002102
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2104 if (--len < 0)
2105 goto out_overflow;
2106 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002107 case RPC_AUTH_ERROR:
2108 break;
2109 case RPC_MISMATCH:
2110 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2111 task->tk_pid, __func__);
2112 error = -EPROTONOSUPPORT;
2113 goto out_err;
2114 default:
2115 dprintk("RPC: %5u %s: RPC call rejected, "
2116 "unknown error: %x\n",
2117 task->tk_pid, __func__, n);
2118 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 }
2120 if (--len < 0)
2121 goto out_overflow;
2122 switch ((n = ntohl(*p++))) {
2123 case RPC_AUTH_REJECTEDCRED:
2124 case RPC_AUTH_REJECTEDVERF:
2125 case RPCSEC_GSS_CREDPROBLEM:
2126 case RPCSEC_GSS_CTXPROBLEM:
2127 if (!task->tk_cred_retry)
2128 break;
2129 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002130 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002131 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002133 /* Ensure we obtain a new XID! */
2134 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002135 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002136 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 case RPC_AUTH_BADCRED:
2138 case RPC_AUTH_BADVERF:
2139 /* possibly garbled cred/verf? */
2140 if (!task->tk_garb_retry)
2141 break;
2142 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002143 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002144 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002146 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002148 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002149 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002150 "authentication.\n",
2151 rcu_dereference(clnt->cl_xprt)->servername);
2152 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 break;
2154 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002155 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002156 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 error = -EIO;
2158 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002159 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002160 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 goto out_err;
2162 }
2163 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002164 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002165 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002166 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002168 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 if (len < 0)
2170 goto out_overflow;
2171 switch ((n = ntohl(*p++))) {
2172 case RPC_SUCCESS:
2173 return p;
2174 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002175 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2176 "by server %s\n", task->tk_pid, __func__,
2177 (unsigned int)clnt->cl_prog,
2178 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002179 error = -EPFNOSUPPORT;
2180 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002182 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2183 "by server %s\n", task->tk_pid, __func__,
2184 (unsigned int)clnt->cl_prog,
2185 (unsigned int)clnt->cl_vers,
2186 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002187 error = -EPROTONOSUPPORT;
2188 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002190 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002191 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002192 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002193 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002194 clnt->cl_prog, clnt->cl_vers,
2195 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002196 error = -EOPNOTSUPP;
2197 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002199 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002200 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 break; /* retry */
2202 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002203 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002204 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 /* Also retry */
2206 }
2207
Trond Myklebustabbcf282006-01-03 09:55:03 +01002208out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002209 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 if (task->tk_garb_retry) {
2211 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002212 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002213 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002215out_retry:
2216 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218out_eio:
2219 error = -EIO;
2220out_err:
2221 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002222 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002223 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002224 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002226 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002227 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002228 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002230
Chuck Lever9f06c712010-12-14 14:59:18 +00002231static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002232{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002233}
2234
Chuck Leverbf269552010-12-14 14:59:29 +00002235static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002236{
2237 return 0;
2238}
2239
2240static struct rpc_procinfo rpcproc_null = {
2241 .p_encode = rpcproc_encode_null,
2242 .p_decode = rpcproc_decode_null,
2243};
2244
Chuck Levercaabea82009-12-03 15:58:56 -05002245static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002246{
2247 struct rpc_message msg = {
2248 .rpc_proc = &rpcproc_null,
2249 };
2250 int err;
2251 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002252 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002253 put_rpccred(msg.rpc_cred);
2254 return err;
2255}
Trond Myklebust188fef12007-06-16 14:18:40 -04002256
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002257struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2258{
2259 struct rpc_message msg = {
2260 .rpc_proc = &rpcproc_null,
2261 .rpc_cred = cred,
2262 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002263 struct rpc_task_setup task_setup_data = {
2264 .rpc_client = clnt,
2265 .rpc_message = &msg,
2266 .callback_ops = &rpc_default_ops,
2267 .flags = flags,
2268 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002269 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002270}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002271EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002272
Trond Myklebust188fef12007-06-16 14:18:40 -04002273#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002274static void rpc_show_header(void)
2275{
Chuck Levercb3997b2008-05-21 17:09:41 -04002276 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2277 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002278}
2279
Chuck Lever38e886e2008-05-21 17:09:33 -04002280static void rpc_show_task(const struct rpc_clnt *clnt,
2281 const struct rpc_task *task)
2282{
2283 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002284
2285 if (RPC_IS_QUEUED(task))
2286 rpc_waitq = rpc_qname(task->tk_waitqueue);
2287
Joe Perchesb3bceda2010-12-21 10:52:24 -05002288 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 -04002289 task->tk_pid, task->tk_flags, task->tk_status,
2290 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2291 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002292 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002293}
2294
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002295void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002296{
2297 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002298 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002299 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002300 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002301
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002302 spin_lock(&sn->rpc_client_lock);
2303 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002304 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002305 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002306 if (!header) {
2307 rpc_show_header();
2308 header++;
2309 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002310 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002311 }
2312 spin_unlock(&clnt->cl_lock);
2313 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002314 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002315}
2316#endif