]>
Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
55aa4f58 | 2 | * linux/net/sunrpc/clnt.c |
1da177e4 LT |
3 | * |
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 | * | |
1da177e4 LT |
16 | * 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> | |
cb3997b5 | 24 | #include <linux/kallsyms.h> |
1da177e4 | 25 | #include <linux/mm.h> |
23ac6581 TM |
26 | #include <linux/namei.h> |
27 | #include <linux/mount.h> | |
1da177e4 | 28 | #include <linux/slab.h> |
1da177e4 | 29 | #include <linux/utsname.h> |
11c556b3 | 30 | #include <linux/workqueue.h> |
176e21ee | 31 | #include <linux/in.h> |
510deb0d | 32 | #include <linux/in6.h> |
176e21ee | 33 | #include <linux/un.h> |
1da177e4 LT |
34 | |
35 | #include <linux/sunrpc/clnt.h> | |
1da177e4 | 36 | #include <linux/sunrpc/rpc_pipe_fs.h> |
11c556b3 | 37 | #include <linux/sunrpc/metrics.h> |
55ae1aab | 38 | #include <linux/sunrpc/bc_xprt.h> |
1da177e4 | 39 | |
55ae1aab | 40 | #include "sunrpc.h" |
70abc49b | 41 | #include "netns.h" |
1da177e4 | 42 | |
1da177e4 LT |
43 | #ifdef RPC_DEBUG |
44 | # define RPCDBG_FACILITY RPCDBG_CALL | |
45 | #endif | |
46 | ||
46121cf7 CL |
47 | #define dprint_status(t) \ |
48 | dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \ | |
0dc47877 | 49 | __func__, t->tk_status) |
46121cf7 | 50 | |
188fef11 TM |
51 | /* |
52 | * All RPC clients are linked into this list | |
53 | */ | |
188fef11 | 54 | |
1da177e4 LT |
55 | static DECLARE_WAIT_QUEUE_HEAD(destroy_wait); |
56 | ||
57 | ||
58 | static void call_start(struct rpc_task *task); | |
59 | static void call_reserve(struct rpc_task *task); | |
60 | static void call_reserveresult(struct rpc_task *task); | |
61 | static void call_allocate(struct rpc_task *task); | |
1da177e4 LT |
62 | static void call_decode(struct rpc_task *task); |
63 | static void call_bind(struct rpc_task *task); | |
da351878 | 64 | static void call_bind_status(struct rpc_task *task); |
1da177e4 | 65 | static void call_transmit(struct rpc_task *task); |
9e00abc3 | 66 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
55ae1aab | 67 | static void call_bc_transmit(struct rpc_task *task); |
9e00abc3 | 68 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
1da177e4 | 69 | static void call_status(struct rpc_task *task); |
940e3318 | 70 | static void call_transmit_status(struct rpc_task *task); |
1da177e4 LT |
71 | static void call_refresh(struct rpc_task *task); |
72 | static void call_refreshresult(struct rpc_task *task); | |
73 | static void call_timeout(struct rpc_task *task); | |
74 | static void call_connect(struct rpc_task *task); | |
75 | static void call_connect_status(struct rpc_task *task); | |
1da177e4 | 76 | |
b0e1c57e CL |
77 | static __be32 *rpc_encode_header(struct rpc_task *task); |
78 | static __be32 *rpc_verify_header(struct rpc_task *task); | |
caabea8a | 79 | static int rpc_ping(struct rpc_clnt *clnt); |
64c91a1f | 80 | |
188fef11 TM |
81 | static void rpc_register_client(struct rpc_clnt *clnt) |
82 | { | |
70abc49b SK |
83 | struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id); |
84 | ||
85 | spin_lock(&sn->rpc_client_lock); | |
86 | list_add(&clnt->cl_clients, &sn->all_clients); | |
87 | spin_unlock(&sn->rpc_client_lock); | |
188fef11 TM |
88 | } |
89 | ||
90 | static void rpc_unregister_client(struct rpc_clnt *clnt) | |
91 | { | |
70abc49b SK |
92 | struct sunrpc_net *sn = net_generic(clnt->cl_xprt->xprt_net, sunrpc_net_id); |
93 | ||
94 | spin_lock(&sn->rpc_client_lock); | |
188fef11 | 95 | list_del(&clnt->cl_clients); |
70abc49b | 96 | spin_unlock(&sn->rpc_client_lock); |
188fef11 | 97 | } |
1da177e4 | 98 | |
0157d021 SK |
99 | static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt) |
100 | { | |
30507f58 | 101 | if (clnt->cl_dentry) { |
80df9d20 SK |
102 | if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy) |
103 | clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth); | |
30507f58 | 104 | rpc_remove_client_dir(clnt->cl_dentry); |
80df9d20 | 105 | } |
30507f58 | 106 | clnt->cl_dentry = NULL; |
0157d021 SK |
107 | } |
108 | ||
109 | static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt) | |
110 | { | |
111 | struct super_block *pipefs_sb; | |
0157d021 SK |
112 | |
113 | pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net); | |
114 | if (pipefs_sb) { | |
0157d021 SK |
115 | __rpc_clnt_remove_pipedir(clnt); |
116 | rpc_put_sb_net(clnt->cl_xprt->xprt_net); | |
117 | } | |
0157d021 SK |
118 | } |
119 | ||
120 | static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb, | |
121 | struct rpc_clnt *clnt, char *dir_name) | |
1da177e4 | 122 | { |
f134585a | 123 | static uint32_t clntid; |
23ac6581 TM |
124 | char name[15]; |
125 | struct qstr q = { | |
126 | .name = name, | |
127 | }; | |
0157d021 | 128 | struct dentry *dir, *dentry; |
1da177e4 LT |
129 | int error; |
130 | ||
0157d021 SK |
131 | dir = rpc_d_lookup_sb(sb, dir_name); |
132 | if (dir == NULL) | |
133 | return dir; | |
f134585a | 134 | for (;;) { |
23ac6581 TM |
135 | q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++); |
136 | name[sizeof(name) - 1] = '\0'; | |
137 | q.hash = full_name_hash(q.name, q.len); | |
0157d021 SK |
138 | dentry = rpc_create_client_dir(dir, &q, clnt); |
139 | if (!IS_ERR(dentry)) | |
23ac6581 | 140 | break; |
0157d021 | 141 | error = PTR_ERR(dentry); |
f134585a | 142 | if (error != -EEXIST) { |
23ac6581 TM |
143 | printk(KERN_INFO "RPC: Couldn't create pipefs entry" |
144 | " %s/%s, error %d\n", | |
145 | dir_name, name, error); | |
0157d021 | 146 | break; |
f134585a | 147 | } |
1da177e4 | 148 | } |
0157d021 SK |
149 | dput(dir); |
150 | return dentry; | |
151 | } | |
152 | ||
153 | static int | |
154 | rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name) | |
155 | { | |
156 | struct super_block *pipefs_sb; | |
30507f58 | 157 | struct dentry *dentry; |
0157d021 | 158 | |
30507f58 | 159 | clnt->cl_dentry = NULL; |
0157d021 SK |
160 | if (dir_name == NULL) |
161 | return 0; | |
0157d021 | 162 | pipefs_sb = rpc_get_sb_net(clnt->cl_xprt->xprt_net); |
70fe25b6 SK |
163 | if (!pipefs_sb) |
164 | return 0; | |
30507f58 | 165 | dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name); |
0157d021 | 166 | rpc_put_sb_net(clnt->cl_xprt->xprt_net); |
30507f58 SK |
167 | if (IS_ERR(dentry)) |
168 | return PTR_ERR(dentry); | |
169 | clnt->cl_dentry = dentry; | |
23ac6581 | 170 | return 0; |
1da177e4 LT |
171 | } |
172 | ||
80df9d20 SK |
173 | static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event, |
174 | struct super_block *sb) | |
175 | { | |
176 | struct dentry *dentry; | |
177 | int err = 0; | |
178 | ||
179 | switch (event) { | |
180 | case RPC_PIPEFS_MOUNT: | |
181 | if (clnt->cl_program->pipe_dir_name == NULL) | |
182 | break; | |
183 | dentry = rpc_setup_pipedir_sb(sb, clnt, | |
184 | clnt->cl_program->pipe_dir_name); | |
185 | BUG_ON(dentry == NULL); | |
186 | if (IS_ERR(dentry)) | |
187 | return PTR_ERR(dentry); | |
30507f58 | 188 | clnt->cl_dentry = dentry; |
80df9d20 SK |
189 | if (clnt->cl_auth->au_ops->pipes_create) { |
190 | err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth); | |
191 | if (err) | |
192 | __rpc_clnt_remove_pipedir(clnt); | |
193 | } | |
194 | break; | |
195 | case RPC_PIPEFS_UMOUNT: | |
196 | __rpc_clnt_remove_pipedir(clnt); | |
197 | break; | |
198 | default: | |
199 | printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event); | |
200 | return -ENOTSUPP; | |
201 | } | |
202 | return err; | |
203 | } | |
204 | ||
205 | static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event, | |
206 | void *ptr) | |
207 | { | |
208 | struct super_block *sb = ptr; | |
209 | struct rpc_clnt *clnt; | |
210 | int error = 0; | |
211 | struct sunrpc_net *sn = net_generic(sb->s_fs_info, sunrpc_net_id); | |
212 | ||
213 | spin_lock(&sn->rpc_client_lock); | |
214 | list_for_each_entry(clnt, &sn->all_clients, cl_clients) { | |
215 | error = __rpc_pipefs_event(clnt, event, sb); | |
216 | if (error) | |
217 | break; | |
218 | } | |
219 | spin_unlock(&sn->rpc_client_lock); | |
220 | return error; | |
221 | } | |
222 | ||
223 | static struct notifier_block rpc_clients_block = { | |
224 | .notifier_call = rpc_pipefs_event, | |
225 | }; | |
226 | ||
227 | int rpc_clients_notifier_register(void) | |
228 | { | |
229 | return rpc_pipefs_notifier_register(&rpc_clients_block); | |
230 | } | |
231 | ||
232 | void rpc_clients_notifier_unregister(void) | |
233 | { | |
234 | return rpc_pipefs_notifier_unregister(&rpc_clients_block); | |
235 | } | |
236 | ||
698b6d08 | 237 | static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt) |
1da177e4 | 238 | { |
698b6d08 | 239 | struct rpc_program *program = args->program; |
1da177e4 LT |
240 | struct rpc_version *version; |
241 | struct rpc_clnt *clnt = NULL; | |
6a19275a | 242 | struct rpc_auth *auth; |
1da177e4 | 243 | int err; |
06b8d255 CL |
244 | size_t len; |
245 | ||
246 | /* sanity check the name before trying to print it */ | |
247 | err = -EINVAL; | |
698b6d08 | 248 | len = strlen(args->servername); |
06b8d255 CL |
249 | if (len > RPC_MAXNETNAMELEN) |
250 | goto out_no_rpciod; | |
251 | len++; | |
1da177e4 | 252 | |
46121cf7 | 253 | dprintk("RPC: creating %s client for %s (xprt %p)\n", |
698b6d08 | 254 | program->name, args->servername, xprt); |
1da177e4 | 255 | |
4ada539e TM |
256 | err = rpciod_up(); |
257 | if (err) | |
258 | goto out_no_rpciod; | |
1da177e4 LT |
259 | err = -EINVAL; |
260 | if (!xprt) | |
712917d1 | 261 | goto out_no_xprt; |
698b6d08 TM |
262 | |
263 | if (args->version >= program->nrvers) | |
264 | goto out_err; | |
265 | version = program->version[args->version]; | |
266 | if (version == NULL) | |
1da177e4 LT |
267 | goto out_err; |
268 | ||
269 | err = -ENOMEM; | |
0da974f4 | 270 | clnt = kzalloc(sizeof(*clnt), GFP_KERNEL); |
1da177e4 LT |
271 | if (!clnt) |
272 | goto out_err; | |
1da177e4 LT |
273 | clnt->cl_parent = clnt; |
274 | ||
275 | clnt->cl_server = clnt->cl_inline_name; | |
1da177e4 LT |
276 | if (len > sizeof(clnt->cl_inline_name)) { |
277 | char *buf = kmalloc(len, GFP_KERNEL); | |
698b6d08 | 278 | if (buf != NULL) |
1da177e4 LT |
279 | clnt->cl_server = buf; |
280 | else | |
281 | len = sizeof(clnt->cl_inline_name); | |
282 | } | |
698b6d08 | 283 | strlcpy(clnt->cl_server, args->servername, len); |
1da177e4 LT |
284 | |
285 | clnt->cl_xprt = xprt; | |
286 | clnt->cl_procinfo = version->procs; | |
287 | clnt->cl_maxproc = version->nrprocs; | |
288 | clnt->cl_protname = program->name; | |
d5b337b4 | 289 | clnt->cl_prog = args->prognumber ? : program->number; |
1da177e4 | 290 | clnt->cl_vers = version->number; |
1da177e4 | 291 | clnt->cl_stats = program->stats; |
11c556b3 | 292 | clnt->cl_metrics = rpc_alloc_iostats(clnt); |
23bf85ba TM |
293 | err = -ENOMEM; |
294 | if (clnt->cl_metrics == NULL) | |
295 | goto out_no_stats; | |
3e32a5d9 | 296 | clnt->cl_program = program; |
6529eba0 | 297 | INIT_LIST_HEAD(&clnt->cl_tasks); |
4bef61ff | 298 | spin_lock_init(&clnt->cl_lock); |
1da177e4 | 299 | |
ec739ef0 | 300 | if (!xprt_bound(clnt->cl_xprt)) |
1da177e4 LT |
301 | clnt->cl_autobind = 1; |
302 | ||
ba7392bb TM |
303 | clnt->cl_timeout = xprt->timeout; |
304 | if (args->timeout != NULL) { | |
305 | memcpy(&clnt->cl_timeout_default, args->timeout, | |
306 | sizeof(clnt->cl_timeout_default)); | |
307 | clnt->cl_timeout = &clnt->cl_timeout_default; | |
308 | } | |
309 | ||
1da177e4 | 310 | clnt->cl_rtt = &clnt->cl_rtt_default; |
ba7392bb | 311 | rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval); |
608207e8 OK |
312 | clnt->cl_principal = NULL; |
313 | if (args->client_name) { | |
314 | clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL); | |
315 | if (!clnt->cl_principal) | |
316 | goto out_no_principal; | |
317 | } | |
1da177e4 | 318 | |
006abe88 | 319 | atomic_set(&clnt->cl_count, 1); |
34f52e35 | 320 | |
1da177e4 LT |
321 | err = rpc_setup_pipedir(clnt, program->pipe_dir_name); |
322 | if (err < 0) | |
323 | goto out_no_path; | |
324 | ||
698b6d08 | 325 | auth = rpcauth_create(args->authflavor, clnt); |
6a19275a | 326 | if (IS_ERR(auth)) { |
1da177e4 | 327 | printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n", |
698b6d08 | 328 | args->authflavor); |
6a19275a | 329 | err = PTR_ERR(auth); |
1da177e4 LT |
330 | goto out_no_auth; |
331 | } | |
332 | ||
333 | /* save the nodename */ | |
63ffc23d | 334 | clnt->cl_nodelen = strlen(init_utsname()->nodename); |
1da177e4 LT |
335 | if (clnt->cl_nodelen > UNX_MAXNODENAME) |
336 | clnt->cl_nodelen = UNX_MAXNODENAME; | |
63ffc23d | 337 | memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen); |
6529eba0 | 338 | rpc_register_client(clnt); |
1da177e4 LT |
339 | return clnt; |
340 | ||
341 | out_no_auth: | |
0157d021 | 342 | rpc_clnt_remove_pipedir(clnt); |
1da177e4 | 343 | out_no_path: |
608207e8 OK |
344 | kfree(clnt->cl_principal); |
345 | out_no_principal: | |
23bf85ba TM |
346 | rpc_free_iostats(clnt->cl_metrics); |
347 | out_no_stats: | |
1da177e4 LT |
348 | if (clnt->cl_server != clnt->cl_inline_name) |
349 | kfree(clnt->cl_server); | |
350 | kfree(clnt); | |
351 | out_err: | |
6b6ca86b | 352 | xprt_put(xprt); |
712917d1 | 353 | out_no_xprt: |
4ada539e TM |
354 | rpciod_down(); |
355 | out_no_rpciod: | |
1da177e4 LT |
356 | return ERR_PTR(err); |
357 | } | |
358 | ||
c2866763 CL |
359 | /* |
360 | * rpc_create - create an RPC client and transport with one call | |
361 | * @args: rpc_clnt create argument structure | |
362 | * | |
363 | * Creates and initializes an RPC transport and an RPC client. | |
364 | * | |
365 | * It can ping the server in order to determine if it is up, and to see if | |
366 | * it supports this program and version. RPC_CLNT_CREATE_NOPING disables | |
367 | * this behavior so asynchronous tasks can also use rpc_create. | |
368 | */ | |
369 | struct rpc_clnt *rpc_create(struct rpc_create_args *args) | |
370 | { | |
371 | struct rpc_xprt *xprt; | |
372 | struct rpc_clnt *clnt; | |
3c341b0b | 373 | struct xprt_create xprtargs = { |
9a23e332 | 374 | .net = args->net, |
4fa016eb | 375 | .ident = args->protocol, |
d3bc9a1d | 376 | .srcaddr = args->saddress, |
96802a09 FM |
377 | .dstaddr = args->address, |
378 | .addrlen = args->addrsize, | |
f300baba | 379 | .bc_xprt = args->bc_xprt, |
96802a09 | 380 | }; |
510deb0d | 381 | char servername[48]; |
c2866763 | 382 | |
43780b87 CL |
383 | /* |
384 | * If the caller chooses not to specify a hostname, whip | |
385 | * up a string representation of the passed-in address. | |
386 | */ | |
387 | if (args->servername == NULL) { | |
176e21ee CL |
388 | struct sockaddr_un *sun = |
389 | (struct sockaddr_un *)args->address; | |
da09eb93 CL |
390 | struct sockaddr_in *sin = |
391 | (struct sockaddr_in *)args->address; | |
392 | struct sockaddr_in6 *sin6 = | |
393 | (struct sockaddr_in6 *)args->address; | |
394 | ||
510deb0d CL |
395 | servername[0] = '\0'; |
396 | switch (args->address->sa_family) { | |
176e21ee CL |
397 | case AF_LOCAL: |
398 | snprintf(servername, sizeof(servername), "%s", | |
399 | sun->sun_path); | |
400 | break; | |
da09eb93 | 401 | case AF_INET: |
21454aaa HH |
402 | snprintf(servername, sizeof(servername), "%pI4", |
403 | &sin->sin_addr.s_addr); | |
510deb0d | 404 | break; |
da09eb93 | 405 | case AF_INET6: |
5b095d98 | 406 | snprintf(servername, sizeof(servername), "%pI6", |
da09eb93 | 407 | &sin6->sin6_addr); |
510deb0d | 408 | break; |
510deb0d CL |
409 | default: |
410 | /* caller wants default server name, but | |
411 | * address family isn't recognized. */ | |
412 | return ERR_PTR(-EINVAL); | |
413 | } | |
43780b87 CL |
414 | args->servername = servername; |
415 | } | |
416 | ||
510deb0d CL |
417 | xprt = xprt_create_transport(&xprtargs); |
418 | if (IS_ERR(xprt)) | |
419 | return (struct rpc_clnt *)xprt; | |
420 | ||
c2866763 CL |
421 | /* |
422 | * By default, kernel RPC client connects from a reserved port. | |
423 | * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters, | |
424 | * but it is always enabled for rpciod, which handles the connect | |
425 | * operation. | |
426 | */ | |
427 | xprt->resvport = 1; | |
428 | if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT) | |
429 | xprt->resvport = 0; | |
430 | ||
698b6d08 | 431 | clnt = rpc_new_client(args, xprt); |
c2866763 CL |
432 | if (IS_ERR(clnt)) |
433 | return clnt; | |
434 | ||
435 | if (!(args->flags & RPC_CLNT_CREATE_NOPING)) { | |
caabea8a | 436 | int err = rpc_ping(clnt); |
c2866763 CL |
437 | if (err != 0) { |
438 | rpc_shutdown_client(clnt); | |
439 | return ERR_PTR(err); | |
440 | } | |
441 | } | |
442 | ||
443 | clnt->cl_softrtry = 1; | |
444 | if (args->flags & RPC_CLNT_CREATE_HARDRTRY) | |
445 | clnt->cl_softrtry = 0; | |
446 | ||
c2866763 CL |
447 | if (args->flags & RPC_CLNT_CREATE_AUTOBIND) |
448 | clnt->cl_autobind = 1; | |
43d78ef2 CL |
449 | if (args->flags & RPC_CLNT_CREATE_DISCRTRY) |
450 | clnt->cl_discrtry = 1; | |
b6b6152c OK |
451 | if (!(args->flags & RPC_CLNT_CREATE_QUIET)) |
452 | clnt->cl_chatty = 1; | |
c2866763 CL |
453 | |
454 | return clnt; | |
455 | } | |
b86acd50 | 456 | EXPORT_SYMBOL_GPL(rpc_create); |
c2866763 | 457 | |
1da177e4 LT |
458 | /* |
459 | * This function clones the RPC client structure. It allows us to share the | |
460 | * same transport while varying parameters such as the authentication | |
461 | * flavour. | |
462 | */ | |
463 | struct rpc_clnt * | |
464 | rpc_clone_client(struct rpc_clnt *clnt) | |
465 | { | |
466 | struct rpc_clnt *new; | |
3e32a5d9 | 467 | int err = -ENOMEM; |
1da177e4 | 468 | |
e69062b4 | 469 | new = kmemdup(clnt, sizeof(*new), GFP_KERNEL); |
1da177e4 LT |
470 | if (!new) |
471 | goto out_no_clnt; | |
d431a555 TM |
472 | 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); | |
ba7392bb | 477 | rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval); |
23bf85ba TM |
478 | new->cl_metrics = rpc_alloc_iostats(clnt); |
479 | if (new->cl_metrics == NULL) | |
480 | goto out_no_stats; | |
608207e8 OK |
481 | 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 | } | |
006abe88 | 486 | atomic_set(&new->cl_count, 1); |
3e32a5d9 TM |
487 | err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name); |
488 | if (err != 0) | |
489 | goto out_no_path; | |
1da177e4 LT |
490 | if (new->cl_auth) |
491 | atomic_inc(&new->cl_auth->au_count); | |
d431a555 | 492 | xprt_get(clnt->cl_xprt); |
006abe88 | 493 | atomic_inc(&clnt->cl_count); |
6529eba0 | 494 | rpc_register_client(new); |
4ada539e | 495 | rpciod_up(); |
1da177e4 | 496 | return new; |
3e32a5d9 | 497 | out_no_path: |
608207e8 OK |
498 | kfree(new->cl_principal); |
499 | out_no_principal: | |
3e32a5d9 | 500 | rpc_free_iostats(new->cl_metrics); |
23bf85ba TM |
501 | out_no_stats: |
502 | kfree(new); | |
1da177e4 | 503 | out_no_clnt: |
0dc47877 | 504 | dprintk("RPC: %s: returned error %d\n", __func__, err); |
3e32a5d9 | 505 | return ERR_PTR(err); |
1da177e4 | 506 | } |
e8914c65 | 507 | EXPORT_SYMBOL_GPL(rpc_clone_client); |
1da177e4 | 508 | |
58f9612c TM |
509 | /* |
510 | * Kill all tasks for the given client. | |
511 | * XXX: kill their descendants as well? | |
512 | */ | |
513 | void rpc_killall_tasks(struct rpc_clnt *clnt) | |
514 | { | |
515 | struct rpc_task *rovr; | |
516 | ||
517 | ||
518 | if (list_empty(&clnt->cl_tasks)) | |
519 | return; | |
520 | dprintk("RPC: killing all tasks for client %p\n", clnt); | |
521 | /* | |
522 | * Spin lock all_tasks to prevent changes... | |
523 | */ | |
524 | spin_lock(&clnt->cl_lock); | |
525 | list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) { | |
526 | if (!RPC_IS_ACTIVATED(rovr)) | |
527 | continue; | |
528 | if (!(rovr->tk_flags & RPC_TASK_KILLED)) { | |
529 | rovr->tk_flags |= RPC_TASK_KILLED; | |
530 | rpc_exit(rovr, -EIO); | |
8e26de23 SK |
531 | if (RPC_IS_QUEUED(rovr)) |
532 | rpc_wake_up_queued_task(rovr->tk_waitqueue, | |
533 | rovr); | |
58f9612c TM |
534 | } |
535 | } | |
536 | spin_unlock(&clnt->cl_lock); | |
537 | } | |
538 | EXPORT_SYMBOL_GPL(rpc_killall_tasks); | |
539 | ||
1da177e4 LT |
540 | /* |
541 | * Properly shut down an RPC client, terminating all outstanding | |
90c5755f | 542 | * requests. |
1da177e4 | 543 | */ |
4c402b40 | 544 | void rpc_shutdown_client(struct rpc_clnt *clnt) |
1da177e4 | 545 | { |
34f52e35 TM |
546 | dprintk("RPC: shutting down %s client for %s\n", |
547 | clnt->cl_protname, clnt->cl_server); | |
1da177e4 | 548 | |
34f52e35 | 549 | while (!list_empty(&clnt->cl_tasks)) { |
1da177e4 | 550 | rpc_killall_tasks(clnt); |
532347e2 | 551 | wait_event_timeout(destroy_wait, |
34f52e35 | 552 | list_empty(&clnt->cl_tasks), 1*HZ); |
1da177e4 LT |
553 | } |
554 | ||
4c402b40 | 555 | rpc_release_client(clnt); |
1da177e4 | 556 | } |
e8914c65 | 557 | EXPORT_SYMBOL_GPL(rpc_shutdown_client); |
1da177e4 LT |
558 | |
559 | /* | |
34f52e35 | 560 | * Free an RPC client |
1da177e4 | 561 | */ |
34f52e35 | 562 | static void |
006abe88 | 563 | rpc_free_client(struct rpc_clnt *clnt) |
1da177e4 | 564 | { |
46121cf7 | 565 | dprintk("RPC: destroying %s client for %s\n", |
1da177e4 | 566 | clnt->cl_protname, clnt->cl_server); |
3e32a5d9 | 567 | if (clnt->cl_parent != clnt) { |
8ad7c892 | 568 | rpc_release_client(clnt->cl_parent); |
3e32a5d9 TM |
569 | goto out_free; |
570 | } | |
1da177e4 LT |
571 | if (clnt->cl_server != clnt->cl_inline_name) |
572 | kfree(clnt->cl_server); | |
573 | out_free: | |
6529eba0 | 574 | rpc_unregister_client(clnt); |
f5131257 | 575 | rpc_clnt_remove_pipedir(clnt); |
11c556b3 | 576 | rpc_free_iostats(clnt->cl_metrics); |
608207e8 | 577 | kfree(clnt->cl_principal); |
11c556b3 | 578 | clnt->cl_metrics = NULL; |
6b6ca86b | 579 | xprt_put(clnt->cl_xprt); |
4ada539e | 580 | rpciod_down(); |
1da177e4 | 581 | kfree(clnt); |
1da177e4 LT |
582 | } |
583 | ||
1dd17ec6 TM |
584 | /* |
585 | * Free an RPC client | |
586 | */ | |
587 | static void | |
006abe88 | 588 | rpc_free_auth(struct rpc_clnt *clnt) |
1dd17ec6 | 589 | { |
1dd17ec6 | 590 | if (clnt->cl_auth == NULL) { |
006abe88 | 591 | rpc_free_client(clnt); |
1dd17ec6 TM |
592 | return; |
593 | } | |
594 | ||
595 | /* | |
596 | * Note: RPCSEC_GSS may need to send NULL RPC calls in order to | |
597 | * release remaining GSS contexts. This mechanism ensures | |
598 | * that it can do so safely. | |
599 | */ | |
006abe88 | 600 | atomic_inc(&clnt->cl_count); |
1dd17ec6 TM |
601 | rpcauth_release(clnt->cl_auth); |
602 | clnt->cl_auth = NULL; | |
006abe88 TM |
603 | if (atomic_dec_and_test(&clnt->cl_count)) |
604 | rpc_free_client(clnt); | |
1dd17ec6 TM |
605 | } |
606 | ||
1da177e4 | 607 | /* |
34f52e35 | 608 | * Release reference to the RPC client |
1da177e4 LT |
609 | */ |
610 | void | |
611 | rpc_release_client(struct rpc_clnt *clnt) | |
612 | { | |
34f52e35 | 613 | dprintk("RPC: rpc_release_client(%p)\n", clnt); |
1da177e4 | 614 | |
34f52e35 TM |
615 | if (list_empty(&clnt->cl_tasks)) |
616 | wake_up(&destroy_wait); | |
006abe88 TM |
617 | if (atomic_dec_and_test(&clnt->cl_count)) |
618 | rpc_free_auth(clnt); | |
34f52e35 TM |
619 | } |
620 | ||
007e251f AG |
621 | /** |
622 | * rpc_bind_new_program - bind a new RPC program to an existing client | |
65b6e42c RD |
623 | * @old: old rpc_client |
624 | * @program: rpc program to set | |
625 | * @vers: rpc program version | |
007e251f AG |
626 | * |
627 | * Clones the rpc client and sets up a new RPC program. This is mainly | |
628 | * of use for enabling different RPC programs to share the same transport. | |
629 | * The Sun NFSv2/v3 ACL protocol can do this. | |
630 | */ | |
631 | struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old, | |
632 | struct rpc_program *program, | |
89eb21c3 | 633 | u32 vers) |
007e251f AG |
634 | { |
635 | struct rpc_clnt *clnt; | |
636 | struct rpc_version *version; | |
637 | int err; | |
638 | ||
639 | BUG_ON(vers >= program->nrvers || !program->version[vers]); | |
640 | version = program->version[vers]; | |
641 | clnt = rpc_clone_client(old); | |
642 | if (IS_ERR(clnt)) | |
643 | goto out; | |
644 | clnt->cl_procinfo = version->procs; | |
645 | clnt->cl_maxproc = version->nrprocs; | |
646 | clnt->cl_protname = program->name; | |
647 | clnt->cl_prog = program->number; | |
648 | clnt->cl_vers = version->number; | |
649 | clnt->cl_stats = program->stats; | |
caabea8a | 650 | err = rpc_ping(clnt); |
007e251f AG |
651 | if (err != 0) { |
652 | rpc_shutdown_client(clnt); | |
653 | clnt = ERR_PTR(err); | |
654 | } | |
cca5172a | 655 | out: |
007e251f AG |
656 | return clnt; |
657 | } | |
e8914c65 | 658 | EXPORT_SYMBOL_GPL(rpc_bind_new_program); |
007e251f | 659 | |
58f9612c TM |
660 | void rpc_task_release_client(struct rpc_task *task) |
661 | { | |
662 | struct rpc_clnt *clnt = task->tk_client; | |
663 | ||
664 | if (clnt != NULL) { | |
665 | /* Remove from client task list */ | |
666 | spin_lock(&clnt->cl_lock); | |
667 | list_del(&task->tk_task); | |
668 | spin_unlock(&clnt->cl_lock); | |
669 | task->tk_client = NULL; | |
670 | ||
671 | rpc_release_client(clnt); | |
672 | } | |
673 | } | |
674 | ||
675 | static | |
676 | void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt) | |
677 | { | |
678 | if (clnt != NULL) { | |
679 | rpc_task_release_client(task); | |
680 | task->tk_client = clnt; | |
006abe88 | 681 | atomic_inc(&clnt->cl_count); |
58f9612c TM |
682 | if (clnt->cl_softrtry) |
683 | task->tk_flags |= RPC_TASK_SOFT; | |
684 | /* Add to the client's list of all tasks */ | |
685 | spin_lock(&clnt->cl_lock); | |
686 | list_add_tail(&task->tk_task, &clnt->cl_tasks); | |
687 | spin_unlock(&clnt->cl_lock); | |
688 | } | |
689 | } | |
690 | ||
cbdabc7f AA |
691 | void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt) |
692 | { | |
693 | rpc_task_release_client(task); | |
694 | rpc_task_set_client(task, clnt); | |
695 | } | |
696 | EXPORT_SYMBOL_GPL(rpc_task_reset_client); | |
697 | ||
698 | ||
58f9612c TM |
699 | static void |
700 | rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg) | |
701 | { | |
702 | if (msg != NULL) { | |
703 | task->tk_msg.rpc_proc = msg->rpc_proc; | |
704 | task->tk_msg.rpc_argp = msg->rpc_argp; | |
705 | task->tk_msg.rpc_resp = msg->rpc_resp; | |
a17c2153 TM |
706 | if (msg->rpc_cred != NULL) |
707 | task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred); | |
58f9612c TM |
708 | } |
709 | } | |
710 | ||
1da177e4 LT |
711 | /* |
712 | * Default callback for async RPC calls | |
713 | */ | |
714 | static void | |
963d8fe5 | 715 | rpc_default_callback(struct rpc_task *task, void *data) |
1da177e4 LT |
716 | { |
717 | } | |
718 | ||
963d8fe5 TM |
719 | static const struct rpc_call_ops rpc_default_ops = { |
720 | .rpc_call_done = rpc_default_callback, | |
721 | }; | |
722 | ||
c970aa85 TM |
723 | /** |
724 | * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it | |
725 | * @task_setup_data: pointer to task initialisation data | |
726 | */ | |
727 | struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data) | |
6e5b70e9 | 728 | { |
19445b99 | 729 | struct rpc_task *task; |
6e5b70e9 | 730 | |
84115e1c | 731 | task = rpc_new_task(task_setup_data); |
19445b99 | 732 | if (IS_ERR(task)) |
50859259 | 733 | goto out; |
6e5b70e9 | 734 | |
58f9612c TM |
735 | rpc_task_set_client(task, task_setup_data->rpc_client); |
736 | rpc_task_set_rpc_message(task, task_setup_data->rpc_message); | |
737 | ||
58f9612c TM |
738 | if (task->tk_action == NULL) |
739 | rpc_call_start(task); | |
740 | ||
6e5b70e9 TM |
741 | atomic_inc(&task->tk_count); |
742 | rpc_execute(task); | |
6e5b70e9 | 743 | out: |
19445b99 | 744 | return task; |
6e5b70e9 | 745 | } |
c970aa85 | 746 | EXPORT_SYMBOL_GPL(rpc_run_task); |
6e5b70e9 TM |
747 | |
748 | /** | |
749 | * rpc_call_sync - Perform a synchronous RPC call | |
750 | * @clnt: pointer to RPC client | |
751 | * @msg: RPC call parameters | |
752 | * @flags: RPC call flags | |
1da177e4 | 753 | */ |
cbc20059 | 754 | int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags) |
1da177e4 LT |
755 | { |
756 | struct rpc_task *task; | |
84115e1c TM |
757 | struct rpc_task_setup task_setup_data = { |
758 | .rpc_client = clnt, | |
759 | .rpc_message = msg, | |
760 | .callback_ops = &rpc_default_ops, | |
761 | .flags = flags, | |
762 | }; | |
6e5b70e9 | 763 | int status; |
1da177e4 | 764 | |
1da177e4 LT |
765 | BUG_ON(flags & RPC_TASK_ASYNC); |
766 | ||
c970aa85 | 767 | task = rpc_run_task(&task_setup_data); |
6e5b70e9 TM |
768 | if (IS_ERR(task)) |
769 | return PTR_ERR(task); | |
e60859ac | 770 | status = task->tk_status; |
bde8f00c | 771 | rpc_put_task(task); |
1da177e4 LT |
772 | return status; |
773 | } | |
e8914c65 | 774 | EXPORT_SYMBOL_GPL(rpc_call_sync); |
1da177e4 | 775 | |
6e5b70e9 TM |
776 | /** |
777 | * rpc_call_async - Perform an asynchronous RPC call | |
778 | * @clnt: pointer to RPC client | |
779 | * @msg: RPC call parameters | |
780 | * @flags: RPC call flags | |
65b6e42c | 781 | * @tk_ops: RPC call ops |
6e5b70e9 | 782 | * @data: user call data |
1da177e4 LT |
783 | */ |
784 | int | |
cbc20059 | 785 | rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags, |
963d8fe5 | 786 | const struct rpc_call_ops *tk_ops, void *data) |
1da177e4 LT |
787 | { |
788 | struct rpc_task *task; | |
84115e1c TM |
789 | struct rpc_task_setup task_setup_data = { |
790 | .rpc_client = clnt, | |
791 | .rpc_message = msg, | |
792 | .callback_ops = tk_ops, | |
793 | .callback_data = data, | |
794 | .flags = flags|RPC_TASK_ASYNC, | |
795 | }; | |
1da177e4 | 796 | |
c970aa85 | 797 | task = rpc_run_task(&task_setup_data); |
6e5b70e9 TM |
798 | if (IS_ERR(task)) |
799 | return PTR_ERR(task); | |
800 | rpc_put_task(task); | |
801 | return 0; | |
1da177e4 | 802 | } |
e8914c65 | 803 | EXPORT_SYMBOL_GPL(rpc_call_async); |
1da177e4 | 804 | |
9e00abc3 | 805 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
55ae1aab RL |
806 | /** |
807 | * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run | |
808 | * rpc_execute against it | |
7a73fdde JSR |
809 | * @req: RPC request |
810 | * @tk_ops: RPC call ops | |
55ae1aab RL |
811 | */ |
812 | struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req, | |
7a73fdde | 813 | const struct rpc_call_ops *tk_ops) |
55ae1aab RL |
814 | { |
815 | struct rpc_task *task; | |
816 | struct xdr_buf *xbufp = &req->rq_snd_buf; | |
817 | struct rpc_task_setup task_setup_data = { | |
818 | .callback_ops = tk_ops, | |
819 | }; | |
820 | ||
821 | dprintk("RPC: rpc_run_bc_task req= %p\n", req); | |
822 | /* | |
823 | * Create an rpc_task to send the data | |
824 | */ | |
825 | task = rpc_new_task(&task_setup_data); | |
19445b99 | 826 | if (IS_ERR(task)) { |
55ae1aab RL |
827 | xprt_free_bc_request(req); |
828 | goto out; | |
829 | } | |
830 | task->tk_rqstp = req; | |
831 | ||
832 | /* | |
833 | * Set up the xdr_buf length. | |
834 | * This also indicates that the buffer is XDR encoded already. | |
835 | */ | |
836 | xbufp->len = xbufp->head[0].iov_len + xbufp->page_len + | |
837 | xbufp->tail[0].iov_len; | |
838 | ||
839 | task->tk_action = call_bc_transmit; | |
840 | atomic_inc(&task->tk_count); | |
841 | BUG_ON(atomic_read(&task->tk_count) != 2); | |
842 | rpc_execute(task); | |
843 | ||
844 | out: | |
845 | dprintk("RPC: rpc_run_bc_task: task= %p\n", task); | |
846 | return task; | |
847 | } | |
9e00abc3 | 848 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
55ae1aab | 849 | |
77de2c59 TM |
850 | void |
851 | rpc_call_start(struct rpc_task *task) | |
852 | { | |
853 | task->tk_action = call_start; | |
854 | } | |
855 | EXPORT_SYMBOL_GPL(rpc_call_start); | |
856 | ||
ed39440a CL |
857 | /** |
858 | * rpc_peeraddr - extract remote peer address from clnt's xprt | |
859 | * @clnt: RPC client structure | |
860 | * @buf: target buffer | |
65b6e42c | 861 | * @bufsize: length of target buffer |
ed39440a CL |
862 | * |
863 | * Returns the number of bytes that are actually in the stored address. | |
864 | */ | |
865 | size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize) | |
866 | { | |
867 | size_t bytes; | |
868 | struct rpc_xprt *xprt = clnt->cl_xprt; | |
869 | ||
870 | bytes = sizeof(xprt->addr); | |
871 | if (bytes > bufsize) | |
872 | bytes = bufsize; | |
873 | memcpy(buf, &clnt->cl_xprt->addr, bytes); | |
c4efcb1d | 874 | return xprt->addrlen; |
ed39440a | 875 | } |
b86acd50 | 876 | EXPORT_SYMBOL_GPL(rpc_peeraddr); |
ed39440a | 877 | |
f425eba4 CL |
878 | /** |
879 | * rpc_peeraddr2str - return remote peer address in printable format | |
880 | * @clnt: RPC client structure | |
881 | * @format: address format | |
882 | * | |
883 | */ | |
b454ae90 CL |
884 | const char *rpc_peeraddr2str(struct rpc_clnt *clnt, |
885 | enum rpc_display_format_t format) | |
f425eba4 CL |
886 | { |
887 | struct rpc_xprt *xprt = clnt->cl_xprt; | |
7559c7a2 CL |
888 | |
889 | if (xprt->address_strings[format] != NULL) | |
890 | return xprt->address_strings[format]; | |
891 | else | |
892 | return "unprintable"; | |
f425eba4 | 893 | } |
b86acd50 | 894 | EXPORT_SYMBOL_GPL(rpc_peeraddr2str); |
f425eba4 | 895 | |
1da177e4 LT |
896 | void |
897 | rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize) | |
898 | { | |
899 | struct rpc_xprt *xprt = clnt->cl_xprt; | |
470056c2 CL |
900 | if (xprt->ops->set_buffer_size) |
901 | xprt->ops->set_buffer_size(xprt, sndsize, rcvsize); | |
1da177e4 | 902 | } |
e8914c65 | 903 | EXPORT_SYMBOL_GPL(rpc_setbufsize); |
1da177e4 LT |
904 | |
905 | /* | |
906 | * Return size of largest payload RPC client can support, in bytes | |
907 | * | |
908 | * For stream transports, this is one RPC record fragment (see RFC | |
909 | * 1831), as we don't support multi-record requests yet. For datagram | |
910 | * transports, this is the size of an IP packet minus the IP, UDP, and | |
911 | * RPC header sizes. | |
912 | */ | |
913 | size_t rpc_max_payload(struct rpc_clnt *clnt) | |
914 | { | |
915 | return clnt->cl_xprt->max_payload; | |
916 | } | |
b86acd50 | 917 | EXPORT_SYMBOL_GPL(rpc_max_payload); |
1da177e4 | 918 | |
35f5a422 CL |
919 | /** |
920 | * rpc_force_rebind - force transport to check that remote port is unchanged | |
921 | * @clnt: client to rebind | |
922 | * | |
923 | */ | |
924 | void rpc_force_rebind(struct rpc_clnt *clnt) | |
925 | { | |
926 | if (clnt->cl_autobind) | |
ec739ef0 | 927 | xprt_clear_bound(clnt->cl_xprt); |
35f5a422 | 928 | } |
b86acd50 | 929 | EXPORT_SYMBOL_GPL(rpc_force_rebind); |
35f5a422 | 930 | |
aae2006e AA |
931 | /* |
932 | * Restart an (async) RPC call from the call_prepare state. | |
933 | * Usually called from within the exit handler. | |
934 | */ | |
f1f88fc7 | 935 | int |
aae2006e AA |
936 | rpc_restart_call_prepare(struct rpc_task *task) |
937 | { | |
938 | if (RPC_ASSASSINATED(task)) | |
f1f88fc7 | 939 | return 0; |
d00c5d43 TM |
940 | task->tk_action = call_start; |
941 | if (task->tk_ops->rpc_call_prepare != NULL) | |
942 | task->tk_action = rpc_prepare_task; | |
f1f88fc7 | 943 | return 1; |
aae2006e AA |
944 | } |
945 | EXPORT_SYMBOL_GPL(rpc_restart_call_prepare); | |
946 | ||
1da177e4 LT |
947 | /* |
948 | * Restart an (async) RPC call. Usually called from within the | |
949 | * exit handler. | |
950 | */ | |
f1f88fc7 | 951 | int |
1da177e4 LT |
952 | rpc_restart_call(struct rpc_task *task) |
953 | { | |
954 | if (RPC_ASSASSINATED(task)) | |
f1f88fc7 | 955 | return 0; |
1da177e4 | 956 | task->tk_action = call_start; |
f1f88fc7 | 957 | return 1; |
1da177e4 | 958 | } |
e8914c65 | 959 | EXPORT_SYMBOL_GPL(rpc_restart_call); |
1da177e4 | 960 | |
3748f1e4 CL |
961 | #ifdef RPC_DEBUG |
962 | static const char *rpc_proc_name(const struct rpc_task *task) | |
963 | { | |
964 | const struct rpc_procinfo *proc = task->tk_msg.rpc_proc; | |
965 | ||
966 | if (proc) { | |
967 | if (proc->p_name) | |
968 | return proc->p_name; | |
969 | else | |
970 | return "NULL"; | |
971 | } else | |
972 | return "no proc"; | |
973 | } | |
974 | #endif | |
975 | ||
1da177e4 LT |
976 | /* |
977 | * 0. Initial state | |
978 | * | |
979 | * Other FSM states can be visited zero or more times, but | |
980 | * this state is visited exactly once for each RPC. | |
981 | */ | |
982 | static void | |
983 | call_start(struct rpc_task *task) | |
984 | { | |
985 | struct rpc_clnt *clnt = task->tk_client; | |
986 | ||
3748f1e4 | 987 | dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid, |
46121cf7 | 988 | clnt->cl_protname, clnt->cl_vers, |
3748f1e4 | 989 | rpc_proc_name(task), |
46121cf7 | 990 | (RPC_IS_ASYNC(task) ? "async" : "sync")); |
1da177e4 LT |
991 | |
992 | /* Increment call count */ | |
993 | task->tk_msg.rpc_proc->p_count++; | |
994 | clnt->cl_stats->rpccnt++; | |
995 | task->tk_action = call_reserve; | |
996 | } | |
997 | ||
998 | /* | |
999 | * 1. Reserve an RPC call slot | |
1000 | */ | |
1001 | static void | |
1002 | call_reserve(struct rpc_task *task) | |
1003 | { | |
46121cf7 | 1004 | dprint_status(task); |
1da177e4 | 1005 | |
1da177e4 LT |
1006 | task->tk_status = 0; |
1007 | task->tk_action = call_reserveresult; | |
1008 | xprt_reserve(task); | |
1009 | } | |
1010 | ||
1011 | /* | |
1012 | * 1b. Grok the result of xprt_reserve() | |
1013 | */ | |
1014 | static void | |
1015 | call_reserveresult(struct rpc_task *task) | |
1016 | { | |
1017 | int status = task->tk_status; | |
1018 | ||
46121cf7 | 1019 | dprint_status(task); |
1da177e4 LT |
1020 | |
1021 | /* | |
1022 | * After a call to xprt_reserve(), we must have either | |
1023 | * a request slot or else an error status. | |
1024 | */ | |
1025 | task->tk_status = 0; | |
1026 | if (status >= 0) { | |
1027 | if (task->tk_rqstp) { | |
f2d47d02 | 1028 | task->tk_action = call_refresh; |
1da177e4 LT |
1029 | return; |
1030 | } | |
1031 | ||
1032 | printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n", | |
0dc47877 | 1033 | __func__, status); |
1da177e4 LT |
1034 | rpc_exit(task, -EIO); |
1035 | return; | |
1036 | } | |
1037 | ||
1038 | /* | |
1039 | * Even though there was an error, we may have acquired | |
1040 | * a request slot somehow. Make sure not to leak it. | |
1041 | */ | |
1042 | if (task->tk_rqstp) { | |
1043 | printk(KERN_ERR "%s: status=%d, request allocated anyway\n", | |
0dc47877 | 1044 | __func__, status); |
1da177e4 LT |
1045 | xprt_release(task); |
1046 | } | |
1047 | ||
1048 | switch (status) { | |
1049 | case -EAGAIN: /* woken up; retry */ | |
1050 | task->tk_action = call_reserve; | |
1051 | return; | |
1052 | case -EIO: /* probably a shutdown */ | |
1053 | break; | |
1054 | default: | |
1055 | printk(KERN_ERR "%s: unrecognized error %d, exiting\n", | |
0dc47877 | 1056 | __func__, status); |
1da177e4 LT |
1057 | break; |
1058 | } | |
1059 | rpc_exit(task, status); | |
1060 | } | |
1061 | ||
1062 | /* | |
55576244 BF |
1063 | * 2. Bind and/or refresh the credentials |
1064 | */ | |
1065 | static void | |
1066 | call_refresh(struct rpc_task *task) | |
1067 | { | |
1068 | dprint_status(task); | |
1069 | ||
1070 | task->tk_action = call_refreshresult; | |
1071 | task->tk_status = 0; | |
1072 | task->tk_client->cl_stats->rpcauthrefresh++; | |
1073 | rpcauth_refreshcred(task); | |
1074 | } | |
1075 | ||
1076 | /* | |
1077 | * 2a. Process the results of a credential refresh | |
1078 | */ | |
1079 | static void | |
1080 | call_refreshresult(struct rpc_task *task) | |
1081 | { | |
1082 | int status = task->tk_status; | |
1083 | ||
1084 | dprint_status(task); | |
1085 | ||
1086 | task->tk_status = 0; | |
5fc43978 | 1087 | task->tk_action = call_refresh; |
55576244 | 1088 | switch (status) { |
5fc43978 TM |
1089 | case 0: |
1090 | if (rpcauth_uptodatecred(task)) | |
1091 | task->tk_action = call_allocate; | |
55576244 BF |
1092 | return; |
1093 | case -ETIMEDOUT: | |
1094 | rpc_delay(task, 3*HZ); | |
5fc43978 TM |
1095 | case -EAGAIN: |
1096 | status = -EACCES; | |
1097 | if (!task->tk_cred_retry) | |
1098 | break; | |
1099 | task->tk_cred_retry--; | |
1100 | dprintk("RPC: %5u %s: retry refresh creds\n", | |
1101 | task->tk_pid, __func__); | |
1102 | return; | |
55576244 | 1103 | } |
5fc43978 TM |
1104 | dprintk("RPC: %5u %s: refresh creds failed with error %d\n", |
1105 | task->tk_pid, __func__, status); | |
1106 | rpc_exit(task, status); | |
55576244 BF |
1107 | } |
1108 | ||
1109 | /* | |
1110 | * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc. | |
02107148 | 1111 | * (Note: buffer memory is freed in xprt_release). |
1da177e4 LT |
1112 | */ |
1113 | static void | |
1114 | call_allocate(struct rpc_task *task) | |
1115 | { | |
f2d47d02 | 1116 | unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack; |
02107148 CL |
1117 | struct rpc_rqst *req = task->tk_rqstp; |
1118 | struct rpc_xprt *xprt = task->tk_xprt; | |
2bea90d4 | 1119 | struct rpc_procinfo *proc = task->tk_msg.rpc_proc; |
1da177e4 | 1120 | |
46121cf7 CL |
1121 | dprint_status(task); |
1122 | ||
2bea90d4 | 1123 | task->tk_status = 0; |
f2d47d02 | 1124 | task->tk_action = call_bind; |
2bea90d4 | 1125 | |
02107148 | 1126 | if (req->rq_buffer) |
1da177e4 LT |
1127 | return; |
1128 | ||
2bea90d4 CL |
1129 | if (proc->p_proc != 0) { |
1130 | BUG_ON(proc->p_arglen == 0); | |
1131 | if (proc->p_decode != NULL) | |
1132 | BUG_ON(proc->p_replen == 0); | |
1133 | } | |
1da177e4 | 1134 | |
2bea90d4 CL |
1135 | /* |
1136 | * Calculate the size (in quads) of the RPC call | |
1137 | * and reply headers, and convert both values | |
1138 | * to byte sizes. | |
1139 | */ | |
1140 | req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen; | |
1141 | req->rq_callsize <<= 2; | |
1142 | req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen; | |
1143 | req->rq_rcvsize <<= 2; | |
1144 | ||
c5a4dd8b CL |
1145 | req->rq_buffer = xprt->ops->buf_alloc(task, |
1146 | req->rq_callsize + req->rq_rcvsize); | |
2bea90d4 | 1147 | if (req->rq_buffer != NULL) |
1da177e4 | 1148 | return; |
46121cf7 CL |
1149 | |
1150 | dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid); | |
1da177e4 | 1151 | |
5afa9133 | 1152 | if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) { |
b6e9c713 | 1153 | task->tk_action = call_allocate; |
1da177e4 LT |
1154 | rpc_delay(task, HZ>>4); |
1155 | return; | |
1156 | } | |
1157 | ||
1158 | rpc_exit(task, -ERESTARTSYS); | |
1159 | } | |
1160 | ||
940e3318 TM |
1161 | static inline int |
1162 | rpc_task_need_encode(struct rpc_task *task) | |
1163 | { | |
1164 | return task->tk_rqstp->rq_snd_buf.len == 0; | |
1165 | } | |
1166 | ||
1167 | static inline void | |
1168 | rpc_task_force_reencode(struct rpc_task *task) | |
1169 | { | |
1170 | task->tk_rqstp->rq_snd_buf.len = 0; | |
2574cc9f | 1171 | task->tk_rqstp->rq_bytes_sent = 0; |
940e3318 TM |
1172 | } |
1173 | ||
2bea90d4 CL |
1174 | static inline void |
1175 | rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len) | |
1176 | { | |
1177 | buf->head[0].iov_base = start; | |
1178 | buf->head[0].iov_len = len; | |
1179 | buf->tail[0].iov_len = 0; | |
1180 | buf->page_len = 0; | |
4f22ccc3 | 1181 | buf->flags = 0; |
2bea90d4 CL |
1182 | buf->len = 0; |
1183 | buf->buflen = len; | |
1184 | } | |
1185 | ||
1da177e4 LT |
1186 | /* |
1187 | * 3. Encode arguments of an RPC call | |
1188 | */ | |
1189 | static void | |
b0e1c57e | 1190 | rpc_xdr_encode(struct rpc_task *task) |
1da177e4 | 1191 | { |
1da177e4 | 1192 | struct rpc_rqst *req = task->tk_rqstp; |
9f06c719 | 1193 | kxdreproc_t encode; |
d8ed029d | 1194 | __be32 *p; |
1da177e4 | 1195 | |
46121cf7 | 1196 | dprint_status(task); |
1da177e4 | 1197 | |
2bea90d4 CL |
1198 | rpc_xdr_buf_init(&req->rq_snd_buf, |
1199 | req->rq_buffer, | |
1200 | req->rq_callsize); | |
1201 | rpc_xdr_buf_init(&req->rq_rcv_buf, | |
1202 | (char *)req->rq_buffer + req->rq_callsize, | |
1203 | req->rq_rcvsize); | |
1da177e4 | 1204 | |
b0e1c57e CL |
1205 | p = rpc_encode_header(task); |
1206 | if (p == NULL) { | |
1207 | printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n"); | |
1da177e4 LT |
1208 | rpc_exit(task, -EIO); |
1209 | return; | |
1210 | } | |
b0e1c57e CL |
1211 | |
1212 | encode = task->tk_msg.rpc_proc->p_encode; | |
f3680312 BF |
1213 | if (encode == NULL) |
1214 | return; | |
1215 | ||
1216 | task->tk_status = rpcauth_wrap_req(task, encode, req, p, | |
1217 | task->tk_msg.rpc_argp); | |
1da177e4 LT |
1218 | } |
1219 | ||
1220 | /* | |
1221 | * 4. Get the server port number if not yet set | |
1222 | */ | |
1223 | static void | |
1224 | call_bind(struct rpc_task *task) | |
1225 | { | |
ec739ef0 | 1226 | struct rpc_xprt *xprt = task->tk_xprt; |
1da177e4 | 1227 | |
46121cf7 | 1228 | dprint_status(task); |
1da177e4 | 1229 | |
da351878 | 1230 | task->tk_action = call_connect; |
ec739ef0 | 1231 | if (!xprt_bound(xprt)) { |
da351878 | 1232 | task->tk_action = call_bind_status; |
ec739ef0 | 1233 | task->tk_timeout = xprt->bind_timeout; |
bbf7c1dd | 1234 | xprt->ops->rpcbind(task); |
1da177e4 LT |
1235 | } |
1236 | } | |
1237 | ||
1238 | /* | |
da351878 CL |
1239 | * 4a. Sort out bind result |
1240 | */ | |
1241 | static void | |
1242 | call_bind_status(struct rpc_task *task) | |
1243 | { | |
906462af | 1244 | int status = -EIO; |
da351878 CL |
1245 | |
1246 | if (task->tk_status >= 0) { | |
46121cf7 | 1247 | dprint_status(task); |
da351878 CL |
1248 | task->tk_status = 0; |
1249 | task->tk_action = call_connect; | |
1250 | return; | |
1251 | } | |
1252 | ||
1253 | switch (task->tk_status) { | |
381ba74a TM |
1254 | case -ENOMEM: |
1255 | dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid); | |
1256 | rpc_delay(task, HZ >> 2); | |
2429cbf6 | 1257 | goto retry_timeout; |
da351878 | 1258 | case -EACCES: |
46121cf7 CL |
1259 | dprintk("RPC: %5u remote rpcbind: RPC program/version " |
1260 | "unavailable\n", task->tk_pid); | |
b79dc8ce CL |
1261 | /* fail immediately if this is an RPC ping */ |
1262 | if (task->tk_msg.rpc_proc->p_proc == 0) { | |
1263 | status = -EOPNOTSUPP; | |
1264 | break; | |
1265 | } | |
0b760113 TM |
1266 | if (task->tk_rebind_retry == 0) |
1267 | break; | |
1268 | task->tk_rebind_retry--; | |
ea635a51 | 1269 | rpc_delay(task, 3*HZ); |
da45828e | 1270 | goto retry_timeout; |
da351878 | 1271 | case -ETIMEDOUT: |
46121cf7 | 1272 | dprintk("RPC: %5u rpcbind request timed out\n", |
da351878 | 1273 | task->tk_pid); |
da45828e | 1274 | goto retry_timeout; |
da351878 | 1275 | case -EPFNOSUPPORT: |
906462af | 1276 | /* server doesn't support any rpcbind version we know of */ |
012da158 | 1277 | dprintk("RPC: %5u unrecognized remote rpcbind service\n", |
da351878 CL |
1278 | task->tk_pid); |
1279 | break; | |
1280 | case -EPROTONOSUPPORT: | |
00a6e7bb | 1281 | dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n", |
da351878 | 1282 | task->tk_pid); |
00a6e7bb CL |
1283 | task->tk_status = 0; |
1284 | task->tk_action = call_bind; | |
1285 | return; | |
012da158 CL |
1286 | case -ECONNREFUSED: /* connection problems */ |
1287 | case -ECONNRESET: | |
1288 | case -ENOTCONN: | |
1289 | case -EHOSTDOWN: | |
1290 | case -EHOSTUNREACH: | |
1291 | case -ENETUNREACH: | |
1292 | case -EPIPE: | |
1293 | dprintk("RPC: %5u remote rpcbind unreachable: %d\n", | |
1294 | task->tk_pid, task->tk_status); | |
1295 | if (!RPC_IS_SOFTCONN(task)) { | |
1296 | rpc_delay(task, 5*HZ); | |
1297 | goto retry_timeout; | |
1298 | } | |
1299 | status = task->tk_status; | |
1300 | break; | |
da351878 | 1301 | default: |
46121cf7 | 1302 | dprintk("RPC: %5u unrecognized rpcbind error (%d)\n", |
da351878 | 1303 | task->tk_pid, -task->tk_status); |
da351878 CL |
1304 | } |
1305 | ||
1306 | rpc_exit(task, status); | |
1307 | return; | |
1308 | ||
da45828e TM |
1309 | retry_timeout: |
1310 | task->tk_action = call_timeout; | |
da351878 CL |
1311 | } |
1312 | ||
1313 | /* | |
1314 | * 4b. Connect to the RPC server | |
1da177e4 LT |
1315 | */ |
1316 | static void | |
1317 | call_connect(struct rpc_task *task) | |
1318 | { | |
da351878 | 1319 | struct rpc_xprt *xprt = task->tk_xprt; |
1da177e4 | 1320 | |
46121cf7 | 1321 | dprintk("RPC: %5u call_connect xprt %p %s connected\n", |
da351878 CL |
1322 | task->tk_pid, xprt, |
1323 | (xprt_connected(xprt) ? "is" : "is not")); | |
1da177e4 | 1324 | |
da351878 CL |
1325 | task->tk_action = call_transmit; |
1326 | if (!xprt_connected(xprt)) { | |
1327 | task->tk_action = call_connect_status; | |
1328 | if (task->tk_status < 0) | |
1329 | return; | |
1330 | xprt_connect(task); | |
1da177e4 | 1331 | } |
1da177e4 LT |
1332 | } |
1333 | ||
1334 | /* | |
da351878 | 1335 | * 4c. Sort out connect result |
1da177e4 LT |
1336 | */ |
1337 | static void | |
1338 | call_connect_status(struct rpc_task *task) | |
1339 | { | |
1340 | struct rpc_clnt *clnt = task->tk_client; | |
1341 | int status = task->tk_status; | |
1342 | ||
46121cf7 | 1343 | dprint_status(task); |
da351878 | 1344 | |
1da177e4 | 1345 | task->tk_status = 0; |
2a491991 | 1346 | if (status >= 0 || status == -EAGAIN) { |
1da177e4 LT |
1347 | clnt->cl_stats->netreconn++; |
1348 | task->tk_action = call_transmit; | |
1349 | return; | |
1350 | } | |
1351 | ||
1da177e4 | 1352 | switch (status) { |
da45828e TM |
1353 | /* if soft mounted, test if we've timed out */ |
1354 | case -ETIMEDOUT: | |
1355 | task->tk_action = call_timeout; | |
2a491991 TM |
1356 | break; |
1357 | default: | |
1358 | rpc_exit(task, -EIO); | |
1da177e4 LT |
1359 | } |
1360 | } | |
1361 | ||
1362 | /* | |
1363 | * 5. Transmit the RPC request, and wait for reply | |
1364 | */ | |
1365 | static void | |
1366 | call_transmit(struct rpc_task *task) | |
1367 | { | |
46121cf7 | 1368 | dprint_status(task); |
1da177e4 LT |
1369 | |
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; | |
e0ab53de | 1376 | task->tk_action = call_transmit_status; |
1da177e4 | 1377 | /* Encode here so that rpcsec_gss can use correct sequence number. */ |
940e3318 | 1378 | if (rpc_task_need_encode(task)) { |
e0ab53de | 1379 | BUG_ON(task->tk_rqstp->rq_bytes_sent != 0); |
b0e1c57e | 1380 | rpc_xdr_encode(task); |
5e5ce5be | 1381 | /* Did the encode result in an error condition? */ |
8b39f2b4 TM |
1382 | 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); | |
e0ab53de | 1388 | return; |
8b39f2b4 | 1389 | } |
5e5ce5be | 1390 | } |
1da177e4 LT |
1391 | xprt_transmit(task); |
1392 | if (task->tk_status < 0) | |
1393 | return; | |
e0ab53de TM |
1394 | /* |
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); | |
55ae1aab | 1399 | if (rpc_reply_expected(task)) |
e0ab53de TM |
1400 | return; |
1401 | task->tk_action = rpc_exit_task; | |
fda13939 | 1402 | rpc_wake_up_queued_task(&task->tk_xprt->pending, task); |
e0ab53de TM |
1403 | } |
1404 | ||
1405 | /* | |
1406 | * 5a. Handle cleanup after a transmission | |
1407 | */ | |
1408 | static void | |
1409 | call_transmit_status(struct rpc_task *task) | |
1410 | { | |
1411 | task->tk_action = call_status; | |
206a134b CL |
1412 | |
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 | ||
15f081ca TM |
1423 | switch (task->tk_status) { |
1424 | case -EAGAIN: | |
1425 | break; | |
1426 | default: | |
206a134b | 1427 | dprint_status(task); |
15f081ca | 1428 | xprt_end_transmit(task); |
09a21c41 CL |
1429 | rpc_task_force_reencode(task); |
1430 | break; | |
15f081ca TM |
1431 | /* |
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: | |
15f081ca TM |
1438 | case -EHOSTDOWN: |
1439 | case -EHOSTUNREACH: | |
1440 | case -ENETUNREACH: | |
09a21c41 CL |
1441 | 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: | |
c8485e4d | 1448 | case -EPIPE: |
15f081ca TM |
1449 | rpc_task_force_reencode(task); |
1450 | } | |
1da177e4 LT |
1451 | } |
1452 | ||
9e00abc3 | 1453 | #if defined(CONFIG_SUNRPC_BACKCHANNEL) |
55ae1aab RL |
1454 | /* |
1455 | * 5b. Send the backchannel RPC reply. On error, drop the reply. In | |
1456 | * addition, disconnect on connectivity errors. | |
1457 | */ | |
1458 | static void | |
1459 | call_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 | } | |
9e00abc3 | 1517 | #endif /* CONFIG_SUNRPC_BACKCHANNEL */ |
55ae1aab | 1518 | |
1da177e4 LT |
1519 | /* |
1520 | * 6. Sort out the RPC call status | |
1521 | */ | |
1522 | static void | |
1523 | call_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 | ||
dd2b63d0 RL |
1529 | if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent) |
1530 | task->tk_status = req->rq_reply_bytes_recvd; | |
1da177e4 | 1531 | |
46121cf7 | 1532 | dprint_status(task); |
1da177e4 LT |
1533 | |
1534 | status = task->tk_status; | |
1535 | if (status >= 0) { | |
1536 | task->tk_action = call_decode; | |
1537 | return; | |
1538 | } | |
1539 | ||
1540 | task->tk_status = 0; | |
1541 | switch(status) { | |
76303992 TM |
1542 | case -EHOSTDOWN: |
1543 | case -EHOSTUNREACH: | |
1544 | case -ENETUNREACH: | |
1545 | /* | |
1546 | * Delay any retries for 3 seconds, then handle as if it | |
1547 | * were a timeout. | |
1548 | */ | |
1549 | rpc_delay(task, 3*HZ); | |
1da177e4 LT |
1550 | case -ETIMEDOUT: |
1551 | task->tk_action = call_timeout; | |
241c39b9 | 1552 | if (task->tk_client->cl_discrtry) |
7c1d71cf TM |
1553 | xprt_conditional_disconnect(task->tk_xprt, |
1554 | req->rq_connect_cookie); | |
1da177e4 | 1555 | break; |
c8485e4d | 1556 | case -ECONNRESET: |
1da177e4 | 1557 | case -ECONNREFUSED: |
35f5a422 | 1558 | rpc_force_rebind(clnt); |
c8485e4d TM |
1559 | rpc_delay(task, 3*HZ); |
1560 | case -EPIPE: | |
1561 | case -ENOTCONN: | |
1da177e4 LT |
1562 | task->tk_action = call_bind; |
1563 | break; | |
1564 | case -EAGAIN: | |
1565 | task->tk_action = call_transmit; | |
1566 | break; | |
1567 | case -EIO: | |
1568 | /* shutdown or soft timeout */ | |
1569 | rpc_exit(task, status); | |
1570 | break; | |
1571 | default: | |
b6b6152c OK |
1572 | if (clnt->cl_chatty) |
1573 | printk("%s: RPC call returned error %d\n", | |
1da177e4 LT |
1574 | clnt->cl_protname, -status); |
1575 | rpc_exit(task, status); | |
1da177e4 LT |
1576 | } |
1577 | } | |
1578 | ||
1579 | /* | |
e0ab53de | 1580 | * 6a. Handle RPC timeout |
1da177e4 LT |
1581 | * We do not release the request slot, so we keep using the |
1582 | * same XID for all retransmits. | |
1583 | */ | |
1584 | static void | |
1585 | call_timeout(struct rpc_task *task) | |
1586 | { | |
1587 | struct rpc_clnt *clnt = task->tk_client; | |
1588 | ||
1589 | if (xprt_adjust_timeout(task->tk_rqstp) == 0) { | |
46121cf7 | 1590 | dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid); |
1da177e4 LT |
1591 | goto retry; |
1592 | } | |
1593 | ||
46121cf7 | 1594 | dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid); |
ef759a2e CL |
1595 | task->tk_timeouts++; |
1596 | ||
3a28becc CL |
1597 | if (RPC_IS_SOFTCONN(task)) { |
1598 | rpc_exit(task, -ETIMEDOUT); | |
1599 | return; | |
1600 | } | |
1da177e4 | 1601 | if (RPC_IS_SOFT(task)) { |
b6b6152c OK |
1602 | if (clnt->cl_chatty) |
1603 | printk(KERN_NOTICE "%s: server %s not responding, timed out\n", | |
1da177e4 | 1604 | clnt->cl_protname, clnt->cl_server); |
7494d00c TM |
1605 | if (task->tk_flags & RPC_TASK_TIMEOUT) |
1606 | rpc_exit(task, -ETIMEDOUT); | |
1607 | else | |
1608 | rpc_exit(task, -EIO); | |
1da177e4 LT |
1609 | return; |
1610 | } | |
1611 | ||
f518e35a | 1612 | if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) { |
1da177e4 | 1613 | task->tk_flags |= RPC_CALL_MAJORSEEN; |
b6b6152c OK |
1614 | if (clnt->cl_chatty) |
1615 | printk(KERN_NOTICE "%s: server %s not responding, still trying\n", | |
1da177e4 LT |
1616 | clnt->cl_protname, clnt->cl_server); |
1617 | } | |
35f5a422 | 1618 | rpc_force_rebind(clnt); |
b48633bd TM |
1619 | /* |
1620 | * Did our request time out due to an RPCSEC_GSS out-of-sequence | |
1621 | * event? RFC2203 requires the server to drop all such requests. | |
1622 | */ | |
1623 | rpcauth_invalcred(task); | |
1da177e4 LT |
1624 | |
1625 | retry: | |
1626 | clnt->cl_stats->rpcretrans++; | |
1627 | task->tk_action = call_bind; | |
1628 | task->tk_status = 0; | |
1629 | } | |
1630 | ||
1631 | /* | |
1632 | * 7. Decode the RPC reply | |
1633 | */ | |
1634 | static void | |
1635 | call_decode(struct rpc_task *task) | |
1636 | { | |
1637 | struct rpc_clnt *clnt = task->tk_client; | |
1638 | struct rpc_rqst *req = task->tk_rqstp; | |
bf269551 | 1639 | kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode; |
d8ed029d | 1640 | __be32 *p; |
1da177e4 | 1641 | |
726fd6ad | 1642 | dprint_status(task); |
1da177e4 | 1643 | |
f518e35a | 1644 | if (task->tk_flags & RPC_CALL_MAJORSEEN) { |
b6b6152c OK |
1645 | if (clnt->cl_chatty) |
1646 | printk(KERN_NOTICE "%s: server %s OK\n", | |
1647 | clnt->cl_protname, clnt->cl_server); | |
1da177e4 LT |
1648 | task->tk_flags &= ~RPC_CALL_MAJORSEEN; |
1649 | } | |
1650 | ||
43ac3f29 TM |
1651 | /* |
1652 | * Ensure that we see all writes made by xprt_complete_rqst() | |
dd2b63d0 | 1653 | * before it changed req->rq_reply_bytes_recvd. |
43ac3f29 TM |
1654 | */ |
1655 | smp_rmb(); | |
1da177e4 LT |
1656 | req->rq_rcv_buf.len = req->rq_private_buf.len; |
1657 | ||
1658 | /* Check that the softirq receive buffer is valid */ | |
1659 | WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf, | |
1660 | sizeof(req->rq_rcv_buf)) != 0); | |
1661 | ||
1e799b67 TM |
1662 | if (req->rq_rcv_buf.len < 12) { |
1663 | if (!RPC_IS_SOFT(task)) { | |
1664 | task->tk_action = call_bind; | |
1665 | clnt->cl_stats->rpcretrans++; | |
1666 | goto out_retry; | |
1667 | } | |
1668 | dprintk("RPC: %s: too small RPC reply size (%d bytes)\n", | |
1669 | clnt->cl_protname, task->tk_status); | |
1670 | task->tk_action = call_timeout; | |
1671 | goto out_retry; | |
1672 | } | |
1673 | ||
b0e1c57e | 1674 | p = rpc_verify_header(task); |
abbcf28f TM |
1675 | if (IS_ERR(p)) { |
1676 | if (p == ERR_PTR(-EAGAIN)) | |
1677 | goto out_retry; | |
1678 | return; | |
1da177e4 LT |
1679 | } |
1680 | ||
abbcf28f | 1681 | task->tk_action = rpc_exit_task; |
1da177e4 | 1682 | |
6d5fcb5a | 1683 | if (decode) { |
1da177e4 LT |
1684 | task->tk_status = rpcauth_unwrap_resp(task, decode, req, p, |
1685 | task->tk_msg.rpc_resp); | |
6d5fcb5a | 1686 | } |
46121cf7 CL |
1687 | dprintk("RPC: %5u call_decode result %d\n", task->tk_pid, |
1688 | task->tk_status); | |
1da177e4 LT |
1689 | return; |
1690 | out_retry: | |
1da177e4 | 1691 | task->tk_status = 0; |
b0e1c57e | 1692 | /* Note: rpc_verify_header() may have freed the RPC slot */ |
24b74bf0 | 1693 | if (task->tk_rqstp == req) { |
dd2b63d0 | 1694 | req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0; |
24b74bf0 | 1695 | if (task->tk_client->cl_discrtry) |
7c1d71cf TM |
1696 | xprt_conditional_disconnect(task->tk_xprt, |
1697 | req->rq_connect_cookie); | |
24b74bf0 | 1698 | } |
1da177e4 LT |
1699 | } |
1700 | ||
d8ed029d | 1701 | static __be32 * |
b0e1c57e | 1702 | rpc_encode_header(struct rpc_task *task) |
1da177e4 LT |
1703 | { |
1704 | struct rpc_clnt *clnt = task->tk_client; | |
1da177e4 | 1705 | struct rpc_rqst *req = task->tk_rqstp; |
d8ed029d | 1706 | __be32 *p = req->rq_svec[0].iov_base; |
1da177e4 LT |
1707 | |
1708 | /* FIXME: check buffer size? */ | |
808012fb CL |
1709 | |
1710 | p = xprt_skip_transport_header(task->tk_xprt, p); | |
1da177e4 LT |
1711 | *p++ = req->rq_xid; /* XID */ |
1712 | *p++ = htonl(RPC_CALL); /* CALL */ | |
1713 | *p++ = htonl(RPC_VERSION); /* RPC version */ | |
1714 | *p++ = htonl(clnt->cl_prog); /* program number */ | |
1715 | *p++ = htonl(clnt->cl_vers); /* program version */ | |
1716 | *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */ | |
334ccfd5 TM |
1717 | p = rpcauth_marshcred(task, p); |
1718 | req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p); | |
1719 | return p; | |
1da177e4 LT |
1720 | } |
1721 | ||
d8ed029d | 1722 | static __be32 * |
b0e1c57e | 1723 | rpc_verify_header(struct rpc_task *task) |
1da177e4 LT |
1724 | { |
1725 | struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0]; | |
1726 | int len = task->tk_rqstp->rq_rcv_buf.len >> 2; | |
d8ed029d AD |
1727 | __be32 *p = iov->iov_base; |
1728 | u32 n; | |
1da177e4 LT |
1729 | int error = -EACCES; |
1730 | ||
e8896495 DH |
1731 | if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) { |
1732 | /* RFC-1014 says that the representation of XDR data must be a | |
1733 | * multiple of four bytes | |
1734 | * - if it isn't pointer subtraction in the NFS client may give | |
1735 | * undefined results | |
1736 | */ | |
8a702bbb | 1737 | dprintk("RPC: %5u %s: XDR representation not a multiple of" |
0dc47877 | 1738 | " 4 bytes: 0x%x\n", task->tk_pid, __func__, |
8a702bbb | 1739 | task->tk_rqstp->rq_rcv_buf.len); |
e8896495 DH |
1740 | goto out_eio; |
1741 | } | |
1da177e4 LT |
1742 | if ((len -= 3) < 0) |
1743 | goto out_overflow; | |
1da177e4 | 1744 | |
f4a2e418 | 1745 | p += 1; /* skip XID */ |
1da177e4 | 1746 | if ((n = ntohl(*p++)) != RPC_REPLY) { |
8a702bbb | 1747 | dprintk("RPC: %5u %s: not an RPC reply: %x\n", |
f4a2e418 | 1748 | task->tk_pid, __func__, n); |
abbcf28f | 1749 | goto out_garbage; |
1da177e4 | 1750 | } |
f4a2e418 | 1751 | |
1da177e4 LT |
1752 | if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) { |
1753 | if (--len < 0) | |
1754 | goto out_overflow; | |
1755 | switch ((n = ntohl(*p++))) { | |
89f0e4fe JP |
1756 | case RPC_AUTH_ERROR: |
1757 | break; | |
1758 | case RPC_MISMATCH: | |
1759 | dprintk("RPC: %5u %s: RPC call version mismatch!\n", | |
1760 | task->tk_pid, __func__); | |
1761 | error = -EPROTONOSUPPORT; | |
1762 | goto out_err; | |
1763 | default: | |
1764 | dprintk("RPC: %5u %s: RPC call rejected, " | |
1765 | "unknown error: %x\n", | |
1766 | task->tk_pid, __func__, n); | |
1767 | goto out_eio; | |
1da177e4 LT |
1768 | } |
1769 | if (--len < 0) | |
1770 | goto out_overflow; | |
1771 | switch ((n = ntohl(*p++))) { | |
1772 | case RPC_AUTH_REJECTEDCRED: | |
1773 | case RPC_AUTH_REJECTEDVERF: | |
1774 | case RPCSEC_GSS_CREDPROBLEM: | |
1775 | case RPCSEC_GSS_CTXPROBLEM: | |
1776 | if (!task->tk_cred_retry) | |
1777 | break; | |
1778 | task->tk_cred_retry--; | |
46121cf7 | 1779 | dprintk("RPC: %5u %s: retry stale creds\n", |
0dc47877 | 1780 | task->tk_pid, __func__); |
1da177e4 | 1781 | rpcauth_invalcred(task); |
220bcc2a TM |
1782 | /* Ensure we obtain a new XID! */ |
1783 | xprt_release(task); | |
118df3d1 | 1784 | task->tk_action = call_reserve; |
abbcf28f | 1785 | goto out_retry; |
1da177e4 LT |
1786 | case RPC_AUTH_BADCRED: |
1787 | case RPC_AUTH_BADVERF: | |
1788 | /* possibly garbled cred/verf? */ | |
1789 | if (!task->tk_garb_retry) | |
1790 | break; | |
1791 | task->tk_garb_retry--; | |
46121cf7 | 1792 | dprintk("RPC: %5u %s: retry garbled creds\n", |
0dc47877 | 1793 | task->tk_pid, __func__); |
1da177e4 | 1794 | task->tk_action = call_bind; |
abbcf28f | 1795 | goto out_retry; |
1da177e4 | 1796 | case RPC_AUTH_TOOWEAK: |
b0e1c57e | 1797 | printk(KERN_NOTICE "RPC: server %s requires stronger " |
1356b8c2 | 1798 | "authentication.\n", task->tk_client->cl_server); |
1da177e4 LT |
1799 | break; |
1800 | default: | |
8a702bbb | 1801 | dprintk("RPC: %5u %s: unknown auth error: %x\n", |
0dc47877 | 1802 | task->tk_pid, __func__, n); |
1da177e4 LT |
1803 | error = -EIO; |
1804 | } | |
46121cf7 | 1805 | dprintk("RPC: %5u %s: call rejected %d\n", |
0dc47877 | 1806 | task->tk_pid, __func__, n); |
1da177e4 LT |
1807 | goto out_err; |
1808 | } | |
1809 | if (!(p = rpcauth_checkverf(task, p))) { | |
8a702bbb | 1810 | dprintk("RPC: %5u %s: auth check failed\n", |
0dc47877 | 1811 | task->tk_pid, __func__); |
abbcf28f | 1812 | goto out_garbage; /* bad verifier, retry */ |
1da177e4 | 1813 | } |
d8ed029d | 1814 | len = p - (__be32 *)iov->iov_base - 1; |
1da177e4 LT |
1815 | if (len < 0) |
1816 | goto out_overflow; | |
1817 | switch ((n = ntohl(*p++))) { | |
1818 | case RPC_SUCCESS: | |
1819 | return p; | |
1820 | case RPC_PROG_UNAVAIL: | |
46121cf7 | 1821 | dprintk("RPC: %5u %s: program %u is unsupported by server %s\n", |
0dc47877 | 1822 | task->tk_pid, __func__, |
1da177e4 LT |
1823 | (unsigned int)task->tk_client->cl_prog, |
1824 | task->tk_client->cl_server); | |
cdf47706 AG |
1825 | error = -EPFNOSUPPORT; |
1826 | goto out_err; | |
1da177e4 | 1827 | case RPC_PROG_MISMATCH: |
46121cf7 | 1828 | dprintk("RPC: %5u %s: program %u, version %u unsupported by " |
0dc47877 | 1829 | "server %s\n", task->tk_pid, __func__, |
1da177e4 LT |
1830 | (unsigned int)task->tk_client->cl_prog, |
1831 | (unsigned int)task->tk_client->cl_vers, | |
1832 | task->tk_client->cl_server); | |
cdf47706 AG |
1833 | error = -EPROTONOSUPPORT; |
1834 | goto out_err; | |
1da177e4 | 1835 | case RPC_PROC_UNAVAIL: |
3748f1e4 | 1836 | dprintk("RPC: %5u %s: proc %s unsupported by program %u, " |
46121cf7 | 1837 | "version %u on server %s\n", |
0dc47877 | 1838 | task->tk_pid, __func__, |
3748f1e4 | 1839 | rpc_proc_name(task), |
1da177e4 LT |
1840 | task->tk_client->cl_prog, |
1841 | task->tk_client->cl_vers, | |
1842 | task->tk_client->cl_server); | |
cdf47706 AG |
1843 | error = -EOPNOTSUPP; |
1844 | goto out_err; | |
1da177e4 | 1845 | case RPC_GARBAGE_ARGS: |
46121cf7 | 1846 | dprintk("RPC: %5u %s: server saw garbage\n", |
0dc47877 | 1847 | task->tk_pid, __func__); |
1da177e4 LT |
1848 | break; /* retry */ |
1849 | default: | |
8a702bbb | 1850 | dprintk("RPC: %5u %s: server accept status: %x\n", |
0dc47877 | 1851 | task->tk_pid, __func__, n); |
1da177e4 LT |
1852 | /* Also retry */ |
1853 | } | |
1854 | ||
abbcf28f | 1855 | out_garbage: |
1da177e4 LT |
1856 | task->tk_client->cl_stats->rpcgarbage++; |
1857 | if (task->tk_garb_retry) { | |
1858 | task->tk_garb_retry--; | |
46121cf7 | 1859 | dprintk("RPC: %5u %s: retrying\n", |
0dc47877 | 1860 | task->tk_pid, __func__); |
1da177e4 | 1861 | task->tk_action = call_bind; |
abbcf28f TM |
1862 | out_retry: |
1863 | return ERR_PTR(-EAGAIN); | |
1da177e4 | 1864 | } |
1da177e4 LT |
1865 | out_eio: |
1866 | error = -EIO; | |
1867 | out_err: | |
1868 | rpc_exit(task, error); | |
8a702bbb | 1869 | dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid, |
0dc47877 | 1870 | __func__, error); |
abbcf28f | 1871 | return ERR_PTR(error); |
1da177e4 | 1872 | out_overflow: |
8a702bbb | 1873 | dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid, |
0dc47877 | 1874 | __func__); |
abbcf28f | 1875 | goto out_garbage; |
1da177e4 | 1876 | } |
5ee0ed7d | 1877 | |
9f06c719 | 1878 | static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj) |
5ee0ed7d | 1879 | { |
5ee0ed7d TM |
1880 | } |
1881 | ||
bf269551 | 1882 | static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj) |
5ee0ed7d TM |
1883 | { |
1884 | return 0; | |
1885 | } | |
1886 | ||
1887 | static struct rpc_procinfo rpcproc_null = { | |
1888 | .p_encode = rpcproc_encode_null, | |
1889 | .p_decode = rpcproc_decode_null, | |
1890 | }; | |
1891 | ||
caabea8a | 1892 | static int rpc_ping(struct rpc_clnt *clnt) |
5ee0ed7d TM |
1893 | { |
1894 | struct rpc_message msg = { | |
1895 | .rpc_proc = &rpcproc_null, | |
1896 | }; | |
1897 | int err; | |
1898 | msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0); | |
caabea8a | 1899 | err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN); |
5ee0ed7d TM |
1900 | put_rpccred(msg.rpc_cred); |
1901 | return err; | |
1902 | } | |
188fef11 | 1903 | |
5e1550d6 TM |
1904 | struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags) |
1905 | { | |
1906 | struct rpc_message msg = { | |
1907 | .rpc_proc = &rpcproc_null, | |
1908 | .rpc_cred = cred, | |
1909 | }; | |
84115e1c TM |
1910 | struct rpc_task_setup task_setup_data = { |
1911 | .rpc_client = clnt, | |
1912 | .rpc_message = &msg, | |
1913 | .callback_ops = &rpc_default_ops, | |
1914 | .flags = flags, | |
1915 | }; | |
c970aa85 | 1916 | return rpc_run_task(&task_setup_data); |
5e1550d6 | 1917 | } |
e8914c65 | 1918 | EXPORT_SYMBOL_GPL(rpc_call_null); |
5e1550d6 | 1919 | |
188fef11 | 1920 | #ifdef RPC_DEBUG |
68a23ee9 CL |
1921 | static void rpc_show_header(void) |
1922 | { | |
cb3997b5 CL |
1923 | printk(KERN_INFO "-pid- flgs status -client- --rqstp- " |
1924 | "-timeout ---ops--\n"); | |
68a23ee9 CL |
1925 | } |
1926 | ||
38e886e0 CL |
1927 | static void rpc_show_task(const struct rpc_clnt *clnt, |
1928 | const struct rpc_task *task) | |
1929 | { | |
1930 | const char *rpc_waitq = "none"; | |
38e886e0 CL |
1931 | |
1932 | if (RPC_IS_QUEUED(task)) | |
1933 | rpc_waitq = rpc_qname(task->tk_waitqueue); | |
1934 | ||
b3bcedad | 1935 | printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n", |
cb3997b5 CL |
1936 | task->tk_pid, task->tk_flags, task->tk_status, |
1937 | clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops, | |
1938 | clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task), | |
b3bcedad | 1939 | task->tk_action, rpc_waitq); |
38e886e0 CL |
1940 | } |
1941 | ||
70abc49b | 1942 | void rpc_show_tasks(struct net *net) |
188fef11 TM |
1943 | { |
1944 | struct rpc_clnt *clnt; | |
38e886e0 | 1945 | struct rpc_task *task; |
68a23ee9 | 1946 | int header = 0; |
70abc49b | 1947 | struct sunrpc_net *sn = net_generic(net, sunrpc_net_id); |
188fef11 | 1948 | |
70abc49b SK |
1949 | spin_lock(&sn->rpc_client_lock); |
1950 | list_for_each_entry(clnt, &sn->all_clients, cl_clients) { | |
188fef11 | 1951 | spin_lock(&clnt->cl_lock); |
38e886e0 | 1952 | list_for_each_entry(task, &clnt->cl_tasks, tk_task) { |
68a23ee9 CL |
1953 | if (!header) { |
1954 | rpc_show_header(); | |
1955 | header++; | |
1956 | } | |
38e886e0 | 1957 | rpc_show_task(clnt, task); |
188fef11 TM |
1958 | } |
1959 | spin_unlock(&clnt->cl_lock); | |
1960 | } | |
70abc49b | 1961 | spin_unlock(&sn->rpc_client_lock); |
188fef11 TM |
1962 | } |
1963 | #endif |