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 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
24 #include <asm/system.h>
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/kallsyms.h>
30 #include <linux/namei.h>
31 #include <linux/mount.h>
32 #include <linux/slab.h>
33 #include <linux/utsname.h>
34 #include <linux/workqueue.h>
35 #include <linux/in6.h>
37 #include <linux/sunrpc/clnt.h>
38 #include <linux/sunrpc/rpc_pipe_fs.h>
39 #include <linux/sunrpc/metrics.h>
40 #include <linux/sunrpc/bc_xprt.h>
45 # define RPCDBG_FACILITY RPCDBG_CALL
48 #define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
50 __func__, t->tk_status)
53 * All RPC clients are linked into this list
55 static LIST_HEAD(all_clients
);
56 static DEFINE_SPINLOCK(rpc_client_lock
);
58 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
61 static void call_start(struct rpc_task
*task
);
62 static void call_reserve(struct rpc_task
*task
);
63 static void call_reserveresult(struct rpc_task
*task
);
64 static void call_allocate(struct rpc_task
*task
);
65 static void call_decode(struct rpc_task
*task
);
66 static void call_bind(struct rpc_task
*task
);
67 static void call_bind_status(struct rpc_task
*task
);
68 static void call_transmit(struct rpc_task
*task
);
69 #if defined(CONFIG_NFS_V4_1)
70 static void call_bc_transmit(struct rpc_task
*task
);
71 #endif /* CONFIG_NFS_V4_1 */
72 static void call_status(struct rpc_task
*task
);
73 static void call_transmit_status(struct rpc_task
*task
);
74 static void call_refresh(struct rpc_task
*task
);
75 static void call_refreshresult(struct rpc_task
*task
);
76 static void call_timeout(struct rpc_task
*task
);
77 static void call_connect(struct rpc_task
*task
);
78 static void call_connect_status(struct rpc_task
*task
);
80 static __be32
*rpc_encode_header(struct rpc_task
*task
);
81 static __be32
*rpc_verify_header(struct rpc_task
*task
);
82 static int rpc_ping(struct rpc_clnt
*clnt
);
84 static void rpc_register_client(struct rpc_clnt
*clnt
)
86 spin_lock(&rpc_client_lock
);
87 list_add(&clnt
->cl_clients
, &all_clients
);
88 spin_unlock(&rpc_client_lock
);
91 static void rpc_unregister_client(struct rpc_clnt
*clnt
)
93 spin_lock(&rpc_client_lock
);
94 list_del(&clnt
->cl_clients
);
95 spin_unlock(&rpc_client_lock
);
99 rpc_setup_pipedir(struct rpc_clnt
*clnt
, char *dir_name
)
101 static uint32_t clntid
;
110 clnt
->cl_path
.mnt
= ERR_PTR(-ENOENT
);
111 clnt
->cl_path
.dentry
= ERR_PTR(-ENOENT
);
112 if (dir_name
== NULL
)
115 path
.mnt
= rpc_get_mount();
116 if (IS_ERR(path
.mnt
))
117 return PTR_ERR(path
.mnt
);
118 error
= vfs_path_lookup(path
.mnt
->mnt_root
, path
.mnt
, dir_name
, 0, &nd
);
123 q
.len
= snprintf(name
, sizeof(name
), "clnt%x", (unsigned int)clntid
++);
124 name
[sizeof(name
) - 1] = '\0';
125 q
.hash
= full_name_hash(q
.name
, q
.len
);
126 path
.dentry
= rpc_create_client_dir(nd
.path
.dentry
, &q
, clnt
);
127 if (!IS_ERR(path
.dentry
))
129 error
= PTR_ERR(path
.dentry
);
130 if (error
!= -EEXIST
) {
131 printk(KERN_INFO
"RPC: Couldn't create pipefs entry"
132 " %s/%s, error %d\n",
133 dir_name
, name
, error
);
138 clnt
->cl_path
= path
;
147 static struct rpc_clnt
* rpc_new_client(const struct rpc_create_args
*args
, struct rpc_xprt
*xprt
)
149 struct rpc_program
*program
= args
->program
;
150 struct rpc_version
*version
;
151 struct rpc_clnt
*clnt
= NULL
;
152 struct rpc_auth
*auth
;
156 /* sanity check the name before trying to print it */
158 len
= strlen(args
->servername
);
159 if (len
> RPC_MAXNETNAMELEN
)
163 dprintk("RPC: creating %s client for %s (xprt %p)\n",
164 program
->name
, args
->servername
, xprt
);
173 if (args
->version
>= program
->nrvers
)
175 version
= program
->version
[args
->version
];
180 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
183 clnt
->cl_parent
= clnt
;
185 clnt
->cl_server
= clnt
->cl_inline_name
;
186 if (len
> sizeof(clnt
->cl_inline_name
)) {
187 char *buf
= kmalloc(len
, GFP_KERNEL
);
189 clnt
->cl_server
= buf
;
191 len
= sizeof(clnt
->cl_inline_name
);
193 strlcpy(clnt
->cl_server
, args
->servername
, len
);
195 clnt
->cl_xprt
= xprt
;
196 clnt
->cl_procinfo
= version
->procs
;
197 clnt
->cl_maxproc
= version
->nrprocs
;
198 clnt
->cl_protname
= program
->name
;
199 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
200 clnt
->cl_vers
= version
->number
;
201 clnt
->cl_stats
= program
->stats
;
202 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
204 if (clnt
->cl_metrics
== NULL
)
206 clnt
->cl_program
= program
;
207 INIT_LIST_HEAD(&clnt
->cl_tasks
);
208 spin_lock_init(&clnt
->cl_lock
);
210 if (!xprt_bound(clnt
->cl_xprt
))
211 clnt
->cl_autobind
= 1;
213 clnt
->cl_timeout
= xprt
->timeout
;
214 if (args
->timeout
!= NULL
) {
215 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
216 sizeof(clnt
->cl_timeout_default
));
217 clnt
->cl_timeout
= &clnt
->cl_timeout_default
;
220 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
221 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
222 clnt
->cl_principal
= NULL
;
223 if (args
->client_name
) {
224 clnt
->cl_principal
= kstrdup(args
->client_name
, GFP_KERNEL
);
225 if (!clnt
->cl_principal
)
226 goto out_no_principal
;
229 kref_init(&clnt
->cl_kref
);
231 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
235 auth
= rpcauth_create(args
->authflavor
, clnt
);
237 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
243 /* save the nodename */
244 clnt
->cl_nodelen
= strlen(init_utsname()->nodename
);
245 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
246 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
247 memcpy(clnt
->cl_nodename
, init_utsname()->nodename
, clnt
->cl_nodelen
);
248 rpc_register_client(clnt
);
252 if (!IS_ERR(clnt
->cl_path
.dentry
)) {
253 rpc_remove_client_dir(clnt
->cl_path
.dentry
);
257 kfree(clnt
->cl_principal
);
259 rpc_free_iostats(clnt
->cl_metrics
);
261 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
262 kfree(clnt
->cl_server
);
273 * rpc_create - create an RPC client and transport with one call
274 * @args: rpc_clnt create argument structure
276 * Creates and initializes an RPC transport and an RPC client.
278 * It can ping the server in order to determine if it is up, and to see if
279 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
280 * this behavior so asynchronous tasks can also use rpc_create.
282 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
284 struct rpc_xprt
*xprt
;
285 struct rpc_clnt
*clnt
;
286 struct xprt_create xprtargs
= {
287 .ident
= args
->protocol
,
288 .srcaddr
= args
->saddress
,
289 .dstaddr
= args
->address
,
290 .addrlen
= args
->addrsize
,
291 .bc_xprt
= args
->bc_xprt
,
296 * If the caller chooses not to specify a hostname, whip
297 * up a string representation of the passed-in address.
299 if (args
->servername
== NULL
) {
300 servername
[0] = '\0';
301 switch (args
->address
->sa_family
) {
303 struct sockaddr_in
*sin
=
304 (struct sockaddr_in
*)args
->address
;
305 snprintf(servername
, sizeof(servername
), "%pI4",
306 &sin
->sin_addr
.s_addr
);
310 struct sockaddr_in6
*sin
=
311 (struct sockaddr_in6
*)args
->address
;
312 snprintf(servername
, sizeof(servername
), "%pI6",
317 /* caller wants default server name, but
318 * address family isn't recognized. */
319 return ERR_PTR(-EINVAL
);
321 args
->servername
= servername
;
324 xprt
= xprt_create_transport(&xprtargs
);
326 return (struct rpc_clnt
*)xprt
;
329 * By default, kernel RPC client connects from a reserved port.
330 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
331 * but it is always enabled for rpciod, which handles the connect
335 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
338 clnt
= rpc_new_client(args
, xprt
);
342 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
343 int err
= rpc_ping(clnt
);
345 rpc_shutdown_client(clnt
);
350 clnt
->cl_softrtry
= 1;
351 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
352 clnt
->cl_softrtry
= 0;
354 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
355 clnt
->cl_autobind
= 1;
356 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
357 clnt
->cl_discrtry
= 1;
358 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
363 EXPORT_SYMBOL_GPL(rpc_create
);
366 * This function clones the RPC client structure. It allows us to share the
367 * same transport while varying parameters such as the authentication
371 rpc_clone_client(struct rpc_clnt
*clnt
)
373 struct rpc_clnt
*new;
376 new = kmemdup(clnt
, sizeof(*new), GFP_KERNEL
);
379 new->cl_parent
= clnt
;
380 /* Turn off autobind on clones */
381 new->cl_autobind
= 0;
382 INIT_LIST_HEAD(&new->cl_tasks
);
383 spin_lock_init(&new->cl_lock
);
384 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
385 new->cl_metrics
= rpc_alloc_iostats(clnt
);
386 if (new->cl_metrics
== NULL
)
388 if (clnt
->cl_principal
) {
389 new->cl_principal
= kstrdup(clnt
->cl_principal
, GFP_KERNEL
);
390 if (new->cl_principal
== NULL
)
391 goto out_no_principal
;
393 kref_init(&new->cl_kref
);
394 err
= rpc_setup_pipedir(new, clnt
->cl_program
->pipe_dir_name
);
398 atomic_inc(&new->cl_auth
->au_count
);
399 xprt_get(clnt
->cl_xprt
);
400 kref_get(&clnt
->cl_kref
);
401 rpc_register_client(new);
405 kfree(new->cl_principal
);
407 rpc_free_iostats(new->cl_metrics
);
411 dprintk("RPC: %s: returned error %d\n", __func__
, err
);
414 EXPORT_SYMBOL_GPL(rpc_clone_client
);
417 * Properly shut down an RPC client, terminating all outstanding
420 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
422 dprintk("RPC: shutting down %s client for %s\n",
423 clnt
->cl_protname
, clnt
->cl_server
);
425 while (!list_empty(&clnt
->cl_tasks
)) {
426 rpc_killall_tasks(clnt
);
427 wait_event_timeout(destroy_wait
,
428 list_empty(&clnt
->cl_tasks
), 1*HZ
);
431 rpc_release_client(clnt
);
433 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
439 rpc_free_client(struct kref
*kref
)
441 struct rpc_clnt
*clnt
= container_of(kref
, struct rpc_clnt
, cl_kref
);
443 dprintk("RPC: destroying %s client for %s\n",
444 clnt
->cl_protname
, clnt
->cl_server
);
445 if (!IS_ERR(clnt
->cl_path
.dentry
)) {
446 rpc_remove_client_dir(clnt
->cl_path
.dentry
);
449 if (clnt
->cl_parent
!= clnt
) {
450 rpc_release_client(clnt
->cl_parent
);
453 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
454 kfree(clnt
->cl_server
);
456 rpc_unregister_client(clnt
);
457 rpc_free_iostats(clnt
->cl_metrics
);
458 kfree(clnt
->cl_principal
);
459 clnt
->cl_metrics
= NULL
;
460 xprt_put(clnt
->cl_xprt
);
469 rpc_free_auth(struct kref
*kref
)
471 struct rpc_clnt
*clnt
= container_of(kref
, struct rpc_clnt
, cl_kref
);
473 if (clnt
->cl_auth
== NULL
) {
474 rpc_free_client(kref
);
479 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
480 * release remaining GSS contexts. This mechanism ensures
481 * that it can do so safely.
484 rpcauth_release(clnt
->cl_auth
);
485 clnt
->cl_auth
= NULL
;
486 kref_put(kref
, rpc_free_client
);
490 * Release reference to the RPC client
493 rpc_release_client(struct rpc_clnt
*clnt
)
495 dprintk("RPC: rpc_release_client(%p)\n", clnt
);
497 if (list_empty(&clnt
->cl_tasks
))
498 wake_up(&destroy_wait
);
499 kref_put(&clnt
->cl_kref
, rpc_free_auth
);
503 * rpc_bind_new_program - bind a new RPC program to an existing client
504 * @old: old rpc_client
505 * @program: rpc program to set
506 * @vers: rpc program version
508 * Clones the rpc client and sets up a new RPC program. This is mainly
509 * of use for enabling different RPC programs to share the same transport.
510 * The Sun NFSv2/v3 ACL protocol can do this.
512 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
513 struct rpc_program
*program
,
516 struct rpc_clnt
*clnt
;
517 struct rpc_version
*version
;
520 BUG_ON(vers
>= program
->nrvers
|| !program
->version
[vers
]);
521 version
= program
->version
[vers
];
522 clnt
= rpc_clone_client(old
);
525 clnt
->cl_procinfo
= version
->procs
;
526 clnt
->cl_maxproc
= version
->nrprocs
;
527 clnt
->cl_protname
= program
->name
;
528 clnt
->cl_prog
= program
->number
;
529 clnt
->cl_vers
= version
->number
;
530 clnt
->cl_stats
= program
->stats
;
531 err
= rpc_ping(clnt
);
533 rpc_shutdown_client(clnt
);
539 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
542 * Default callback for async RPC calls
545 rpc_default_callback(struct rpc_task
*task
, void *data
)
549 static const struct rpc_call_ops rpc_default_ops
= {
550 .rpc_call_done
= rpc_default_callback
,
554 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
555 * @task_setup_data: pointer to task initialisation data
557 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
559 struct rpc_task
*task
, *ret
;
561 task
= rpc_new_task(task_setup_data
);
563 rpc_release_calldata(task_setup_data
->callback_ops
,
564 task_setup_data
->callback_data
);
565 ret
= ERR_PTR(-ENOMEM
);
569 if (task
->tk_status
!= 0) {
570 ret
= ERR_PTR(task
->tk_status
);
574 atomic_inc(&task
->tk_count
);
580 EXPORT_SYMBOL_GPL(rpc_run_task
);
583 * rpc_call_sync - Perform a synchronous RPC call
584 * @clnt: pointer to RPC client
585 * @msg: RPC call parameters
586 * @flags: RPC call flags
588 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
590 struct rpc_task
*task
;
591 struct rpc_task_setup task_setup_data
= {
594 .callback_ops
= &rpc_default_ops
,
599 BUG_ON(flags
& RPC_TASK_ASYNC
);
601 task
= rpc_run_task(&task_setup_data
);
603 return PTR_ERR(task
);
604 status
= task
->tk_status
;
608 EXPORT_SYMBOL_GPL(rpc_call_sync
);
611 * rpc_call_async - Perform an asynchronous RPC call
612 * @clnt: pointer to RPC client
613 * @msg: RPC call parameters
614 * @flags: RPC call flags
615 * @tk_ops: RPC call ops
616 * @data: user call data
619 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
620 const struct rpc_call_ops
*tk_ops
, void *data
)
622 struct rpc_task
*task
;
623 struct rpc_task_setup task_setup_data
= {
626 .callback_ops
= tk_ops
,
627 .callback_data
= data
,
628 .flags
= flags
|RPC_TASK_ASYNC
,
631 task
= rpc_run_task(&task_setup_data
);
633 return PTR_ERR(task
);
637 EXPORT_SYMBOL_GPL(rpc_call_async
);
639 #if defined(CONFIG_NFS_V4_1)
641 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
642 * rpc_execute against it
644 * @tk_ops: RPC call ops
646 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
,
647 const struct rpc_call_ops
*tk_ops
)
649 struct rpc_task
*task
;
650 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
651 struct rpc_task_setup task_setup_data
= {
652 .callback_ops
= tk_ops
,
655 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
657 * Create an rpc_task to send the data
659 task
= rpc_new_task(&task_setup_data
);
661 xprt_free_bc_request(req
);
664 task
->tk_rqstp
= req
;
667 * Set up the xdr_buf length.
668 * This also indicates that the buffer is XDR encoded already.
670 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
671 xbufp
->tail
[0].iov_len
;
673 task
->tk_action
= call_bc_transmit
;
674 atomic_inc(&task
->tk_count
);
675 BUG_ON(atomic_read(&task
->tk_count
) != 2);
679 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
682 #endif /* CONFIG_NFS_V4_1 */
685 rpc_call_start(struct rpc_task
*task
)
687 task
->tk_action
= call_start
;
689 EXPORT_SYMBOL_GPL(rpc_call_start
);
692 * rpc_peeraddr - extract remote peer address from clnt's xprt
693 * @clnt: RPC client structure
694 * @buf: target buffer
695 * @bufsize: length of target buffer
697 * Returns the number of bytes that are actually in the stored address.
699 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
702 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
704 bytes
= sizeof(xprt
->addr
);
707 memcpy(buf
, &clnt
->cl_xprt
->addr
, bytes
);
708 return xprt
->addrlen
;
710 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
713 * rpc_peeraddr2str - return remote peer address in printable format
714 * @clnt: RPC client structure
715 * @format: address format
718 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
719 enum rpc_display_format_t format
)
721 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
723 if (xprt
->address_strings
[format
] != NULL
)
724 return xprt
->address_strings
[format
];
726 return "unprintable";
728 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
731 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
733 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
734 if (xprt
->ops
->set_buffer_size
)
735 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
737 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
740 * Return size of largest payload RPC client can support, in bytes
742 * For stream transports, this is one RPC record fragment (see RFC
743 * 1831), as we don't support multi-record requests yet. For datagram
744 * transports, this is the size of an IP packet minus the IP, UDP, and
747 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
749 return clnt
->cl_xprt
->max_payload
;
751 EXPORT_SYMBOL_GPL(rpc_max_payload
);
754 * rpc_force_rebind - force transport to check that remote port is unchanged
755 * @clnt: client to rebind
758 void rpc_force_rebind(struct rpc_clnt
*clnt
)
760 if (clnt
->cl_autobind
)
761 xprt_clear_bound(clnt
->cl_xprt
);
763 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
766 * Restart an (async) RPC call from the call_prepare state.
767 * Usually called from within the exit handler.
770 rpc_restart_call_prepare(struct rpc_task
*task
)
772 if (RPC_ASSASSINATED(task
))
774 task
->tk_action
= rpc_prepare_task
;
776 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
779 * Restart an (async) RPC call. Usually called from within the
783 rpc_restart_call(struct rpc_task
*task
)
785 if (RPC_ASSASSINATED(task
))
788 task
->tk_action
= call_start
;
790 EXPORT_SYMBOL_GPL(rpc_restart_call
);
793 static const char *rpc_proc_name(const struct rpc_task
*task
)
795 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
810 * Other FSM states can be visited zero or more times, but
811 * this state is visited exactly once for each RPC.
814 call_start(struct rpc_task
*task
)
816 struct rpc_clnt
*clnt
= task
->tk_client
;
818 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task
->tk_pid
,
819 clnt
->cl_protname
, clnt
->cl_vers
,
821 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
823 /* Increment call count */
824 task
->tk_msg
.rpc_proc
->p_count
++;
825 clnt
->cl_stats
->rpccnt
++;
826 task
->tk_action
= call_reserve
;
830 * 1. Reserve an RPC call slot
833 call_reserve(struct rpc_task
*task
)
837 if (!rpcauth_uptodatecred(task
)) {
838 task
->tk_action
= call_refresh
;
843 task
->tk_action
= call_reserveresult
;
848 * 1b. Grok the result of xprt_reserve()
851 call_reserveresult(struct rpc_task
*task
)
853 int status
= task
->tk_status
;
858 * After a call to xprt_reserve(), we must have either
859 * a request slot or else an error status.
863 if (task
->tk_rqstp
) {
864 task
->tk_action
= call_allocate
;
868 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
870 rpc_exit(task
, -EIO
);
875 * Even though there was an error, we may have acquired
876 * a request slot somehow. Make sure not to leak it.
878 if (task
->tk_rqstp
) {
879 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
885 case -EAGAIN
: /* woken up; retry */
886 task
->tk_action
= call_reserve
;
888 case -EIO
: /* probably a shutdown */
891 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
895 rpc_exit(task
, status
);
899 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
900 * (Note: buffer memory is freed in xprt_release).
903 call_allocate(struct rpc_task
*task
)
905 unsigned int slack
= task
->tk_msg
.rpc_cred
->cr_auth
->au_cslack
;
906 struct rpc_rqst
*req
= task
->tk_rqstp
;
907 struct rpc_xprt
*xprt
= task
->tk_xprt
;
908 struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
913 task
->tk_action
= call_bind
;
918 if (proc
->p_proc
!= 0) {
919 BUG_ON(proc
->p_arglen
== 0);
920 if (proc
->p_decode
!= NULL
)
921 BUG_ON(proc
->p_replen
== 0);
925 * Calculate the size (in quads) of the RPC call
926 * and reply headers, and convert both values
929 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (slack
<< 1) + proc
->p_arglen
;
930 req
->rq_callsize
<<= 2;
931 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ slack
+ proc
->p_replen
;
932 req
->rq_rcvsize
<<= 2;
934 req
->rq_buffer
= xprt
->ops
->buf_alloc(task
,
935 req
->rq_callsize
+ req
->rq_rcvsize
);
936 if (req
->rq_buffer
!= NULL
)
939 dprintk("RPC: %5u rpc_buffer allocation failed\n", task
->tk_pid
);
941 if (RPC_IS_ASYNC(task
) || !signalled()) {
942 task
->tk_action
= call_allocate
;
943 rpc_delay(task
, HZ
>>4);
947 rpc_exit(task
, -ERESTARTSYS
);
951 rpc_task_need_encode(struct rpc_task
*task
)
953 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
957 rpc_task_force_reencode(struct rpc_task
*task
)
959 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
960 task
->tk_rqstp
->rq_bytes_sent
= 0;
964 rpc_xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
966 buf
->head
[0].iov_base
= start
;
967 buf
->head
[0].iov_len
= len
;
968 buf
->tail
[0].iov_len
= 0;
976 * 3. Encode arguments of an RPC call
979 rpc_xdr_encode(struct rpc_task
*task
)
981 struct rpc_rqst
*req
= task
->tk_rqstp
;
987 rpc_xdr_buf_init(&req
->rq_snd_buf
,
990 rpc_xdr_buf_init(&req
->rq_rcv_buf
,
991 (char *)req
->rq_buffer
+ req
->rq_callsize
,
994 p
= rpc_encode_header(task
);
996 printk(KERN_INFO
"RPC: couldn't encode RPC header, exit EIO\n");
997 rpc_exit(task
, -EIO
);
1001 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
1005 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
1006 task
->tk_msg
.rpc_argp
);
1010 * 4. Get the server port number if not yet set
1013 call_bind(struct rpc_task
*task
)
1015 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1017 dprint_status(task
);
1019 task
->tk_action
= call_connect
;
1020 if (!xprt_bound(xprt
)) {
1021 task
->tk_action
= call_bind_status
;
1022 task
->tk_timeout
= xprt
->bind_timeout
;
1023 xprt
->ops
->rpcbind(task
);
1028 * 4a. Sort out bind result
1031 call_bind_status(struct rpc_task
*task
)
1035 if (task
->tk_status
>= 0) {
1036 dprint_status(task
);
1037 task
->tk_status
= 0;
1038 task
->tk_action
= call_connect
;
1042 switch (task
->tk_status
) {
1044 dprintk("RPC: %5u rpcbind out of memory\n", task
->tk_pid
);
1045 rpc_delay(task
, HZ
>> 2);
1048 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1049 "unavailable\n", task
->tk_pid
);
1050 /* fail immediately if this is an RPC ping */
1051 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1052 status
= -EOPNOTSUPP
;
1055 rpc_delay(task
, 3*HZ
);
1058 dprintk("RPC: %5u rpcbind request timed out\n",
1062 /* server doesn't support any rpcbind version we know of */
1063 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1066 case -EPROTONOSUPPORT
:
1067 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1069 task
->tk_status
= 0;
1070 task
->tk_action
= call_bind
;
1072 case -ECONNREFUSED
: /* connection problems */
1079 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1080 task
->tk_pid
, task
->tk_status
);
1081 if (!RPC_IS_SOFTCONN(task
)) {
1082 rpc_delay(task
, 5*HZ
);
1085 status
= task
->tk_status
;
1088 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1089 task
->tk_pid
, -task
->tk_status
);
1092 rpc_exit(task
, status
);
1096 task
->tk_action
= call_timeout
;
1100 * 4b. Connect to the RPC server
1103 call_connect(struct rpc_task
*task
)
1105 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1107 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1109 (xprt_connected(xprt
) ? "is" : "is not"));
1111 task
->tk_action
= call_transmit
;
1112 if (!xprt_connected(xprt
)) {
1113 task
->tk_action
= call_connect_status
;
1114 if (task
->tk_status
< 0)
1121 * 4c. Sort out connect result
1124 call_connect_status(struct rpc_task
*task
)
1126 struct rpc_clnt
*clnt
= task
->tk_client
;
1127 int status
= task
->tk_status
;
1129 dprint_status(task
);
1131 task
->tk_status
= 0;
1132 if (status
>= 0 || status
== -EAGAIN
) {
1133 clnt
->cl_stats
->netreconn
++;
1134 task
->tk_action
= call_transmit
;
1139 /* if soft mounted, test if we've timed out */
1141 task
->tk_action
= call_timeout
;
1144 rpc_exit(task
, -EIO
);
1149 * 5. Transmit the RPC request, and wait for reply
1152 call_transmit(struct rpc_task
*task
)
1154 dprint_status(task
);
1156 task
->tk_action
= call_status
;
1157 if (task
->tk_status
< 0)
1159 task
->tk_status
= xprt_prepare_transmit(task
);
1160 if (task
->tk_status
!= 0)
1162 task
->tk_action
= call_transmit_status
;
1163 /* Encode here so that rpcsec_gss can use correct sequence number. */
1164 if (rpc_task_need_encode(task
)) {
1165 BUG_ON(task
->tk_rqstp
->rq_bytes_sent
!= 0);
1166 rpc_xdr_encode(task
);
1167 /* Did the encode result in an error condition? */
1168 if (task
->tk_status
!= 0) {
1169 /* Was the error nonfatal? */
1170 if (task
->tk_status
== -EAGAIN
)
1171 rpc_delay(task
, HZ
>> 4);
1173 rpc_exit(task
, task
->tk_status
);
1177 xprt_transmit(task
);
1178 if (task
->tk_status
< 0)
1181 * On success, ensure that we call xprt_end_transmit() before sleeping
1182 * in order to allow access to the socket to other RPC requests.
1184 call_transmit_status(task
);
1185 if (rpc_reply_expected(task
))
1187 task
->tk_action
= rpc_exit_task
;
1188 rpc_wake_up_queued_task(&task
->tk_xprt
->pending
, task
);
1192 * 5a. Handle cleanup after a transmission
1195 call_transmit_status(struct rpc_task
*task
)
1197 task
->tk_action
= call_status
;
1200 * Common case: success. Force the compiler to put this
1203 if (task
->tk_status
== 0) {
1204 xprt_end_transmit(task
);
1205 rpc_task_force_reencode(task
);
1209 switch (task
->tk_status
) {
1213 dprint_status(task
);
1214 xprt_end_transmit(task
);
1215 rpc_task_force_reencode(task
);
1218 * Special cases: if we've been waiting on the
1219 * socket's write_space() callback, or if the
1220 * socket just returned a connection error,
1221 * then hold onto the transport lock.
1227 if (RPC_IS_SOFTCONN(task
)) {
1228 xprt_end_transmit(task
);
1229 rpc_exit(task
, task
->tk_status
);
1235 rpc_task_force_reencode(task
);
1239 #if defined(CONFIG_NFS_V4_1)
1241 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1242 * addition, disconnect on connectivity errors.
1245 call_bc_transmit(struct rpc_task
*task
)
1247 struct rpc_rqst
*req
= task
->tk_rqstp
;
1249 BUG_ON(task
->tk_status
!= 0);
1250 task
->tk_status
= xprt_prepare_transmit(task
);
1251 if (task
->tk_status
== -EAGAIN
) {
1253 * Could not reserve the transport. Try again after the
1254 * transport is released.
1256 task
->tk_status
= 0;
1257 task
->tk_action
= call_bc_transmit
;
1261 task
->tk_action
= rpc_exit_task
;
1262 if (task
->tk_status
< 0) {
1263 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1264 "error: %d\n", task
->tk_status
);
1268 xprt_transmit(task
);
1269 xprt_end_transmit(task
);
1270 dprint_status(task
);
1271 switch (task
->tk_status
) {
1280 * Problem reaching the server. Disconnect and let the
1281 * forechannel reestablish the connection. The server will
1282 * have to retransmit the backchannel request and we'll
1283 * reprocess it. Since these ops are idempotent, there's no
1284 * need to cache our reply at this time.
1286 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1287 "error: %d\n", task
->tk_status
);
1288 xprt_conditional_disconnect(task
->tk_xprt
,
1289 req
->rq_connect_cookie
);
1293 * We were unable to reply and will have to drop the
1294 * request. The server should reconnect and retransmit.
1296 BUG_ON(task
->tk_status
== -EAGAIN
);
1297 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1298 "error: %d\n", task
->tk_status
);
1301 rpc_wake_up_queued_task(&req
->rq_xprt
->pending
, task
);
1303 #endif /* CONFIG_NFS_V4_1 */
1306 * 6. Sort out the RPC call status
1309 call_status(struct rpc_task
*task
)
1311 struct rpc_clnt
*clnt
= task
->tk_client
;
1312 struct rpc_rqst
*req
= task
->tk_rqstp
;
1315 if (req
->rq_reply_bytes_recvd
> 0 && !req
->rq_bytes_sent
)
1316 task
->tk_status
= req
->rq_reply_bytes_recvd
;
1318 dprint_status(task
);
1320 status
= task
->tk_status
;
1322 task
->tk_action
= call_decode
;
1326 task
->tk_status
= 0;
1332 * Delay any retries for 3 seconds, then handle as if it
1335 rpc_delay(task
, 3*HZ
);
1337 task
->tk_action
= call_timeout
;
1338 if (task
->tk_client
->cl_discrtry
)
1339 xprt_conditional_disconnect(task
->tk_xprt
,
1340 req
->rq_connect_cookie
);
1344 rpc_force_rebind(clnt
);
1345 rpc_delay(task
, 3*HZ
);
1348 task
->tk_action
= call_bind
;
1351 task
->tk_action
= call_transmit
;
1354 /* shutdown or soft timeout */
1355 rpc_exit(task
, status
);
1358 if (clnt
->cl_chatty
)
1359 printk("%s: RPC call returned error %d\n",
1360 clnt
->cl_protname
, -status
);
1361 rpc_exit(task
, status
);
1366 * 6a. Handle RPC timeout
1367 * We do not release the request slot, so we keep using the
1368 * same XID for all retransmits.
1371 call_timeout(struct rpc_task
*task
)
1373 struct rpc_clnt
*clnt
= task
->tk_client
;
1375 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
1376 dprintk("RPC: %5u call_timeout (minor)\n", task
->tk_pid
);
1380 dprintk("RPC: %5u call_timeout (major)\n", task
->tk_pid
);
1381 task
->tk_timeouts
++;
1383 if (RPC_IS_SOFTCONN(task
)) {
1384 rpc_exit(task
, -ETIMEDOUT
);
1387 if (RPC_IS_SOFT(task
)) {
1388 if (clnt
->cl_chatty
)
1389 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1390 clnt
->cl_protname
, clnt
->cl_server
);
1391 rpc_exit(task
, -EIO
);
1395 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1396 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1397 if (clnt
->cl_chatty
)
1398 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1399 clnt
->cl_protname
, clnt
->cl_server
);
1401 rpc_force_rebind(clnt
);
1403 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1404 * event? RFC2203 requires the server to drop all such requests.
1406 rpcauth_invalcred(task
);
1409 clnt
->cl_stats
->rpcretrans
++;
1410 task
->tk_action
= call_bind
;
1411 task
->tk_status
= 0;
1415 * 7. Decode the RPC reply
1418 call_decode(struct rpc_task
*task
)
1420 struct rpc_clnt
*clnt
= task
->tk_client
;
1421 struct rpc_rqst
*req
= task
->tk_rqstp
;
1422 kxdrproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1425 dprintk("RPC: %5u call_decode (status %d)\n",
1426 task
->tk_pid
, task
->tk_status
);
1428 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1429 if (clnt
->cl_chatty
)
1430 printk(KERN_NOTICE
"%s: server %s OK\n",
1431 clnt
->cl_protname
, clnt
->cl_server
);
1432 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
1436 * Ensure that we see all writes made by xprt_complete_rqst()
1437 * before it changed req->rq_reply_bytes_recvd.
1440 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
1442 /* Check that the softirq receive buffer is valid */
1443 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
1444 sizeof(req
->rq_rcv_buf
)) != 0);
1446 if (req
->rq_rcv_buf
.len
< 12) {
1447 if (!RPC_IS_SOFT(task
)) {
1448 task
->tk_action
= call_bind
;
1449 clnt
->cl_stats
->rpcretrans
++;
1452 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1453 clnt
->cl_protname
, task
->tk_status
);
1454 task
->tk_action
= call_timeout
;
1458 p
= rpc_verify_header(task
);
1460 if (p
== ERR_PTR(-EAGAIN
))
1465 task
->tk_action
= rpc_exit_task
;
1468 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
1469 task
->tk_msg
.rpc_resp
);
1471 dprintk("RPC: %5u call_decode result %d\n", task
->tk_pid
,
1475 task
->tk_status
= 0;
1476 /* Note: rpc_verify_header() may have freed the RPC slot */
1477 if (task
->tk_rqstp
== req
) {
1478 req
->rq_reply_bytes_recvd
= req
->rq_rcv_buf
.len
= 0;
1479 if (task
->tk_client
->cl_discrtry
)
1480 xprt_conditional_disconnect(task
->tk_xprt
,
1481 req
->rq_connect_cookie
);
1486 * 8. Refresh the credentials if rejected by the server
1489 call_refresh(struct rpc_task
*task
)
1491 dprint_status(task
);
1493 task
->tk_action
= call_refreshresult
;
1494 task
->tk_status
= 0;
1495 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1496 rpcauth_refreshcred(task
);
1500 * 8a. Process the results of a credential refresh
1503 call_refreshresult(struct rpc_task
*task
)
1505 int status
= task
->tk_status
;
1507 dprint_status(task
);
1509 task
->tk_status
= 0;
1510 task
->tk_action
= call_reserve
;
1511 if (status
>= 0 && rpcauth_uptodatecred(task
))
1513 if (status
== -EACCES
) {
1514 rpc_exit(task
, -EACCES
);
1517 task
->tk_action
= call_refresh
;
1518 if (status
!= -ETIMEDOUT
)
1519 rpc_delay(task
, 3*HZ
);
1524 rpc_encode_header(struct rpc_task
*task
)
1526 struct rpc_clnt
*clnt
= task
->tk_client
;
1527 struct rpc_rqst
*req
= task
->tk_rqstp
;
1528 __be32
*p
= req
->rq_svec
[0].iov_base
;
1530 /* FIXME: check buffer size? */
1532 p
= xprt_skip_transport_header(task
->tk_xprt
, p
);
1533 *p
++ = req
->rq_xid
; /* XID */
1534 *p
++ = htonl(RPC_CALL
); /* CALL */
1535 *p
++ = htonl(RPC_VERSION
); /* RPC version */
1536 *p
++ = htonl(clnt
->cl_prog
); /* program number */
1537 *p
++ = htonl(clnt
->cl_vers
); /* program version */
1538 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
1539 p
= rpcauth_marshcred(task
, p
);
1540 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
1545 rpc_verify_header(struct rpc_task
*task
)
1547 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
1548 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
1549 __be32
*p
= iov
->iov_base
;
1551 int error
= -EACCES
;
1553 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
1554 /* RFC-1014 says that the representation of XDR data must be a
1555 * multiple of four bytes
1556 * - if it isn't pointer subtraction in the NFS client may give
1559 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1560 " 4 bytes: 0x%x\n", task
->tk_pid
, __func__
,
1561 task
->tk_rqstp
->rq_rcv_buf
.len
);
1567 p
+= 1; /* skip XID */
1568 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
1569 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1570 task
->tk_pid
, __func__
, n
);
1574 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
1577 switch ((n
= ntohl(*p
++))) {
1578 case RPC_AUTH_ERROR
:
1581 dprintk("RPC: %5u %s: RPC call version "
1583 task
->tk_pid
, __func__
);
1584 error
= -EPROTONOSUPPORT
;
1587 dprintk("RPC: %5u %s: RPC call rejected, "
1588 "unknown error: %x\n",
1589 task
->tk_pid
, __func__
, n
);
1594 switch ((n
= ntohl(*p
++))) {
1595 case RPC_AUTH_REJECTEDCRED
:
1596 case RPC_AUTH_REJECTEDVERF
:
1597 case RPCSEC_GSS_CREDPROBLEM
:
1598 case RPCSEC_GSS_CTXPROBLEM
:
1599 if (!task
->tk_cred_retry
)
1601 task
->tk_cred_retry
--;
1602 dprintk("RPC: %5u %s: retry stale creds\n",
1603 task
->tk_pid
, __func__
);
1604 rpcauth_invalcred(task
);
1605 /* Ensure we obtain a new XID! */
1607 task
->tk_action
= call_refresh
;
1609 case RPC_AUTH_BADCRED
:
1610 case RPC_AUTH_BADVERF
:
1611 /* possibly garbled cred/verf? */
1612 if (!task
->tk_garb_retry
)
1614 task
->tk_garb_retry
--;
1615 dprintk("RPC: %5u %s: retry garbled creds\n",
1616 task
->tk_pid
, __func__
);
1617 task
->tk_action
= call_bind
;
1619 case RPC_AUTH_TOOWEAK
:
1620 printk(KERN_NOTICE
"RPC: server %s requires stronger "
1621 "authentication.\n", task
->tk_client
->cl_server
);
1624 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1625 task
->tk_pid
, __func__
, n
);
1628 dprintk("RPC: %5u %s: call rejected %d\n",
1629 task
->tk_pid
, __func__
, n
);
1632 if (!(p
= rpcauth_checkverf(task
, p
))) {
1633 dprintk("RPC: %5u %s: auth check failed\n",
1634 task
->tk_pid
, __func__
);
1635 goto out_garbage
; /* bad verifier, retry */
1637 len
= p
- (__be32
*)iov
->iov_base
- 1;
1640 switch ((n
= ntohl(*p
++))) {
1643 case RPC_PROG_UNAVAIL
:
1644 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1645 task
->tk_pid
, __func__
,
1646 (unsigned int)task
->tk_client
->cl_prog
,
1647 task
->tk_client
->cl_server
);
1648 error
= -EPFNOSUPPORT
;
1650 case RPC_PROG_MISMATCH
:
1651 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1652 "server %s\n", task
->tk_pid
, __func__
,
1653 (unsigned int)task
->tk_client
->cl_prog
,
1654 (unsigned int)task
->tk_client
->cl_vers
,
1655 task
->tk_client
->cl_server
);
1656 error
= -EPROTONOSUPPORT
;
1658 case RPC_PROC_UNAVAIL
:
1659 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1660 "version %u on server %s\n",
1661 task
->tk_pid
, __func__
,
1662 rpc_proc_name(task
),
1663 task
->tk_client
->cl_prog
,
1664 task
->tk_client
->cl_vers
,
1665 task
->tk_client
->cl_server
);
1666 error
= -EOPNOTSUPP
;
1668 case RPC_GARBAGE_ARGS
:
1669 dprintk("RPC: %5u %s: server saw garbage\n",
1670 task
->tk_pid
, __func__
);
1673 dprintk("RPC: %5u %s: server accept status: %x\n",
1674 task
->tk_pid
, __func__
, n
);
1679 task
->tk_client
->cl_stats
->rpcgarbage
++;
1680 if (task
->tk_garb_retry
) {
1681 task
->tk_garb_retry
--;
1682 dprintk("RPC: %5u %s: retrying\n",
1683 task
->tk_pid
, __func__
);
1684 task
->tk_action
= call_bind
;
1686 return ERR_PTR(-EAGAIN
);
1691 rpc_exit(task
, error
);
1692 dprintk("RPC: %5u %s: call failed with error %d\n", task
->tk_pid
,
1694 return ERR_PTR(error
);
1696 dprintk("RPC: %5u %s: server reply was truncated.\n", task
->tk_pid
,
1701 static int rpcproc_encode_null(void *rqstp
, __be32
*data
, void *obj
)
1706 static int rpcproc_decode_null(void *rqstp
, __be32
*data
, void *obj
)
1711 static struct rpc_procinfo rpcproc_null
= {
1712 .p_encode
= rpcproc_encode_null
,
1713 .p_decode
= rpcproc_decode_null
,
1716 static int rpc_ping(struct rpc_clnt
*clnt
)
1718 struct rpc_message msg
= {
1719 .rpc_proc
= &rpcproc_null
,
1722 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
1723 err
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
);
1724 put_rpccred(msg
.rpc_cred
);
1728 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
1730 struct rpc_message msg
= {
1731 .rpc_proc
= &rpcproc_null
,
1734 struct rpc_task_setup task_setup_data
= {
1736 .rpc_message
= &msg
,
1737 .callback_ops
= &rpc_default_ops
,
1740 return rpc_run_task(&task_setup_data
);
1742 EXPORT_SYMBOL_GPL(rpc_call_null
);
1745 static void rpc_show_header(void)
1747 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
1748 "-timeout ---ops--\n");
1751 static void rpc_show_task(const struct rpc_clnt
*clnt
,
1752 const struct rpc_task
*task
)
1754 const char *rpc_waitq
= "none";
1755 char *p
, action
[KSYM_SYMBOL_LEN
];
1757 if (RPC_IS_QUEUED(task
))
1758 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
1760 /* map tk_action pointer to a function name; then trim off
1761 * the "+0x0 [sunrpc]" */
1762 sprint_symbol(action
, (unsigned long)task
->tk_action
);
1763 p
= strchr(action
, '+');
1767 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1768 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
1769 clnt
, task
->tk_rqstp
, task
->tk_timeout
, task
->tk_ops
,
1770 clnt
->cl_protname
, clnt
->cl_vers
, rpc_proc_name(task
),
1774 void rpc_show_tasks(void)
1776 struct rpc_clnt
*clnt
;
1777 struct rpc_task
*task
;
1780 spin_lock(&rpc_client_lock
);
1781 list_for_each_entry(clnt
, &all_clients
, cl_clients
) {
1782 spin_lock(&clnt
->cl_lock
);
1783 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
1788 rpc_show_task(clnt
, task
);
1790 spin_unlock(&clnt
->cl_lock
);
1792 spin_unlock(&rpc_client_lock
);