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