2 * linux/net/sunrpc/rpcclnt.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>
29 #include <linux/slab.h>
31 #include <linux/utsname.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/workqueue.h>
35 #include <linux/sunrpc/rpc_pipe_fs.h>
37 #include <linux/nfs.h>
40 #define RPC_SLACK_SPACE (1024) /* total overkill */
43 # define RPCDBG_FACILITY RPCDBG_CALL
46 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
49 static void call_start(struct rpc_task *task);
50 static void call_reserve(struct rpc_task *task);
51 static void call_reserveresult(struct rpc_task *task);
52 static void call_allocate(struct rpc_task *task);
53 static void call_encode(struct rpc_task *task);
54 static void call_decode(struct rpc_task *task);
55 static void call_bind(struct rpc_task *task);
56 static void call_bind_status(struct rpc_task *task);
57 static void call_transmit(struct rpc_task *task);
58 static void call_status(struct rpc_task *task);
59 static void call_refresh(struct rpc_task *task);
60 static void call_refreshresult(struct rpc_task *task);
61 static void call_timeout(struct rpc_task *task);
62 static void call_connect(struct rpc_task *task);
63 static void call_connect_status(struct rpc_task *task);
64 static u32 * call_header(struct rpc_task *task);
65 static u32 * call_verify(struct rpc_task *task);
69 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
71 static uint32_t clntid;
77 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
78 "%s/clnt%x", dir_name,
79 (unsigned int)clntid++);
80 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
81 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
82 if (!IS_ERR(clnt->cl_dentry))
84 error = PTR_ERR(clnt->cl_dentry);
85 if (error != -EEXIST) {
86 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
87 clnt->cl_pathname, error);
94 * Create an RPC client
95 * FIXME: This should also take a flags argument (as in task->tk_flags).
96 * It's called (among others) from pmap_create_client, which may in
97 * turn be called by an async task. In this case, rpciod should not be
98 * made to sleep too long.
101 rpc_new_client(struct rpc_xprt *xprt, char *servname,
102 struct rpc_program *program, u32 vers,
103 rpc_authflavor_t flavor)
105 struct rpc_version *version;
106 struct rpc_clnt *clnt = NULL;
107 struct rpc_auth *auth;
111 dprintk("RPC: creating %s client for %s (xprt %p)\n",
112 program->name, servname, xprt);
117 if (vers >= program->nrvers || !(version = program->version[vers]))
121 clnt = (struct rpc_clnt *) kmalloc(sizeof(*clnt), GFP_KERNEL);
124 memset(clnt, 0, sizeof(*clnt));
125 atomic_set(&clnt->cl_users, 0);
126 atomic_set(&clnt->cl_count, 1);
127 clnt->cl_parent = clnt;
129 clnt->cl_server = clnt->cl_inline_name;
130 len = strlen(servname) + 1;
131 if (len > sizeof(clnt->cl_inline_name)) {
132 char *buf = kmalloc(len, GFP_KERNEL);
134 clnt->cl_server = buf;
136 len = sizeof(clnt->cl_inline_name);
138 strlcpy(clnt->cl_server, servname, len);
140 clnt->cl_xprt = xprt;
141 clnt->cl_procinfo = version->procs;
142 clnt->cl_maxproc = version->nrprocs;
143 clnt->cl_protname = program->name;
144 clnt->cl_pmap = &clnt->cl_pmap_default;
145 clnt->cl_port = xprt->addr.sin_port;
146 clnt->cl_prog = program->number;
147 clnt->cl_vers = version->number;
148 clnt->cl_prot = xprt->prot;
149 clnt->cl_stats = program->stats;
150 rpc_init_wait_queue(&clnt->cl_pmap_default.pm_bindwait, "bindwait");
153 clnt->cl_autobind = 1;
155 clnt->cl_rtt = &clnt->cl_rtt_default;
156 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
158 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
162 auth = rpcauth_create(flavor, clnt);
164 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
170 /* save the nodename */
171 clnt->cl_nodelen = strlen(system_utsname.nodename);
172 if (clnt->cl_nodelen > UNX_MAXNODENAME)
173 clnt->cl_nodelen = UNX_MAXNODENAME;
174 memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
178 rpc_rmdir(clnt->cl_pathname);
180 if (clnt->cl_server != clnt->cl_inline_name)
181 kfree(clnt->cl_server);
189 * Create an RPC client
190 * @xprt - pointer to xprt struct
191 * @servname - name of server
192 * @info - rpc_program
193 * @version - rpc_program version
194 * @authflavor - rpc_auth flavour to use
196 * Creates an RPC client structure, then pings the server in order to
197 * determine if it is up, and if it supports this program and version.
199 * This function should never be called by asynchronous tasks such as
202 struct rpc_clnt *rpc_create_client(struct rpc_xprt *xprt, char *servname,
203 struct rpc_program *info, u32 version, rpc_authflavor_t authflavor)
205 struct rpc_clnt *clnt;
208 clnt = rpc_new_client(xprt, servname, info, version, authflavor);
211 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
214 rpc_shutdown_client(clnt);
219 * This function clones the RPC client structure. It allows us to share the
220 * same transport while varying parameters such as the authentication
224 rpc_clone_client(struct rpc_clnt *clnt)
226 struct rpc_clnt *new;
228 new = (struct rpc_clnt *)kmalloc(sizeof(*new), GFP_KERNEL);
231 memcpy(new, clnt, sizeof(*new));
232 atomic_set(&new->cl_count, 1);
233 atomic_set(&new->cl_users, 0);
234 new->cl_parent = clnt;
235 atomic_inc(&clnt->cl_count);
236 /* Duplicate portmapper */
237 rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
238 /* Turn off autobind on clones */
239 new->cl_autobind = 0;
242 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
244 atomic_inc(&new->cl_auth->au_count);
245 new->cl_pmap = &new->cl_pmap_default;
246 rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
249 printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
250 return ERR_PTR(-ENOMEM);
254 * Properly shut down an RPC client, terminating all outstanding
255 * requests. Note that we must be certain that cl_oneshot and
256 * cl_dead are cleared, or else the client would be destroyed
257 * when the last task releases it.
260 rpc_shutdown_client(struct rpc_clnt *clnt)
262 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
263 clnt->cl_protname, clnt->cl_server,
264 atomic_read(&clnt->cl_users));
266 while (atomic_read(&clnt->cl_users) > 0) {
267 /* Don't let rpc_release_client destroy us */
268 clnt->cl_oneshot = 0;
270 rpc_killall_tasks(clnt);
271 sleep_on_timeout(&destroy_wait, 1*HZ);
274 if (atomic_read(&clnt->cl_users) < 0) {
275 printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
276 clnt, atomic_read(&clnt->cl_users));
283 return rpc_destroy_client(clnt);
287 * Delete an RPC client
290 rpc_destroy_client(struct rpc_clnt *clnt)
292 if (!atomic_dec_and_test(&clnt->cl_count))
294 BUG_ON(atomic_read(&clnt->cl_users) != 0);
296 dprintk("RPC: destroying %s client for %s\n",
297 clnt->cl_protname, clnt->cl_server);
299 rpcauth_destroy(clnt->cl_auth);
300 clnt->cl_auth = NULL;
302 if (clnt->cl_parent != clnt) {
303 rpc_destroy_client(clnt->cl_parent);
306 if (clnt->cl_pathname[0])
307 rpc_rmdir(clnt->cl_pathname);
309 xprt_destroy(clnt->cl_xprt);
310 clnt->cl_xprt = NULL;
312 if (clnt->cl_server != clnt->cl_inline_name)
313 kfree(clnt->cl_server);
320 * Release an RPC client
323 rpc_release_client(struct rpc_clnt *clnt)
325 dprintk("RPC: rpc_release_client(%p, %d)\n",
326 clnt, atomic_read(&clnt->cl_users));
328 if (!atomic_dec_and_test(&clnt->cl_users))
330 wake_up(&destroy_wait);
331 if (clnt->cl_oneshot || clnt->cl_dead)
332 rpc_destroy_client(clnt);
336 * rpc_bind_new_program - bind a new RPC program to an existing client
337 * @old - old rpc_client
338 * @program - rpc program to set
339 * @vers - rpc program version
341 * Clones the rpc client and sets up a new RPC program. This is mainly
342 * of use for enabling different RPC programs to share the same transport.
343 * The Sun NFSv2/v3 ACL protocol can do this.
345 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
346 struct rpc_program *program,
349 struct rpc_clnt *clnt;
350 struct rpc_version *version;
353 BUG_ON(vers >= program->nrvers || !program->version[vers]);
354 version = program->version[vers];
355 clnt = rpc_clone_client(old);
358 clnt->cl_procinfo = version->procs;
359 clnt->cl_maxproc = version->nrprocs;
360 clnt->cl_protname = program->name;
361 clnt->cl_prog = program->number;
362 clnt->cl_vers = version->number;
363 clnt->cl_stats = program->stats;
364 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
366 rpc_shutdown_client(clnt);
374 * Default callback for async RPC calls
377 rpc_default_callback(struct rpc_task *task)
382 * Export the signal mask handling for synchronous code that
383 * sleeps on RPC calls
385 #define RPC_INTR_SIGNALS (sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGKILL))
387 static void rpc_save_sigmask(sigset_t *oldset, int intr)
389 unsigned long sigallow = 0;
392 /* Block all signals except those listed in sigallow */
394 sigallow |= RPC_INTR_SIGNALS;
395 siginitsetinv(&sigmask, sigallow);
396 sigprocmask(SIG_BLOCK, &sigmask, oldset);
399 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
401 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
404 static inline void rpc_restore_sigmask(sigset_t *oldset)
406 sigprocmask(SIG_SETMASK, oldset, NULL);
409 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
411 rpc_save_sigmask(oldset, clnt->cl_intr);
414 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
416 rpc_restore_sigmask(oldset);
420 * New rpc_call implementation
422 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
424 struct rpc_task *task;
428 /* If this client is slain all further I/O fails */
432 BUG_ON(flags & RPC_TASK_ASYNC);
435 task = rpc_new_task(clnt, NULL, flags);
439 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
440 rpc_task_sigmask(task, &oldset);
442 rpc_call_setup(task, msg, 0);
444 /* Set up the call info struct and execute the task */
445 if (task->tk_status == 0) {
446 status = rpc_execute(task);
448 status = task->tk_status;
449 rpc_release_task(task);
452 rpc_restore_sigmask(&oldset);
458 * New rpc_call implementation
461 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
462 rpc_action callback, void *data)
464 struct rpc_task *task;
468 /* If this client is slain all further I/O fails */
472 flags |= RPC_TASK_ASYNC;
474 /* Create/initialize a new RPC task */
476 callback = rpc_default_callback;
478 if (!(task = rpc_new_task(clnt, callback, flags)))
480 task->tk_calldata = data;
482 /* Mask signals on GSS_AUTH upcalls */
483 rpc_task_sigmask(task, &oldset);
485 rpc_call_setup(task, msg, 0);
487 /* Set up the call info struct and execute the task */
488 status = task->tk_status;
492 rpc_release_task(task);
494 rpc_restore_sigmask(&oldset);
501 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
504 task->tk_flags |= flags;
505 /* Bind the user cred */
506 if (task->tk_msg.rpc_cred != NULL)
507 rpcauth_holdcred(task);
509 rpcauth_bindcred(task);
511 if (task->tk_status == 0)
512 task->tk_action = call_start;
514 task->tk_action = NULL;
518 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
520 struct rpc_xprt *xprt = clnt->cl_xprt;
524 xprt->sndsize = sndsize + RPC_SLACK_SPACE;
527 xprt->rcvsize = rcvsize + RPC_SLACK_SPACE;
528 if (xprt_connected(xprt))
529 xprt_sock_setbufsize(xprt);
533 * Return size of largest payload RPC client can support, in bytes
535 * For stream transports, this is one RPC record fragment (see RFC
536 * 1831), as we don't support multi-record requests yet. For datagram
537 * transports, this is the size of an IP packet minus the IP, UDP, and
540 size_t rpc_max_payload(struct rpc_clnt *clnt)
542 return clnt->cl_xprt->max_payload;
544 EXPORT_SYMBOL(rpc_max_payload);
547 * Restart an (async) RPC call. Usually called from within the
551 rpc_restart_call(struct rpc_task *task)
553 if (RPC_ASSASSINATED(task))
556 task->tk_action = call_start;
562 * Other FSM states can be visited zero or more times, but
563 * this state is visited exactly once for each RPC.
566 call_start(struct rpc_task *task)
568 struct rpc_clnt *clnt = task->tk_client;
570 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
571 clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
572 (RPC_IS_ASYNC(task) ? "async" : "sync"));
574 /* Increment call count */
575 task->tk_msg.rpc_proc->p_count++;
576 clnt->cl_stats->rpccnt++;
577 task->tk_action = call_reserve;
581 * 1. Reserve an RPC call slot
584 call_reserve(struct rpc_task *task)
586 dprintk("RPC: %4d call_reserve\n", task->tk_pid);
588 if (!rpcauth_uptodatecred(task)) {
589 task->tk_action = call_refresh;
594 task->tk_action = call_reserveresult;
599 * 1b. Grok the result of xprt_reserve()
602 call_reserveresult(struct rpc_task *task)
604 int status = task->tk_status;
606 dprintk("RPC: %4d call_reserveresult (status %d)\n",
607 task->tk_pid, task->tk_status);
610 * After a call to xprt_reserve(), we must have either
611 * a request slot or else an error status.
615 if (task->tk_rqstp) {
616 task->tk_action = call_allocate;
620 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
621 __FUNCTION__, status);
622 rpc_exit(task, -EIO);
627 * Even though there was an error, we may have acquired
628 * a request slot somehow. Make sure not to leak it.
630 if (task->tk_rqstp) {
631 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
632 __FUNCTION__, status);
637 case -EAGAIN: /* woken up; retry */
638 task->tk_action = call_reserve;
640 case -EIO: /* probably a shutdown */
643 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
644 __FUNCTION__, status);
647 rpc_exit(task, status);
651 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
652 * (Note: buffer memory is freed in rpc_task_release).
655 call_allocate(struct rpc_task *task)
659 dprintk("RPC: %4d call_allocate (status %d)\n",
660 task->tk_pid, task->tk_status);
661 task->tk_action = call_bind;
665 /* FIXME: compute buffer requirements more exactly using
667 bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
669 if (rpc_malloc(task, bufsiz << 1) != NULL)
671 printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task);
673 if (RPC_IS_ASYNC(task) || !signalled()) {
675 task->tk_action = call_reserve;
676 rpc_delay(task, HZ>>4);
680 rpc_exit(task, -ERESTARTSYS);
684 * 3. Encode arguments of an RPC call
687 call_encode(struct rpc_task *task)
689 struct rpc_clnt *clnt = task->tk_client;
690 struct rpc_rqst *req = task->tk_rqstp;
691 struct xdr_buf *sndbuf = &req->rq_snd_buf;
692 struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
698 dprintk("RPC: %4d call_encode (status %d)\n",
699 task->tk_pid, task->tk_status);
701 /* Default buffer setup */
702 bufsiz = task->tk_bufsize >> 1;
703 sndbuf->head[0].iov_base = (void *)task->tk_buffer;
704 sndbuf->head[0].iov_len = bufsiz;
705 sndbuf->tail[0].iov_len = 0;
706 sndbuf->page_len = 0;
708 sndbuf->buflen = bufsiz;
709 rcvbuf->head[0].iov_base = (void *)((char *)task->tk_buffer + bufsiz);
710 rcvbuf->head[0].iov_len = bufsiz;
711 rcvbuf->tail[0].iov_len = 0;
712 rcvbuf->page_len = 0;
714 rcvbuf->buflen = bufsiz;
716 /* Encode header and provided arguments */
717 encode = task->tk_msg.rpc_proc->p_encode;
718 if (!(p = call_header(task))) {
719 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
720 rpc_exit(task, -EIO);
723 if (encode && (status = rpcauth_wrap_req(task, encode, req, p,
724 task->tk_msg.rpc_argp)) < 0) {
725 printk(KERN_WARNING "%s: can't encode arguments: %d\n",
726 clnt->cl_protname, -status);
727 rpc_exit(task, status);
732 * 4. Get the server port number if not yet set
735 call_bind(struct rpc_task *task)
737 struct rpc_clnt *clnt = task->tk_client;
739 dprintk("RPC: %4d call_bind (status %d)\n",
740 task->tk_pid, task->tk_status);
742 task->tk_action = call_connect;
743 if (!clnt->cl_port) {
744 task->tk_action = call_bind_status;
745 task->tk_timeout = RPC_CONNECT_TIMEOUT;
746 rpc_getport(task, clnt);
751 * 4a. Sort out bind result
754 call_bind_status(struct rpc_task *task)
756 int status = -EACCES;
758 if (task->tk_status >= 0) {
759 dprintk("RPC: %4d call_bind_status (status %d)\n",
760 task->tk_pid, task->tk_status);
762 task->tk_action = call_connect;
766 switch (task->tk_status) {
768 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
772 dprintk("RPC: %4d rpcbind request timed out\n",
774 if (RPC_IS_SOFT(task)) {
780 dprintk("RPC: %4d remote rpcbind service unavailable\n",
783 case -EPROTONOSUPPORT:
784 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
788 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
789 task->tk_pid, -task->tk_status);
794 rpc_exit(task, status);
799 task->tk_action = call_bind;
804 * 4b. Connect to the RPC server
807 call_connect(struct rpc_task *task)
809 struct rpc_xprt *xprt = task->tk_xprt;
811 dprintk("RPC: %4d call_connect xprt %p %s connected\n",
813 (xprt_connected(xprt) ? "is" : "is not"));
815 task->tk_action = call_transmit;
816 if (!xprt_connected(xprt)) {
817 task->tk_action = call_connect_status;
818 if (task->tk_status < 0)
825 * 4c. Sort out connect result
828 call_connect_status(struct rpc_task *task)
830 struct rpc_clnt *clnt = task->tk_client;
831 int status = task->tk_status;
833 dprintk("RPC: %5u call_connect_status (status %d)\n",
834 task->tk_pid, task->tk_status);
838 clnt->cl_stats->netreconn++;
839 task->tk_action = call_transmit;
843 /* Something failed: remote service port may have changed */
844 if (clnt->cl_autobind)
851 task->tk_action = call_bind;
854 rpc_exit(task, -EIO);
860 * 5. Transmit the RPC request, and wait for reply
863 call_transmit(struct rpc_task *task)
865 dprintk("RPC: %4d call_transmit (status %d)\n",
866 task->tk_pid, task->tk_status);
868 task->tk_action = call_status;
869 if (task->tk_status < 0)
871 task->tk_status = xprt_prepare_transmit(task);
872 if (task->tk_status != 0)
874 /* Encode here so that rpcsec_gss can use correct sequence number. */
875 if (!task->tk_rqstp->rq_bytes_sent)
877 if (task->tk_status < 0)
880 if (task->tk_status < 0)
882 if (!task->tk_msg.rpc_proc->p_decode) {
883 task->tk_action = NULL;
884 rpc_wake_up_task(task);
889 * 6. Sort out the RPC call status
892 call_status(struct rpc_task *task)
894 struct rpc_clnt *clnt = task->tk_client;
895 struct rpc_rqst *req = task->tk_rqstp;
898 if (req->rq_received > 0 && !req->rq_bytes_sent)
899 task->tk_status = req->rq_received;
901 dprintk("RPC: %4d call_status (status %d)\n",
902 task->tk_pid, task->tk_status);
904 status = task->tk_status;
906 task->tk_action = call_decode;
913 task->tk_action = call_timeout;
917 req->rq_bytes_sent = 0;
918 if (clnt->cl_autobind)
920 task->tk_action = call_bind;
923 task->tk_action = call_transmit;
926 /* shutdown or soft timeout */
927 rpc_exit(task, status);
931 printk("%s: RPC call returned error %d\n",
932 clnt->cl_protname, -status);
933 rpc_exit(task, status);
939 * 6a. Handle RPC timeout
940 * We do not release the request slot, so we keep using the
941 * same XID for all retransmits.
944 call_timeout(struct rpc_task *task)
946 struct rpc_clnt *clnt = task->tk_client;
948 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
949 dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
953 dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
954 if (RPC_IS_SOFT(task)) {
956 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
957 clnt->cl_protname, clnt->cl_server);
958 rpc_exit(task, -EIO);
962 if (clnt->cl_chatty && !(task->tk_flags & RPC_CALL_MAJORSEEN)) {
963 task->tk_flags |= RPC_CALL_MAJORSEEN;
964 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
965 clnt->cl_protname, clnt->cl_server);
967 if (clnt->cl_autobind)
971 clnt->cl_stats->rpcretrans++;
972 task->tk_action = call_bind;
977 * 7. Decode the RPC reply
980 call_decode(struct rpc_task *task)
982 struct rpc_clnt *clnt = task->tk_client;
983 struct rpc_rqst *req = task->tk_rqstp;
984 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
987 dprintk("RPC: %4d call_decode (status %d)\n",
988 task->tk_pid, task->tk_status);
990 if (clnt->cl_chatty && (task->tk_flags & RPC_CALL_MAJORSEEN)) {
991 printk(KERN_NOTICE "%s: server %s OK\n",
992 clnt->cl_protname, clnt->cl_server);
993 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
996 if (task->tk_status < 12) {
997 if (!RPC_IS_SOFT(task)) {
998 task->tk_action = call_bind;
999 clnt->cl_stats->rpcretrans++;
1002 printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
1003 clnt->cl_protname, task->tk_status);
1004 rpc_exit(task, -EIO);
1008 req->rq_rcv_buf.len = req->rq_private_buf.len;
1010 /* Check that the softirq receive buffer is valid */
1011 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1012 sizeof(req->rq_rcv_buf)) != 0);
1014 /* Verify the RPC header */
1015 if (!(p = call_verify(task))) {
1016 if (task->tk_action == NULL)
1021 task->tk_action = NULL;
1024 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1025 task->tk_msg.rpc_resp);
1026 dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
1030 req->rq_received = req->rq_private_buf.len = 0;
1031 task->tk_status = 0;
1035 * 8. Refresh the credentials if rejected by the server
1038 call_refresh(struct rpc_task *task)
1040 dprintk("RPC: %4d call_refresh\n", task->tk_pid);
1042 xprt_release(task); /* Must do to obtain new XID */
1043 task->tk_action = call_refreshresult;
1044 task->tk_status = 0;
1045 task->tk_client->cl_stats->rpcauthrefresh++;
1046 rpcauth_refreshcred(task);
1050 * 8a. Process the results of a credential refresh
1053 call_refreshresult(struct rpc_task *task)
1055 int status = task->tk_status;
1056 dprintk("RPC: %4d call_refreshresult (status %d)\n",
1057 task->tk_pid, task->tk_status);
1059 task->tk_status = 0;
1060 task->tk_action = call_reserve;
1061 if (status >= 0 && rpcauth_uptodatecred(task))
1063 if (status == -EACCES) {
1064 rpc_exit(task, -EACCES);
1067 task->tk_action = call_refresh;
1068 if (status != -ETIMEDOUT)
1069 rpc_delay(task, 3*HZ);
1074 * Call header serialization
1077 call_header(struct rpc_task *task)
1079 struct rpc_clnt *clnt = task->tk_client;
1080 struct rpc_xprt *xprt = clnt->cl_xprt;
1081 struct rpc_rqst *req = task->tk_rqstp;
1082 u32 *p = req->rq_svec[0].iov_base;
1084 /* FIXME: check buffer size? */
1086 *p++ = 0; /* fill in later */
1087 *p++ = req->rq_xid; /* XID */
1088 *p++ = htonl(RPC_CALL); /* CALL */
1089 *p++ = htonl(RPC_VERSION); /* RPC version */
1090 *p++ = htonl(clnt->cl_prog); /* program number */
1091 *p++ = htonl(clnt->cl_vers); /* program version */
1092 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1093 p = rpcauth_marshcred(task, p);
1094 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1099 * Reply header verification
1102 call_verify(struct rpc_task *task)
1104 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1105 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1106 u32 *p = iov->iov_base, n;
1107 int error = -EACCES;
1111 p += 1; /* skip XID */
1113 if ((n = ntohl(*p++)) != RPC_REPLY) {
1114 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1117 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1120 switch ((n = ntohl(*p++))) {
1121 case RPC_AUTH_ERROR:
1124 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__);
1125 error = -EPROTONOSUPPORT;
1128 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
1133 switch ((n = ntohl(*p++))) {
1134 case RPC_AUTH_REJECTEDCRED:
1135 case RPC_AUTH_REJECTEDVERF:
1136 case RPCSEC_GSS_CREDPROBLEM:
1137 case RPCSEC_GSS_CTXPROBLEM:
1138 if (!task->tk_cred_retry)
1140 task->tk_cred_retry--;
1141 dprintk("RPC: %4d call_verify: retry stale creds\n",
1143 rpcauth_invalcred(task);
1144 task->tk_action = call_refresh;
1146 case RPC_AUTH_BADCRED:
1147 case RPC_AUTH_BADVERF:
1148 /* possibly garbled cred/verf? */
1149 if (!task->tk_garb_retry)
1151 task->tk_garb_retry--;
1152 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1154 task->tk_action = call_bind;
1156 case RPC_AUTH_TOOWEAK:
1157 printk(KERN_NOTICE "call_verify: server requires stronger "
1158 "authentication.\n");
1161 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1164 dprintk("RPC: %4d call_verify: call rejected %d\n",
1168 if (!(p = rpcauth_checkverf(task, p))) {
1169 printk(KERN_WARNING "call_verify: auth check failed\n");
1170 goto out_retry; /* bad verifier, retry */
1172 len = p - (u32 *)iov->iov_base - 1;
1175 switch ((n = ntohl(*p++))) {
1178 case RPC_PROG_UNAVAIL:
1179 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1180 (unsigned int)task->tk_client->cl_prog,
1181 task->tk_client->cl_server);
1182 error = -EPFNOSUPPORT;
1184 case RPC_PROG_MISMATCH:
1185 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1186 (unsigned int)task->tk_client->cl_prog,
1187 (unsigned int)task->tk_client->cl_vers,
1188 task->tk_client->cl_server);
1189 error = -EPROTONOSUPPORT;
1191 case RPC_PROC_UNAVAIL:
1192 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1193 task->tk_msg.rpc_proc,
1194 task->tk_client->cl_prog,
1195 task->tk_client->cl_vers,
1196 task->tk_client->cl_server);
1197 error = -EOPNOTSUPP;
1199 case RPC_GARBAGE_ARGS:
1200 dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
1203 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1208 task->tk_client->cl_stats->rpcgarbage++;
1209 if (task->tk_garb_retry) {
1210 task->tk_garb_retry--;
1211 dprintk("RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
1212 task->tk_action = call_bind;
1215 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1219 rpc_exit(task, error);
1222 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1226 static int rpcproc_encode_null(void *rqstp, u32 *data, void *obj)
1231 static int rpcproc_decode_null(void *rqstp, u32 *data, void *obj)
1236 static struct rpc_procinfo rpcproc_null = {
1237 .p_encode = rpcproc_encode_null,
1238 .p_decode = rpcproc_decode_null,
1241 int rpc_ping(struct rpc_clnt *clnt, int flags)
1243 struct rpc_message msg = {
1244 .rpc_proc = &rpcproc_null,
1247 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1248 err = rpc_call_sync(clnt, &msg, flags);
1249 put_rpccred(msg.rpc_cred);