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 qstr q
= { .name
= name
};
132 struct dentry
*dir
, *dentry
;
135 dir
= rpc_d_lookup_sb(sb
, dir_name
);
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name
);
141 q
.len
= snprintf(name
, sizeof(name
), "clnt%x", (unsigned int)clntid
++);
142 name
[sizeof(name
) - 1] = '\0';
143 q
.hash
= full_name_hash(q
.name
, q
.len
);
144 dentry
= rpc_create_client_dir(dir
, &q
, clnt
);
147 error
= PTR_ERR(dentry
);
148 if (error
!= -EEXIST
) {
149 printk(KERN_INFO
"RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name
, name
, error
);
160 rpc_setup_pipedir(struct rpc_clnt
*clnt
, const char *dir_name
)
162 struct net
*net
= rpc_net_ns(clnt
);
163 struct super_block
*pipefs_sb
;
164 struct dentry
*dentry
;
166 clnt
->cl_dentry
= NULL
;
167 if (dir_name
== NULL
)
169 pipefs_sb
= rpc_get_sb_net(net
);
172 dentry
= rpc_setup_pipedir_sb(pipefs_sb
, clnt
, dir_name
);
175 return PTR_ERR(dentry
);
176 clnt
->cl_dentry
= dentry
;
180 static inline int rpc_clnt_skip_event(struct rpc_clnt
*clnt
, unsigned long event
)
182 if (((event
== RPC_PIPEFS_MOUNT
) && clnt
->cl_dentry
) ||
183 ((event
== RPC_PIPEFS_UMOUNT
) && !clnt
->cl_dentry
))
188 static int __rpc_clnt_handle_event(struct rpc_clnt
*clnt
, unsigned long event
,
189 struct super_block
*sb
)
191 struct dentry
*dentry
;
195 case RPC_PIPEFS_MOUNT
:
196 dentry
= rpc_setup_pipedir_sb(sb
, clnt
,
197 clnt
->cl_program
->pipe_dir_name
);
201 return PTR_ERR(dentry
);
202 clnt
->cl_dentry
= dentry
;
203 if (clnt
->cl_auth
->au_ops
->pipes_create
) {
204 err
= clnt
->cl_auth
->au_ops
->pipes_create(clnt
->cl_auth
);
206 __rpc_clnt_remove_pipedir(clnt
);
209 case RPC_PIPEFS_UMOUNT
:
210 __rpc_clnt_remove_pipedir(clnt
);
213 printk(KERN_ERR
"%s: unknown event: %ld\n", __func__
, event
);
219 static int __rpc_pipefs_event(struct rpc_clnt
*clnt
, unsigned long event
,
220 struct super_block
*sb
)
224 for (;; clnt
= clnt
->cl_parent
) {
225 if (!rpc_clnt_skip_event(clnt
, event
))
226 error
= __rpc_clnt_handle_event(clnt
, event
, sb
);
227 if (error
|| clnt
== clnt
->cl_parent
)
233 static struct rpc_clnt
*rpc_get_client_for_event(struct net
*net
, int event
)
235 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
236 struct rpc_clnt
*clnt
;
238 spin_lock(&sn
->rpc_client_lock
);
239 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
240 if (clnt
->cl_program
->pipe_dir_name
== NULL
)
242 if (rpc_clnt_skip_event(clnt
, event
))
244 if (atomic_inc_not_zero(&clnt
->cl_count
) == 0)
246 spin_unlock(&sn
->rpc_client_lock
);
249 spin_unlock(&sn
->rpc_client_lock
);
253 static int rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
,
256 struct super_block
*sb
= ptr
;
257 struct rpc_clnt
*clnt
;
260 while ((clnt
= rpc_get_client_for_event(sb
->s_fs_info
, event
))) {
261 error
= __rpc_pipefs_event(clnt
, event
, sb
);
262 rpc_release_client(clnt
);
269 static struct notifier_block rpc_clients_block
= {
270 .notifier_call
= rpc_pipefs_event
,
271 .priority
= SUNRPC_PIPEFS_RPC_PRIO
,
274 int rpc_clients_notifier_register(void)
276 return rpc_pipefs_notifier_register(&rpc_clients_block
);
279 void rpc_clients_notifier_unregister(void)
281 return rpc_pipefs_notifier_unregister(&rpc_clients_block
);
284 static void rpc_clnt_set_nodename(struct rpc_clnt
*clnt
, const char *nodename
)
286 clnt
->cl_nodelen
= strlen(nodename
);
287 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
288 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
289 memcpy(clnt
->cl_nodename
, nodename
, clnt
->cl_nodelen
);
292 static struct rpc_clnt
* rpc_new_client(const struct rpc_create_args
*args
, struct rpc_xprt
*xprt
)
294 const struct rpc_program
*program
= args
->program
;
295 const struct rpc_version
*version
;
296 struct rpc_clnt
*clnt
= NULL
;
297 struct rpc_auth
*auth
;
300 /* sanity check the name before trying to print it */
301 dprintk("RPC: creating %s client for %s (xprt %p)\n",
302 program
->name
, args
->servername
, xprt
);
311 if (args
->version
>= program
->nrvers
)
313 version
= program
->version
[args
->version
];
318 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
321 clnt
->cl_parent
= clnt
;
323 rcu_assign_pointer(clnt
->cl_xprt
, xprt
);
324 clnt
->cl_procinfo
= version
->procs
;
325 clnt
->cl_maxproc
= version
->nrprocs
;
326 clnt
->cl_protname
= program
->name
;
327 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
328 clnt
->cl_vers
= version
->number
;
329 clnt
->cl_stats
= program
->stats
;
330 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
332 if (clnt
->cl_metrics
== NULL
)
334 clnt
->cl_program
= program
;
335 INIT_LIST_HEAD(&clnt
->cl_tasks
);
336 spin_lock_init(&clnt
->cl_lock
);
338 if (!xprt_bound(xprt
))
339 clnt
->cl_autobind
= 1;
341 clnt
->cl_timeout
= xprt
->timeout
;
342 if (args
->timeout
!= NULL
) {
343 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
344 sizeof(clnt
->cl_timeout_default
));
345 clnt
->cl_timeout
= &clnt
->cl_timeout_default
;
348 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
349 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
350 clnt
->cl_principal
= NULL
;
351 if (args
->client_name
) {
352 clnt
->cl_principal
= kstrdup(args
->client_name
, GFP_KERNEL
);
353 if (!clnt
->cl_principal
)
354 goto out_no_principal
;
357 atomic_set(&clnt
->cl_count
, 1);
359 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
363 auth
= rpcauth_create(args
->authflavor
, clnt
);
365 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
371 /* save the nodename */
372 rpc_clnt_set_nodename(clnt
, utsname()->nodename
);
373 rpc_register_client(clnt
);
377 rpc_clnt_remove_pipedir(clnt
);
379 kfree(clnt
->cl_principal
);
381 rpc_free_iostats(clnt
->cl_metrics
);
393 * rpc_create - create an RPC client and transport with one call
394 * @args: rpc_clnt create argument structure
396 * Creates and initializes an RPC transport and an RPC client.
398 * It can ping the server in order to determine if it is up, and to see if
399 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
400 * this behavior so asynchronous tasks can also use rpc_create.
402 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
404 struct rpc_xprt
*xprt
;
405 struct rpc_clnt
*clnt
;
406 struct xprt_create xprtargs
= {
408 .ident
= args
->protocol
,
409 .srcaddr
= args
->saddress
,
410 .dstaddr
= args
->address
,
411 .addrlen
= args
->addrsize
,
412 .servername
= args
->servername
,
413 .bc_xprt
= args
->bc_xprt
,
418 * If the caller chooses not to specify a hostname, whip
419 * up a string representation of the passed-in address.
421 if (xprtargs
.servername
== NULL
) {
422 struct sockaddr_un
*sun
=
423 (struct sockaddr_un
*)args
->address
;
424 struct sockaddr_in
*sin
=
425 (struct sockaddr_in
*)args
->address
;
426 struct sockaddr_in6
*sin6
=
427 (struct sockaddr_in6
*)args
->address
;
429 servername
[0] = '\0';
430 switch (args
->address
->sa_family
) {
432 snprintf(servername
, sizeof(servername
), "%s",
436 snprintf(servername
, sizeof(servername
), "%pI4",
437 &sin
->sin_addr
.s_addr
);
440 snprintf(servername
, sizeof(servername
), "%pI6",
444 /* caller wants default server name, but
445 * address family isn't recognized. */
446 return ERR_PTR(-EINVAL
);
448 xprtargs
.servername
= servername
;
451 xprt
= xprt_create_transport(&xprtargs
);
453 return (struct rpc_clnt
*)xprt
;
456 * By default, kernel RPC client connects from a reserved port.
457 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
458 * but it is always enabled for rpciod, which handles the connect
462 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
465 clnt
= rpc_new_client(args
, xprt
);
469 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
470 int err
= rpc_ping(clnt
);
472 rpc_shutdown_client(clnt
);
477 clnt
->cl_softrtry
= 1;
478 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
479 clnt
->cl_softrtry
= 0;
481 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
482 clnt
->cl_autobind
= 1;
483 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
484 clnt
->cl_discrtry
= 1;
485 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
490 EXPORT_SYMBOL_GPL(rpc_create
);
493 * This function clones the RPC client structure. It allows us to share the
494 * same transport while varying parameters such as the authentication
497 static struct rpc_clnt
*__rpc_clone_client(struct rpc_create_args
*args
,
498 struct rpc_clnt
*clnt
)
500 struct rpc_xprt
*xprt
;
501 struct rpc_clnt
*new;
506 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
510 args
->servername
= xprt
->servername
;
512 new = rpc_new_client(args
, xprt
);
518 atomic_inc(&clnt
->cl_count
);
519 new->cl_parent
= clnt
;
521 /* Turn off autobind on clones */
522 new->cl_autobind
= 0;
523 new->cl_softrtry
= clnt
->cl_softrtry
;
524 new->cl_discrtry
= clnt
->cl_discrtry
;
525 new->cl_chatty
= clnt
->cl_chatty
;
529 dprintk("RPC: %s: returned error %d\n", __func__
, err
);
534 * rpc_clone_client - Clone an RPC client structure
536 * @clnt: RPC client whose parameters are copied
538 * Returns a fresh RPC client or an ERR_PTR.
540 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*clnt
)
542 struct rpc_create_args args
= {
543 .program
= clnt
->cl_program
,
544 .prognumber
= clnt
->cl_prog
,
545 .version
= clnt
->cl_vers
,
546 .authflavor
= clnt
->cl_auth
->au_flavor
,
547 .client_name
= clnt
->cl_principal
,
549 return __rpc_clone_client(&args
, clnt
);
551 EXPORT_SYMBOL_GPL(rpc_clone_client
);
554 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
556 * @clnt: RPC client whose parameters are copied
557 * @flavor: security flavor for new client
559 * Returns a fresh RPC client or an ERR_PTR.
562 rpc_clone_client_set_auth(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
564 struct rpc_create_args args
= {
565 .program
= clnt
->cl_program
,
566 .prognumber
= clnt
->cl_prog
,
567 .version
= clnt
->cl_vers
,
568 .authflavor
= flavor
,
569 .client_name
= clnt
->cl_principal
,
571 return __rpc_clone_client(&args
, clnt
);
573 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth
);
576 * Kill all tasks for the given client.
577 * XXX: kill their descendants as well?
579 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
581 struct rpc_task
*rovr
;
584 if (list_empty(&clnt
->cl_tasks
))
586 dprintk("RPC: killing all tasks for client %p\n", clnt
);
588 * Spin lock all_tasks to prevent changes...
590 spin_lock(&clnt
->cl_lock
);
591 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
) {
592 if (!RPC_IS_ACTIVATED(rovr
))
594 if (!(rovr
->tk_flags
& RPC_TASK_KILLED
)) {
595 rovr
->tk_flags
|= RPC_TASK_KILLED
;
596 rpc_exit(rovr
, -EIO
);
597 if (RPC_IS_QUEUED(rovr
))
598 rpc_wake_up_queued_task(rovr
->tk_waitqueue
,
602 spin_unlock(&clnt
->cl_lock
);
604 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
607 * Properly shut down an RPC client, terminating all outstanding
610 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
614 dprintk_rcu("RPC: shutting down %s client for %s\n",
616 rcu_dereference(clnt
->cl_xprt
)->servername
);
618 while (!list_empty(&clnt
->cl_tasks
)) {
619 rpc_killall_tasks(clnt
);
620 wait_event_timeout(destroy_wait
,
621 list_empty(&clnt
->cl_tasks
), 1*HZ
);
624 rpc_release_client(clnt
);
626 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
632 rpc_free_client(struct rpc_clnt
*clnt
)
634 dprintk_rcu("RPC: destroying %s client for %s\n",
636 rcu_dereference(clnt
->cl_xprt
)->servername
);
637 if (clnt
->cl_parent
!= clnt
)
638 rpc_release_client(clnt
->cl_parent
);
639 rpc_unregister_client(clnt
);
640 rpc_clnt_remove_pipedir(clnt
);
641 rpc_free_iostats(clnt
->cl_metrics
);
642 kfree(clnt
->cl_principal
);
643 clnt
->cl_metrics
= NULL
;
644 xprt_put(rcu_dereference_raw(clnt
->cl_xprt
));
653 rpc_free_auth(struct rpc_clnt
*clnt
)
655 if (clnt
->cl_auth
== NULL
) {
656 rpc_free_client(clnt
);
661 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
662 * release remaining GSS contexts. This mechanism ensures
663 * that it can do so safely.
665 atomic_inc(&clnt
->cl_count
);
666 rpcauth_release(clnt
->cl_auth
);
667 clnt
->cl_auth
= NULL
;
668 if (atomic_dec_and_test(&clnt
->cl_count
))
669 rpc_free_client(clnt
);
673 * Release reference to the RPC client
676 rpc_release_client(struct rpc_clnt
*clnt
)
678 dprintk("RPC: rpc_release_client(%p)\n", clnt
);
680 if (list_empty(&clnt
->cl_tasks
))
681 wake_up(&destroy_wait
);
682 if (atomic_dec_and_test(&clnt
->cl_count
))
687 * rpc_bind_new_program - bind a new RPC program to an existing client
688 * @old: old rpc_client
689 * @program: rpc program to set
690 * @vers: rpc program version
692 * Clones the rpc client and sets up a new RPC program. This is mainly
693 * of use for enabling different RPC programs to share the same transport.
694 * The Sun NFSv2/v3 ACL protocol can do this.
696 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
697 const struct rpc_program
*program
,
700 struct rpc_create_args args
= {
702 .prognumber
= program
->number
,
704 .authflavor
= old
->cl_auth
->au_flavor
,
705 .client_name
= old
->cl_principal
,
707 struct rpc_clnt
*clnt
;
710 clnt
= __rpc_clone_client(&args
, old
);
713 err
= rpc_ping(clnt
);
715 rpc_shutdown_client(clnt
);
721 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
723 void rpc_task_release_client(struct rpc_task
*task
)
725 struct rpc_clnt
*clnt
= task
->tk_client
;
728 /* Remove from client task list */
729 spin_lock(&clnt
->cl_lock
);
730 list_del(&task
->tk_task
);
731 spin_unlock(&clnt
->cl_lock
);
732 task
->tk_client
= NULL
;
734 rpc_release_client(clnt
);
739 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
742 rpc_task_release_client(task
);
743 task
->tk_client
= clnt
;
744 atomic_inc(&clnt
->cl_count
);
745 if (clnt
->cl_softrtry
)
746 task
->tk_flags
|= RPC_TASK_SOFT
;
747 if (sk_memalloc_socks()) {
748 struct rpc_xprt
*xprt
;
751 xprt
= rcu_dereference(clnt
->cl_xprt
);
753 task
->tk_flags
|= RPC_TASK_SWAPPER
;
756 /* Add to the client's list of all tasks */
757 spin_lock(&clnt
->cl_lock
);
758 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
759 spin_unlock(&clnt
->cl_lock
);
763 void rpc_task_reset_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
765 rpc_task_release_client(task
);
766 rpc_task_set_client(task
, clnt
);
768 EXPORT_SYMBOL_GPL(rpc_task_reset_client
);
772 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
775 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
776 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
777 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
778 if (msg
->rpc_cred
!= NULL
)
779 task
->tk_msg
.rpc_cred
= get_rpccred(msg
->rpc_cred
);
784 * Default callback for async RPC calls
787 rpc_default_callback(struct rpc_task
*task
, void *data
)
791 static const struct rpc_call_ops rpc_default_ops
= {
792 .rpc_call_done
= rpc_default_callback
,
796 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
797 * @task_setup_data: pointer to task initialisation data
799 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
801 struct rpc_task
*task
;
803 task
= rpc_new_task(task_setup_data
);
807 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
808 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
810 if (task
->tk_action
== NULL
)
811 rpc_call_start(task
);
813 atomic_inc(&task
->tk_count
);
818 EXPORT_SYMBOL_GPL(rpc_run_task
);
821 * rpc_call_sync - Perform a synchronous RPC call
822 * @clnt: pointer to RPC client
823 * @msg: RPC call parameters
824 * @flags: RPC call flags
826 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
828 struct rpc_task
*task
;
829 struct rpc_task_setup task_setup_data
= {
832 .callback_ops
= &rpc_default_ops
,
837 WARN_ON_ONCE(flags
& RPC_TASK_ASYNC
);
838 if (flags
& RPC_TASK_ASYNC
) {
839 rpc_release_calldata(task_setup_data
.callback_ops
,
840 task_setup_data
.callback_data
);
844 task
= rpc_run_task(&task_setup_data
);
846 return PTR_ERR(task
);
847 status
= task
->tk_status
;
851 EXPORT_SYMBOL_GPL(rpc_call_sync
);
854 * rpc_call_async - Perform an asynchronous RPC call
855 * @clnt: pointer to RPC client
856 * @msg: RPC call parameters
857 * @flags: RPC call flags
858 * @tk_ops: RPC call ops
859 * @data: user call data
862 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
863 const struct rpc_call_ops
*tk_ops
, void *data
)
865 struct rpc_task
*task
;
866 struct rpc_task_setup task_setup_data
= {
869 .callback_ops
= tk_ops
,
870 .callback_data
= data
,
871 .flags
= flags
|RPC_TASK_ASYNC
,
874 task
= rpc_run_task(&task_setup_data
);
876 return PTR_ERR(task
);
880 EXPORT_SYMBOL_GPL(rpc_call_async
);
882 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
884 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
885 * rpc_execute against it
887 * @tk_ops: RPC call ops
889 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
,
890 const struct rpc_call_ops
*tk_ops
)
892 struct rpc_task
*task
;
893 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
894 struct rpc_task_setup task_setup_data
= {
895 .callback_ops
= tk_ops
,
898 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
900 * Create an rpc_task to send the data
902 task
= rpc_new_task(&task_setup_data
);
904 xprt_free_bc_request(req
);
907 task
->tk_rqstp
= req
;
910 * Set up the xdr_buf length.
911 * This also indicates that the buffer is XDR encoded already.
913 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
914 xbufp
->tail
[0].iov_len
;
916 task
->tk_action
= call_bc_transmit
;
917 atomic_inc(&task
->tk_count
);
918 WARN_ON_ONCE(atomic_read(&task
->tk_count
) != 2);
922 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
925 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
928 rpc_call_start(struct rpc_task
*task
)
930 task
->tk_action
= call_start
;
932 EXPORT_SYMBOL_GPL(rpc_call_start
);
935 * rpc_peeraddr - extract remote peer address from clnt's xprt
936 * @clnt: RPC client structure
937 * @buf: target buffer
938 * @bufsize: length of target buffer
940 * Returns the number of bytes that are actually in the stored address.
942 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
945 struct rpc_xprt
*xprt
;
948 xprt
= rcu_dereference(clnt
->cl_xprt
);
950 bytes
= xprt
->addrlen
;
953 memcpy(buf
, &xprt
->addr
, bytes
);
958 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
961 * rpc_peeraddr2str - return remote peer address in printable format
962 * @clnt: RPC client structure
963 * @format: address format
965 * NB: the lifetime of the memory referenced by the returned pointer is
966 * the same as the rpc_xprt itself. As long as the caller uses this
967 * pointer, it must hold the RCU read lock.
969 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
970 enum rpc_display_format_t format
)
972 struct rpc_xprt
*xprt
;
974 xprt
= rcu_dereference(clnt
->cl_xprt
);
976 if (xprt
->address_strings
[format
] != NULL
)
977 return xprt
->address_strings
[format
];
979 return "unprintable";
981 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
983 static const struct sockaddr_in rpc_inaddr_loopback
= {
984 .sin_family
= AF_INET
,
985 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
988 static const struct sockaddr_in6 rpc_in6addr_loopback
= {
989 .sin6_family
= AF_INET6
,
990 .sin6_addr
= IN6ADDR_ANY_INIT
,
994 * Try a getsockname() on a connected datagram socket. Using a
995 * connected datagram socket prevents leaving a socket in TIME_WAIT.
996 * This conserves the ephemeral port number space.
998 * Returns zero and fills in "buf" if successful; otherwise, a
999 * negative errno is returned.
1001 static int rpc_sockname(struct net
*net
, struct sockaddr
*sap
, size_t salen
,
1002 struct sockaddr
*buf
, int buflen
)
1004 struct socket
*sock
;
1007 err
= __sock_create(net
, sap
->sa_family
,
1008 SOCK_DGRAM
, IPPROTO_UDP
, &sock
, 1);
1010 dprintk("RPC: can't create UDP socket (%d)\n", err
);
1014 switch (sap
->sa_family
) {
1016 err
= kernel_bind(sock
,
1017 (struct sockaddr
*)&rpc_inaddr_loopback
,
1018 sizeof(rpc_inaddr_loopback
));
1021 err
= kernel_bind(sock
,
1022 (struct sockaddr
*)&rpc_in6addr_loopback
,
1023 sizeof(rpc_in6addr_loopback
));
1026 err
= -EAFNOSUPPORT
;
1030 dprintk("RPC: can't bind UDP socket (%d)\n", err
);
1034 err
= kernel_connect(sock
, sap
, salen
, 0);
1036 dprintk("RPC: can't connect UDP socket (%d)\n", err
);
1040 err
= kernel_getsockname(sock
, buf
, &buflen
);
1042 dprintk("RPC: getsockname failed (%d)\n", err
);
1047 if (buf
->sa_family
== AF_INET6
) {
1048 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)buf
;
1049 sin6
->sin6_scope_id
= 0;
1051 dprintk("RPC: %s succeeded\n", __func__
);
1060 * Scraping a connected socket failed, so we don't have a useable
1061 * local address. Fallback: generate an address that will prevent
1062 * the server from calling us back.
1064 * Returns zero and fills in "buf" if successful; otherwise, a
1065 * negative errno is returned.
1067 static int rpc_anyaddr(int family
, struct sockaddr
*buf
, size_t buflen
)
1071 if (buflen
< sizeof(rpc_inaddr_loopback
))
1073 memcpy(buf
, &rpc_inaddr_loopback
,
1074 sizeof(rpc_inaddr_loopback
));
1077 if (buflen
< sizeof(rpc_in6addr_loopback
))
1079 memcpy(buf
, &rpc_in6addr_loopback
,
1080 sizeof(rpc_in6addr_loopback
));
1082 dprintk("RPC: %s: address family not supported\n",
1084 return -EAFNOSUPPORT
;
1086 dprintk("RPC: %s: succeeded\n", __func__
);
1091 * rpc_localaddr - discover local endpoint address for an RPC client
1092 * @clnt: RPC client structure
1093 * @buf: target buffer
1094 * @buflen: size of target buffer, in bytes
1096 * Returns zero and fills in "buf" and "buflen" if successful;
1097 * otherwise, a negative errno is returned.
1099 * This works even if the underlying transport is not currently connected,
1100 * or if the upper layer never previously provided a source address.
1102 * The result of this function call is transient: multiple calls in
1103 * succession may give different results, depending on how local
1104 * networking configuration changes over time.
1106 int rpc_localaddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t buflen
)
1108 struct sockaddr_storage address
;
1109 struct sockaddr
*sap
= (struct sockaddr
*)&address
;
1110 struct rpc_xprt
*xprt
;
1116 xprt
= rcu_dereference(clnt
->cl_xprt
);
1117 salen
= xprt
->addrlen
;
1118 memcpy(sap
, &xprt
->addr
, salen
);
1119 net
= get_net(xprt
->xprt_net
);
1122 rpc_set_port(sap
, 0);
1123 err
= rpc_sockname(net
, sap
, salen
, buf
, buflen
);
1126 /* Couldn't discover local address, return ANYADDR */
1127 return rpc_anyaddr(sap
->sa_family
, buf
, buflen
);
1130 EXPORT_SYMBOL_GPL(rpc_localaddr
);
1133 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
1135 struct rpc_xprt
*xprt
;
1138 xprt
= rcu_dereference(clnt
->cl_xprt
);
1139 if (xprt
->ops
->set_buffer_size
)
1140 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
1143 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
1146 * rpc_protocol - Get transport protocol number for an RPC client
1147 * @clnt: RPC client to query
1150 int rpc_protocol(struct rpc_clnt
*clnt
)
1155 protocol
= rcu_dereference(clnt
->cl_xprt
)->prot
;
1159 EXPORT_SYMBOL_GPL(rpc_protocol
);
1162 * rpc_net_ns - Get the network namespace for this RPC client
1163 * @clnt: RPC client to query
1166 struct net
*rpc_net_ns(struct rpc_clnt
*clnt
)
1171 ret
= rcu_dereference(clnt
->cl_xprt
)->xprt_net
;
1175 EXPORT_SYMBOL_GPL(rpc_net_ns
);
1178 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1179 * @clnt: RPC client to query
1181 * For stream transports, this is one RPC record fragment (see RFC
1182 * 1831), as we don't support multi-record requests yet. For datagram
1183 * transports, this is the size of an IP packet minus the IP, UDP, and
1186 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
1191 ret
= rcu_dereference(clnt
->cl_xprt
)->max_payload
;
1195 EXPORT_SYMBOL_GPL(rpc_max_payload
);
1198 * rpc_get_timeout - Get timeout for transport in units of HZ
1199 * @clnt: RPC client to query
1201 unsigned long rpc_get_timeout(struct rpc_clnt
*clnt
)
1206 ret
= rcu_dereference(clnt
->cl_xprt
)->timeout
->to_initval
;
1210 EXPORT_SYMBOL_GPL(rpc_get_timeout
);
1213 * rpc_force_rebind - force transport to check that remote port is unchanged
1214 * @clnt: client to rebind
1217 void rpc_force_rebind(struct rpc_clnt
*clnt
)
1219 if (clnt
->cl_autobind
) {
1221 xprt_clear_bound(rcu_dereference(clnt
->cl_xprt
));
1225 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
1228 * Restart an (async) RPC call from the call_prepare state.
1229 * Usually called from within the exit handler.
1232 rpc_restart_call_prepare(struct rpc_task
*task
)
1234 if (RPC_ASSASSINATED(task
))
1236 task
->tk_action
= call_start
;
1237 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1238 task
->tk_action
= rpc_prepare_task
;
1241 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
1244 * Restart an (async) RPC call. Usually called from within the
1248 rpc_restart_call(struct rpc_task
*task
)
1250 if (RPC_ASSASSINATED(task
))
1252 task
->tk_action
= call_start
;
1255 EXPORT_SYMBOL_GPL(rpc_restart_call
);
1258 static const char *rpc_proc_name(const struct rpc_task
*task
)
1260 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1264 return proc
->p_name
;
1275 * Other FSM states can be visited zero or more times, but
1276 * this state is visited exactly once for each RPC.
1279 call_start(struct rpc_task
*task
)
1281 struct rpc_clnt
*clnt
= task
->tk_client
;
1283 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task
->tk_pid
,
1284 clnt
->cl_protname
, clnt
->cl_vers
,
1285 rpc_proc_name(task
),
1286 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
1288 /* Increment call count */
1289 task
->tk_msg
.rpc_proc
->p_count
++;
1290 clnt
->cl_stats
->rpccnt
++;
1291 task
->tk_action
= call_reserve
;
1295 * 1. Reserve an RPC call slot
1298 call_reserve(struct rpc_task
*task
)
1300 dprint_status(task
);
1302 task
->tk_status
= 0;
1303 task
->tk_action
= call_reserveresult
;
1308 * 1b. Grok the result of xprt_reserve()
1311 call_reserveresult(struct rpc_task
*task
)
1313 int status
= task
->tk_status
;
1315 dprint_status(task
);
1318 * After a call to xprt_reserve(), we must have either
1319 * a request slot or else an error status.
1321 task
->tk_status
= 0;
1323 if (task
->tk_rqstp
) {
1324 task
->tk_action
= call_refresh
;
1328 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
1330 rpc_exit(task
, -EIO
);
1335 * Even though there was an error, we may have acquired
1336 * a request slot somehow. Make sure not to leak it.
1338 if (task
->tk_rqstp
) {
1339 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
1346 rpc_delay(task
, HZ
>> 2);
1347 case -EAGAIN
: /* woken up; retry */
1348 task
->tk_action
= call_reserve
;
1350 case -EIO
: /* probably a shutdown */
1353 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
1357 rpc_exit(task
, status
);
1361 * 2. Bind and/or refresh the credentials
1364 call_refresh(struct rpc_task
*task
)
1366 dprint_status(task
);
1368 task
->tk_action
= call_refreshresult
;
1369 task
->tk_status
= 0;
1370 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1371 rpcauth_refreshcred(task
);
1375 * 2a. Process the results of a credential refresh
1378 call_refreshresult(struct rpc_task
*task
)
1380 int status
= task
->tk_status
;
1382 dprint_status(task
);
1384 task
->tk_status
= 0;
1385 task
->tk_action
= call_refresh
;
1388 if (rpcauth_uptodatecred(task
))
1389 task
->tk_action
= call_allocate
;
1392 rpc_delay(task
, 3*HZ
);
1396 if (!task
->tk_cred_retry
)
1398 task
->tk_cred_retry
--;
1399 dprintk("RPC: %5u %s: retry refresh creds\n",
1400 task
->tk_pid
, __func__
);
1403 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1404 task
->tk_pid
, __func__
, status
);
1405 rpc_exit(task
, status
);
1409 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1410 * (Note: buffer memory is freed in xprt_release).
1413 call_allocate(struct rpc_task
*task
)
1415 unsigned int slack
= task
->tk_rqstp
->rq_cred
->cr_auth
->au_cslack
;
1416 struct rpc_rqst
*req
= task
->tk_rqstp
;
1417 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1418 struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1420 dprint_status(task
);
1422 task
->tk_status
= 0;
1423 task
->tk_action
= call_bind
;
1428 if (proc
->p_proc
!= 0) {
1429 BUG_ON(proc
->p_arglen
== 0);
1430 if (proc
->p_decode
!= NULL
)
1431 BUG_ON(proc
->p_replen
== 0);
1435 * Calculate the size (in quads) of the RPC call
1436 * and reply headers, and convert both values
1439 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (slack
<< 1) + proc
->p_arglen
;
1440 req
->rq_callsize
<<= 2;
1441 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ slack
+ proc
->p_replen
;
1442 req
->rq_rcvsize
<<= 2;
1444 req
->rq_buffer
= xprt
->ops
->buf_alloc(task
,
1445 req
->rq_callsize
+ req
->rq_rcvsize
);
1446 if (req
->rq_buffer
!= NULL
)
1449 dprintk("RPC: %5u rpc_buffer allocation failed\n", task
->tk_pid
);
1451 if (RPC_IS_ASYNC(task
) || !fatal_signal_pending(current
)) {
1452 task
->tk_action
= call_allocate
;
1453 rpc_delay(task
, HZ
>>4);
1457 rpc_exit(task
, -ERESTARTSYS
);
1461 rpc_task_need_encode(struct rpc_task
*task
)
1463 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
1467 rpc_task_force_reencode(struct rpc_task
*task
)
1469 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
1470 task
->tk_rqstp
->rq_bytes_sent
= 0;
1474 rpc_xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
1476 buf
->head
[0].iov_base
= start
;
1477 buf
->head
[0].iov_len
= len
;
1478 buf
->tail
[0].iov_len
= 0;
1486 * 3. Encode arguments of an RPC call
1489 rpc_xdr_encode(struct rpc_task
*task
)
1491 struct rpc_rqst
*req
= task
->tk_rqstp
;
1495 dprint_status(task
);
1497 rpc_xdr_buf_init(&req
->rq_snd_buf
,
1500 rpc_xdr_buf_init(&req
->rq_rcv_buf
,
1501 (char *)req
->rq_buffer
+ req
->rq_callsize
,
1504 p
= rpc_encode_header(task
);
1506 printk(KERN_INFO
"RPC: couldn't encode RPC header, exit EIO\n");
1507 rpc_exit(task
, -EIO
);
1511 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
1515 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
1516 task
->tk_msg
.rpc_argp
);
1520 * 4. Get the server port number if not yet set
1523 call_bind(struct rpc_task
*task
)
1525 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1527 dprint_status(task
);
1529 task
->tk_action
= call_connect
;
1530 if (!xprt_bound(xprt
)) {
1531 task
->tk_action
= call_bind_status
;
1532 task
->tk_timeout
= xprt
->bind_timeout
;
1533 xprt
->ops
->rpcbind(task
);
1538 * 4a. Sort out bind result
1541 call_bind_status(struct rpc_task
*task
)
1545 if (task
->tk_status
>= 0) {
1546 dprint_status(task
);
1547 task
->tk_status
= 0;
1548 task
->tk_action
= call_connect
;
1552 trace_rpc_bind_status(task
);
1553 switch (task
->tk_status
) {
1555 dprintk("RPC: %5u rpcbind out of memory\n", task
->tk_pid
);
1556 rpc_delay(task
, HZ
>> 2);
1559 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1560 "unavailable\n", task
->tk_pid
);
1561 /* fail immediately if this is an RPC ping */
1562 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1563 status
= -EOPNOTSUPP
;
1566 if (task
->tk_rebind_retry
== 0)
1568 task
->tk_rebind_retry
--;
1569 rpc_delay(task
, 3*HZ
);
1572 dprintk("RPC: %5u rpcbind request timed out\n",
1576 /* server doesn't support any rpcbind version we know of */
1577 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1580 case -EPROTONOSUPPORT
:
1581 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1583 task
->tk_status
= 0;
1584 task
->tk_action
= call_bind
;
1586 case -ECONNREFUSED
: /* connection problems */
1593 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1594 task
->tk_pid
, task
->tk_status
);
1595 if (!RPC_IS_SOFTCONN(task
)) {
1596 rpc_delay(task
, 5*HZ
);
1599 status
= task
->tk_status
;
1602 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1603 task
->tk_pid
, -task
->tk_status
);
1606 rpc_exit(task
, status
);
1610 task
->tk_action
= call_timeout
;
1614 * 4b. Connect to the RPC server
1617 call_connect(struct rpc_task
*task
)
1619 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1621 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1623 (xprt_connected(xprt
) ? "is" : "is not"));
1625 task
->tk_action
= call_transmit
;
1626 if (!xprt_connected(xprt
)) {
1627 task
->tk_action
= call_connect_status
;
1628 if (task
->tk_status
< 0)
1635 * 4c. Sort out connect result
1638 call_connect_status(struct rpc_task
*task
)
1640 struct rpc_clnt
*clnt
= task
->tk_client
;
1641 int status
= task
->tk_status
;
1643 dprint_status(task
);
1645 task
->tk_status
= 0;
1646 if (status
>= 0 || status
== -EAGAIN
) {
1647 clnt
->cl_stats
->netreconn
++;
1648 task
->tk_action
= call_transmit
;
1652 trace_rpc_connect_status(task
, status
);
1654 /* if soft mounted, test if we've timed out */
1656 task
->tk_action
= call_timeout
;
1659 rpc_exit(task
, -EIO
);
1664 * 5. Transmit the RPC request, and wait for reply
1667 call_transmit(struct rpc_task
*task
)
1669 dprint_status(task
);
1671 task
->tk_action
= call_status
;
1672 if (task
->tk_status
< 0)
1674 task
->tk_status
= xprt_prepare_transmit(task
);
1675 if (task
->tk_status
!= 0)
1677 task
->tk_action
= call_transmit_status
;
1678 /* Encode here so that rpcsec_gss can use correct sequence number. */
1679 if (rpc_task_need_encode(task
)) {
1680 rpc_xdr_encode(task
);
1681 /* Did the encode result in an error condition? */
1682 if (task
->tk_status
!= 0) {
1683 /* Was the error nonfatal? */
1684 if (task
->tk_status
== -EAGAIN
)
1685 rpc_delay(task
, HZ
>> 4);
1687 rpc_exit(task
, task
->tk_status
);
1691 xprt_transmit(task
);
1692 if (task
->tk_status
< 0)
1695 * On success, ensure that we call xprt_end_transmit() before sleeping
1696 * in order to allow access to the socket to other RPC requests.
1698 call_transmit_status(task
);
1699 if (rpc_reply_expected(task
))
1701 task
->tk_action
= rpc_exit_task
;
1702 rpc_wake_up_queued_task(&task
->tk_rqstp
->rq_xprt
->pending
, task
);
1706 * 5a. Handle cleanup after a transmission
1709 call_transmit_status(struct rpc_task
*task
)
1711 task
->tk_action
= call_status
;
1714 * Common case: success. Force the compiler to put this
1717 if (task
->tk_status
== 0) {
1718 xprt_end_transmit(task
);
1719 rpc_task_force_reencode(task
);
1723 switch (task
->tk_status
) {
1727 dprint_status(task
);
1728 xprt_end_transmit(task
);
1729 rpc_task_force_reencode(task
);
1732 * Special cases: if we've been waiting on the
1733 * socket's write_space() callback, or if the
1734 * socket just returned a connection error,
1735 * then hold onto the transport lock.
1741 if (RPC_IS_SOFTCONN(task
)) {
1742 xprt_end_transmit(task
);
1743 rpc_exit(task
, task
->tk_status
);
1749 rpc_task_force_reencode(task
);
1753 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1755 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1756 * addition, disconnect on connectivity errors.
1759 call_bc_transmit(struct rpc_task
*task
)
1761 struct rpc_rqst
*req
= task
->tk_rqstp
;
1763 task
->tk_status
= xprt_prepare_transmit(task
);
1764 if (task
->tk_status
== -EAGAIN
) {
1766 * Could not reserve the transport. Try again after the
1767 * transport is released.
1769 task
->tk_status
= 0;
1770 task
->tk_action
= call_bc_transmit
;
1774 task
->tk_action
= rpc_exit_task
;
1775 if (task
->tk_status
< 0) {
1776 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1777 "error: %d\n", task
->tk_status
);
1781 xprt_transmit(task
);
1782 xprt_end_transmit(task
);
1783 dprint_status(task
);
1784 switch (task
->tk_status
) {
1793 * Problem reaching the server. Disconnect and let the
1794 * forechannel reestablish the connection. The server will
1795 * have to retransmit the backchannel request and we'll
1796 * reprocess it. Since these ops are idempotent, there's no
1797 * need to cache our reply at this time.
1799 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1800 "error: %d\n", task
->tk_status
);
1801 xprt_conditional_disconnect(req
->rq_xprt
,
1802 req
->rq_connect_cookie
);
1806 * We were unable to reply and will have to drop the
1807 * request. The server should reconnect and retransmit.
1809 WARN_ON_ONCE(task
->tk_status
== -EAGAIN
);
1810 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1811 "error: %d\n", task
->tk_status
);
1814 rpc_wake_up_queued_task(&req
->rq_xprt
->pending
, task
);
1816 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1819 * 6. Sort out the RPC call status
1822 call_status(struct rpc_task
*task
)
1824 struct rpc_clnt
*clnt
= task
->tk_client
;
1825 struct rpc_rqst
*req
= task
->tk_rqstp
;
1828 if (req
->rq_reply_bytes_recvd
> 0 && !req
->rq_bytes_sent
)
1829 task
->tk_status
= req
->rq_reply_bytes_recvd
;
1831 dprint_status(task
);
1833 status
= task
->tk_status
;
1835 task
->tk_action
= call_decode
;
1839 trace_rpc_call_status(task
);
1840 task
->tk_status
= 0;
1846 * Delay any retries for 3 seconds, then handle as if it
1849 rpc_delay(task
, 3*HZ
);
1851 task
->tk_action
= call_timeout
;
1852 if (task
->tk_client
->cl_discrtry
)
1853 xprt_conditional_disconnect(req
->rq_xprt
,
1854 req
->rq_connect_cookie
);
1858 rpc_force_rebind(clnt
);
1859 rpc_delay(task
, 3*HZ
);
1862 task
->tk_action
= call_bind
;
1865 task
->tk_action
= call_transmit
;
1868 /* shutdown or soft timeout */
1869 rpc_exit(task
, status
);
1872 if (clnt
->cl_chatty
)
1873 printk("%s: RPC call returned error %d\n",
1874 clnt
->cl_protname
, -status
);
1875 rpc_exit(task
, status
);
1880 * 6a. Handle RPC timeout
1881 * We do not release the request slot, so we keep using the
1882 * same XID for all retransmits.
1885 call_timeout(struct rpc_task
*task
)
1887 struct rpc_clnt
*clnt
= task
->tk_client
;
1889 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
1890 dprintk("RPC: %5u call_timeout (minor)\n", task
->tk_pid
);
1894 dprintk("RPC: %5u call_timeout (major)\n", task
->tk_pid
);
1895 task
->tk_timeouts
++;
1897 if (RPC_IS_SOFTCONN(task
)) {
1898 rpc_exit(task
, -ETIMEDOUT
);
1901 if (RPC_IS_SOFT(task
)) {
1902 if (clnt
->cl_chatty
) {
1904 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1906 rcu_dereference(clnt
->cl_xprt
)->servername
);
1909 if (task
->tk_flags
& RPC_TASK_TIMEOUT
)
1910 rpc_exit(task
, -ETIMEDOUT
);
1912 rpc_exit(task
, -EIO
);
1916 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1917 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1918 if (clnt
->cl_chatty
) {
1920 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1922 rcu_dereference(clnt
->cl_xprt
)->servername
);
1926 rpc_force_rebind(clnt
);
1928 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1929 * event? RFC2203 requires the server to drop all such requests.
1931 rpcauth_invalcred(task
);
1934 clnt
->cl_stats
->rpcretrans
++;
1935 task
->tk_action
= call_bind
;
1936 task
->tk_status
= 0;
1940 * 7. Decode the RPC reply
1943 call_decode(struct rpc_task
*task
)
1945 struct rpc_clnt
*clnt
= task
->tk_client
;
1946 struct rpc_rqst
*req
= task
->tk_rqstp
;
1947 kxdrdproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1950 dprint_status(task
);
1952 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1953 if (clnt
->cl_chatty
) {
1955 printk(KERN_NOTICE
"%s: server %s OK\n",
1957 rcu_dereference(clnt
->cl_xprt
)->servername
);
1960 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
1964 * Ensure that we see all writes made by xprt_complete_rqst()
1965 * before it changed req->rq_reply_bytes_recvd.
1968 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
1970 /* Check that the softirq receive buffer is valid */
1971 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
1972 sizeof(req
->rq_rcv_buf
)) != 0);
1974 if (req
->rq_rcv_buf
.len
< 12) {
1975 if (!RPC_IS_SOFT(task
)) {
1976 task
->tk_action
= call_bind
;
1977 clnt
->cl_stats
->rpcretrans
++;
1980 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1981 clnt
->cl_protname
, task
->tk_status
);
1982 task
->tk_action
= call_timeout
;
1986 p
= rpc_verify_header(task
);
1988 if (p
== ERR_PTR(-EAGAIN
))
1993 task
->tk_action
= rpc_exit_task
;
1996 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
1997 task
->tk_msg
.rpc_resp
);
1999 dprintk("RPC: %5u call_decode result %d\n", task
->tk_pid
,
2003 task
->tk_status
= 0;
2004 /* Note: rpc_verify_header() may have freed the RPC slot */
2005 if (task
->tk_rqstp
== req
) {
2006 req
->rq_reply_bytes_recvd
= req
->rq_rcv_buf
.len
= 0;
2007 if (task
->tk_client
->cl_discrtry
)
2008 xprt_conditional_disconnect(req
->rq_xprt
,
2009 req
->rq_connect_cookie
);
2014 rpc_encode_header(struct rpc_task
*task
)
2016 struct rpc_clnt
*clnt
= task
->tk_client
;
2017 struct rpc_rqst
*req
= task
->tk_rqstp
;
2018 __be32
*p
= req
->rq_svec
[0].iov_base
;
2020 /* FIXME: check buffer size? */
2022 p
= xprt_skip_transport_header(req
->rq_xprt
, p
);
2023 *p
++ = req
->rq_xid
; /* XID */
2024 *p
++ = htonl(RPC_CALL
); /* CALL */
2025 *p
++ = htonl(RPC_VERSION
); /* RPC version */
2026 *p
++ = htonl(clnt
->cl_prog
); /* program number */
2027 *p
++ = htonl(clnt
->cl_vers
); /* program version */
2028 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
2029 p
= rpcauth_marshcred(task
, p
);
2030 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
2035 rpc_verify_header(struct rpc_task
*task
)
2037 struct rpc_clnt
*clnt
= task
->tk_client
;
2038 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
2039 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
2040 __be32
*p
= iov
->iov_base
;
2042 int error
= -EACCES
;
2044 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
2045 /* RFC-1014 says that the representation of XDR data must be a
2046 * multiple of four bytes
2047 * - if it isn't pointer subtraction in the NFS client may give
2050 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2051 " 4 bytes: 0x%x\n", task
->tk_pid
, __func__
,
2052 task
->tk_rqstp
->rq_rcv_buf
.len
);
2058 p
+= 1; /* skip XID */
2059 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
2060 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2061 task
->tk_pid
, __func__
, n
);
2065 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
2068 switch ((n
= ntohl(*p
++))) {
2069 case RPC_AUTH_ERROR
:
2072 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2073 task
->tk_pid
, __func__
);
2074 error
= -EPROTONOSUPPORT
;
2077 dprintk("RPC: %5u %s: RPC call rejected, "
2078 "unknown error: %x\n",
2079 task
->tk_pid
, __func__
, n
);
2084 switch ((n
= ntohl(*p
++))) {
2085 case RPC_AUTH_REJECTEDCRED
:
2086 case RPC_AUTH_REJECTEDVERF
:
2087 case RPCSEC_GSS_CREDPROBLEM
:
2088 case RPCSEC_GSS_CTXPROBLEM
:
2089 if (!task
->tk_cred_retry
)
2091 task
->tk_cred_retry
--;
2092 dprintk("RPC: %5u %s: retry stale creds\n",
2093 task
->tk_pid
, __func__
);
2094 rpcauth_invalcred(task
);
2095 /* Ensure we obtain a new XID! */
2097 task
->tk_action
= call_reserve
;
2099 case RPC_AUTH_BADCRED
:
2100 case RPC_AUTH_BADVERF
:
2101 /* possibly garbled cred/verf? */
2102 if (!task
->tk_garb_retry
)
2104 task
->tk_garb_retry
--;
2105 dprintk("RPC: %5u %s: retry garbled creds\n",
2106 task
->tk_pid
, __func__
);
2107 task
->tk_action
= call_bind
;
2109 case RPC_AUTH_TOOWEAK
:
2111 printk(KERN_NOTICE
"RPC: server %s requires stronger "
2112 "authentication.\n",
2113 rcu_dereference(clnt
->cl_xprt
)->servername
);
2117 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2118 task
->tk_pid
, __func__
, n
);
2121 dprintk("RPC: %5u %s: call rejected %d\n",
2122 task
->tk_pid
, __func__
, n
);
2125 if (!(p
= rpcauth_checkverf(task
, p
))) {
2126 dprintk("RPC: %5u %s: auth check failed\n",
2127 task
->tk_pid
, __func__
);
2128 goto out_garbage
; /* bad verifier, retry */
2130 len
= p
- (__be32
*)iov
->iov_base
- 1;
2133 switch ((n
= ntohl(*p
++))) {
2136 case RPC_PROG_UNAVAIL
:
2137 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2138 "by server %s\n", task
->tk_pid
, __func__
,
2139 (unsigned int)clnt
->cl_prog
,
2140 rcu_dereference(clnt
->cl_xprt
)->servername
);
2141 error
= -EPFNOSUPPORT
;
2143 case RPC_PROG_MISMATCH
:
2144 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2145 "by server %s\n", task
->tk_pid
, __func__
,
2146 (unsigned int)clnt
->cl_prog
,
2147 (unsigned int)clnt
->cl_vers
,
2148 rcu_dereference(clnt
->cl_xprt
)->servername
);
2149 error
= -EPROTONOSUPPORT
;
2151 case RPC_PROC_UNAVAIL
:
2152 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2153 "version %u on server %s\n",
2154 task
->tk_pid
, __func__
,
2155 rpc_proc_name(task
),
2156 clnt
->cl_prog
, clnt
->cl_vers
,
2157 rcu_dereference(clnt
->cl_xprt
)->servername
);
2158 error
= -EOPNOTSUPP
;
2160 case RPC_GARBAGE_ARGS
:
2161 dprintk("RPC: %5u %s: server saw garbage\n",
2162 task
->tk_pid
, __func__
);
2165 dprintk("RPC: %5u %s: server accept status: %x\n",
2166 task
->tk_pid
, __func__
, n
);
2171 clnt
->cl_stats
->rpcgarbage
++;
2172 if (task
->tk_garb_retry
) {
2173 task
->tk_garb_retry
--;
2174 dprintk("RPC: %5u %s: retrying\n",
2175 task
->tk_pid
, __func__
);
2176 task
->tk_action
= call_bind
;
2178 return ERR_PTR(-EAGAIN
);
2183 rpc_exit(task
, error
);
2184 dprintk("RPC: %5u %s: call failed with error %d\n", task
->tk_pid
,
2186 return ERR_PTR(error
);
2188 dprintk("RPC: %5u %s: server reply was truncated.\n", task
->tk_pid
,
2193 static void rpcproc_encode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
2197 static int rpcproc_decode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
2202 static struct rpc_procinfo rpcproc_null
= {
2203 .p_encode
= rpcproc_encode_null
,
2204 .p_decode
= rpcproc_decode_null
,
2207 static int rpc_ping(struct rpc_clnt
*clnt
)
2209 struct rpc_message msg
= {
2210 .rpc_proc
= &rpcproc_null
,
2213 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
2214 err
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
);
2215 put_rpccred(msg
.rpc_cred
);
2219 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
2221 struct rpc_message msg
= {
2222 .rpc_proc
= &rpcproc_null
,
2225 struct rpc_task_setup task_setup_data
= {
2227 .rpc_message
= &msg
,
2228 .callback_ops
= &rpc_default_ops
,
2231 return rpc_run_task(&task_setup_data
);
2233 EXPORT_SYMBOL_GPL(rpc_call_null
);
2236 static void rpc_show_header(void)
2238 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
2239 "-timeout ---ops--\n");
2242 static void rpc_show_task(const struct rpc_clnt
*clnt
,
2243 const struct rpc_task
*task
)
2245 const char *rpc_waitq
= "none";
2247 if (RPC_IS_QUEUED(task
))
2248 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
2250 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2251 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
2252 clnt
, task
->tk_rqstp
, task
->tk_timeout
, task
->tk_ops
,
2253 clnt
->cl_protname
, clnt
->cl_vers
, rpc_proc_name(task
),
2254 task
->tk_action
, rpc_waitq
);
2257 void rpc_show_tasks(struct net
*net
)
2259 struct rpc_clnt
*clnt
;
2260 struct rpc_task
*task
;
2262 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
2264 spin_lock(&sn
->rpc_client_lock
);
2265 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
2266 spin_lock(&clnt
->cl_lock
);
2267 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
2272 rpc_show_task(clnt
, task
);
2274 spin_unlock(&clnt
->cl_lock
);
2276 spin_unlock(&sn
->rpc_client_lock
);