2 * linux/net/sunrpc/clnt.c
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.
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.
16 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/kallsyms.h>
25 #include <linux/namei.h>
26 #include <linux/mount.h>
27 #include <linux/slab.h>
28 #include <linux/utsname.h>
29 #include <linux/workqueue.h>
31 #include <linux/in6.h>
33 #include <linux/rcupdate.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/addr.h>
37 #include <linux/sunrpc/rpc_pipe_fs.h>
38 #include <linux/sunrpc/metrics.h>
39 #include <linux/sunrpc/bc_xprt.h>
40 #include <trace/events/sunrpc.h>
46 # define RPCDBG_FACILITY RPCDBG_CALL
49 #define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
51 __func__, t->tk_status)
54 * All RPC clients are linked into this list
57 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
60 static void call_start(struct rpc_task
*task
);
61 static void call_reserve(struct rpc_task
*task
);
62 static void call_reserveresult(struct rpc_task
*task
);
63 static void call_allocate(struct rpc_task
*task
);
64 static void call_decode(struct rpc_task
*task
);
65 static void call_bind(struct rpc_task
*task
);
66 static void call_bind_status(struct rpc_task
*task
);
67 static void call_transmit(struct rpc_task
*task
);
68 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
69 static void call_bc_transmit(struct rpc_task
*task
);
70 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
71 static void call_status(struct rpc_task
*task
);
72 static void call_transmit_status(struct rpc_task
*task
);
73 static void call_refresh(struct rpc_task
*task
);
74 static void call_refreshresult(struct rpc_task
*task
);
75 static void call_timeout(struct rpc_task
*task
);
76 static void call_connect(struct rpc_task
*task
);
77 static void call_connect_status(struct rpc_task
*task
);
79 static __be32
*rpc_encode_header(struct rpc_task
*task
);
80 static __be32
*rpc_verify_header(struct rpc_task
*task
);
81 static int rpc_ping(struct rpc_clnt
*clnt
);
83 static void rpc_register_client(struct rpc_clnt
*clnt
)
85 struct net
*net
= rpc_net_ns(clnt
);
86 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
88 spin_lock(&sn
->rpc_client_lock
);
89 list_add(&clnt
->cl_clients
, &sn
->all_clients
);
90 spin_unlock(&sn
->rpc_client_lock
);
93 static void rpc_unregister_client(struct rpc_clnt
*clnt
)
95 struct net
*net
= rpc_net_ns(clnt
);
96 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
98 spin_lock(&sn
->rpc_client_lock
);
99 list_del(&clnt
->cl_clients
);
100 spin_unlock(&sn
->rpc_client_lock
);
103 static void __rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
105 if (clnt
->cl_dentry
) {
106 if (clnt
->cl_auth
&& clnt
->cl_auth
->au_ops
->pipes_destroy
)
107 clnt
->cl_auth
->au_ops
->pipes_destroy(clnt
->cl_auth
);
108 rpc_remove_client_dir(clnt
->cl_dentry
);
110 clnt
->cl_dentry
= NULL
;
113 static void rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
115 struct net
*net
= rpc_net_ns(clnt
);
116 struct super_block
*pipefs_sb
;
118 pipefs_sb
= rpc_get_sb_net(net
);
120 __rpc_clnt_remove_pipedir(clnt
);
125 static struct dentry
*rpc_setup_pipedir_sb(struct super_block
*sb
,
126 struct rpc_clnt
*clnt
,
127 const char *dir_name
)
129 static uint32_t clntid
;
131 struct dentry
*dir
, *dentry
;
133 dir
= rpc_d_lookup_sb(sb
, dir_name
);
135 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name
);
139 snprintf(name
, sizeof(name
), "clnt%x", (unsigned int)clntid
++);
140 name
[sizeof(name
) - 1] = '\0';
141 dentry
= rpc_create_client_dir(dir
, name
, clnt
);
144 if (dentry
== ERR_PTR(-EEXIST
))
146 printk(KERN_INFO
"RPC: Couldn't create pipefs entry"
147 " %s/%s, error %ld\n",
148 dir_name
, name
, PTR_ERR(dentry
));
156 rpc_setup_pipedir(struct rpc_clnt
*clnt
, const char *dir_name
,
157 struct super_block
*pipefs_sb
)
159 struct dentry
*dentry
;
161 clnt
->cl_dentry
= NULL
;
162 if (dir_name
== NULL
)
164 dentry
= rpc_setup_pipedir_sb(pipefs_sb
, clnt
, dir_name
);
166 return PTR_ERR(dentry
);
167 clnt
->cl_dentry
= dentry
;
171 static inline int rpc_clnt_skip_event(struct rpc_clnt
*clnt
, unsigned long event
)
173 if (((event
== RPC_PIPEFS_MOUNT
) && clnt
->cl_dentry
) ||
174 ((event
== RPC_PIPEFS_UMOUNT
) && !clnt
->cl_dentry
))
176 if ((event
== RPC_PIPEFS_MOUNT
) && atomic_read(&clnt
->cl_count
) == 0)
181 static int __rpc_clnt_handle_event(struct rpc_clnt
*clnt
, unsigned long event
,
182 struct super_block
*sb
)
184 struct dentry
*dentry
;
188 case RPC_PIPEFS_MOUNT
:
189 dentry
= rpc_setup_pipedir_sb(sb
, clnt
,
190 clnt
->cl_program
->pipe_dir_name
);
194 return PTR_ERR(dentry
);
195 clnt
->cl_dentry
= dentry
;
196 if (clnt
->cl_auth
->au_ops
->pipes_create
) {
197 err
= clnt
->cl_auth
->au_ops
->pipes_create(clnt
->cl_auth
);
199 __rpc_clnt_remove_pipedir(clnt
);
202 case RPC_PIPEFS_UMOUNT
:
203 __rpc_clnt_remove_pipedir(clnt
);
206 printk(KERN_ERR
"%s: unknown event: %ld\n", __func__
, event
);
212 static int __rpc_pipefs_event(struct rpc_clnt
*clnt
, unsigned long event
,
213 struct super_block
*sb
)
217 for (;; clnt
= clnt
->cl_parent
) {
218 if (!rpc_clnt_skip_event(clnt
, event
))
219 error
= __rpc_clnt_handle_event(clnt
, event
, sb
);
220 if (error
|| clnt
== clnt
->cl_parent
)
226 static struct rpc_clnt
*rpc_get_client_for_event(struct net
*net
, int event
)
228 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
229 struct rpc_clnt
*clnt
;
231 spin_lock(&sn
->rpc_client_lock
);
232 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
233 if (clnt
->cl_program
->pipe_dir_name
== NULL
)
235 if (rpc_clnt_skip_event(clnt
, event
))
237 spin_unlock(&sn
->rpc_client_lock
);
240 spin_unlock(&sn
->rpc_client_lock
);
244 static int rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
,
247 struct super_block
*sb
= ptr
;
248 struct rpc_clnt
*clnt
;
251 while ((clnt
= rpc_get_client_for_event(sb
->s_fs_info
, event
))) {
252 error
= __rpc_pipefs_event(clnt
, event
, sb
);
259 static struct notifier_block rpc_clients_block
= {
260 .notifier_call
= rpc_pipefs_event
,
261 .priority
= SUNRPC_PIPEFS_RPC_PRIO
,
264 int rpc_clients_notifier_register(void)
266 return rpc_pipefs_notifier_register(&rpc_clients_block
);
269 void rpc_clients_notifier_unregister(void)
271 return rpc_pipefs_notifier_unregister(&rpc_clients_block
);
274 static void rpc_clnt_set_nodename(struct rpc_clnt
*clnt
, const char *nodename
)
276 clnt
->cl_nodelen
= strlen(nodename
);
277 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
278 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
279 memcpy(clnt
->cl_nodename
, nodename
, clnt
->cl_nodelen
);
282 static int rpc_client_register(const struct rpc_create_args
*args
,
283 struct rpc_clnt
*clnt
)
285 const struct rpc_program
*program
= args
->program
;
286 struct rpc_auth
*auth
;
287 struct net
*net
= rpc_net_ns(clnt
);
288 struct super_block
*pipefs_sb
;
291 pipefs_sb
= rpc_get_sb_net(net
);
293 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
, pipefs_sb
);
298 rpc_register_client(clnt
);
302 auth
= rpcauth_create(args
->authflavor
, clnt
);
304 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
311 pipefs_sb
= rpc_get_sb_net(net
);
312 __rpc_clnt_remove_pipedir(clnt
);
319 static struct rpc_clnt
* rpc_new_client(const struct rpc_create_args
*args
, struct rpc_xprt
*xprt
)
321 const struct rpc_program
*program
= args
->program
;
322 const struct rpc_version
*version
;
323 struct rpc_clnt
*clnt
= NULL
;
326 /* sanity check the name before trying to print it */
327 dprintk("RPC: creating %s client for %s (xprt %p)\n",
328 program
->name
, args
->servername
, xprt
);
335 if (args
->version
>= program
->nrvers
)
337 version
= program
->version
[args
->version
];
342 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
345 clnt
->cl_parent
= clnt
;
347 rcu_assign_pointer(clnt
->cl_xprt
, xprt
);
348 clnt
->cl_procinfo
= version
->procs
;
349 clnt
->cl_maxproc
= version
->nrprocs
;
350 clnt
->cl_protname
= program
->name
;
351 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
352 clnt
->cl_vers
= version
->number
;
353 clnt
->cl_stats
= program
->stats
;
354 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
356 if (clnt
->cl_metrics
== NULL
)
358 clnt
->cl_program
= program
;
359 INIT_LIST_HEAD(&clnt
->cl_tasks
);
360 spin_lock_init(&clnt
->cl_lock
);
362 if (!xprt_bound(xprt
))
363 clnt
->cl_autobind
= 1;
365 clnt
->cl_timeout
= xprt
->timeout
;
366 if (args
->timeout
!= NULL
) {
367 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
368 sizeof(clnt
->cl_timeout_default
));
369 clnt
->cl_timeout
= &clnt
->cl_timeout_default
;
372 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
373 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
374 clnt
->cl_principal
= NULL
;
375 if (args
->client_name
) {
376 clnt
->cl_principal
= kstrdup(args
->client_name
, GFP_KERNEL
);
377 if (!clnt
->cl_principal
)
378 goto out_no_principal
;
381 atomic_set(&clnt
->cl_count
, 1);
383 /* save the nodename */
384 rpc_clnt_set_nodename(clnt
, utsname()->nodename
);
386 err
= rpc_client_register(args
, clnt
);
392 kfree(clnt
->cl_principal
);
394 rpc_free_iostats(clnt
->cl_metrics
);
405 * rpc_create - create an RPC client and transport with one call
406 * @args: rpc_clnt create argument structure
408 * Creates and initializes an RPC transport and an RPC client.
410 * It can ping the server in order to determine if it is up, and to see if
411 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
412 * this behavior so asynchronous tasks can also use rpc_create.
414 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
416 struct rpc_xprt
*xprt
;
417 struct rpc_clnt
*clnt
;
418 struct xprt_create xprtargs
= {
420 .ident
= args
->protocol
,
421 .srcaddr
= args
->saddress
,
422 .dstaddr
= args
->address
,
423 .addrlen
= args
->addrsize
,
424 .servername
= args
->servername
,
425 .bc_xprt
= args
->bc_xprt
,
429 if (args
->flags
& RPC_CLNT_CREATE_INFINITE_SLOTS
)
430 xprtargs
.flags
|= XPRT_CREATE_INFINITE_SLOTS
;
431 if (args
->flags
& RPC_CLNT_CREATE_NO_IDLE_TIMEOUT
)
432 xprtargs
.flags
|= XPRT_CREATE_NO_IDLE_TIMEOUT
;
434 * If the caller chooses not to specify a hostname, whip
435 * up a string representation of the passed-in address.
437 if (xprtargs
.servername
== NULL
) {
438 struct sockaddr_un
*sun
=
439 (struct sockaddr_un
*)args
->address
;
440 struct sockaddr_in
*sin
=
441 (struct sockaddr_in
*)args
->address
;
442 struct sockaddr_in6
*sin6
=
443 (struct sockaddr_in6
*)args
->address
;
445 servername
[0] = '\0';
446 switch (args
->address
->sa_family
) {
448 snprintf(servername
, sizeof(servername
), "%s",
452 snprintf(servername
, sizeof(servername
), "%pI4",
453 &sin
->sin_addr
.s_addr
);
456 snprintf(servername
, sizeof(servername
), "%pI6",
460 /* caller wants default server name, but
461 * address family isn't recognized. */
462 return ERR_PTR(-EINVAL
);
464 xprtargs
.servername
= servername
;
467 xprt
= xprt_create_transport(&xprtargs
);
469 return (struct rpc_clnt
*)xprt
;
472 * By default, kernel RPC client connects from a reserved port.
473 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
474 * but it is always enabled for rpciod, which handles the connect
478 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
481 clnt
= rpc_new_client(args
, xprt
);
485 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
486 int err
= rpc_ping(clnt
);
488 rpc_shutdown_client(clnt
);
493 clnt
->cl_softrtry
= 1;
494 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
495 clnt
->cl_softrtry
= 0;
497 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
498 clnt
->cl_autobind
= 1;
499 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
500 clnt
->cl_discrtry
= 1;
501 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
506 EXPORT_SYMBOL_GPL(rpc_create
);
509 * This function clones the RPC client structure. It allows us to share the
510 * same transport while varying parameters such as the authentication
513 static struct rpc_clnt
*__rpc_clone_client(struct rpc_create_args
*args
,
514 struct rpc_clnt
*clnt
)
516 struct rpc_xprt
*xprt
;
517 struct rpc_clnt
*new;
522 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
526 args
->servername
= xprt
->servername
;
528 new = rpc_new_client(args
, xprt
);
534 atomic_inc(&clnt
->cl_count
);
535 new->cl_parent
= clnt
;
537 /* Turn off autobind on clones */
538 new->cl_autobind
= 0;
539 new->cl_softrtry
= clnt
->cl_softrtry
;
540 new->cl_discrtry
= clnt
->cl_discrtry
;
541 new->cl_chatty
= clnt
->cl_chatty
;
545 dprintk("RPC: %s: returned error %d\n", __func__
, err
);
550 * rpc_clone_client - Clone an RPC client structure
552 * @clnt: RPC client whose parameters are copied
554 * Returns a fresh RPC client or an ERR_PTR.
556 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*clnt
)
558 struct rpc_create_args args
= {
559 .program
= clnt
->cl_program
,
560 .prognumber
= clnt
->cl_prog
,
561 .version
= clnt
->cl_vers
,
562 .authflavor
= clnt
->cl_auth
->au_flavor
,
563 .client_name
= clnt
->cl_principal
,
565 return __rpc_clone_client(&args
, clnt
);
567 EXPORT_SYMBOL_GPL(rpc_clone_client
);
570 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
572 * @clnt: RPC client whose parameters are copied
573 * @flavor: security flavor for new client
575 * Returns a fresh RPC client or an ERR_PTR.
578 rpc_clone_client_set_auth(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
580 struct rpc_create_args args
= {
581 .program
= clnt
->cl_program
,
582 .prognumber
= clnt
->cl_prog
,
583 .version
= clnt
->cl_vers
,
584 .authflavor
= flavor
,
585 .client_name
= clnt
->cl_principal
,
587 return __rpc_clone_client(&args
, clnt
);
589 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth
);
592 * Kill all tasks for the given client.
593 * XXX: kill their descendants as well?
595 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
597 struct rpc_task
*rovr
;
600 if (list_empty(&clnt
->cl_tasks
))
602 dprintk("RPC: killing all tasks for client %p\n", clnt
);
604 * Spin lock all_tasks to prevent changes...
606 spin_lock(&clnt
->cl_lock
);
607 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
) {
608 if (!RPC_IS_ACTIVATED(rovr
))
610 if (!(rovr
->tk_flags
& RPC_TASK_KILLED
)) {
611 rovr
->tk_flags
|= RPC_TASK_KILLED
;
612 rpc_exit(rovr
, -EIO
);
613 if (RPC_IS_QUEUED(rovr
))
614 rpc_wake_up_queued_task(rovr
->tk_waitqueue
,
618 spin_unlock(&clnt
->cl_lock
);
620 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
623 * Properly shut down an RPC client, terminating all outstanding
626 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
630 dprintk_rcu("RPC: shutting down %s client for %s\n",
632 rcu_dereference(clnt
->cl_xprt
)->servername
);
634 while (!list_empty(&clnt
->cl_tasks
)) {
635 rpc_killall_tasks(clnt
);
636 wait_event_timeout(destroy_wait
,
637 list_empty(&clnt
->cl_tasks
), 1*HZ
);
640 rpc_release_client(clnt
);
642 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
648 rpc_free_client(struct rpc_clnt
*clnt
)
650 dprintk_rcu("RPC: destroying %s client for %s\n",
652 rcu_dereference(clnt
->cl_xprt
)->servername
);
653 if (clnt
->cl_parent
!= clnt
)
654 rpc_release_client(clnt
->cl_parent
);
655 rpc_clnt_remove_pipedir(clnt
);
656 rpc_unregister_client(clnt
);
657 rpc_free_iostats(clnt
->cl_metrics
);
658 kfree(clnt
->cl_principal
);
659 clnt
->cl_metrics
= NULL
;
660 xprt_put(rcu_dereference_raw(clnt
->cl_xprt
));
669 rpc_free_auth(struct rpc_clnt
*clnt
)
671 if (clnt
->cl_auth
== NULL
) {
672 rpc_free_client(clnt
);
677 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
678 * release remaining GSS contexts. This mechanism ensures
679 * that it can do so safely.
681 atomic_inc(&clnt
->cl_count
);
682 rpcauth_release(clnt
->cl_auth
);
683 clnt
->cl_auth
= NULL
;
684 if (atomic_dec_and_test(&clnt
->cl_count
))
685 rpc_free_client(clnt
);
689 * Release reference to the RPC client
692 rpc_release_client(struct rpc_clnt
*clnt
)
694 dprintk("RPC: rpc_release_client(%p)\n", clnt
);
696 if (list_empty(&clnt
->cl_tasks
))
697 wake_up(&destroy_wait
);
698 if (atomic_dec_and_test(&clnt
->cl_count
))
701 EXPORT_SYMBOL_GPL(rpc_release_client
);
704 * rpc_bind_new_program - bind a new RPC program to an existing client
705 * @old: old rpc_client
706 * @program: rpc program to set
707 * @vers: rpc program version
709 * Clones the rpc client and sets up a new RPC program. This is mainly
710 * of use for enabling different RPC programs to share the same transport.
711 * The Sun NFSv2/v3 ACL protocol can do this.
713 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
714 const struct rpc_program
*program
,
717 struct rpc_create_args args
= {
719 .prognumber
= program
->number
,
721 .authflavor
= old
->cl_auth
->au_flavor
,
722 .client_name
= old
->cl_principal
,
724 struct rpc_clnt
*clnt
;
727 clnt
= __rpc_clone_client(&args
, old
);
730 err
= rpc_ping(clnt
);
732 rpc_shutdown_client(clnt
);
738 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
740 void rpc_task_release_client(struct rpc_task
*task
)
742 struct rpc_clnt
*clnt
= task
->tk_client
;
745 /* Remove from client task list */
746 spin_lock(&clnt
->cl_lock
);
747 list_del(&task
->tk_task
);
748 spin_unlock(&clnt
->cl_lock
);
749 task
->tk_client
= NULL
;
751 rpc_release_client(clnt
);
756 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
759 rpc_task_release_client(task
);
760 task
->tk_client
= clnt
;
761 atomic_inc(&clnt
->cl_count
);
762 if (clnt
->cl_softrtry
)
763 task
->tk_flags
|= RPC_TASK_SOFT
;
764 if (sk_memalloc_socks()) {
765 struct rpc_xprt
*xprt
;
768 xprt
= rcu_dereference(clnt
->cl_xprt
);
770 task
->tk_flags
|= RPC_TASK_SWAPPER
;
773 /* Add to the client's list of all tasks */
774 spin_lock(&clnt
->cl_lock
);
775 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
776 spin_unlock(&clnt
->cl_lock
);
780 void rpc_task_reset_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
782 rpc_task_release_client(task
);
783 rpc_task_set_client(task
, clnt
);
785 EXPORT_SYMBOL_GPL(rpc_task_reset_client
);
789 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
792 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
793 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
794 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
795 if (msg
->rpc_cred
!= NULL
)
796 task
->tk_msg
.rpc_cred
= get_rpccred(msg
->rpc_cred
);
801 * Default callback for async RPC calls
804 rpc_default_callback(struct rpc_task
*task
, void *data
)
808 static const struct rpc_call_ops rpc_default_ops
= {
809 .rpc_call_done
= rpc_default_callback
,
813 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
814 * @task_setup_data: pointer to task initialisation data
816 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
818 struct rpc_task
*task
;
820 task
= rpc_new_task(task_setup_data
);
824 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
825 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
827 if (task
->tk_action
== NULL
)
828 rpc_call_start(task
);
830 atomic_inc(&task
->tk_count
);
835 EXPORT_SYMBOL_GPL(rpc_run_task
);
838 * rpc_call_sync - Perform a synchronous RPC call
839 * @clnt: pointer to RPC client
840 * @msg: RPC call parameters
841 * @flags: RPC call flags
843 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
845 struct rpc_task
*task
;
846 struct rpc_task_setup task_setup_data
= {
849 .callback_ops
= &rpc_default_ops
,
854 WARN_ON_ONCE(flags
& RPC_TASK_ASYNC
);
855 if (flags
& RPC_TASK_ASYNC
) {
856 rpc_release_calldata(task_setup_data
.callback_ops
,
857 task_setup_data
.callback_data
);
861 task
= rpc_run_task(&task_setup_data
);
863 return PTR_ERR(task
);
864 status
= task
->tk_status
;
868 EXPORT_SYMBOL_GPL(rpc_call_sync
);
871 * rpc_call_async - Perform an asynchronous RPC call
872 * @clnt: pointer to RPC client
873 * @msg: RPC call parameters
874 * @flags: RPC call flags
875 * @tk_ops: RPC call ops
876 * @data: user call data
879 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
880 const struct rpc_call_ops
*tk_ops
, void *data
)
882 struct rpc_task
*task
;
883 struct rpc_task_setup task_setup_data
= {
886 .callback_ops
= tk_ops
,
887 .callback_data
= data
,
888 .flags
= flags
|RPC_TASK_ASYNC
,
891 task
= rpc_run_task(&task_setup_data
);
893 return PTR_ERR(task
);
897 EXPORT_SYMBOL_GPL(rpc_call_async
);
899 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
901 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
902 * rpc_execute against it
904 * @tk_ops: RPC call ops
906 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
,
907 const struct rpc_call_ops
*tk_ops
)
909 struct rpc_task
*task
;
910 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
911 struct rpc_task_setup task_setup_data
= {
912 .callback_ops
= tk_ops
,
915 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
917 * Create an rpc_task to send the data
919 task
= rpc_new_task(&task_setup_data
);
921 xprt_free_bc_request(req
);
924 task
->tk_rqstp
= req
;
927 * Set up the xdr_buf length.
928 * This also indicates that the buffer is XDR encoded already.
930 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
931 xbufp
->tail
[0].iov_len
;
933 task
->tk_action
= call_bc_transmit
;
934 atomic_inc(&task
->tk_count
);
935 WARN_ON_ONCE(atomic_read(&task
->tk_count
) != 2);
939 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
942 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
945 rpc_call_start(struct rpc_task
*task
)
947 task
->tk_action
= call_start
;
949 EXPORT_SYMBOL_GPL(rpc_call_start
);
952 * rpc_peeraddr - extract remote peer address from clnt's xprt
953 * @clnt: RPC client structure
954 * @buf: target buffer
955 * @bufsize: length of target buffer
957 * Returns the number of bytes that are actually in the stored address.
959 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
962 struct rpc_xprt
*xprt
;
965 xprt
= rcu_dereference(clnt
->cl_xprt
);
967 bytes
= xprt
->addrlen
;
970 memcpy(buf
, &xprt
->addr
, bytes
);
975 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
978 * rpc_peeraddr2str - return remote peer address in printable format
979 * @clnt: RPC client structure
980 * @format: address format
982 * NB: the lifetime of the memory referenced by the returned pointer is
983 * the same as the rpc_xprt itself. As long as the caller uses this
984 * pointer, it must hold the RCU read lock.
986 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
987 enum rpc_display_format_t format
)
989 struct rpc_xprt
*xprt
;
991 xprt
= rcu_dereference(clnt
->cl_xprt
);
993 if (xprt
->address_strings
[format
] != NULL
)
994 return xprt
->address_strings
[format
];
996 return "unprintable";
998 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
1000 static const struct sockaddr_in rpc_inaddr_loopback
= {
1001 .sin_family
= AF_INET
,
1002 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
1005 static const struct sockaddr_in6 rpc_in6addr_loopback
= {
1006 .sin6_family
= AF_INET6
,
1007 .sin6_addr
= IN6ADDR_ANY_INIT
,
1011 * Try a getsockname() on a connected datagram socket. Using a
1012 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1013 * This conserves the ephemeral port number space.
1015 * Returns zero and fills in "buf" if successful; otherwise, a
1016 * negative errno is returned.
1018 static int rpc_sockname(struct net
*net
, struct sockaddr
*sap
, size_t salen
,
1019 struct sockaddr
*buf
, int buflen
)
1021 struct socket
*sock
;
1024 err
= __sock_create(net
, sap
->sa_family
,
1025 SOCK_DGRAM
, IPPROTO_UDP
, &sock
, 1);
1027 dprintk("RPC: can't create UDP socket (%d)\n", err
);
1031 switch (sap
->sa_family
) {
1033 err
= kernel_bind(sock
,
1034 (struct sockaddr
*)&rpc_inaddr_loopback
,
1035 sizeof(rpc_inaddr_loopback
));
1038 err
= kernel_bind(sock
,
1039 (struct sockaddr
*)&rpc_in6addr_loopback
,
1040 sizeof(rpc_in6addr_loopback
));
1043 err
= -EAFNOSUPPORT
;
1047 dprintk("RPC: can't bind UDP socket (%d)\n", err
);
1051 err
= kernel_connect(sock
, sap
, salen
, 0);
1053 dprintk("RPC: can't connect UDP socket (%d)\n", err
);
1057 err
= kernel_getsockname(sock
, buf
, &buflen
);
1059 dprintk("RPC: getsockname failed (%d)\n", err
);
1064 if (buf
->sa_family
== AF_INET6
) {
1065 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)buf
;
1066 sin6
->sin6_scope_id
= 0;
1068 dprintk("RPC: %s succeeded\n", __func__
);
1077 * Scraping a connected socket failed, so we don't have a useable
1078 * local address. Fallback: generate an address that will prevent
1079 * the server from calling us back.
1081 * Returns zero and fills in "buf" if successful; otherwise, a
1082 * negative errno is returned.
1084 static int rpc_anyaddr(int family
, struct sockaddr
*buf
, size_t buflen
)
1088 if (buflen
< sizeof(rpc_inaddr_loopback
))
1090 memcpy(buf
, &rpc_inaddr_loopback
,
1091 sizeof(rpc_inaddr_loopback
));
1094 if (buflen
< sizeof(rpc_in6addr_loopback
))
1096 memcpy(buf
, &rpc_in6addr_loopback
,
1097 sizeof(rpc_in6addr_loopback
));
1099 dprintk("RPC: %s: address family not supported\n",
1101 return -EAFNOSUPPORT
;
1103 dprintk("RPC: %s: succeeded\n", __func__
);
1108 * rpc_localaddr - discover local endpoint address for an RPC client
1109 * @clnt: RPC client structure
1110 * @buf: target buffer
1111 * @buflen: size of target buffer, in bytes
1113 * Returns zero and fills in "buf" and "buflen" if successful;
1114 * otherwise, a negative errno is returned.
1116 * This works even if the underlying transport is not currently connected,
1117 * or if the upper layer never previously provided a source address.
1119 * The result of this function call is transient: multiple calls in
1120 * succession may give different results, depending on how local
1121 * networking configuration changes over time.
1123 int rpc_localaddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t buflen
)
1125 struct sockaddr_storage address
;
1126 struct sockaddr
*sap
= (struct sockaddr
*)&address
;
1127 struct rpc_xprt
*xprt
;
1133 xprt
= rcu_dereference(clnt
->cl_xprt
);
1134 salen
= xprt
->addrlen
;
1135 memcpy(sap
, &xprt
->addr
, salen
);
1136 net
= get_net(xprt
->xprt_net
);
1139 rpc_set_port(sap
, 0);
1140 err
= rpc_sockname(net
, sap
, salen
, buf
, buflen
);
1143 /* Couldn't discover local address, return ANYADDR */
1144 return rpc_anyaddr(sap
->sa_family
, buf
, buflen
);
1147 EXPORT_SYMBOL_GPL(rpc_localaddr
);
1150 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
1152 struct rpc_xprt
*xprt
;
1155 xprt
= rcu_dereference(clnt
->cl_xprt
);
1156 if (xprt
->ops
->set_buffer_size
)
1157 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
1160 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
1163 * rpc_protocol - Get transport protocol number for an RPC client
1164 * @clnt: RPC client to query
1167 int rpc_protocol(struct rpc_clnt
*clnt
)
1172 protocol
= rcu_dereference(clnt
->cl_xprt
)->prot
;
1176 EXPORT_SYMBOL_GPL(rpc_protocol
);
1179 * rpc_net_ns - Get the network namespace for this RPC client
1180 * @clnt: RPC client to query
1183 struct net
*rpc_net_ns(struct rpc_clnt
*clnt
)
1188 ret
= rcu_dereference(clnt
->cl_xprt
)->xprt_net
;
1192 EXPORT_SYMBOL_GPL(rpc_net_ns
);
1195 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1196 * @clnt: RPC client to query
1198 * For stream transports, this is one RPC record fragment (see RFC
1199 * 1831), as we don't support multi-record requests yet. For datagram
1200 * transports, this is the size of an IP packet minus the IP, UDP, and
1203 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
1208 ret
= rcu_dereference(clnt
->cl_xprt
)->max_payload
;
1212 EXPORT_SYMBOL_GPL(rpc_max_payload
);
1215 * rpc_get_timeout - Get timeout for transport in units of HZ
1216 * @clnt: RPC client to query
1218 unsigned long rpc_get_timeout(struct rpc_clnt
*clnt
)
1223 ret
= rcu_dereference(clnt
->cl_xprt
)->timeout
->to_initval
;
1227 EXPORT_SYMBOL_GPL(rpc_get_timeout
);
1230 * rpc_force_rebind - force transport to check that remote port is unchanged
1231 * @clnt: client to rebind
1234 void rpc_force_rebind(struct rpc_clnt
*clnt
)
1236 if (clnt
->cl_autobind
) {
1238 xprt_clear_bound(rcu_dereference(clnt
->cl_xprt
));
1242 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
1245 * Restart an (async) RPC call from the call_prepare state.
1246 * Usually called from within the exit handler.
1249 rpc_restart_call_prepare(struct rpc_task
*task
)
1251 if (RPC_ASSASSINATED(task
))
1253 task
->tk_action
= call_start
;
1254 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1255 task
->tk_action
= rpc_prepare_task
;
1258 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
1261 * Restart an (async) RPC call. Usually called from within the
1265 rpc_restart_call(struct rpc_task
*task
)
1267 if (RPC_ASSASSINATED(task
))
1269 task
->tk_action
= call_start
;
1272 EXPORT_SYMBOL_GPL(rpc_restart_call
);
1275 static const char *rpc_proc_name(const struct rpc_task
*task
)
1277 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1281 return proc
->p_name
;
1292 * Other FSM states can be visited zero or more times, but
1293 * this state is visited exactly once for each RPC.
1296 call_start(struct rpc_task
*task
)
1298 struct rpc_clnt
*clnt
= task
->tk_client
;
1300 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task
->tk_pid
,
1301 clnt
->cl_protname
, clnt
->cl_vers
,
1302 rpc_proc_name(task
),
1303 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
1305 /* Increment call count */
1306 task
->tk_msg
.rpc_proc
->p_count
++;
1307 clnt
->cl_stats
->rpccnt
++;
1308 task
->tk_action
= call_reserve
;
1312 * 1. Reserve an RPC call slot
1315 call_reserve(struct rpc_task
*task
)
1317 dprint_status(task
);
1319 task
->tk_status
= 0;
1320 task
->tk_action
= call_reserveresult
;
1324 static void call_retry_reserve(struct rpc_task
*task
);
1327 * 1b. Grok the result of xprt_reserve()
1330 call_reserveresult(struct rpc_task
*task
)
1332 int status
= task
->tk_status
;
1334 dprint_status(task
);
1337 * After a call to xprt_reserve(), we must have either
1338 * a request slot or else an error status.
1340 task
->tk_status
= 0;
1342 if (task
->tk_rqstp
) {
1343 task
->tk_action
= call_refresh
;
1347 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
1349 rpc_exit(task
, -EIO
);
1354 * Even though there was an error, we may have acquired
1355 * a request slot somehow. Make sure not to leak it.
1357 if (task
->tk_rqstp
) {
1358 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
1365 rpc_delay(task
, HZ
>> 2);
1366 case -EAGAIN
: /* woken up; retry */
1367 task
->tk_action
= call_retry_reserve
;
1369 case -EIO
: /* probably a shutdown */
1372 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
1376 rpc_exit(task
, status
);
1380 * 1c. Retry reserving an RPC call slot
1383 call_retry_reserve(struct rpc_task
*task
)
1385 dprint_status(task
);
1387 task
->tk_status
= 0;
1388 task
->tk_action
= call_reserveresult
;
1389 xprt_retry_reserve(task
);
1393 * 2. Bind and/or refresh the credentials
1396 call_refresh(struct rpc_task
*task
)
1398 dprint_status(task
);
1400 task
->tk_action
= call_refreshresult
;
1401 task
->tk_status
= 0;
1402 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1403 rpcauth_refreshcred(task
);
1407 * 2a. Process the results of a credential refresh
1410 call_refreshresult(struct rpc_task
*task
)
1412 int status
= task
->tk_status
;
1414 dprint_status(task
);
1416 task
->tk_status
= 0;
1417 task
->tk_action
= call_refresh
;
1420 if (rpcauth_uptodatecred(task
))
1421 task
->tk_action
= call_allocate
;
1424 rpc_delay(task
, 3*HZ
);
1428 if (!task
->tk_cred_retry
)
1430 task
->tk_cred_retry
--;
1431 dprintk("RPC: %5u %s: retry refresh creds\n",
1432 task
->tk_pid
, __func__
);
1435 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1436 task
->tk_pid
, __func__
, status
);
1437 rpc_exit(task
, status
);
1441 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1442 * (Note: buffer memory is freed in xprt_release).
1445 call_allocate(struct rpc_task
*task
)
1447 unsigned int slack
= task
->tk_rqstp
->rq_cred
->cr_auth
->au_cslack
;
1448 struct rpc_rqst
*req
= task
->tk_rqstp
;
1449 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1450 struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1452 dprint_status(task
);
1454 task
->tk_status
= 0;
1455 task
->tk_action
= call_bind
;
1460 if (proc
->p_proc
!= 0) {
1461 BUG_ON(proc
->p_arglen
== 0);
1462 if (proc
->p_decode
!= NULL
)
1463 BUG_ON(proc
->p_replen
== 0);
1467 * Calculate the size (in quads) of the RPC call
1468 * and reply headers, and convert both values
1471 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (slack
<< 1) + proc
->p_arglen
;
1472 req
->rq_callsize
<<= 2;
1473 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ slack
+ proc
->p_replen
;
1474 req
->rq_rcvsize
<<= 2;
1476 req
->rq_buffer
= xprt
->ops
->buf_alloc(task
,
1477 req
->rq_callsize
+ req
->rq_rcvsize
);
1478 if (req
->rq_buffer
!= NULL
)
1481 dprintk("RPC: %5u rpc_buffer allocation failed\n", task
->tk_pid
);
1483 if (RPC_IS_ASYNC(task
) || !fatal_signal_pending(current
)) {
1484 task
->tk_action
= call_allocate
;
1485 rpc_delay(task
, HZ
>>4);
1489 rpc_exit(task
, -ERESTARTSYS
);
1493 rpc_task_need_encode(struct rpc_task
*task
)
1495 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
1499 rpc_task_force_reencode(struct rpc_task
*task
)
1501 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
1502 task
->tk_rqstp
->rq_bytes_sent
= 0;
1506 rpc_xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
1508 buf
->head
[0].iov_base
= start
;
1509 buf
->head
[0].iov_len
= len
;
1510 buf
->tail
[0].iov_len
= 0;
1518 * 3. Encode arguments of an RPC call
1521 rpc_xdr_encode(struct rpc_task
*task
)
1523 struct rpc_rqst
*req
= task
->tk_rqstp
;
1527 dprint_status(task
);
1529 rpc_xdr_buf_init(&req
->rq_snd_buf
,
1532 rpc_xdr_buf_init(&req
->rq_rcv_buf
,
1533 (char *)req
->rq_buffer
+ req
->rq_callsize
,
1536 p
= rpc_encode_header(task
);
1538 printk(KERN_INFO
"RPC: couldn't encode RPC header, exit EIO\n");
1539 rpc_exit(task
, -EIO
);
1543 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
1547 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
1548 task
->tk_msg
.rpc_argp
);
1552 * 4. Get the server port number if not yet set
1555 call_bind(struct rpc_task
*task
)
1557 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1559 dprint_status(task
);
1561 task
->tk_action
= call_connect
;
1562 if (!xprt_bound(xprt
)) {
1563 task
->tk_action
= call_bind_status
;
1564 task
->tk_timeout
= xprt
->bind_timeout
;
1565 xprt
->ops
->rpcbind(task
);
1570 * 4a. Sort out bind result
1573 call_bind_status(struct rpc_task
*task
)
1577 if (task
->tk_status
>= 0) {
1578 dprint_status(task
);
1579 task
->tk_status
= 0;
1580 task
->tk_action
= call_connect
;
1584 trace_rpc_bind_status(task
);
1585 switch (task
->tk_status
) {
1587 dprintk("RPC: %5u rpcbind out of memory\n", task
->tk_pid
);
1588 rpc_delay(task
, HZ
>> 2);
1591 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1592 "unavailable\n", task
->tk_pid
);
1593 /* fail immediately if this is an RPC ping */
1594 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1595 status
= -EOPNOTSUPP
;
1598 if (task
->tk_rebind_retry
== 0)
1600 task
->tk_rebind_retry
--;
1601 rpc_delay(task
, 3*HZ
);
1604 dprintk("RPC: %5u rpcbind request timed out\n",
1608 /* server doesn't support any rpcbind version we know of */
1609 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1612 case -EPROTONOSUPPORT
:
1613 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1615 task
->tk_status
= 0;
1616 task
->tk_action
= call_bind
;
1618 case -ECONNREFUSED
: /* connection problems */
1625 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1626 task
->tk_pid
, task
->tk_status
);
1627 if (!RPC_IS_SOFTCONN(task
)) {
1628 rpc_delay(task
, 5*HZ
);
1631 status
= task
->tk_status
;
1634 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1635 task
->tk_pid
, -task
->tk_status
);
1638 rpc_exit(task
, status
);
1642 task
->tk_action
= call_timeout
;
1646 * 4b. Connect to the RPC server
1649 call_connect(struct rpc_task
*task
)
1651 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1653 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1655 (xprt_connected(xprt
) ? "is" : "is not"));
1657 task
->tk_action
= call_transmit
;
1658 if (!xprt_connected(xprt
)) {
1659 task
->tk_action
= call_connect_status
;
1660 if (task
->tk_status
< 0)
1667 * 4c. Sort out connect result
1670 call_connect_status(struct rpc_task
*task
)
1672 struct rpc_clnt
*clnt
= task
->tk_client
;
1673 int status
= task
->tk_status
;
1675 dprint_status(task
);
1677 trace_rpc_connect_status(task
, status
);
1679 /* if soft mounted, test if we've timed out */
1681 task
->tk_action
= call_timeout
;
1686 if (RPC_IS_SOFTCONN(task
))
1688 /* retry with existing socket, after a delay */
1691 task
->tk_status
= 0;
1692 clnt
->cl_stats
->netreconn
++;
1693 task
->tk_action
= call_transmit
;
1696 rpc_exit(task
, status
);
1700 * 5. Transmit the RPC request, and wait for reply
1703 call_transmit(struct rpc_task
*task
)
1705 dprint_status(task
);
1707 task
->tk_action
= call_status
;
1708 if (task
->tk_status
< 0)
1710 task
->tk_status
= xprt_prepare_transmit(task
);
1711 if (task
->tk_status
!= 0)
1713 task
->tk_action
= call_transmit_status
;
1714 /* Encode here so that rpcsec_gss can use correct sequence number. */
1715 if (rpc_task_need_encode(task
)) {
1716 rpc_xdr_encode(task
);
1717 /* Did the encode result in an error condition? */
1718 if (task
->tk_status
!= 0) {
1719 /* Was the error nonfatal? */
1720 if (task
->tk_status
== -EAGAIN
)
1721 rpc_delay(task
, HZ
>> 4);
1723 rpc_exit(task
, task
->tk_status
);
1727 xprt_transmit(task
);
1728 if (task
->tk_status
< 0)
1731 * On success, ensure that we call xprt_end_transmit() before sleeping
1732 * in order to allow access to the socket to other RPC requests.
1734 call_transmit_status(task
);
1735 if (rpc_reply_expected(task
))
1737 task
->tk_action
= rpc_exit_task
;
1738 rpc_wake_up_queued_task(&task
->tk_rqstp
->rq_xprt
->pending
, task
);
1742 * 5a. Handle cleanup after a transmission
1745 call_transmit_status(struct rpc_task
*task
)
1747 task
->tk_action
= call_status
;
1750 * Common case: success. Force the compiler to put this
1753 if (task
->tk_status
== 0) {
1754 xprt_end_transmit(task
);
1755 rpc_task_force_reencode(task
);
1759 switch (task
->tk_status
) {
1763 dprint_status(task
);
1764 xprt_end_transmit(task
);
1765 rpc_task_force_reencode(task
);
1768 * Special cases: if we've been waiting on the
1769 * socket's write_space() callback, or if the
1770 * socket just returned a connection error,
1771 * then hold onto the transport lock.
1777 if (RPC_IS_SOFTCONN(task
)) {
1778 xprt_end_transmit(task
);
1779 rpc_exit(task
, task
->tk_status
);
1785 rpc_task_force_reencode(task
);
1789 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1791 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1792 * addition, disconnect on connectivity errors.
1795 call_bc_transmit(struct rpc_task
*task
)
1797 struct rpc_rqst
*req
= task
->tk_rqstp
;
1799 task
->tk_status
= xprt_prepare_transmit(task
);
1800 if (task
->tk_status
== -EAGAIN
) {
1802 * Could not reserve the transport. Try again after the
1803 * transport is released.
1805 task
->tk_status
= 0;
1806 task
->tk_action
= call_bc_transmit
;
1810 task
->tk_action
= rpc_exit_task
;
1811 if (task
->tk_status
< 0) {
1812 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1813 "error: %d\n", task
->tk_status
);
1817 xprt_transmit(task
);
1818 xprt_end_transmit(task
);
1819 dprint_status(task
);
1820 switch (task
->tk_status
) {
1829 * Problem reaching the server. Disconnect and let the
1830 * forechannel reestablish the connection. The server will
1831 * have to retransmit the backchannel request and we'll
1832 * reprocess it. Since these ops are idempotent, there's no
1833 * need to cache our reply at this time.
1835 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1836 "error: %d\n", task
->tk_status
);
1837 xprt_conditional_disconnect(req
->rq_xprt
,
1838 req
->rq_connect_cookie
);
1842 * We were unable to reply and will have to drop the
1843 * request. The server should reconnect and retransmit.
1845 WARN_ON_ONCE(task
->tk_status
== -EAGAIN
);
1846 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1847 "error: %d\n", task
->tk_status
);
1850 rpc_wake_up_queued_task(&req
->rq_xprt
->pending
, task
);
1852 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1855 * 6. Sort out the RPC call status
1858 call_status(struct rpc_task
*task
)
1860 struct rpc_clnt
*clnt
= task
->tk_client
;
1861 struct rpc_rqst
*req
= task
->tk_rqstp
;
1864 if (req
->rq_reply_bytes_recvd
> 0 && !req
->rq_bytes_sent
)
1865 task
->tk_status
= req
->rq_reply_bytes_recvd
;
1867 dprint_status(task
);
1869 status
= task
->tk_status
;
1871 task
->tk_action
= call_decode
;
1875 trace_rpc_call_status(task
);
1876 task
->tk_status
= 0;
1882 * Delay any retries for 3 seconds, then handle as if it
1885 rpc_delay(task
, 3*HZ
);
1887 task
->tk_action
= call_timeout
;
1888 if (task
->tk_client
->cl_discrtry
)
1889 xprt_conditional_disconnect(req
->rq_xprt
,
1890 req
->rq_connect_cookie
);
1894 rpc_force_rebind(clnt
);
1895 rpc_delay(task
, 3*HZ
);
1898 task
->tk_action
= call_bind
;
1901 task
->tk_action
= call_transmit
;
1904 /* shutdown or soft timeout */
1905 rpc_exit(task
, status
);
1908 if (clnt
->cl_chatty
)
1909 printk("%s: RPC call returned error %d\n",
1910 clnt
->cl_protname
, -status
);
1911 rpc_exit(task
, status
);
1916 * 6a. Handle RPC timeout
1917 * We do not release the request slot, so we keep using the
1918 * same XID for all retransmits.
1921 call_timeout(struct rpc_task
*task
)
1923 struct rpc_clnt
*clnt
= task
->tk_client
;
1925 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
1926 dprintk("RPC: %5u call_timeout (minor)\n", task
->tk_pid
);
1930 dprintk("RPC: %5u call_timeout (major)\n", task
->tk_pid
);
1931 task
->tk_timeouts
++;
1933 if (RPC_IS_SOFTCONN(task
)) {
1934 rpc_exit(task
, -ETIMEDOUT
);
1937 if (RPC_IS_SOFT(task
)) {
1938 if (clnt
->cl_chatty
) {
1940 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1942 rcu_dereference(clnt
->cl_xprt
)->servername
);
1945 if (task
->tk_flags
& RPC_TASK_TIMEOUT
)
1946 rpc_exit(task
, -ETIMEDOUT
);
1948 rpc_exit(task
, -EIO
);
1952 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1953 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1954 if (clnt
->cl_chatty
) {
1956 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1958 rcu_dereference(clnt
->cl_xprt
)->servername
);
1962 rpc_force_rebind(clnt
);
1964 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1965 * event? RFC2203 requires the server to drop all such requests.
1967 rpcauth_invalcred(task
);
1970 clnt
->cl_stats
->rpcretrans
++;
1971 task
->tk_action
= call_bind
;
1972 task
->tk_status
= 0;
1976 * 7. Decode the RPC reply
1979 call_decode(struct rpc_task
*task
)
1981 struct rpc_clnt
*clnt
= task
->tk_client
;
1982 struct rpc_rqst
*req
= task
->tk_rqstp
;
1983 kxdrdproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1986 dprint_status(task
);
1988 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1989 if (clnt
->cl_chatty
) {
1991 printk(KERN_NOTICE
"%s: server %s OK\n",
1993 rcu_dereference(clnt
->cl_xprt
)->servername
);
1996 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
2000 * Ensure that we see all writes made by xprt_complete_rqst()
2001 * before it changed req->rq_reply_bytes_recvd.
2004 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
2006 /* Check that the softirq receive buffer is valid */
2007 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
2008 sizeof(req
->rq_rcv_buf
)) != 0);
2010 if (req
->rq_rcv_buf
.len
< 12) {
2011 if (!RPC_IS_SOFT(task
)) {
2012 task
->tk_action
= call_bind
;
2013 clnt
->cl_stats
->rpcretrans
++;
2016 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2017 clnt
->cl_protname
, task
->tk_status
);
2018 task
->tk_action
= call_timeout
;
2022 p
= rpc_verify_header(task
);
2024 if (p
== ERR_PTR(-EAGAIN
))
2029 task
->tk_action
= rpc_exit_task
;
2032 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
2033 task
->tk_msg
.rpc_resp
);
2035 dprintk("RPC: %5u call_decode result %d\n", task
->tk_pid
,
2039 task
->tk_status
= 0;
2040 /* Note: rpc_verify_header() may have freed the RPC slot */
2041 if (task
->tk_rqstp
== req
) {
2042 req
->rq_reply_bytes_recvd
= req
->rq_rcv_buf
.len
= 0;
2043 if (task
->tk_client
->cl_discrtry
)
2044 xprt_conditional_disconnect(req
->rq_xprt
,
2045 req
->rq_connect_cookie
);
2050 rpc_encode_header(struct rpc_task
*task
)
2052 struct rpc_clnt
*clnt
= task
->tk_client
;
2053 struct rpc_rqst
*req
= task
->tk_rqstp
;
2054 __be32
*p
= req
->rq_svec
[0].iov_base
;
2056 /* FIXME: check buffer size? */
2058 p
= xprt_skip_transport_header(req
->rq_xprt
, p
);
2059 *p
++ = req
->rq_xid
; /* XID */
2060 *p
++ = htonl(RPC_CALL
); /* CALL */
2061 *p
++ = htonl(RPC_VERSION
); /* RPC version */
2062 *p
++ = htonl(clnt
->cl_prog
); /* program number */
2063 *p
++ = htonl(clnt
->cl_vers
); /* program version */
2064 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
2065 p
= rpcauth_marshcred(task
, p
);
2066 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
2071 rpc_verify_header(struct rpc_task
*task
)
2073 struct rpc_clnt
*clnt
= task
->tk_client
;
2074 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
2075 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
2076 __be32
*p
= iov
->iov_base
;
2078 int error
= -EACCES
;
2080 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
2081 /* RFC-1014 says that the representation of XDR data must be a
2082 * multiple of four bytes
2083 * - if it isn't pointer subtraction in the NFS client may give
2086 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2087 " 4 bytes: 0x%x\n", task
->tk_pid
, __func__
,
2088 task
->tk_rqstp
->rq_rcv_buf
.len
);
2094 p
+= 1; /* skip XID */
2095 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
2096 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2097 task
->tk_pid
, __func__
, n
);
2101 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
2104 switch ((n
= ntohl(*p
++))) {
2105 case RPC_AUTH_ERROR
:
2108 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2109 task
->tk_pid
, __func__
);
2110 error
= -EPROTONOSUPPORT
;
2113 dprintk("RPC: %5u %s: RPC call rejected, "
2114 "unknown error: %x\n",
2115 task
->tk_pid
, __func__
, n
);
2120 switch ((n
= ntohl(*p
++))) {
2121 case RPC_AUTH_REJECTEDCRED
:
2122 case RPC_AUTH_REJECTEDVERF
:
2123 case RPCSEC_GSS_CREDPROBLEM
:
2124 case RPCSEC_GSS_CTXPROBLEM
:
2125 if (!task
->tk_cred_retry
)
2127 task
->tk_cred_retry
--;
2128 dprintk("RPC: %5u %s: retry stale creds\n",
2129 task
->tk_pid
, __func__
);
2130 rpcauth_invalcred(task
);
2131 /* Ensure we obtain a new XID! */
2133 task
->tk_action
= call_reserve
;
2135 case RPC_AUTH_BADCRED
:
2136 case RPC_AUTH_BADVERF
:
2137 /* possibly garbled cred/verf? */
2138 if (!task
->tk_garb_retry
)
2140 task
->tk_garb_retry
--;
2141 dprintk("RPC: %5u %s: retry garbled creds\n",
2142 task
->tk_pid
, __func__
);
2143 task
->tk_action
= call_bind
;
2145 case RPC_AUTH_TOOWEAK
:
2147 printk(KERN_NOTICE
"RPC: server %s requires stronger "
2148 "authentication.\n",
2149 rcu_dereference(clnt
->cl_xprt
)->servername
);
2153 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2154 task
->tk_pid
, __func__
, n
);
2157 dprintk("RPC: %5u %s: call rejected %d\n",
2158 task
->tk_pid
, __func__
, n
);
2161 if (!(p
= rpcauth_checkverf(task
, p
))) {
2162 dprintk("RPC: %5u %s: auth check failed\n",
2163 task
->tk_pid
, __func__
);
2164 goto out_garbage
; /* bad verifier, retry */
2166 len
= p
- (__be32
*)iov
->iov_base
- 1;
2169 switch ((n
= ntohl(*p
++))) {
2172 case RPC_PROG_UNAVAIL
:
2173 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2174 "by server %s\n", task
->tk_pid
, __func__
,
2175 (unsigned int)clnt
->cl_prog
,
2176 rcu_dereference(clnt
->cl_xprt
)->servername
);
2177 error
= -EPFNOSUPPORT
;
2179 case RPC_PROG_MISMATCH
:
2180 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2181 "by server %s\n", task
->tk_pid
, __func__
,
2182 (unsigned int)clnt
->cl_prog
,
2183 (unsigned int)clnt
->cl_vers
,
2184 rcu_dereference(clnt
->cl_xprt
)->servername
);
2185 error
= -EPROTONOSUPPORT
;
2187 case RPC_PROC_UNAVAIL
:
2188 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2189 "version %u on server %s\n",
2190 task
->tk_pid
, __func__
,
2191 rpc_proc_name(task
),
2192 clnt
->cl_prog
, clnt
->cl_vers
,
2193 rcu_dereference(clnt
->cl_xprt
)->servername
);
2194 error
= -EOPNOTSUPP
;
2196 case RPC_GARBAGE_ARGS
:
2197 dprintk("RPC: %5u %s: server saw garbage\n",
2198 task
->tk_pid
, __func__
);
2201 dprintk("RPC: %5u %s: server accept status: %x\n",
2202 task
->tk_pid
, __func__
, n
);
2207 clnt
->cl_stats
->rpcgarbage
++;
2208 if (task
->tk_garb_retry
) {
2209 task
->tk_garb_retry
--;
2210 dprintk("RPC: %5u %s: retrying\n",
2211 task
->tk_pid
, __func__
);
2212 task
->tk_action
= call_bind
;
2214 return ERR_PTR(-EAGAIN
);
2219 rpc_exit(task
, error
);
2220 dprintk("RPC: %5u %s: call failed with error %d\n", task
->tk_pid
,
2222 return ERR_PTR(error
);
2224 dprintk("RPC: %5u %s: server reply was truncated.\n", task
->tk_pid
,
2229 static void rpcproc_encode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
2233 static int rpcproc_decode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
2238 static struct rpc_procinfo rpcproc_null
= {
2239 .p_encode
= rpcproc_encode_null
,
2240 .p_decode
= rpcproc_decode_null
,
2243 static int rpc_ping(struct rpc_clnt
*clnt
)
2245 struct rpc_message msg
= {
2246 .rpc_proc
= &rpcproc_null
,
2249 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
2250 err
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
);
2251 put_rpccred(msg
.rpc_cred
);
2255 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
2257 struct rpc_message msg
= {
2258 .rpc_proc
= &rpcproc_null
,
2261 struct rpc_task_setup task_setup_data
= {
2263 .rpc_message
= &msg
,
2264 .callback_ops
= &rpc_default_ops
,
2267 return rpc_run_task(&task_setup_data
);
2269 EXPORT_SYMBOL_GPL(rpc_call_null
);
2272 static void rpc_show_header(void)
2274 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
2275 "-timeout ---ops--\n");
2278 static void rpc_show_task(const struct rpc_clnt
*clnt
,
2279 const struct rpc_task
*task
)
2281 const char *rpc_waitq
= "none";
2283 if (RPC_IS_QUEUED(task
))
2284 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
2286 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2287 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
2288 clnt
, task
->tk_rqstp
, task
->tk_timeout
, task
->tk_ops
,
2289 clnt
->cl_protname
, clnt
->cl_vers
, rpc_proc_name(task
),
2290 task
->tk_action
, rpc_waitq
);
2293 void rpc_show_tasks(struct net
*net
)
2295 struct rpc_clnt
*clnt
;
2296 struct rpc_task
*task
;
2298 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
2300 spin_lock(&sn
->rpc_client_lock
);
2301 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
2302 spin_lock(&clnt
->cl_lock
);
2303 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
2308 rpc_show_task(clnt
, task
);
2310 spin_unlock(&clnt
->cl_lock
);
2312 spin_unlock(&sn
->rpc_client_lock
);