blob: bb7ed2f3aee6b29594e1f8d6116c8467a57ecd62 [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
20#include <asm/system.h>
21
22#include <linux/module.h>
23#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040024#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040026#include <linux/namei.h>
27#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050037#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040038#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050039#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040041#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040042#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#ifdef RPC_DEBUG
45# define RPCDBG_FACILITY RPCDBG_CALL
46#endif
47
Chuck Lever46121cf2007-01-31 12:14:08 -050048#define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080050 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050051
Trond Myklebust188fef12007-06-16 14:18:40 -040052/*
53 * All RPC clients are linked into this list
54 */
Trond Myklebust188fef12007-06-16 14:18:40 -040055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
57
58
59static void call_start(struct rpc_task *task);
60static void call_reserve(struct rpc_task *task);
61static void call_reserveresult(struct rpc_task *task);
62static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063static void call_decode(struct rpc_task *task);
64static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040065static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040067#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040068static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040069#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050071static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072static void call_refresh(struct rpc_task *task);
73static void call_refreshresult(struct rpc_task *task);
74static void call_timeout(struct rpc_task *task);
75static void call_connect(struct rpc_task *task);
76static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Chuck Leverb0e1c572008-05-21 17:09:19 -040078static __be32 *rpc_encode_header(struct rpc_task *task);
79static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050080static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040081
Trond Myklebust188fef12007-06-16 14:18:40 -040082static void rpc_register_client(struct rpc_clnt *clnt)
83{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040084 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
85
86 spin_lock(&sn->rpc_client_lock);
87 list_add(&clnt->cl_clients, &sn->all_clients);
88 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040089}
90
91static void rpc_unregister_client(struct rpc_clnt *clnt)
92{
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040093 struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id);
94
95 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040096 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040098}
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400100static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
101{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400102 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400103 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
104 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400107 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400108}
109
110static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
111{
112 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400113
114 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
115 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 __rpc_clnt_remove_pipedir(clnt);
117 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
118 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119}
120
121static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust080b7942012-01-20 13:53:56 -0500122 struct rpc_clnt *clnt,
123 const char *dir_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124{
Trond Myklebustf1345852005-09-23 11:08:25 -0400125 static uint32_t clntid;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400126 char name[15];
127 struct qstr q = {
128 .name = name,
129 };
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400130 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 int error;
132
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 dir = rpc_d_lookup_sb(sb, dir_name);
134 if (dir == NULL)
135 return dir;
136 for (;;) {
137 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
138 name[sizeof(name) - 1] = '\0';
139 q.hash = full_name_hash(q.name, q.len);
140 dentry = rpc_create_client_dir(dir, &q, clnt);
141 if (!IS_ERR(dentry))
142 break;
143 error = PTR_ERR(dentry);
144 if (error != -EEXIST) {
145 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
146 " %s/%s, error %d\n",
147 dir_name, name, error);
148 break;
149 }
150 }
151 dput(dir);
152 return dentry;
153}
154
155static int
Trond Myklebust080b7942012-01-20 13:53:56 -0500156rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400157{
158 struct super_block *pipefs_sb;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400159 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400160
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400161 clnt->cl_dentry = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 if (dir_name == NULL)
163 return 0;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400164 pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net);
Stanislav Kinsbursky70fe25b2012-01-11 19:18:34 +0400165 if (!pipefs_sb)
166 return 0;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400167 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400168 rpc_put_sb_net(clnt->cl_xprt->xprt_net);
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 Kinsbursky80df9d22012-01-11 19:18:17 +0400175static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
176 struct super_block *sb)
177{
178 struct dentry *dentry;
179 int err = 0;
180
181 switch (event) {
182 case RPC_PIPEFS_MOUNT:
183 if (clnt->cl_program->pipe_dir_name == NULL)
184 break;
185 dentry = rpc_setup_pipedir_sb(sb, clnt,
186 clnt->cl_program->pipe_dir_name);
187 BUG_ON(dentry == NULL);
188 if (IS_ERR(dentry))
189 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400190 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400191 if (clnt->cl_auth->au_ops->pipes_create) {
192 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
193 if (err)
194 __rpc_clnt_remove_pipedir(clnt);
195 }
196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
207static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
208 void *ptr)
209{
210 struct super_block *sb = ptr;
211 struct rpc_clnt *clnt;
212 int error = 0;
213 struct sunrpc_net *sn = net_generic(sb->s_fs_info, sunrpc_net_id);
214
215 spin_lock(&sn->rpc_client_lock);
216 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
217 error = __rpc_pipefs_event(clnt, event, sb);
218 if (error)
219 break;
220 }
221 spin_unlock(&sn->rpc_client_lock);
222 return error;
223}
224
225static struct notifier_block rpc_clients_block = {
226 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400227 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400228};
229
230int rpc_clients_notifier_register(void)
231{
232 return rpc_pipefs_notifier_register(&rpc_clients_block);
233}
234
235void rpc_clients_notifier_unregister(void)
236{
237 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
238}
239
Trond Myklebust698b6d02007-12-20 16:03:53 -0500240static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500242 const struct rpc_program *program = args->program;
243 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct rpc_clnt *clnt = NULL;
J. Bruce Fields6a192752005-06-22 17:16:23 +0000245 struct rpc_auth *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400247 size_t len;
248
249 /* sanity check the name before trying to print it */
250 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500251 len = strlen(args->servername);
Chuck Lever06b8d252007-09-11 18:00:20 -0400252 if (len > RPC_MAXNETNAMELEN)
253 goto out_no_rpciod;
254 len++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Chuck Lever46121cf2007-01-31 12:14:08 -0500256 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500257 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Trond Myklebust4ada5392007-06-14 17:26:17 -0400259 err = rpciod_up();
260 if (err)
261 goto out_no_rpciod;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 err = -EINVAL;
263 if (!xprt)
Adrian Bunk712917d2006-03-13 21:20:47 -0800264 goto out_no_xprt;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500265
266 if (args->version >= program->nrvers)
267 goto out_err;
268 version = program->version[args->version];
269 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 goto out_err;
271
272 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700273 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 if (!clnt)
275 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 clnt->cl_parent = clnt;
277
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500278 clnt->cl_server = kstrdup(args->servername, GFP_KERNEL);
279 if (clnt->cl_server == NULL)
280 goto out_no_server;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282 clnt->cl_xprt = xprt;
283 clnt->cl_procinfo = version->procs;
284 clnt->cl_maxproc = version->nrprocs;
285 clnt->cl_protname = program->name;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300286 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500289 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500290 err = -ENOMEM;
291 if (clnt->cl_metrics == NULL)
292 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500293 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400294 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400295 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Chuck Leverec739ef2006-08-22 20:06:15 -0400297 if (!xprt_bound(clnt->cl_xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 clnt->cl_autobind = 1;
299
Trond Myklebustba7392b2007-12-20 16:03:55 -0500300 clnt->cl_timeout = xprt->timeout;
301 if (args->timeout != NULL) {
302 memcpy(&clnt->cl_timeout_default, args->timeout,
303 sizeof(clnt->cl_timeout_default));
304 clnt->cl_timeout = &clnt->cl_timeout_default;
305 }
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500308 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500309 clnt->cl_principal = NULL;
310 if (args->client_name) {
311 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
312 if (!clnt->cl_principal)
313 goto out_no_principal;
314 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Trond Myklebust006abe82010-09-12 19:55:25 -0400316 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
319 if (err < 0)
320 goto out_no_path;
321
Trond Myklebust698b6d02007-12-20 16:03:53 -0500322 auth = rpcauth_create(args->authflavor, clnt);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000323 if (IS_ERR(auth)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500325 args->authflavor);
J. Bruce Fields6a192752005-06-22 17:16:23 +0000326 err = PTR_ERR(auth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 goto out_no_auth;
328 }
329
330 /* save the nodename */
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400331 clnt->cl_nodelen = strlen(init_utsname()->nodename);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 if (clnt->cl_nodelen > UNX_MAXNODENAME)
333 clnt->cl_nodelen = UNX_MAXNODENAME;
Cedric Le Goater63ffc232008-10-03 23:41:51 -0400334 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400335 rpc_register_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 return clnt;
337
338out_no_auth:
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400339 rpc_clnt_remove_pipedir(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500341 kfree(clnt->cl_principal);
342out_no_principal:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500343 rpc_free_iostats(clnt->cl_metrics);
344out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500345 kfree(clnt->cl_server);
346out_no_server:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 kfree(clnt);
348out_err:
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400349 xprt_put(xprt);
Adrian Bunk712917d2006-03-13 21:20:47 -0800350out_no_xprt:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400351 rpciod_down();
352out_no_rpciod:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return ERR_PTR(err);
354}
355
Chuck Leverc2866762006-08-22 20:06:20 -0400356/*
357 * rpc_create - create an RPC client and transport with one call
358 * @args: rpc_clnt create argument structure
359 *
360 * Creates and initializes an RPC transport and an RPC client.
361 *
362 * It can ping the server in order to determine if it is up, and to see if
363 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
364 * this behavior so asynchronous tasks can also use rpc_create.
365 */
366struct rpc_clnt *rpc_create(struct rpc_create_args *args)
367{
368 struct rpc_xprt *xprt;
369 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b02007-09-10 13:47:07 -0400370 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400371 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400372 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200373 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200374 .dstaddr = args->address,
375 .addrlen = args->addrsize,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300376 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200377 };
Chuck Lever510deb02007-12-10 14:56:24 -0500378 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400379
Chuck Leverc2866762006-08-22 20:06:20 -0400380 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400381 * If the caller chooses not to specify a hostname, whip
382 * up a string representation of the passed-in address.
383 */
384 if (args->servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400385 struct sockaddr_un *sun =
386 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400387 struct sockaddr_in *sin =
388 (struct sockaddr_in *)args->address;
389 struct sockaddr_in6 *sin6 =
390 (struct sockaddr_in6 *)args->address;
391
Chuck Lever510deb02007-12-10 14:56:24 -0500392 servername[0] = '\0';
393 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400394 case AF_LOCAL:
395 snprintf(servername, sizeof(servername), "%s",
396 sun->sun_path);
397 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400398 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700399 snprintf(servername, sizeof(servername), "%pI4",
400 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500401 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400402 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700403 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400404 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500405 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500406 default:
407 /* caller wants default server name, but
408 * address family isn't recognized. */
409 return ERR_PTR(-EINVAL);
410 }
Chuck Lever43780b82007-07-01 12:13:22 -0400411 args->servername = servername;
412 }
413
Chuck Lever510deb02007-12-10 14:56:24 -0500414 xprt = xprt_create_transport(&xprtargs);
415 if (IS_ERR(xprt))
416 return (struct rpc_clnt *)xprt;
417
Chuck Lever43780b82007-07-01 12:13:22 -0400418 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400419 * By default, kernel RPC client connects from a reserved port.
420 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
421 * but it is always enabled for rpciod, which handles the connect
422 * operation.
423 */
424 xprt->resvport = 1;
425 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
426 xprt->resvport = 0;
427
Trond Myklebust698b6d02007-12-20 16:03:53 -0500428 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400429 if (IS_ERR(clnt))
430 return clnt;
431
432 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500433 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400434 if (err != 0) {
435 rpc_shutdown_client(clnt);
436 return ERR_PTR(err);
437 }
438 }
439
440 clnt->cl_softrtry = 1;
441 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
442 clnt->cl_softrtry = 0;
443
Chuck Leverc2866762006-08-22 20:06:20 -0400444 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
445 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500446 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
447 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400448 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
449 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400450
451 return clnt;
452}
Chuck Leverb86acd52006-08-22 20:06:22 -0400453EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455/*
456 * This function clones the RPC client structure. It allows us to share the
457 * same transport while varying parameters such as the authentication
458 * flavour.
459 */
460struct rpc_clnt *
461rpc_clone_client(struct rpc_clnt *clnt)
462{
463 struct rpc_clnt *new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500464 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Arnaldo Carvalho de Meloe69062b2006-11-21 01:21:34 -0200466 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 if (!new)
468 goto out_no_clnt;
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500469 new->cl_server = kstrdup(clnt->cl_server, GFP_KERNEL);
470 if (new->cl_server == NULL)
471 goto out_no_server;
Trond Myklebustd431a5552007-06-17 17:07:54 -0400472 new->cl_parent = clnt;
473 /* Turn off autobind on clones */
474 new->cl_autobind = 0;
475 INIT_LIST_HEAD(&new->cl_tasks);
476 spin_lock_init(&new->cl_lock);
Trond Myklebustba7392b2007-12-20 16:03:55 -0500477 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500478 new->cl_metrics = rpc_alloc_iostats(clnt);
479 if (new->cl_metrics == NULL)
480 goto out_no_stats;
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500481 if (clnt->cl_principal) {
482 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
483 if (new->cl_principal == NULL)
484 goto out_no_principal;
485 }
Trond Myklebust006abe82010-09-12 19:55:25 -0400486 atomic_set(&new->cl_count, 1);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500487 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
488 if (err != 0)
489 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 if (new->cl_auth)
491 atomic_inc(&new->cl_auth->au_count);
Trond Myklebustd431a5552007-06-17 17:07:54 -0400492 xprt_get(clnt->cl_xprt);
Trond Myklebust006abe82010-09-12 19:55:25 -0400493 atomic_inc(&clnt->cl_count);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400494 rpc_register_client(new);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400495 rpciod_up();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 return new;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500497out_no_path:
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500498 kfree(new->cl_principal);
499out_no_principal:
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500500 rpc_free_iostats(new->cl_metrics);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500501out_no_stats:
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500502 kfree(new->cl_server);
503out_no_server:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500504 kfree(new);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505out_no_clnt:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800506 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500507 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400509EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400512 * Kill all tasks for the given client.
513 * XXX: kill their descendants as well?
514 */
515void rpc_killall_tasks(struct rpc_clnt *clnt)
516{
517 struct rpc_task *rovr;
518
519
520 if (list_empty(&clnt->cl_tasks))
521 return;
522 dprintk("RPC: killing all tasks for client %p\n", clnt);
523 /*
524 * Spin lock all_tasks to prevent changes...
525 */
526 spin_lock(&clnt->cl_lock);
527 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
528 if (!RPC_IS_ACTIVATED(rovr))
529 continue;
530 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
531 rovr->tk_flags |= RPC_TASK_KILLED;
532 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300533 if (RPC_IS_QUEUED(rovr))
534 rpc_wake_up_queued_task(rovr->tk_waitqueue,
535 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400536 }
537 }
538 spin_unlock(&clnt->cl_lock);
539}
540EXPORT_SYMBOL_GPL(rpc_killall_tasks);
541
542/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400544 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400546void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400548 dprintk("RPC: shutting down %s client for %s\n",
549 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Trond Myklebust34f52e32007-06-14 16:40:31 -0400551 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800553 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400554 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 }
556
Trond Myklebust4c402b42007-06-14 16:40:32 -0400557 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400559EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400562 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400564static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400565rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Chuck Lever46121cf2007-01-31 12:14:08 -0500567 dprintk("RPC: destroying %s client for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 clnt->cl_protname, clnt->cl_server);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500569 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400570 rpc_release_client(clnt->cl_parent);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500571 kfree(clnt->cl_server);
Trond Myklebust6529eba2007-06-14 16:40:14 -0400572 rpc_unregister_client(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400573 rpc_clnt_remove_pipedir(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500574 rpc_free_iostats(clnt->cl_metrics);
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500575 kfree(clnt->cl_principal);
Chuck Lever11c556b2006-03-20 13:44:22 -0500576 clnt->cl_metrics = NULL;
Trond Myklebust6b6ca862006-09-05 12:55:57 -0400577 xprt_put(clnt->cl_xprt);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400578 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580}
581
582/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400583 * Free an RPC client
584 */
585static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400586rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400587{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400588 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400589 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400590 return;
591 }
592
593 /*
594 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
595 * release remaining GSS contexts. This mechanism ensures
596 * that it can do so safely.
597 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400598 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400599 rpcauth_release(clnt->cl_auth);
600 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400601 if (atomic_dec_and_test(&clnt->cl_count))
602 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400603}
604
605/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400606 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 */
608void
609rpc_release_client(struct rpc_clnt *clnt)
610{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400611 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Trond Myklebust34f52e32007-06-14 16:40:31 -0400613 if (list_empty(&clnt->cl_tasks))
614 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400615 if (atomic_dec_and_test(&clnt->cl_count))
616 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400617}
618
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000619/**
620 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800621 * @old: old rpc_client
622 * @program: rpc program to set
623 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000624 *
625 * Clones the rpc client and sets up a new RPC program. This is mainly
626 * of use for enabling different RPC programs to share the same transport.
627 * The Sun NFSv2/v3 ACL protocol can do this.
628 */
629struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500630 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400631 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000632{
633 struct rpc_clnt *clnt;
Trond Myklebusta613fa12012-01-20 13:53:56 -0500634 const struct rpc_version *version;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000635 int err;
636
637 BUG_ON(vers >= program->nrvers || !program->version[vers]);
638 version = program->version[vers];
639 clnt = rpc_clone_client(old);
640 if (IS_ERR(clnt))
641 goto out;
642 clnt->cl_procinfo = version->procs;
643 clnt->cl_maxproc = version->nrprocs;
644 clnt->cl_protname = program->name;
645 clnt->cl_prog = program->number;
646 clnt->cl_vers = version->number;
647 clnt->cl_stats = program->stats;
Chuck Levercaabea82009-12-03 15:58:56 -0500648 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000649 if (err != 0) {
650 rpc_shutdown_client(clnt);
651 clnt = ERR_PTR(err);
652 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800653out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000654 return clnt;
655}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400656EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000657
Trond Myklebust58f96122010-07-31 14:29:08 -0400658void rpc_task_release_client(struct rpc_task *task)
659{
660 struct rpc_clnt *clnt = task->tk_client;
661
662 if (clnt != NULL) {
663 /* Remove from client task list */
664 spin_lock(&clnt->cl_lock);
665 list_del(&task->tk_task);
666 spin_unlock(&clnt->cl_lock);
667 task->tk_client = NULL;
668
669 rpc_release_client(clnt);
670 }
671}
672
673static
674void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
675{
676 if (clnt != NULL) {
677 rpc_task_release_client(task);
678 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400679 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400680 if (clnt->cl_softrtry)
681 task->tk_flags |= RPC_TASK_SOFT;
682 /* Add to the client's list of all tasks */
683 spin_lock(&clnt->cl_lock);
684 list_add_tail(&task->tk_task, &clnt->cl_tasks);
685 spin_unlock(&clnt->cl_lock);
686 }
687}
688
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000689void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
690{
691 rpc_task_release_client(task);
692 rpc_task_set_client(task, clnt);
693}
694EXPORT_SYMBOL_GPL(rpc_task_reset_client);
695
696
Trond Myklebust58f96122010-07-31 14:29:08 -0400697static void
698rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
699{
700 if (msg != NULL) {
701 task->tk_msg.rpc_proc = msg->rpc_proc;
702 task->tk_msg.rpc_argp = msg->rpc_argp;
703 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400704 if (msg->rpc_cred != NULL)
705 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400706 }
707}
708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/*
710 * Default callback for async RPC calls
711 */
712static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100713rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
715}
716
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100717static const struct rpc_call_ops rpc_default_ops = {
718 .rpc_call_done = rpc_default_callback,
719};
720
Trond Myklebustc970aa82007-07-14 15:39:59 -0400721/**
722 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
723 * @task_setup_data: pointer to task initialisation data
724 */
725struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400726{
Trond Myklebust19445b92010-04-16 16:41:10 -0400727 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400728
Trond Myklebust84115e12007-07-14 15:39:59 -0400729 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400730 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400731 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400732
Trond Myklebust58f96122010-07-31 14:29:08 -0400733 rpc_task_set_client(task, task_setup_data->rpc_client);
734 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
735
Trond Myklebust58f96122010-07-31 14:29:08 -0400736 if (task->tk_action == NULL)
737 rpc_call_start(task);
738
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400739 atomic_inc(&task->tk_count);
740 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400741out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400742 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400743}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400744EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400745
746/**
747 * rpc_call_sync - Perform a synchronous RPC call
748 * @clnt: pointer to RPC client
749 * @msg: RPC call parameters
750 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500752int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
754 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400755 struct rpc_task_setup task_setup_data = {
756 .rpc_client = clnt,
757 .rpc_message = msg,
758 .callback_ops = &rpc_default_ops,
759 .flags = flags,
760 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400761 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 BUG_ON(flags & RPC_TASK_ASYNC);
764
Trond Myklebustc970aa82007-07-14 15:39:59 -0400765 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400766 if (IS_ERR(task))
767 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100768 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800769 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return status;
771}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400772EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400774/**
775 * rpc_call_async - Perform an asynchronous RPC call
776 * @clnt: pointer to RPC client
777 * @msg: RPC call parameters
778 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800779 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400780 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 */
782int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500783rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100784 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
786 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400787 struct rpc_task_setup task_setup_data = {
788 .rpc_client = clnt,
789 .rpc_message = msg,
790 .callback_ops = tk_ops,
791 .callback_data = data,
792 .flags = flags|RPC_TASK_ASYNC,
793 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Trond Myklebustc970aa82007-07-14 15:39:59 -0400795 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400796 if (IS_ERR(task))
797 return PTR_ERR(task);
798 rpc_put_task(task);
799 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400801EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400803#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400804/**
805 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
806 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400807 * @req: RPC request
808 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400809 */
810struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400811 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400812{
813 struct rpc_task *task;
814 struct xdr_buf *xbufp = &req->rq_snd_buf;
815 struct rpc_task_setup task_setup_data = {
816 .callback_ops = tk_ops,
817 };
818
819 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
820 /*
821 * Create an rpc_task to send the data
822 */
823 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400824 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400825 xprt_free_bc_request(req);
826 goto out;
827 }
828 task->tk_rqstp = req;
829
830 /*
831 * Set up the xdr_buf length.
832 * This also indicates that the buffer is XDR encoded already.
833 */
834 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
835 xbufp->tail[0].iov_len;
836
837 task->tk_action = call_bc_transmit;
838 atomic_inc(&task->tk_count);
839 BUG_ON(atomic_read(&task->tk_count) != 2);
840 rpc_execute(task);
841
842out:
843 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
844 return task;
845}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400846#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400849rpc_call_start(struct rpc_task *task)
850{
851 task->tk_action = call_start;
852}
853EXPORT_SYMBOL_GPL(rpc_call_start);
854
Chuck Levered394402006-08-22 20:06:17 -0400855/**
856 * rpc_peeraddr - extract remote peer address from clnt's xprt
857 * @clnt: RPC client structure
858 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800859 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400860 *
861 * Returns the number of bytes that are actually in the stored address.
862 */
863size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
864{
865 size_t bytes;
866 struct rpc_xprt *xprt = clnt->cl_xprt;
867
868 bytes = sizeof(xprt->addr);
869 if (bytes > bufsize)
870 bytes = bufsize;
871 memcpy(buf, &clnt->cl_xprt->addr, bytes);
Chuck Leverc4efcb12006-08-22 20:06:19 -0400872 return xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400873}
Chuck Leverb86acd52006-08-22 20:06:22 -0400874EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400875
Chuck Leverf425eba2006-08-22 20:06:18 -0400876/**
877 * rpc_peeraddr2str - return remote peer address in printable format
878 * @clnt: RPC client structure
879 * @format: address format
880 *
881 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500882const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
883 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400884{
885 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever7559c7a2006-12-05 16:35:37 -0500886
887 if (xprt->address_strings[format] != NULL)
888 return xprt->address_strings[format];
889 else
890 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400891}
Chuck Leverb86acd52006-08-22 20:06:22 -0400892EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400893
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894void
895rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
896{
897 struct rpc_xprt *xprt = clnt->cl_xprt;
Chuck Lever470056c2005-08-25 16:25:56 -0700898 if (xprt->ops->set_buffer_size)
899 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400901EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
903/*
904 * Return size of largest payload RPC client can support, in bytes
905 *
906 * For stream transports, this is one RPC record fragment (see RFC
907 * 1831), as we don't support multi-record requests yet. For datagram
908 * transports, this is the size of an IP packet minus the IP, UDP, and
909 * RPC header sizes.
910 */
911size_t rpc_max_payload(struct rpc_clnt *clnt)
912{
913 return clnt->cl_xprt->max_payload;
914}
Chuck Leverb86acd52006-08-22 20:06:22 -0400915EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Chuck Lever35f5a422006-01-03 09:55:50 +0100917/**
918 * rpc_force_rebind - force transport to check that remote port is unchanged
919 * @clnt: client to rebind
920 *
921 */
922void rpc_force_rebind(struct rpc_clnt *clnt)
923{
924 if (clnt->cl_autobind)
Chuck Leverec739ef2006-08-22 20:06:15 -0400925 xprt_clear_bound(clnt->cl_xprt);
Chuck Lever35f5a422006-01-03 09:55:50 +0100926}
Chuck Leverb86acd52006-08-22 20:06:22 -0400927EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +0100928
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929/*
Andy Adamsonaae20062009-04-01 09:22:40 -0400930 * Restart an (async) RPC call from the call_prepare state.
931 * Usually called from within the exit handler.
932 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400933int
Andy Adamsonaae20062009-04-01 09:22:40 -0400934rpc_restart_call_prepare(struct rpc_task *task)
935{
936 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400937 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -0700938 task->tk_action = call_start;
939 if (task->tk_ops->rpc_call_prepare != NULL)
940 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400941 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -0400942}
943EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
944
945/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 * Restart an (async) RPC call. Usually called from within the
947 * exit handler.
948 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400949int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950rpc_restart_call(struct rpc_task *task)
951{
952 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400953 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -0400955 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400957EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
Chuck Lever3748f1e2008-05-21 17:09:12 -0400959#ifdef RPC_DEBUG
960static const char *rpc_proc_name(const struct rpc_task *task)
961{
962 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
963
964 if (proc) {
965 if (proc->p_name)
966 return proc->p_name;
967 else
968 return "NULL";
969 } else
970 return "no proc";
971}
972#endif
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974/*
975 * 0. Initial state
976 *
977 * Other FSM states can be visited zero or more times, but
978 * this state is visited exactly once for each RPC.
979 */
980static void
981call_start(struct rpc_task *task)
982{
983 struct rpc_clnt *clnt = task->tk_client;
984
Chuck Lever3748f1e2008-05-21 17:09:12 -0400985 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Chuck Lever46121cf2007-01-31 12:14:08 -0500986 clnt->cl_protname, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -0400987 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -0500988 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
990 /* Increment call count */
991 task->tk_msg.rpc_proc->p_count++;
992 clnt->cl_stats->rpccnt++;
993 task->tk_action = call_reserve;
994}
995
996/*
997 * 1. Reserve an RPC call slot
998 */
999static void
1000call_reserve(struct rpc_task *task)
1001{
Chuck Lever46121cf2007-01-31 12:14:08 -05001002 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 task->tk_status = 0;
1005 task->tk_action = call_reserveresult;
1006 xprt_reserve(task);
1007}
1008
1009/*
1010 * 1b. Grok the result of xprt_reserve()
1011 */
1012static void
1013call_reserveresult(struct rpc_task *task)
1014{
1015 int status = task->tk_status;
1016
Chuck Lever46121cf2007-01-31 12:14:08 -05001017 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019 /*
1020 * After a call to xprt_reserve(), we must have either
1021 * a request slot or else an error status.
1022 */
1023 task->tk_status = 0;
1024 if (status >= 0) {
1025 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001026 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 return;
1028 }
1029
1030 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001031 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 rpc_exit(task, -EIO);
1033 return;
1034 }
1035
1036 /*
1037 * Even though there was an error, we may have acquired
1038 * a request slot somehow. Make sure not to leak it.
1039 */
1040 if (task->tk_rqstp) {
1041 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001042 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 xprt_release(task);
1044 }
1045
1046 switch (status) {
1047 case -EAGAIN: /* woken up; retry */
1048 task->tk_action = call_reserve;
1049 return;
1050 case -EIO: /* probably a shutdown */
1051 break;
1052 default:
1053 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001054 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 break;
1056 }
1057 rpc_exit(task, status);
1058}
1059
1060/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001061 * 2. Bind and/or refresh the credentials
1062 */
1063static void
1064call_refresh(struct rpc_task *task)
1065{
1066 dprint_status(task);
1067
1068 task->tk_action = call_refreshresult;
1069 task->tk_status = 0;
1070 task->tk_client->cl_stats->rpcauthrefresh++;
1071 rpcauth_refreshcred(task);
1072}
1073
1074/*
1075 * 2a. Process the results of a credential refresh
1076 */
1077static void
1078call_refreshresult(struct rpc_task *task)
1079{
1080 int status = task->tk_status;
1081
1082 dprint_status(task);
1083
1084 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001085 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001086 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001087 case 0:
1088 if (rpcauth_uptodatecred(task))
1089 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001090 return;
1091 case -ETIMEDOUT:
1092 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001093 case -EAGAIN:
1094 status = -EACCES;
1095 if (!task->tk_cred_retry)
1096 break;
1097 task->tk_cred_retry--;
1098 dprintk("RPC: %5u %s: retry refresh creds\n",
1099 task->tk_pid, __func__);
1100 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001101 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001102 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1103 task->tk_pid, __func__, status);
1104 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001105}
1106
1107/*
1108 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001109 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 */
1111static void
1112call_allocate(struct rpc_task *task)
1113{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001114 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001115 struct rpc_rqst *req = task->tk_rqstp;
1116 struct rpc_xprt *xprt = task->tk_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001117 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
Chuck Lever46121cf2007-01-31 12:14:08 -05001119 dprint_status(task);
1120
Chuck Lever2bea90d2007-03-29 16:47:53 -04001121 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001122 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001123
Chuck Lever02107142006-01-03 09:55:49 +01001124 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 return;
1126
Chuck Lever2bea90d2007-03-29 16:47:53 -04001127 if (proc->p_proc != 0) {
1128 BUG_ON(proc->p_arglen == 0);
1129 if (proc->p_decode != NULL)
1130 BUG_ON(proc->p_replen == 0);
1131 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132
Chuck Lever2bea90d2007-03-29 16:47:53 -04001133 /*
1134 * Calculate the size (in quads) of the RPC call
1135 * and reply headers, and convert both values
1136 * to byte sizes.
1137 */
1138 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1139 req->rq_callsize <<= 2;
1140 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1141 req->rq_rcvsize <<= 2;
1142
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001143 req->rq_buffer = xprt->ops->buf_alloc(task,
1144 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001145 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001147
1148 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
Trond Myklebust5afa9132011-06-17 10:14:59 -04001150 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001151 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 rpc_delay(task, HZ>>4);
1153 return;
1154 }
1155
1156 rpc_exit(task, -ERESTARTSYS);
1157}
1158
Trond Myklebust940e3312005-11-09 21:45:24 -05001159static inline int
1160rpc_task_need_encode(struct rpc_task *task)
1161{
1162 return task->tk_rqstp->rq_snd_buf.len == 0;
1163}
1164
1165static inline void
1166rpc_task_force_reencode(struct rpc_task *task)
1167{
1168 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001169 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001170}
1171
Chuck Lever2bea90d2007-03-29 16:47:53 -04001172static inline void
1173rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1174{
1175 buf->head[0].iov_base = start;
1176 buf->head[0].iov_len = len;
1177 buf->tail[0].iov_len = 0;
1178 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001179 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001180 buf->len = 0;
1181 buf->buflen = len;
1182}
1183
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184/*
1185 * 3. Encode arguments of an RPC call
1186 */
1187static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001188rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001191 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001192 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
Chuck Lever46121cf2007-01-31 12:14:08 -05001194 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Chuck Lever2bea90d2007-03-29 16:47:53 -04001196 rpc_xdr_buf_init(&req->rq_snd_buf,
1197 req->rq_buffer,
1198 req->rq_callsize);
1199 rpc_xdr_buf_init(&req->rq_rcv_buf,
1200 (char *)req->rq_buffer + req->rq_callsize,
1201 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
Chuck Leverb0e1c572008-05-21 17:09:19 -04001203 p = rpc_encode_header(task);
1204 if (p == NULL) {
1205 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 rpc_exit(task, -EIO);
1207 return;
1208 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001209
1210 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001211 if (encode == NULL)
1212 return;
1213
1214 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1215 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
1217
1218/*
1219 * 4. Get the server port number if not yet set
1220 */
1221static void
1222call_bind(struct rpc_task *task)
1223{
Chuck Leverec739ef2006-08-22 20:06:15 -04001224 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225
Chuck Lever46121cf2007-01-31 12:14:08 -05001226 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227
Chuck Leverda351872005-08-11 16:25:11 -04001228 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001229 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001230 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001231 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001232 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 }
1234}
1235
1236/*
Chuck Leverda351872005-08-11 16:25:11 -04001237 * 4a. Sort out bind result
1238 */
1239static void
1240call_bind_status(struct rpc_task *task)
1241{
Chuck Lever906462a2007-09-11 18:00:47 -04001242 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001243
1244 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001245 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001246 task->tk_status = 0;
1247 task->tk_action = call_connect;
1248 return;
1249 }
1250
Steve Dickson5753cba2012-02-06 10:08:08 -05001251 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001252 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001253 case -ENOMEM:
1254 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1255 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001256 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001257 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001258 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1259 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001260 /* fail immediately if this is an RPC ping */
1261 if (task->tk_msg.rpc_proc->p_proc == 0) {
1262 status = -EOPNOTSUPP;
1263 break;
1264 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001265 if (task->tk_rebind_retry == 0)
1266 break;
1267 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001268 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001269 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001270 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001271 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001272 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001273 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001274 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001275 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001276 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001277 task->tk_pid);
1278 break;
1279 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001280 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001281 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001282 task->tk_status = 0;
1283 task->tk_action = call_bind;
1284 return;
Chuck Lever012da152009-12-03 15:58:56 -05001285 case -ECONNREFUSED: /* connection problems */
1286 case -ECONNRESET:
1287 case -ENOTCONN:
1288 case -EHOSTDOWN:
1289 case -EHOSTUNREACH:
1290 case -ENETUNREACH:
1291 case -EPIPE:
1292 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1293 task->tk_pid, task->tk_status);
1294 if (!RPC_IS_SOFTCONN(task)) {
1295 rpc_delay(task, 5*HZ);
1296 goto retry_timeout;
1297 }
1298 status = task->tk_status;
1299 break;
Chuck Leverda351872005-08-11 16:25:11 -04001300 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001301 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001302 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001303 }
1304
1305 rpc_exit(task, status);
1306 return;
1307
Trond Myklebustda458282006-08-31 15:44:52 -04001308retry_timeout:
1309 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001310}
1311
1312/*
1313 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 */
1315static void
1316call_connect(struct rpc_task *task)
1317{
Chuck Leverda351872005-08-11 16:25:11 -04001318 struct rpc_xprt *xprt = task->tk_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Chuck Lever46121cf2007-01-31 12:14:08 -05001320 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001321 task->tk_pid, xprt,
1322 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Chuck Leverda351872005-08-11 16:25:11 -04001324 task->tk_action = call_transmit;
1325 if (!xprt_connected(xprt)) {
1326 task->tk_action = call_connect_status;
1327 if (task->tk_status < 0)
1328 return;
1329 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331}
1332
1333/*
Chuck Leverda351872005-08-11 16:25:11 -04001334 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 */
1336static void
1337call_connect_status(struct rpc_task *task)
1338{
1339 struct rpc_clnt *clnt = task->tk_client;
1340 int status = task->tk_status;
1341
Chuck Lever46121cf2007-01-31 12:14:08 -05001342 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 task->tk_status = 0;
Trond Myklebust2a491992009-03-11 14:38:00 -04001345 if (status >= 0 || status == -EAGAIN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 clnt->cl_stats->netreconn++;
1347 task->tk_action = call_transmit;
1348 return;
1349 }
1350
Steve Dickson5753cba2012-02-06 10:08:08 -05001351 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001353 /* if soft mounted, test if we've timed out */
1354 case -ETIMEDOUT:
1355 task->tk_action = call_timeout;
Trond Myklebust2a491992009-03-11 14:38:00 -04001356 break;
1357 default:
1358 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 }
1360}
1361
1362/*
1363 * 5. Transmit the RPC request, and wait for reply
1364 */
1365static void
1366call_transmit(struct rpc_task *task)
1367{
Chuck Lever46121cf2007-01-31 12:14:08 -05001368 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
1370 task->tk_action = call_status;
1371 if (task->tk_status < 0)
1372 return;
1373 task->tk_status = xprt_prepare_transmit(task);
1374 if (task->tk_status != 0)
1375 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001376 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001378 if (rpc_task_need_encode(task)) {
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001379 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
Chuck Leverb0e1c572008-05-21 17:09:19 -04001380 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001381 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001382 if (task->tk_status != 0) {
1383 /* Was the error nonfatal? */
1384 if (task->tk_status == -EAGAIN)
1385 rpc_delay(task, HZ >> 4);
1386 else
1387 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001388 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001389 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001390 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 xprt_transmit(task);
1392 if (task->tk_status < 0)
1393 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001394 /*
1395 * On success, ensure that we call xprt_end_transmit() before sleeping
1396 * in order to allow access to the socket to other RPC requests.
1397 */
1398 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001399 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001400 return;
1401 task->tk_action = rpc_exit_task;
Trond Myklebustfda13932008-02-22 16:34:12 -05001402 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001403}
1404
1405/*
1406 * 5a. Handle cleanup after a transmission
1407 */
1408static void
1409call_transmit_status(struct rpc_task *task)
1410{
1411 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001412
1413 /*
1414 * Common case: success. Force the compiler to put this
1415 * test first.
1416 */
1417 if (task->tk_status == 0) {
1418 xprt_end_transmit(task);
1419 rpc_task_force_reencode(task);
1420 return;
1421 }
1422
Trond Myklebust15f081c2009-03-11 14:37:57 -04001423 switch (task->tk_status) {
1424 case -EAGAIN:
1425 break;
1426 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001427 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001428 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001429 rpc_task_force_reencode(task);
1430 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001431 /*
1432 * Special cases: if we've been waiting on the
1433 * socket's write_space() callback, or if the
1434 * socket just returned a connection error,
1435 * then hold onto the transport lock.
1436 */
1437 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001438 case -EHOSTDOWN:
1439 case -EHOSTUNREACH:
1440 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001441 if (RPC_IS_SOFTCONN(task)) {
1442 xprt_end_transmit(task);
1443 rpc_exit(task, task->tk_status);
1444 break;
1445 }
1446 case -ECONNRESET:
1447 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001448 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001449 rpc_task_force_reencode(task);
1450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451}
1452
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001453#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001454/*
1455 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1456 * addition, disconnect on connectivity errors.
1457 */
1458static void
1459call_bc_transmit(struct rpc_task *task)
1460{
1461 struct rpc_rqst *req = task->tk_rqstp;
1462
1463 BUG_ON(task->tk_status != 0);
1464 task->tk_status = xprt_prepare_transmit(task);
1465 if (task->tk_status == -EAGAIN) {
1466 /*
1467 * Could not reserve the transport. Try again after the
1468 * transport is released.
1469 */
1470 task->tk_status = 0;
1471 task->tk_action = call_bc_transmit;
1472 return;
1473 }
1474
1475 task->tk_action = rpc_exit_task;
1476 if (task->tk_status < 0) {
1477 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1478 "error: %d\n", task->tk_status);
1479 return;
1480 }
1481
1482 xprt_transmit(task);
1483 xprt_end_transmit(task);
1484 dprint_status(task);
1485 switch (task->tk_status) {
1486 case 0:
1487 /* Success */
1488 break;
1489 case -EHOSTDOWN:
1490 case -EHOSTUNREACH:
1491 case -ENETUNREACH:
1492 case -ETIMEDOUT:
1493 /*
1494 * Problem reaching the server. Disconnect and let the
1495 * forechannel reestablish the connection. The server will
1496 * have to retransmit the backchannel request and we'll
1497 * reprocess it. Since these ops are idempotent, there's no
1498 * need to cache our reply at this time.
1499 */
1500 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1501 "error: %d\n", task->tk_status);
1502 xprt_conditional_disconnect(task->tk_xprt,
1503 req->rq_connect_cookie);
1504 break;
1505 default:
1506 /*
1507 * We were unable to reply and will have to drop the
1508 * request. The server should reconnect and retransmit.
1509 */
1510 BUG_ON(task->tk_status == -EAGAIN);
1511 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1512 "error: %d\n", task->tk_status);
1513 break;
1514 }
1515 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1516}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001517#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001518
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519/*
1520 * 6. Sort out the RPC call status
1521 */
1522static void
1523call_status(struct rpc_task *task)
1524{
1525 struct rpc_clnt *clnt = task->tk_client;
1526 struct rpc_rqst *req = task->tk_rqstp;
1527 int status;
1528
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001529 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1530 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Chuck Lever46121cf2007-01-31 12:14:08 -05001532 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
1534 status = task->tk_status;
1535 if (status >= 0) {
1536 task->tk_action = call_decode;
1537 return;
1538 }
1539
Steve Dickson5753cba2012-02-06 10:08:08 -05001540 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 task->tk_status = 0;
1542 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001543 case -EHOSTDOWN:
1544 case -EHOSTUNREACH:
1545 case -ENETUNREACH:
1546 /*
1547 * Delay any retries for 3 seconds, then handle as if it
1548 * were a timeout.
1549 */
1550 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 case -ETIMEDOUT:
1552 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001553 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001554 xprt_conditional_disconnect(task->tk_xprt,
1555 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001557 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001559 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001560 rpc_delay(task, 3*HZ);
1561 case -EPIPE:
1562 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 task->tk_action = call_bind;
1564 break;
1565 case -EAGAIN:
1566 task->tk_action = call_transmit;
1567 break;
1568 case -EIO:
1569 /* shutdown or soft timeout */
1570 rpc_exit(task, status);
1571 break;
1572 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001573 if (clnt->cl_chatty)
1574 printk("%s: RPC call returned error %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 clnt->cl_protname, -status);
1576 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 }
1578}
1579
1580/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001581 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 * We do not release the request slot, so we keep using the
1583 * same XID for all retransmits.
1584 */
1585static void
1586call_timeout(struct rpc_task *task)
1587{
1588 struct rpc_clnt *clnt = task->tk_client;
1589
1590 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001591 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 goto retry;
1593 }
1594
Chuck Lever46121cf2007-01-31 12:14:08 -05001595 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001596 task->tk_timeouts++;
1597
Chuck Lever3a28bec2009-12-03 15:58:56 -05001598 if (RPC_IS_SOFTCONN(task)) {
1599 rpc_exit(task, -ETIMEDOUT);
1600 return;
1601 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 if (RPC_IS_SOFT(task)) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001603 if (clnt->cl_chatty)
1604 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 clnt->cl_protname, clnt->cl_server);
Trond Myklebust7494d002011-04-24 14:28:45 -04001606 if (task->tk_flags & RPC_TASK_TIMEOUT)
1607 rpc_exit(task, -ETIMEDOUT);
1608 else
1609 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 return;
1611 }
1612
Chuck Leverf518e352006-01-03 09:55:52 +01001613 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 task->tk_flags |= RPC_CALL_MAJORSEEN;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001615 if (clnt->cl_chatty)
1616 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 clnt->cl_protname, clnt->cl_server);
1618 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001619 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001620 /*
1621 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1622 * event? RFC2203 requires the server to drop all such requests.
1623 */
1624 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
1626retry:
1627 clnt->cl_stats->rpcretrans++;
1628 task->tk_action = call_bind;
1629 task->tk_status = 0;
1630}
1631
1632/*
1633 * 7. Decode the RPC reply
1634 */
1635static void
1636call_decode(struct rpc_task *task)
1637{
1638 struct rpc_clnt *clnt = task->tk_client;
1639 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001640 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001641 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Vasily Averin726fd6a2011-06-01 16:23:59 +04001643 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644
Chuck Leverf518e352006-01-03 09:55:52 +01001645 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001646 if (clnt->cl_chatty)
1647 printk(KERN_NOTICE "%s: server %s OK\n",
1648 clnt->cl_protname, clnt->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1650 }
1651
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001652 /*
1653 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001654 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001655 */
1656 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 req->rq_rcv_buf.len = req->rq_private_buf.len;
1658
1659 /* Check that the softirq receive buffer is valid */
1660 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1661 sizeof(req->rq_rcv_buf)) != 0);
1662
Trond Myklebust1e799b62008-03-21 16:19:41 -04001663 if (req->rq_rcv_buf.len < 12) {
1664 if (!RPC_IS_SOFT(task)) {
1665 task->tk_action = call_bind;
1666 clnt->cl_stats->rpcretrans++;
1667 goto out_retry;
1668 }
1669 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1670 clnt->cl_protname, task->tk_status);
1671 task->tk_action = call_timeout;
1672 goto out_retry;
1673 }
1674
Chuck Leverb0e1c572008-05-21 17:09:19 -04001675 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001676 if (IS_ERR(p)) {
1677 if (p == ERR_PTR(-EAGAIN))
1678 goto out_retry;
1679 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 }
1681
Trond Myklebustabbcf282006-01-03 09:55:03 +01001682 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001684 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1686 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04001687 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001688 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1689 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 return;
1691out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04001693 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001694 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001695 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001696 if (task->tk_client->cl_discrtry)
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001697 xprt_conditional_disconnect(task->tk_xprt,
1698 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04001699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700}
1701
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001702static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001703rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704{
1705 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001707 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
1709 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07001710
1711 p = xprt_skip_transport_header(task->tk_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 *p++ = req->rq_xid; /* XID */
1713 *p++ = htonl(RPC_CALL); /* CALL */
1714 *p++ = htonl(RPC_VERSION); /* RPC version */
1715 *p++ = htonl(clnt->cl_prog); /* program number */
1716 *p++ = htonl(clnt->cl_vers); /* program version */
1717 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00001718 p = rpcauth_marshcred(task, p);
1719 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1720 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721}
1722
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001723static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04001724rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725{
1726 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1727 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001728 __be32 *p = iov->iov_base;
1729 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 int error = -EACCES;
1731
David Howellse8896492006-08-24 15:44:19 -04001732 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1733 /* RFC-1014 says that the representation of XDR data must be a
1734 * multiple of four bytes
1735 * - if it isn't pointer subtraction in the NFS client may give
1736 * undefined results
1737 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001738 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08001739 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001740 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04001741 goto out_eio;
1742 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 if ((len -= 3) < 0)
1744 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001746 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001748 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001749 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001750 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04001752
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1754 if (--len < 0)
1755 goto out_overflow;
1756 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00001757 case RPC_AUTH_ERROR:
1758 break;
1759 case RPC_MISMATCH:
1760 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
1761 task->tk_pid, __func__);
1762 error = -EPROTONOSUPPORT;
1763 goto out_err;
1764 default:
1765 dprintk("RPC: %5u %s: RPC call rejected, "
1766 "unknown error: %x\n",
1767 task->tk_pid, __func__, n);
1768 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 }
1770 if (--len < 0)
1771 goto out_overflow;
1772 switch ((n = ntohl(*p++))) {
1773 case RPC_AUTH_REJECTEDCRED:
1774 case RPC_AUTH_REJECTEDVERF:
1775 case RPCSEC_GSS_CREDPROBLEM:
1776 case RPCSEC_GSS_CTXPROBLEM:
1777 if (!task->tk_cred_retry)
1778 break;
1779 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001780 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001781 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04001783 /* Ensure we obtain a new XID! */
1784 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04001785 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001786 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 case RPC_AUTH_BADCRED:
1788 case RPC_AUTH_BADVERF:
1789 /* possibly garbled cred/verf? */
1790 if (!task->tk_garb_retry)
1791 break;
1792 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001793 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001794 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001796 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04001798 printk(KERN_NOTICE "RPC: server %s requires stronger "
Levent Serinol1356b8c2006-03-20 13:44:11 -05001799 "authentication.\n", task->tk_client->cl_server);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 break;
1801 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001802 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001803 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 error = -EIO;
1805 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001806 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001807 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 goto out_err;
1809 }
1810 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001811 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001812 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001813 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001815 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 if (len < 0)
1817 goto out_overflow;
1818 switch ((n = ntohl(*p++))) {
1819 case RPC_SUCCESS:
1820 return p;
1821 case RPC_PROG_UNAVAIL:
Chuck Lever46121cf2007-01-31 12:14:08 -05001822 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001823 task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 (unsigned int)task->tk_client->cl_prog,
1825 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001826 error = -EPFNOSUPPORT;
1827 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 case RPC_PROG_MISMATCH:
Chuck Lever46121cf2007-01-31 12:14:08 -05001829 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
Harvey Harrison0dc47872008-03-05 20:47:47 -08001830 "server %s\n", task->tk_pid, __func__,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 (unsigned int)task->tk_client->cl_prog,
1832 (unsigned int)task->tk_client->cl_vers,
1833 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001834 error = -EPROTONOSUPPORT;
1835 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 case RPC_PROC_UNAVAIL:
Chuck Lever3748f1e2008-05-21 17:09:12 -04001837 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05001838 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001839 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001840 rpc_proc_name(task),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 task->tk_client->cl_prog,
1842 task->tk_client->cl_vers,
1843 task->tk_client->cl_server);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00001844 error = -EOPNOTSUPP;
1845 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05001847 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001848 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 break; /* retry */
1850 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001851 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001852 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 /* Also retry */
1854 }
1855
Trond Myklebustabbcf282006-01-03 09:55:03 +01001856out_garbage:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 task->tk_client->cl_stats->rpcgarbage++;
1858 if (task->tk_garb_retry) {
1859 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05001860 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001861 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01001863out_retry:
1864 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866out_eio:
1867 error = -EIO;
1868out_err:
1869 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001870 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001871 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001872 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04001874 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08001875 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01001876 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001878
Chuck Lever9f06c712010-12-14 14:59:18 +00001879static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001880{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001881}
1882
Chuck Leverbf269552010-12-14 14:59:29 +00001883static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001884{
1885 return 0;
1886}
1887
1888static struct rpc_procinfo rpcproc_null = {
1889 .p_encode = rpcproc_encode_null,
1890 .p_decode = rpcproc_decode_null,
1891};
1892
Chuck Levercaabea82009-12-03 15:58:56 -05001893static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001894{
1895 struct rpc_message msg = {
1896 .rpc_proc = &rpcproc_null,
1897 };
1898 int err;
1899 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05001900 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00001901 put_rpccred(msg.rpc_cred);
1902 return err;
1903}
Trond Myklebust188fef12007-06-16 14:18:40 -04001904
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001905struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1906{
1907 struct rpc_message msg = {
1908 .rpc_proc = &rpcproc_null,
1909 .rpc_cred = cred,
1910 };
Trond Myklebust84115e12007-07-14 15:39:59 -04001911 struct rpc_task_setup task_setup_data = {
1912 .rpc_client = clnt,
1913 .rpc_message = &msg,
1914 .callback_ops = &rpc_default_ops,
1915 .flags = flags,
1916 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04001917 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001918}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001919EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04001920
Trond Myklebust188fef12007-06-16 14:18:40 -04001921#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04001922static void rpc_show_header(void)
1923{
Chuck Levercb3997b2008-05-21 17:09:41 -04001924 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1925 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04001926}
1927
Chuck Lever38e886e2008-05-21 17:09:33 -04001928static void rpc_show_task(const struct rpc_clnt *clnt,
1929 const struct rpc_task *task)
1930{
1931 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04001932
1933 if (RPC_IS_QUEUED(task))
1934 rpc_waitq = rpc_qname(task->tk_waitqueue);
1935
Joe Perchesb3bceda2010-12-21 10:52:24 -05001936 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 -04001937 task->tk_pid, task->tk_flags, task->tk_status,
1938 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1939 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05001940 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04001941}
1942
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001943void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04001944{
1945 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04001946 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04001947 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001948 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04001949
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001950 spin_lock(&sn->rpc_client_lock);
1951 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04001952 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04001953 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04001954 if (!header) {
1955 rpc_show_header();
1956 header++;
1957 }
Chuck Lever38e886e2008-05-21 17:09:33 -04001958 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04001959 }
1960 spin_unlock(&clnt->cl_lock);
1961 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04001962 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04001963}
1964#endif