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 atomic_set(&clnt
->cl_count
, 1);
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
= {
288 .ident
= args
->protocol
,
289 .srcaddr
= args
->saddress
,
290 .dstaddr
= args
->address
,
291 .addrlen
= args
->addrsize
,
292 .bc_xprt
= args
->bc_xprt
,
297 * If the caller chooses not to specify a hostname, whip
298 * up a string representation of the passed-in address.
300 if (args
->servername
== NULL
) {
301 servername
[0] = '\0';
302 switch (args
->address
->sa_family
) {
304 struct sockaddr_in
*sin
=
305 (struct sockaddr_in
*)args
->address
;
306 snprintf(servername
, sizeof(servername
), "%pI4",
307 &sin
->sin_addr
.s_addr
);
311 struct sockaddr_in6
*sin
=
312 (struct sockaddr_in6
*)args
->address
;
313 snprintf(servername
, sizeof(servername
), "%pI6",
318 /* caller wants default server name, but
319 * address family isn't recognized. */
320 return ERR_PTR(-EINVAL
);
322 args
->servername
= servername
;
325 xprt
= xprt_create_transport(&xprtargs
);
327 return (struct rpc_clnt
*)xprt
;
330 * By default, kernel RPC client connects from a reserved port.
331 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
332 * but it is always enabled for rpciod, which handles the connect
336 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
339 clnt
= rpc_new_client(args
, xprt
);
343 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
344 int err
= rpc_ping(clnt
);
346 rpc_shutdown_client(clnt
);
351 clnt
->cl_softrtry
= 1;
352 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
353 clnt
->cl_softrtry
= 0;
355 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
356 clnt
->cl_autobind
= 1;
357 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
358 clnt
->cl_discrtry
= 1;
359 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
364 EXPORT_SYMBOL_GPL(rpc_create
);
367 * This function clones the RPC client structure. It allows us to share the
368 * same transport while varying parameters such as the authentication
372 rpc_clone_client(struct rpc_clnt
*clnt
)
374 struct rpc_clnt
*new;
377 new = kmemdup(clnt
, sizeof(*new), GFP_KERNEL
);
380 new->cl_parent
= clnt
;
381 /* Turn off autobind on clones */
382 new->cl_autobind
= 0;
383 INIT_LIST_HEAD(&new->cl_tasks
);
384 spin_lock_init(&new->cl_lock
);
385 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
386 new->cl_metrics
= rpc_alloc_iostats(clnt
);
387 if (new->cl_metrics
== NULL
)
389 if (clnt
->cl_principal
) {
390 new->cl_principal
= kstrdup(clnt
->cl_principal
, GFP_KERNEL
);
391 if (new->cl_principal
== NULL
)
392 goto out_no_principal
;
394 atomic_set(&new->cl_count
, 1);
395 err
= rpc_setup_pipedir(new, clnt
->cl_program
->pipe_dir_name
);
399 atomic_inc(&new->cl_auth
->au_count
);
400 xprt_get(clnt
->cl_xprt
);
401 atomic_inc(&clnt
->cl_count
);
402 rpc_register_client(new);
406 kfree(new->cl_principal
);
408 rpc_free_iostats(new->cl_metrics
);
412 dprintk("RPC: %s: returned error %d\n", __func__
, err
);
415 EXPORT_SYMBOL_GPL(rpc_clone_client
);
418 * Kill all tasks for the given client.
419 * XXX: kill their descendants as well?
421 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
423 struct rpc_task
*rovr
;
426 if (list_empty(&clnt
->cl_tasks
))
428 dprintk("RPC: killing all tasks for client %p\n", clnt
);
430 * Spin lock all_tasks to prevent changes...
432 spin_lock(&clnt
->cl_lock
);
433 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
) {
434 if (!RPC_IS_ACTIVATED(rovr
))
436 if (!(rovr
->tk_flags
& RPC_TASK_KILLED
)) {
437 rovr
->tk_flags
|= RPC_TASK_KILLED
;
438 rpc_exit(rovr
, -EIO
);
439 if (RPC_IS_QUEUED(rovr
))
440 rpc_wake_up_queued_task(rovr
->tk_waitqueue
,
444 spin_unlock(&clnt
->cl_lock
);
446 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
449 * Properly shut down an RPC client, terminating all outstanding
452 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
454 dprintk("RPC: shutting down %s client for %s\n",
455 clnt
->cl_protname
, clnt
->cl_server
);
457 while (!list_empty(&clnt
->cl_tasks
)) {
458 rpc_killall_tasks(clnt
);
459 wait_event_timeout(destroy_wait
,
460 list_empty(&clnt
->cl_tasks
), 1*HZ
);
463 rpc_release_client(clnt
);
465 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
471 rpc_free_client(struct rpc_clnt
*clnt
)
473 dprintk("RPC: destroying %s client for %s\n",
474 clnt
->cl_protname
, clnt
->cl_server
);
475 if (!IS_ERR(clnt
->cl_path
.dentry
)) {
476 rpc_remove_client_dir(clnt
->cl_path
.dentry
);
479 if (clnt
->cl_parent
!= clnt
) {
480 rpc_release_client(clnt
->cl_parent
);
483 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
484 kfree(clnt
->cl_server
);
486 rpc_unregister_client(clnt
);
487 rpc_free_iostats(clnt
->cl_metrics
);
488 kfree(clnt
->cl_principal
);
489 clnt
->cl_metrics
= NULL
;
490 xprt_put(clnt
->cl_xprt
);
499 rpc_free_auth(struct rpc_clnt
*clnt
)
501 if (clnt
->cl_auth
== NULL
) {
502 rpc_free_client(clnt
);
507 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
508 * release remaining GSS contexts. This mechanism ensures
509 * that it can do so safely.
511 atomic_inc(&clnt
->cl_count
);
512 rpcauth_release(clnt
->cl_auth
);
513 clnt
->cl_auth
= NULL
;
514 if (atomic_dec_and_test(&clnt
->cl_count
))
515 rpc_free_client(clnt
);
519 * Release reference to the RPC client
522 rpc_release_client(struct rpc_clnt
*clnt
)
524 dprintk("RPC: rpc_release_client(%p)\n", clnt
);
526 if (list_empty(&clnt
->cl_tasks
))
527 wake_up(&destroy_wait
);
528 if (atomic_dec_and_test(&clnt
->cl_count
))
533 * rpc_bind_new_program - bind a new RPC program to an existing client
534 * @old: old rpc_client
535 * @program: rpc program to set
536 * @vers: rpc program version
538 * Clones the rpc client and sets up a new RPC program. This is mainly
539 * of use for enabling different RPC programs to share the same transport.
540 * The Sun NFSv2/v3 ACL protocol can do this.
542 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
543 struct rpc_program
*program
,
546 struct rpc_clnt
*clnt
;
547 struct rpc_version
*version
;
550 BUG_ON(vers
>= program
->nrvers
|| !program
->version
[vers
]);
551 version
= program
->version
[vers
];
552 clnt
= rpc_clone_client(old
);
555 clnt
->cl_procinfo
= version
->procs
;
556 clnt
->cl_maxproc
= version
->nrprocs
;
557 clnt
->cl_protname
= program
->name
;
558 clnt
->cl_prog
= program
->number
;
559 clnt
->cl_vers
= version
->number
;
560 clnt
->cl_stats
= program
->stats
;
561 err
= rpc_ping(clnt
);
563 rpc_shutdown_client(clnt
);
569 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
571 void rpc_task_release_client(struct rpc_task
*task
)
573 struct rpc_clnt
*clnt
= task
->tk_client
;
576 /* Remove from client task list */
577 spin_lock(&clnt
->cl_lock
);
578 list_del(&task
->tk_task
);
579 spin_unlock(&clnt
->cl_lock
);
580 task
->tk_client
= NULL
;
582 rpc_release_client(clnt
);
587 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
590 rpc_task_release_client(task
);
591 task
->tk_client
= clnt
;
592 atomic_inc(&clnt
->cl_count
);
593 if (clnt
->cl_softrtry
)
594 task
->tk_flags
|= RPC_TASK_SOFT
;
595 /* Add to the client's list of all tasks */
596 spin_lock(&clnt
->cl_lock
);
597 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
598 spin_unlock(&clnt
->cl_lock
);
603 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
606 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
607 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
608 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
609 if (msg
->rpc_cred
!= NULL
)
610 task
->tk_msg
.rpc_cred
= get_rpccred(msg
->rpc_cred
);
615 * Default callback for async RPC calls
618 rpc_default_callback(struct rpc_task
*task
, void *data
)
622 static const struct rpc_call_ops rpc_default_ops
= {
623 .rpc_call_done
= rpc_default_callback
,
627 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
628 * @task_setup_data: pointer to task initialisation data
630 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
632 struct rpc_task
*task
;
634 task
= rpc_new_task(task_setup_data
);
638 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
639 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
641 if (task
->tk_status
!= 0) {
642 int ret
= task
->tk_status
;
647 if (task
->tk_action
== NULL
)
648 rpc_call_start(task
);
650 atomic_inc(&task
->tk_count
);
655 EXPORT_SYMBOL_GPL(rpc_run_task
);
658 * rpc_call_sync - Perform a synchronous RPC call
659 * @clnt: pointer to RPC client
660 * @msg: RPC call parameters
661 * @flags: RPC call flags
663 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
665 struct rpc_task
*task
;
666 struct rpc_task_setup task_setup_data
= {
669 .callback_ops
= &rpc_default_ops
,
674 BUG_ON(flags
& RPC_TASK_ASYNC
);
676 task
= rpc_run_task(&task_setup_data
);
678 return PTR_ERR(task
);
679 status
= task
->tk_status
;
683 EXPORT_SYMBOL_GPL(rpc_call_sync
);
686 * rpc_call_async - Perform an asynchronous RPC call
687 * @clnt: pointer to RPC client
688 * @msg: RPC call parameters
689 * @flags: RPC call flags
690 * @tk_ops: RPC call ops
691 * @data: user call data
694 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
695 const struct rpc_call_ops
*tk_ops
, void *data
)
697 struct rpc_task
*task
;
698 struct rpc_task_setup task_setup_data
= {
701 .callback_ops
= tk_ops
,
702 .callback_data
= data
,
703 .flags
= flags
|RPC_TASK_ASYNC
,
706 task
= rpc_run_task(&task_setup_data
);
708 return PTR_ERR(task
);
712 EXPORT_SYMBOL_GPL(rpc_call_async
);
714 #if defined(CONFIG_NFS_V4_1)
716 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
717 * rpc_execute against it
719 * @tk_ops: RPC call ops
721 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
,
722 const struct rpc_call_ops
*tk_ops
)
724 struct rpc_task
*task
;
725 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
726 struct rpc_task_setup task_setup_data
= {
727 .callback_ops
= tk_ops
,
730 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
732 * Create an rpc_task to send the data
734 task
= rpc_new_task(&task_setup_data
);
736 xprt_free_bc_request(req
);
739 task
->tk_rqstp
= req
;
742 * Set up the xdr_buf length.
743 * This also indicates that the buffer is XDR encoded already.
745 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
746 xbufp
->tail
[0].iov_len
;
748 task
->tk_action
= call_bc_transmit
;
749 atomic_inc(&task
->tk_count
);
750 BUG_ON(atomic_read(&task
->tk_count
) != 2);
754 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
757 #endif /* CONFIG_NFS_V4_1 */
760 rpc_call_start(struct rpc_task
*task
)
762 task
->tk_action
= call_start
;
764 EXPORT_SYMBOL_GPL(rpc_call_start
);
767 * rpc_peeraddr - extract remote peer address from clnt's xprt
768 * @clnt: RPC client structure
769 * @buf: target buffer
770 * @bufsize: length of target buffer
772 * Returns the number of bytes that are actually in the stored address.
774 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
777 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
779 bytes
= sizeof(xprt
->addr
);
782 memcpy(buf
, &clnt
->cl_xprt
->addr
, bytes
);
783 return xprt
->addrlen
;
785 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
788 * rpc_peeraddr2str - return remote peer address in printable format
789 * @clnt: RPC client structure
790 * @format: address format
793 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
794 enum rpc_display_format_t format
)
796 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
798 if (xprt
->address_strings
[format
] != NULL
)
799 return xprt
->address_strings
[format
];
801 return "unprintable";
803 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
806 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
808 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
809 if (xprt
->ops
->set_buffer_size
)
810 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
812 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
815 * Return size of largest payload RPC client can support, in bytes
817 * For stream transports, this is one RPC record fragment (see RFC
818 * 1831), as we don't support multi-record requests yet. For datagram
819 * transports, this is the size of an IP packet minus the IP, UDP, and
822 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
824 return clnt
->cl_xprt
->max_payload
;
826 EXPORT_SYMBOL_GPL(rpc_max_payload
);
829 * rpc_force_rebind - force transport to check that remote port is unchanged
830 * @clnt: client to rebind
833 void rpc_force_rebind(struct rpc_clnt
*clnt
)
835 if (clnt
->cl_autobind
)
836 xprt_clear_bound(clnt
->cl_xprt
);
838 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
841 * Restart an (async) RPC call from the call_prepare state.
842 * Usually called from within the exit handler.
845 rpc_restart_call_prepare(struct rpc_task
*task
)
847 if (RPC_ASSASSINATED(task
))
849 task
->tk_action
= rpc_prepare_task
;
852 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
855 * Restart an (async) RPC call. Usually called from within the
859 rpc_restart_call(struct rpc_task
*task
)
861 if (RPC_ASSASSINATED(task
))
863 task
->tk_action
= call_start
;
866 EXPORT_SYMBOL_GPL(rpc_restart_call
);
869 static const char *rpc_proc_name(const struct rpc_task
*task
)
871 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
886 * Other FSM states can be visited zero or more times, but
887 * this state is visited exactly once for each RPC.
890 call_start(struct rpc_task
*task
)
892 struct rpc_clnt
*clnt
= task
->tk_client
;
894 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task
->tk_pid
,
895 clnt
->cl_protname
, clnt
->cl_vers
,
897 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
899 /* Increment call count */
900 task
->tk_msg
.rpc_proc
->p_count
++;
901 clnt
->cl_stats
->rpccnt
++;
902 task
->tk_action
= call_reserve
;
906 * 1. Reserve an RPC call slot
909 call_reserve(struct rpc_task
*task
)
914 task
->tk_action
= call_reserveresult
;
919 * 1b. Grok the result of xprt_reserve()
922 call_reserveresult(struct rpc_task
*task
)
924 int status
= task
->tk_status
;
929 * After a call to xprt_reserve(), we must have either
930 * a request slot or else an error status.
934 if (task
->tk_rqstp
) {
935 task
->tk_action
= call_refresh
;
939 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
941 rpc_exit(task
, -EIO
);
946 * Even though there was an error, we may have acquired
947 * a request slot somehow. Make sure not to leak it.
949 if (task
->tk_rqstp
) {
950 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
956 case -EAGAIN
: /* woken up; retry */
957 task
->tk_action
= call_reserve
;
959 case -EIO
: /* probably a shutdown */
962 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
966 rpc_exit(task
, status
);
970 * 2. Bind and/or refresh the credentials
973 call_refresh(struct rpc_task
*task
)
977 task
->tk_action
= call_refreshresult
;
979 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
980 rpcauth_refreshcred(task
);
984 * 2a. Process the results of a credential refresh
987 call_refreshresult(struct rpc_task
*task
)
989 int status
= task
->tk_status
;
994 task
->tk_action
= call_refresh
;
997 if (rpcauth_uptodatecred(task
))
998 task
->tk_action
= call_allocate
;
1001 rpc_delay(task
, 3*HZ
);
1004 if (!task
->tk_cred_retry
)
1006 task
->tk_cred_retry
--;
1007 dprintk("RPC: %5u %s: retry refresh creds\n",
1008 task
->tk_pid
, __func__
);
1011 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1012 task
->tk_pid
, __func__
, status
);
1013 rpc_exit(task
, status
);
1017 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1018 * (Note: buffer memory is freed in xprt_release).
1021 call_allocate(struct rpc_task
*task
)
1023 unsigned int slack
= task
->tk_rqstp
->rq_cred
->cr_auth
->au_cslack
;
1024 struct rpc_rqst
*req
= task
->tk_rqstp
;
1025 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1026 struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1028 dprint_status(task
);
1030 task
->tk_status
= 0;
1031 task
->tk_action
= call_bind
;
1036 if (proc
->p_proc
!= 0) {
1037 BUG_ON(proc
->p_arglen
== 0);
1038 if (proc
->p_decode
!= NULL
)
1039 BUG_ON(proc
->p_replen
== 0);
1043 * Calculate the size (in quads) of the RPC call
1044 * and reply headers, and convert both values
1047 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (slack
<< 1) + proc
->p_arglen
;
1048 req
->rq_callsize
<<= 2;
1049 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ slack
+ proc
->p_replen
;
1050 req
->rq_rcvsize
<<= 2;
1052 req
->rq_buffer
= xprt
->ops
->buf_alloc(task
,
1053 req
->rq_callsize
+ req
->rq_rcvsize
);
1054 if (req
->rq_buffer
!= NULL
)
1057 dprintk("RPC: %5u rpc_buffer allocation failed\n", task
->tk_pid
);
1059 if (RPC_IS_ASYNC(task
) || !signalled()) {
1060 task
->tk_action
= call_allocate
;
1061 rpc_delay(task
, HZ
>>4);
1065 rpc_exit(task
, -ERESTARTSYS
);
1069 rpc_task_need_encode(struct rpc_task
*task
)
1071 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
1075 rpc_task_force_reencode(struct rpc_task
*task
)
1077 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
1078 task
->tk_rqstp
->rq_bytes_sent
= 0;
1082 rpc_xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
1084 buf
->head
[0].iov_base
= start
;
1085 buf
->head
[0].iov_len
= len
;
1086 buf
->tail
[0].iov_len
= 0;
1094 * 3. Encode arguments of an RPC call
1097 rpc_xdr_encode(struct rpc_task
*task
)
1099 struct rpc_rqst
*req
= task
->tk_rqstp
;
1103 dprint_status(task
);
1105 rpc_xdr_buf_init(&req
->rq_snd_buf
,
1108 rpc_xdr_buf_init(&req
->rq_rcv_buf
,
1109 (char *)req
->rq_buffer
+ req
->rq_callsize
,
1112 p
= rpc_encode_header(task
);
1114 printk(KERN_INFO
"RPC: couldn't encode RPC header, exit EIO\n");
1115 rpc_exit(task
, -EIO
);
1119 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
1123 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
1124 task
->tk_msg
.rpc_argp
);
1128 * 4. Get the server port number if not yet set
1131 call_bind(struct rpc_task
*task
)
1133 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1135 dprint_status(task
);
1137 task
->tk_action
= call_connect
;
1138 if (!xprt_bound(xprt
)) {
1139 task
->tk_action
= call_bind_status
;
1140 task
->tk_timeout
= xprt
->bind_timeout
;
1141 xprt
->ops
->rpcbind(task
);
1146 * 4a. Sort out bind result
1149 call_bind_status(struct rpc_task
*task
)
1153 if (task
->tk_status
>= 0) {
1154 dprint_status(task
);
1155 task
->tk_status
= 0;
1156 task
->tk_action
= call_connect
;
1160 switch (task
->tk_status
) {
1162 dprintk("RPC: %5u rpcbind out of memory\n", task
->tk_pid
);
1163 rpc_delay(task
, HZ
>> 2);
1166 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1167 "unavailable\n", task
->tk_pid
);
1168 /* fail immediately if this is an RPC ping */
1169 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1170 status
= -EOPNOTSUPP
;
1173 rpc_delay(task
, 3*HZ
);
1176 dprintk("RPC: %5u rpcbind request timed out\n",
1180 /* server doesn't support any rpcbind version we know of */
1181 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1184 case -EPROTONOSUPPORT
:
1185 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1187 task
->tk_status
= 0;
1188 task
->tk_action
= call_bind
;
1190 case -ECONNREFUSED
: /* connection problems */
1197 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1198 task
->tk_pid
, task
->tk_status
);
1199 if (!RPC_IS_SOFTCONN(task
)) {
1200 rpc_delay(task
, 5*HZ
);
1203 status
= task
->tk_status
;
1206 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1207 task
->tk_pid
, -task
->tk_status
);
1210 rpc_exit(task
, status
);
1214 task
->tk_action
= call_timeout
;
1218 * 4b. Connect to the RPC server
1221 call_connect(struct rpc_task
*task
)
1223 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1225 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1227 (xprt_connected(xprt
) ? "is" : "is not"));
1229 task
->tk_action
= call_transmit
;
1230 if (!xprt_connected(xprt
)) {
1231 task
->tk_action
= call_connect_status
;
1232 if (task
->tk_status
< 0)
1239 * 4c. Sort out connect result
1242 call_connect_status(struct rpc_task
*task
)
1244 struct rpc_clnt
*clnt
= task
->tk_client
;
1245 int status
= task
->tk_status
;
1247 dprint_status(task
);
1249 task
->tk_status
= 0;
1250 if (status
>= 0 || status
== -EAGAIN
) {
1251 clnt
->cl_stats
->netreconn
++;
1252 task
->tk_action
= call_transmit
;
1257 /* if soft mounted, test if we've timed out */
1259 task
->tk_action
= call_timeout
;
1262 rpc_exit(task
, -EIO
);
1267 * 5. Transmit the RPC request, and wait for reply
1270 call_transmit(struct rpc_task
*task
)
1272 dprint_status(task
);
1274 task
->tk_action
= call_status
;
1275 if (task
->tk_status
< 0)
1277 task
->tk_status
= xprt_prepare_transmit(task
);
1278 if (task
->tk_status
!= 0)
1280 task
->tk_action
= call_transmit_status
;
1281 /* Encode here so that rpcsec_gss can use correct sequence number. */
1282 if (rpc_task_need_encode(task
)) {
1283 BUG_ON(task
->tk_rqstp
->rq_bytes_sent
!= 0);
1284 rpc_xdr_encode(task
);
1285 /* Did the encode result in an error condition? */
1286 if (task
->tk_status
!= 0) {
1287 /* Was the error nonfatal? */
1288 if (task
->tk_status
== -EAGAIN
)
1289 rpc_delay(task
, HZ
>> 4);
1291 rpc_exit(task
, task
->tk_status
);
1295 xprt_transmit(task
);
1296 if (task
->tk_status
< 0)
1299 * On success, ensure that we call xprt_end_transmit() before sleeping
1300 * in order to allow access to the socket to other RPC requests.
1302 call_transmit_status(task
);
1303 if (rpc_reply_expected(task
))
1305 task
->tk_action
= rpc_exit_task
;
1306 rpc_wake_up_queued_task(&task
->tk_xprt
->pending
, task
);
1310 * 5a. Handle cleanup after a transmission
1313 call_transmit_status(struct rpc_task
*task
)
1315 task
->tk_action
= call_status
;
1318 * Common case: success. Force the compiler to put this
1321 if (task
->tk_status
== 0) {
1322 xprt_end_transmit(task
);
1323 rpc_task_force_reencode(task
);
1327 switch (task
->tk_status
) {
1331 dprint_status(task
);
1332 xprt_end_transmit(task
);
1333 rpc_task_force_reencode(task
);
1336 * Special cases: if we've been waiting on the
1337 * socket's write_space() callback, or if the
1338 * socket just returned a connection error,
1339 * then hold onto the transport lock.
1345 if (RPC_IS_SOFTCONN(task
)) {
1346 xprt_end_transmit(task
);
1347 rpc_exit(task
, task
->tk_status
);
1353 rpc_task_force_reencode(task
);
1357 #if defined(CONFIG_NFS_V4_1)
1359 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1360 * addition, disconnect on connectivity errors.
1363 call_bc_transmit(struct rpc_task
*task
)
1365 struct rpc_rqst
*req
= task
->tk_rqstp
;
1367 BUG_ON(task
->tk_status
!= 0);
1368 task
->tk_status
= xprt_prepare_transmit(task
);
1369 if (task
->tk_status
== -EAGAIN
) {
1371 * Could not reserve the transport. Try again after the
1372 * transport is released.
1374 task
->tk_status
= 0;
1375 task
->tk_action
= call_bc_transmit
;
1379 task
->tk_action
= rpc_exit_task
;
1380 if (task
->tk_status
< 0) {
1381 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1382 "error: %d\n", task
->tk_status
);
1386 xprt_transmit(task
);
1387 xprt_end_transmit(task
);
1388 dprint_status(task
);
1389 switch (task
->tk_status
) {
1398 * Problem reaching the server. Disconnect and let the
1399 * forechannel reestablish the connection. The server will
1400 * have to retransmit the backchannel request and we'll
1401 * reprocess it. Since these ops are idempotent, there's no
1402 * need to cache our reply at this time.
1404 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1405 "error: %d\n", task
->tk_status
);
1406 xprt_conditional_disconnect(task
->tk_xprt
,
1407 req
->rq_connect_cookie
);
1411 * We were unable to reply and will have to drop the
1412 * request. The server should reconnect and retransmit.
1414 BUG_ON(task
->tk_status
== -EAGAIN
);
1415 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1416 "error: %d\n", task
->tk_status
);
1419 rpc_wake_up_queued_task(&req
->rq_xprt
->pending
, task
);
1421 #endif /* CONFIG_NFS_V4_1 */
1424 * 6. Sort out the RPC call status
1427 call_status(struct rpc_task
*task
)
1429 struct rpc_clnt
*clnt
= task
->tk_client
;
1430 struct rpc_rqst
*req
= task
->tk_rqstp
;
1433 if (req
->rq_reply_bytes_recvd
> 0 && !req
->rq_bytes_sent
)
1434 task
->tk_status
= req
->rq_reply_bytes_recvd
;
1436 dprint_status(task
);
1438 status
= task
->tk_status
;
1440 task
->tk_action
= call_decode
;
1444 task
->tk_status
= 0;
1450 * Delay any retries for 3 seconds, then handle as if it
1453 rpc_delay(task
, 3*HZ
);
1455 task
->tk_action
= call_timeout
;
1456 if (task
->tk_client
->cl_discrtry
)
1457 xprt_conditional_disconnect(task
->tk_xprt
,
1458 req
->rq_connect_cookie
);
1462 rpc_force_rebind(clnt
);
1463 rpc_delay(task
, 3*HZ
);
1466 task
->tk_action
= call_bind
;
1469 task
->tk_action
= call_transmit
;
1472 /* shutdown or soft timeout */
1473 rpc_exit(task
, status
);
1476 if (clnt
->cl_chatty
)
1477 printk("%s: RPC call returned error %d\n",
1478 clnt
->cl_protname
, -status
);
1479 rpc_exit(task
, status
);
1484 * 6a. Handle RPC timeout
1485 * We do not release the request slot, so we keep using the
1486 * same XID for all retransmits.
1489 call_timeout(struct rpc_task
*task
)
1491 struct rpc_clnt
*clnt
= task
->tk_client
;
1493 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
1494 dprintk("RPC: %5u call_timeout (minor)\n", task
->tk_pid
);
1498 dprintk("RPC: %5u call_timeout (major)\n", task
->tk_pid
);
1499 task
->tk_timeouts
++;
1501 if (RPC_IS_SOFTCONN(task
)) {
1502 rpc_exit(task
, -ETIMEDOUT
);
1505 if (RPC_IS_SOFT(task
)) {
1506 if (clnt
->cl_chatty
)
1507 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1508 clnt
->cl_protname
, clnt
->cl_server
);
1509 rpc_exit(task
, -EIO
);
1513 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1514 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1515 if (clnt
->cl_chatty
)
1516 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1517 clnt
->cl_protname
, clnt
->cl_server
);
1519 rpc_force_rebind(clnt
);
1521 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1522 * event? RFC2203 requires the server to drop all such requests.
1524 rpcauth_invalcred(task
);
1527 clnt
->cl_stats
->rpcretrans
++;
1528 task
->tk_action
= call_bind
;
1529 task
->tk_status
= 0;
1533 * 7. Decode the RPC reply
1536 call_decode(struct rpc_task
*task
)
1538 struct rpc_clnt
*clnt
= task
->tk_client
;
1539 struct rpc_rqst
*req
= task
->tk_rqstp
;
1540 kxdrdproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1543 dprintk("RPC: %5u call_decode (status %d)\n",
1544 task
->tk_pid
, task
->tk_status
);
1546 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1547 if (clnt
->cl_chatty
)
1548 printk(KERN_NOTICE
"%s: server %s OK\n",
1549 clnt
->cl_protname
, clnt
->cl_server
);
1550 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
1554 * Ensure that we see all writes made by xprt_complete_rqst()
1555 * before it changed req->rq_reply_bytes_recvd.
1558 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
1560 /* Check that the softirq receive buffer is valid */
1561 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
1562 sizeof(req
->rq_rcv_buf
)) != 0);
1564 if (req
->rq_rcv_buf
.len
< 12) {
1565 if (!RPC_IS_SOFT(task
)) {
1566 task
->tk_action
= call_bind
;
1567 clnt
->cl_stats
->rpcretrans
++;
1570 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1571 clnt
->cl_protname
, task
->tk_status
);
1572 task
->tk_action
= call_timeout
;
1576 p
= rpc_verify_header(task
);
1578 if (p
== ERR_PTR(-EAGAIN
))
1583 task
->tk_action
= rpc_exit_task
;
1586 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
1587 task
->tk_msg
.rpc_resp
);
1589 dprintk("RPC: %5u call_decode result %d\n", task
->tk_pid
,
1593 task
->tk_status
= 0;
1594 /* Note: rpc_verify_header() may have freed the RPC slot */
1595 if (task
->tk_rqstp
== req
) {
1596 req
->rq_reply_bytes_recvd
= req
->rq_rcv_buf
.len
= 0;
1597 if (task
->tk_client
->cl_discrtry
)
1598 xprt_conditional_disconnect(task
->tk_xprt
,
1599 req
->rq_connect_cookie
);
1604 rpc_encode_header(struct rpc_task
*task
)
1606 struct rpc_clnt
*clnt
= task
->tk_client
;
1607 struct rpc_rqst
*req
= task
->tk_rqstp
;
1608 __be32
*p
= req
->rq_svec
[0].iov_base
;
1610 /* FIXME: check buffer size? */
1612 p
= xprt_skip_transport_header(task
->tk_xprt
, p
);
1613 *p
++ = req
->rq_xid
; /* XID */
1614 *p
++ = htonl(RPC_CALL
); /* CALL */
1615 *p
++ = htonl(RPC_VERSION
); /* RPC version */
1616 *p
++ = htonl(clnt
->cl_prog
); /* program number */
1617 *p
++ = htonl(clnt
->cl_vers
); /* program version */
1618 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
1619 p
= rpcauth_marshcred(task
, p
);
1620 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
1625 rpc_verify_header(struct rpc_task
*task
)
1627 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
1628 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
1629 __be32
*p
= iov
->iov_base
;
1631 int error
= -EACCES
;
1633 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
1634 /* RFC-1014 says that the representation of XDR data must be a
1635 * multiple of four bytes
1636 * - if it isn't pointer subtraction in the NFS client may give
1639 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1640 " 4 bytes: 0x%x\n", task
->tk_pid
, __func__
,
1641 task
->tk_rqstp
->rq_rcv_buf
.len
);
1647 p
+= 1; /* skip XID */
1648 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
1649 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1650 task
->tk_pid
, __func__
, n
);
1654 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
1657 switch ((n
= ntohl(*p
++))) {
1658 case RPC_AUTH_ERROR
:
1661 dprintk("RPC: %5u %s: RPC call version "
1663 task
->tk_pid
, __func__
);
1664 error
= -EPROTONOSUPPORT
;
1667 dprintk("RPC: %5u %s: RPC call rejected, "
1668 "unknown error: %x\n",
1669 task
->tk_pid
, __func__
, n
);
1674 switch ((n
= ntohl(*p
++))) {
1675 case RPC_AUTH_REJECTEDCRED
:
1676 case RPC_AUTH_REJECTEDVERF
:
1677 case RPCSEC_GSS_CREDPROBLEM
:
1678 case RPCSEC_GSS_CTXPROBLEM
:
1679 if (!task
->tk_cred_retry
)
1681 task
->tk_cred_retry
--;
1682 dprintk("RPC: %5u %s: retry stale creds\n",
1683 task
->tk_pid
, __func__
);
1684 rpcauth_invalcred(task
);
1685 /* Ensure we obtain a new XID! */
1687 task
->tk_action
= call_reserve
;
1689 case RPC_AUTH_BADCRED
:
1690 case RPC_AUTH_BADVERF
:
1691 /* possibly garbled cred/verf? */
1692 if (!task
->tk_garb_retry
)
1694 task
->tk_garb_retry
--;
1695 dprintk("RPC: %5u %s: retry garbled creds\n",
1696 task
->tk_pid
, __func__
);
1697 task
->tk_action
= call_bind
;
1699 case RPC_AUTH_TOOWEAK
:
1700 printk(KERN_NOTICE
"RPC: server %s requires stronger "
1701 "authentication.\n", task
->tk_client
->cl_server
);
1704 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1705 task
->tk_pid
, __func__
, n
);
1708 dprintk("RPC: %5u %s: call rejected %d\n",
1709 task
->tk_pid
, __func__
, n
);
1712 if (!(p
= rpcauth_checkverf(task
, p
))) {
1713 dprintk("RPC: %5u %s: auth check failed\n",
1714 task
->tk_pid
, __func__
);
1715 goto out_garbage
; /* bad verifier, retry */
1717 len
= p
- (__be32
*)iov
->iov_base
- 1;
1720 switch ((n
= ntohl(*p
++))) {
1723 case RPC_PROG_UNAVAIL
:
1724 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1725 task
->tk_pid
, __func__
,
1726 (unsigned int)task
->tk_client
->cl_prog
,
1727 task
->tk_client
->cl_server
);
1728 error
= -EPFNOSUPPORT
;
1730 case RPC_PROG_MISMATCH
:
1731 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1732 "server %s\n", task
->tk_pid
, __func__
,
1733 (unsigned int)task
->tk_client
->cl_prog
,
1734 (unsigned int)task
->tk_client
->cl_vers
,
1735 task
->tk_client
->cl_server
);
1736 error
= -EPROTONOSUPPORT
;
1738 case RPC_PROC_UNAVAIL
:
1739 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1740 "version %u on server %s\n",
1741 task
->tk_pid
, __func__
,
1742 rpc_proc_name(task
),
1743 task
->tk_client
->cl_prog
,
1744 task
->tk_client
->cl_vers
,
1745 task
->tk_client
->cl_server
);
1746 error
= -EOPNOTSUPP
;
1748 case RPC_GARBAGE_ARGS
:
1749 dprintk("RPC: %5u %s: server saw garbage\n",
1750 task
->tk_pid
, __func__
);
1753 dprintk("RPC: %5u %s: server accept status: %x\n",
1754 task
->tk_pid
, __func__
, n
);
1759 task
->tk_client
->cl_stats
->rpcgarbage
++;
1760 if (task
->tk_garb_retry
) {
1761 task
->tk_garb_retry
--;
1762 dprintk("RPC: %5u %s: retrying\n",
1763 task
->tk_pid
, __func__
);
1764 task
->tk_action
= call_bind
;
1766 return ERR_PTR(-EAGAIN
);
1771 rpc_exit(task
, error
);
1772 dprintk("RPC: %5u %s: call failed with error %d\n", task
->tk_pid
,
1774 return ERR_PTR(error
);
1776 dprintk("RPC: %5u %s: server reply was truncated.\n", task
->tk_pid
,
1781 static void rpcproc_encode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
1785 static int rpcproc_decode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
1790 static struct rpc_procinfo rpcproc_null
= {
1791 .p_encode
= rpcproc_encode_null
,
1792 .p_decode
= rpcproc_decode_null
,
1795 static int rpc_ping(struct rpc_clnt
*clnt
)
1797 struct rpc_message msg
= {
1798 .rpc_proc
= &rpcproc_null
,
1801 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
1802 err
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
);
1803 put_rpccred(msg
.rpc_cred
);
1807 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
1809 struct rpc_message msg
= {
1810 .rpc_proc
= &rpcproc_null
,
1813 struct rpc_task_setup task_setup_data
= {
1815 .rpc_message
= &msg
,
1816 .callback_ops
= &rpc_default_ops
,
1819 return rpc_run_task(&task_setup_data
);
1821 EXPORT_SYMBOL_GPL(rpc_call_null
);
1824 static void rpc_show_header(void)
1826 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
1827 "-timeout ---ops--\n");
1830 static void rpc_show_task(const struct rpc_clnt
*clnt
,
1831 const struct rpc_task
*task
)
1833 const char *rpc_waitq
= "none";
1835 if (RPC_IS_QUEUED(task
))
1836 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
1838 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
1839 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
1840 clnt
, task
->tk_rqstp
, task
->tk_timeout
, task
->tk_ops
,
1841 clnt
->cl_protname
, clnt
->cl_vers
, rpc_proc_name(task
),
1842 task
->tk_action
, rpc_waitq
);
1845 void rpc_show_tasks(void)
1847 struct rpc_clnt
*clnt
;
1848 struct rpc_task
*task
;
1851 spin_lock(&rpc_client_lock
);
1852 list_for_each_entry(clnt
, &all_clients
, cl_clients
) {
1853 spin_lock(&clnt
->cl_lock
);
1854 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
1859 rpc_show_task(clnt
, task
);
1861 spin_unlock(&clnt
->cl_lock
);
1863 spin_unlock(&rpc_client_lock
);