SUNRPC: Introduce transport switch callout for pluggable rpcbind
[powerpc.git] / net / sunrpc / clnt.c
1 /*
2  *  linux/net/sunrpc/clnt.c
3  *
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.
7  *
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.
15  *
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.
19  *
20  *  Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21  *  Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
22  */
23
24 #include <asm/system.h>
25
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/mm.h>
29 #include <linux/slab.h>
30 #include <linux/utsname.h>
31 #include <linux/workqueue.h>
32
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/rpc_pipe_fs.h>
35 #include <linux/sunrpc/metrics.h>
36
37
38 #define RPC_SLACK_SPACE         (1024)  /* total overkill */
39
40 #ifdef RPC_DEBUG
41 # define RPCDBG_FACILITY        RPCDBG_CALL
42 #endif
43
44 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
45
46
47 static void     call_start(struct rpc_task *task);
48 static void     call_reserve(struct rpc_task *task);
49 static void     call_reserveresult(struct rpc_task *task);
50 static void     call_allocate(struct rpc_task *task);
51 static void     call_encode(struct rpc_task *task);
52 static void     call_decode(struct rpc_task *task);
53 static void     call_bind(struct rpc_task *task);
54 static void     call_bind_status(struct rpc_task *task);
55 static void     call_transmit(struct rpc_task *task);
56 static void     call_status(struct rpc_task *task);
57 static void     call_transmit_status(struct rpc_task *task);
58 static void     call_refresh(struct rpc_task *task);
59 static void     call_refreshresult(struct rpc_task *task);
60 static void     call_timeout(struct rpc_task *task);
61 static void     call_connect(struct rpc_task *task);
62 static void     call_connect_status(struct rpc_task *task);
63 static u32 *    call_header(struct rpc_task *task);
64 static u32 *    call_verify(struct rpc_task *task);
65
66
67 static int
68 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
69 {
70         static uint32_t clntid;
71         int error;
72
73         clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
74         clnt->cl_dentry = ERR_PTR(-ENOENT);
75         if (dir_name == NULL)
76                 return 0;
77
78         clnt->cl_vfsmnt = rpc_get_mount();
79         if (IS_ERR(clnt->cl_vfsmnt))
80                 return PTR_ERR(clnt->cl_vfsmnt);
81
82         for (;;) {
83                 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
84                                 "%s/clnt%x", dir_name,
85                                 (unsigned int)clntid++);
86                 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
87                 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
88                 if (!IS_ERR(clnt->cl_dentry))
89                         return 0;
90                 error = PTR_ERR(clnt->cl_dentry);
91                 if (error != -EEXIST) {
92                         printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
93                                         clnt->cl_pathname, error);
94                         rpc_put_mount();
95                         return error;
96                 }
97         }
98 }
99
100 /*
101  * Create an RPC client
102  * FIXME: This should also take a flags argument (as in task->tk_flags).
103  * It's called (among others) from pmap_create_client, which may in
104  * turn be called by an async task. In this case, rpciod should not be
105  * made to sleep too long.
106  */
107 struct rpc_clnt *
108 rpc_new_client(struct rpc_xprt *xprt, char *servname,
109                   struct rpc_program *program, u32 vers,
110                   rpc_authflavor_t flavor)
111 {
112         struct rpc_version      *version;
113         struct rpc_clnt         *clnt = NULL;
114         struct rpc_auth         *auth;
115         int err;
116         int len;
117
118         dprintk("RPC: creating %s client for %s (xprt %p)\n",
119                 program->name, servname, xprt);
120
121         err = -EINVAL;
122         if (!xprt)
123                 goto out_no_xprt;
124         if (vers >= program->nrvers || !(version = program->version[vers]))
125                 goto out_err;
126
127         err = -ENOMEM;
128         clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
129         if (!clnt)
130                 goto out_err;
131         atomic_set(&clnt->cl_users, 0);
132         atomic_set(&clnt->cl_count, 1);
133         clnt->cl_parent = clnt;
134
135         clnt->cl_server = clnt->cl_inline_name;
136         len = strlen(servname) + 1;
137         if (len > sizeof(clnt->cl_inline_name)) {
138                 char *buf = kmalloc(len, GFP_KERNEL);
139                 if (buf != 0)
140                         clnt->cl_server = buf;
141                 else
142                         len = sizeof(clnt->cl_inline_name);
143         }
144         strlcpy(clnt->cl_server, servname, len);
145
146         clnt->cl_xprt     = xprt;
147         clnt->cl_procinfo = version->procs;
148         clnt->cl_maxproc  = version->nrprocs;
149         clnt->cl_protname = program->name;
150         clnt->cl_prog     = program->number;
151         clnt->cl_vers     = version->number;
152         clnt->cl_stats    = program->stats;
153         clnt->cl_metrics  = rpc_alloc_iostats(clnt);
154
155         if (!xprt_bound(clnt->cl_xprt))
156                 clnt->cl_autobind = 1;
157
158         clnt->cl_rtt = &clnt->cl_rtt_default;
159         rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
160
161         err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
162         if (err < 0)
163                 goto out_no_path;
164
165         auth = rpcauth_create(flavor, clnt);
166         if (IS_ERR(auth)) {
167                 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
168                                 flavor);
169                 err = PTR_ERR(auth);
170                 goto out_no_auth;
171         }
172
173         /* save the nodename */
174         clnt->cl_nodelen = strlen(system_utsname.nodename);
175         if (clnt->cl_nodelen > UNX_MAXNODENAME)
176                 clnt->cl_nodelen = UNX_MAXNODENAME;
177         memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
178         return clnt;
179
180 out_no_auth:
181         if (!IS_ERR(clnt->cl_dentry)) {
182                 rpc_rmdir(clnt->cl_dentry);
183                 rpc_put_mount();
184         }
185 out_no_path:
186         if (clnt->cl_server != clnt->cl_inline_name)
187                 kfree(clnt->cl_server);
188         kfree(clnt);
189 out_err:
190         xprt_destroy(xprt);
191 out_no_xprt:
192         return ERR_PTR(err);
193 }
194
195 /**
196  * Create an RPC client
197  * @xprt - pointer to xprt struct
198  * @servname - name of server
199  * @info - rpc_program
200  * @version - rpc_program version
201  * @authflavor - rpc_auth flavour to use
202  *
203  * Creates an RPC client structure, then pings the server in order to
204  * determine if it is up, and if it supports this program and version.
205  *
206  * This function should never be called by asynchronous tasks such as
207  * the portmapper.
208  */
209 struct rpc_clnt *rpc_create_client(struct rpc_xprt *xprt, char *servname,
210                 struct rpc_program *info, u32 version, rpc_authflavor_t authflavor)
211 {
212         struct rpc_clnt *clnt;
213         int err;
214         
215         clnt = rpc_new_client(xprt, servname, info, version, authflavor);
216         if (IS_ERR(clnt))
217                 return clnt;
218         err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
219         if (err == 0)
220                 return clnt;
221         rpc_shutdown_client(clnt);
222         return ERR_PTR(err);
223 }
224
225 /*
226  * This function clones the RPC client structure. It allows us to share the
227  * same transport while varying parameters such as the authentication
228  * flavour.
229  */
230 struct rpc_clnt *
231 rpc_clone_client(struct rpc_clnt *clnt)
232 {
233         struct rpc_clnt *new;
234
235         new = kmalloc(sizeof(*new), GFP_KERNEL);
236         if (!new)
237                 goto out_no_clnt;
238         memcpy(new, clnt, sizeof(*new));
239         atomic_set(&new->cl_count, 1);
240         atomic_set(&new->cl_users, 0);
241         new->cl_parent = clnt;
242         atomic_inc(&clnt->cl_count);
243         /* Turn off autobind on clones */
244         new->cl_autobind = 0;
245         new->cl_oneshot = 0;
246         new->cl_dead = 0;
247         if (!IS_ERR(new->cl_dentry))
248                 dget(new->cl_dentry);
249         rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
250         if (new->cl_auth)
251                 atomic_inc(&new->cl_auth->au_count);
252         new->cl_metrics = rpc_alloc_iostats(clnt);
253         return new;
254 out_no_clnt:
255         printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
256         return ERR_PTR(-ENOMEM);
257 }
258
259 /*
260  * Properly shut down an RPC client, terminating all outstanding
261  * requests. Note that we must be certain that cl_oneshot and
262  * cl_dead are cleared, or else the client would be destroyed
263  * when the last task releases it.
264  */
265 int
266 rpc_shutdown_client(struct rpc_clnt *clnt)
267 {
268         dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
269                         clnt->cl_protname, clnt->cl_server,
270                         atomic_read(&clnt->cl_users));
271
272         while (atomic_read(&clnt->cl_users) > 0) {
273                 /* Don't let rpc_release_client destroy us */
274                 clnt->cl_oneshot = 0;
275                 clnt->cl_dead = 0;
276                 rpc_killall_tasks(clnt);
277                 wait_event_timeout(destroy_wait,
278                         !atomic_read(&clnt->cl_users), 1*HZ);
279         }
280
281         if (atomic_read(&clnt->cl_users) < 0) {
282                 printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
283                                 clnt, atomic_read(&clnt->cl_users));
284 #ifdef RPC_DEBUG
285                 rpc_show_tasks();
286 #endif
287                 BUG();
288         }
289
290         return rpc_destroy_client(clnt);
291 }
292
293 /*
294  * Delete an RPC client
295  */
296 int
297 rpc_destroy_client(struct rpc_clnt *clnt)
298 {
299         if (!atomic_dec_and_test(&clnt->cl_count))
300                 return 1;
301         BUG_ON(atomic_read(&clnt->cl_users) != 0);
302
303         dprintk("RPC: destroying %s client for %s\n",
304                         clnt->cl_protname, clnt->cl_server);
305         if (clnt->cl_auth) {
306                 rpcauth_destroy(clnt->cl_auth);
307                 clnt->cl_auth = NULL;
308         }
309         if (clnt->cl_parent != clnt) {
310                 if (!IS_ERR(clnt->cl_dentry))
311                         dput(clnt->cl_dentry);
312                 rpc_destroy_client(clnt->cl_parent);
313                 goto out_free;
314         }
315         if (!IS_ERR(clnt->cl_dentry)) {
316                 rpc_rmdir(clnt->cl_dentry);
317                 rpc_put_mount();
318         }
319         if (clnt->cl_xprt) {
320                 xprt_destroy(clnt->cl_xprt);
321                 clnt->cl_xprt = NULL;
322         }
323         if (clnt->cl_server != clnt->cl_inline_name)
324                 kfree(clnt->cl_server);
325 out_free:
326         rpc_free_iostats(clnt->cl_metrics);
327         clnt->cl_metrics = NULL;
328         kfree(clnt);
329         return 0;
330 }
331
332 /*
333  * Release an RPC client
334  */
335 void
336 rpc_release_client(struct rpc_clnt *clnt)
337 {
338         dprintk("RPC:      rpc_release_client(%p, %d)\n",
339                                 clnt, atomic_read(&clnt->cl_users));
340
341         if (!atomic_dec_and_test(&clnt->cl_users))
342                 return;
343         wake_up(&destroy_wait);
344         if (clnt->cl_oneshot || clnt->cl_dead)
345                 rpc_destroy_client(clnt);
346 }
347
348 /**
349  * rpc_bind_new_program - bind a new RPC program to an existing client
350  * @old - old rpc_client
351  * @program - rpc program to set
352  * @vers - rpc program version
353  *
354  * Clones the rpc client and sets up a new RPC program. This is mainly
355  * of use for enabling different RPC programs to share the same transport.
356  * The Sun NFSv2/v3 ACL protocol can do this.
357  */
358 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
359                                       struct rpc_program *program,
360                                       int vers)
361 {
362         struct rpc_clnt *clnt;
363         struct rpc_version *version;
364         int err;
365
366         BUG_ON(vers >= program->nrvers || !program->version[vers]);
367         version = program->version[vers];
368         clnt = rpc_clone_client(old);
369         if (IS_ERR(clnt))
370                 goto out;
371         clnt->cl_procinfo = version->procs;
372         clnt->cl_maxproc  = version->nrprocs;
373         clnt->cl_protname = program->name;
374         clnt->cl_prog     = program->number;
375         clnt->cl_vers     = version->number;
376         clnt->cl_stats    = program->stats;
377         err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
378         if (err != 0) {
379                 rpc_shutdown_client(clnt);
380                 clnt = ERR_PTR(err);
381         }
382 out:    
383         return clnt;
384 }
385
386 /*
387  * Default callback for async RPC calls
388  */
389 static void
390 rpc_default_callback(struct rpc_task *task, void *data)
391 {
392 }
393
394 static const struct rpc_call_ops rpc_default_ops = {
395         .rpc_call_done = rpc_default_callback,
396 };
397
398 /*
399  *      Export the signal mask handling for synchronous code that
400  *      sleeps on RPC calls
401  */
402 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
403  
404 static void rpc_save_sigmask(sigset_t *oldset, int intr)
405 {
406         unsigned long   sigallow = sigmask(SIGKILL);
407         sigset_t sigmask;
408
409         /* Block all signals except those listed in sigallow */
410         if (intr)
411                 sigallow |= RPC_INTR_SIGNALS;
412         siginitsetinv(&sigmask, sigallow);
413         sigprocmask(SIG_BLOCK, &sigmask, oldset);
414 }
415
416 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
417 {
418         rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
419 }
420
421 static inline void rpc_restore_sigmask(sigset_t *oldset)
422 {
423         sigprocmask(SIG_SETMASK, oldset, NULL);
424 }
425
426 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
427 {
428         rpc_save_sigmask(oldset, clnt->cl_intr);
429 }
430
431 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
432 {
433         rpc_restore_sigmask(oldset);
434 }
435
436 /*
437  * New rpc_call implementation
438  */
439 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
440 {
441         struct rpc_task *task;
442         sigset_t        oldset;
443         int             status;
444
445         /* If this client is slain all further I/O fails */
446         if (clnt->cl_dead) 
447                 return -EIO;
448
449         BUG_ON(flags & RPC_TASK_ASYNC);
450
451         status = -ENOMEM;
452         task = rpc_new_task(clnt, flags, &rpc_default_ops, NULL);
453         if (task == NULL)
454                 goto out;
455
456         /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
457         rpc_task_sigmask(task, &oldset);
458
459         rpc_call_setup(task, msg, 0);
460
461         /* Set up the call info struct and execute the task */
462         status = task->tk_status;
463         if (status == 0) {
464                 atomic_inc(&task->tk_count);
465                 status = rpc_execute(task);
466                 if (status == 0)
467                         status = task->tk_status;
468         }
469         rpc_restore_sigmask(&oldset);
470         rpc_release_task(task);
471 out:
472         return status;
473 }
474
475 /*
476  * New rpc_call implementation
477  */
478 int
479 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
480                const struct rpc_call_ops *tk_ops, void *data)
481 {
482         struct rpc_task *task;
483         sigset_t        oldset;
484         int             status;
485
486         /* If this client is slain all further I/O fails */
487         status = -EIO;
488         if (clnt->cl_dead) 
489                 goto out_release;
490
491         flags |= RPC_TASK_ASYNC;
492
493         /* Create/initialize a new RPC task */
494         status = -ENOMEM;
495         if (!(task = rpc_new_task(clnt, flags, tk_ops, data)))
496                 goto out_release;
497
498         /* Mask signals on GSS_AUTH upcalls */
499         rpc_task_sigmask(task, &oldset);                
500
501         rpc_call_setup(task, msg, 0);
502
503         /* Set up the call info struct and execute the task */
504         status = task->tk_status;
505         if (status == 0)
506                 rpc_execute(task);
507         else
508                 rpc_release_task(task);
509
510         rpc_restore_sigmask(&oldset);           
511         return status;
512 out_release:
513         if (tk_ops->rpc_release != NULL)
514                 tk_ops->rpc_release(data);
515         return status;
516 }
517
518
519 void
520 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
521 {
522         task->tk_msg   = *msg;
523         task->tk_flags |= flags;
524         /* Bind the user cred */
525         if (task->tk_msg.rpc_cred != NULL)
526                 rpcauth_holdcred(task);
527         else
528                 rpcauth_bindcred(task);
529
530         if (task->tk_status == 0)
531                 task->tk_action = call_start;
532         else
533                 task->tk_action = rpc_exit_task;
534 }
535
536 void
537 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
538 {
539         struct rpc_xprt *xprt = clnt->cl_xprt;
540         if (xprt->ops->set_buffer_size)
541                 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
542 }
543
544 /*
545  * Return size of largest payload RPC client can support, in bytes
546  *
547  * For stream transports, this is one RPC record fragment (see RFC
548  * 1831), as we don't support multi-record requests yet.  For datagram
549  * transports, this is the size of an IP packet minus the IP, UDP, and
550  * RPC header sizes.
551  */
552 size_t rpc_max_payload(struct rpc_clnt *clnt)
553 {
554         return clnt->cl_xprt->max_payload;
555 }
556 EXPORT_SYMBOL(rpc_max_payload);
557
558 /**
559  * rpc_force_rebind - force transport to check that remote port is unchanged
560  * @clnt: client to rebind
561  *
562  */
563 void rpc_force_rebind(struct rpc_clnt *clnt)
564 {
565         if (clnt->cl_autobind)
566                 xprt_clear_bound(clnt->cl_xprt);
567 }
568 EXPORT_SYMBOL(rpc_force_rebind);
569
570 /*
571  * Restart an (async) RPC call. Usually called from within the
572  * exit handler.
573  */
574 void
575 rpc_restart_call(struct rpc_task *task)
576 {
577         if (RPC_ASSASSINATED(task))
578                 return;
579
580         task->tk_action = call_start;
581 }
582
583 /*
584  * 0.  Initial state
585  *
586  *     Other FSM states can be visited zero or more times, but
587  *     this state is visited exactly once for each RPC.
588  */
589 static void
590 call_start(struct rpc_task *task)
591 {
592         struct rpc_clnt *clnt = task->tk_client;
593
594         dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
595                 clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
596                 (RPC_IS_ASYNC(task) ? "async" : "sync"));
597
598         /* Increment call count */
599         task->tk_msg.rpc_proc->p_count++;
600         clnt->cl_stats->rpccnt++;
601         task->tk_action = call_reserve;
602 }
603
604 /*
605  * 1.   Reserve an RPC call slot
606  */
607 static void
608 call_reserve(struct rpc_task *task)
609 {
610         dprintk("RPC: %4d call_reserve\n", task->tk_pid);
611
612         if (!rpcauth_uptodatecred(task)) {
613                 task->tk_action = call_refresh;
614                 return;
615         }
616
617         task->tk_status  = 0;
618         task->tk_action  = call_reserveresult;
619         xprt_reserve(task);
620 }
621
622 /*
623  * 1b.  Grok the result of xprt_reserve()
624  */
625 static void
626 call_reserveresult(struct rpc_task *task)
627 {
628         int status = task->tk_status;
629
630         dprintk("RPC: %4d call_reserveresult (status %d)\n",
631                                 task->tk_pid, task->tk_status);
632
633         /*
634          * After a call to xprt_reserve(), we must have either
635          * a request slot or else an error status.
636          */
637         task->tk_status = 0;
638         if (status >= 0) {
639                 if (task->tk_rqstp) {
640                         task->tk_action = call_allocate;
641                         return;
642                 }
643
644                 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
645                                 __FUNCTION__, status);
646                 rpc_exit(task, -EIO);
647                 return;
648         }
649
650         /*
651          * Even though there was an error, we may have acquired
652          * a request slot somehow.  Make sure not to leak it.
653          */
654         if (task->tk_rqstp) {
655                 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
656                                 __FUNCTION__, status);
657                 xprt_release(task);
658         }
659
660         switch (status) {
661         case -EAGAIN:   /* woken up; retry */
662                 task->tk_action = call_reserve;
663                 return;
664         case -EIO:      /* probably a shutdown */
665                 break;
666         default:
667                 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
668                                 __FUNCTION__, status);
669                 break;
670         }
671         rpc_exit(task, status);
672 }
673
674 /*
675  * 2.   Allocate the buffer. For details, see sched.c:rpc_malloc.
676  *      (Note: buffer memory is freed in xprt_release).
677  */
678 static void
679 call_allocate(struct rpc_task *task)
680 {
681         struct rpc_rqst *req = task->tk_rqstp;
682         struct rpc_xprt *xprt = task->tk_xprt;
683         unsigned int    bufsiz;
684
685         dprintk("RPC: %4d call_allocate (status %d)\n", 
686                                 task->tk_pid, task->tk_status);
687         task->tk_action = call_bind;
688         if (req->rq_buffer)
689                 return;
690
691         /* FIXME: compute buffer requirements more exactly using
692          * auth->au_wslack */
693         bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
694
695         if (xprt->ops->buf_alloc(task, bufsiz << 1) != NULL)
696                 return;
697         printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task); 
698
699         if (RPC_IS_ASYNC(task) || !signalled()) {
700                 xprt_release(task);
701                 task->tk_action = call_reserve;
702                 rpc_delay(task, HZ>>4);
703                 return;
704         }
705
706         rpc_exit(task, -ERESTARTSYS);
707 }
708
709 static inline int
710 rpc_task_need_encode(struct rpc_task *task)
711 {
712         return task->tk_rqstp->rq_snd_buf.len == 0;
713 }
714
715 static inline void
716 rpc_task_force_reencode(struct rpc_task *task)
717 {
718         task->tk_rqstp->rq_snd_buf.len = 0;
719 }
720
721 /*
722  * 3.   Encode arguments of an RPC call
723  */
724 static void
725 call_encode(struct rpc_task *task)
726 {
727         struct rpc_rqst *req = task->tk_rqstp;
728         struct xdr_buf *sndbuf = &req->rq_snd_buf;
729         struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
730         unsigned int    bufsiz;
731         kxdrproc_t      encode;
732         u32             *p;
733
734         dprintk("RPC: %4d call_encode (status %d)\n", 
735                                 task->tk_pid, task->tk_status);
736
737         /* Default buffer setup */
738         bufsiz = req->rq_bufsize >> 1;
739         sndbuf->head[0].iov_base = (void *)req->rq_buffer;
740         sndbuf->head[0].iov_len  = bufsiz;
741         sndbuf->tail[0].iov_len  = 0;
742         sndbuf->page_len         = 0;
743         sndbuf->len              = 0;
744         sndbuf->buflen           = bufsiz;
745         rcvbuf->head[0].iov_base = (void *)((char *)req->rq_buffer + bufsiz);
746         rcvbuf->head[0].iov_len  = bufsiz;
747         rcvbuf->tail[0].iov_len  = 0;
748         rcvbuf->page_len         = 0;
749         rcvbuf->len              = 0;
750         rcvbuf->buflen           = bufsiz;
751
752         /* Encode header and provided arguments */
753         encode = task->tk_msg.rpc_proc->p_encode;
754         if (!(p = call_header(task))) {
755                 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
756                 rpc_exit(task, -EIO);
757                 return;
758         }
759         if (encode == NULL)
760                 return;
761
762         task->tk_status = rpcauth_wrap_req(task, encode, req, p,
763                         task->tk_msg.rpc_argp);
764         if (task->tk_status == -ENOMEM) {
765                 /* XXX: Is this sane? */
766                 rpc_delay(task, 3*HZ);
767                 task->tk_status = -EAGAIN;
768         }
769 }
770
771 /*
772  * 4.   Get the server port number if not yet set
773  */
774 static void
775 call_bind(struct rpc_task *task)
776 {
777         struct rpc_xprt *xprt = task->tk_xprt;
778
779         dprintk("RPC: %4d call_bind (status %d)\n",
780                                 task->tk_pid, task->tk_status);
781
782         task->tk_action = call_connect;
783         if (!xprt_bound(xprt)) {
784                 task->tk_action = call_bind_status;
785                 task->tk_timeout = xprt->bind_timeout;
786                 xprt->ops->rpcbind(task);
787         }
788 }
789
790 /*
791  * 4a.  Sort out bind result
792  */
793 static void
794 call_bind_status(struct rpc_task *task)
795 {
796         int status = -EACCES;
797
798         if (task->tk_status >= 0) {
799                 dprintk("RPC: %4d call_bind_status (status %d)\n",
800                                         task->tk_pid, task->tk_status);
801                 task->tk_status = 0;
802                 task->tk_action = call_connect;
803                 return;
804         }
805
806         switch (task->tk_status) {
807         case -EACCES:
808                 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
809                                 task->tk_pid);
810                 rpc_delay(task, 3*HZ);
811                 goto retry_bind;
812         case -ETIMEDOUT:
813                 dprintk("RPC: %4d rpcbind request timed out\n",
814                                 task->tk_pid);
815                 if (RPC_IS_SOFT(task)) {
816                         status = -EIO;
817                         break;
818                 }
819                 goto retry_bind;
820         case -EPFNOSUPPORT:
821                 dprintk("RPC: %4d remote rpcbind service unavailable\n",
822                                 task->tk_pid);
823                 break;
824         case -EPROTONOSUPPORT:
825                 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
826                                 task->tk_pid);
827                 break;
828         default:
829                 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
830                                 task->tk_pid, -task->tk_status);
831                 status = -EIO;
832                 break;
833         }
834
835         rpc_exit(task, status);
836         return;
837
838 retry_bind:
839         task->tk_status = 0;
840         task->tk_action = call_bind;
841         return;
842 }
843
844 /*
845  * 4b.  Connect to the RPC server
846  */
847 static void
848 call_connect(struct rpc_task *task)
849 {
850         struct rpc_xprt *xprt = task->tk_xprt;
851
852         dprintk("RPC: %4d call_connect xprt %p %s connected\n",
853                         task->tk_pid, xprt,
854                         (xprt_connected(xprt) ? "is" : "is not"));
855
856         task->tk_action = call_transmit;
857         if (!xprt_connected(xprt)) {
858                 task->tk_action = call_connect_status;
859                 if (task->tk_status < 0)
860                         return;
861                 xprt_connect(task);
862         }
863 }
864
865 /*
866  * 4c.  Sort out connect result
867  */
868 static void
869 call_connect_status(struct rpc_task *task)
870 {
871         struct rpc_clnt *clnt = task->tk_client;
872         int status = task->tk_status;
873
874         dprintk("RPC: %5u call_connect_status (status %d)\n", 
875                                 task->tk_pid, task->tk_status);
876
877         task->tk_status = 0;
878         if (status >= 0) {
879                 clnt->cl_stats->netreconn++;
880                 task->tk_action = call_transmit;
881                 return;
882         }
883
884         /* Something failed: remote service port may have changed */
885         rpc_force_rebind(clnt);
886
887         switch (status) {
888         case -ENOTCONN:
889         case -ETIMEDOUT:
890         case -EAGAIN:
891                 task->tk_action = call_bind;
892                 break;
893         default:
894                 rpc_exit(task, -EIO);
895                 break;
896         }
897 }
898
899 /*
900  * 5.   Transmit the RPC request, and wait for reply
901  */
902 static void
903 call_transmit(struct rpc_task *task)
904 {
905         dprintk("RPC: %4d call_transmit (status %d)\n", 
906                                 task->tk_pid, task->tk_status);
907
908         task->tk_action = call_status;
909         if (task->tk_status < 0)
910                 return;
911         task->tk_status = xprt_prepare_transmit(task);
912         if (task->tk_status != 0)
913                 return;
914         task->tk_action = call_transmit_status;
915         /* Encode here so that rpcsec_gss can use correct sequence number. */
916         if (rpc_task_need_encode(task)) {
917                 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
918                 call_encode(task);
919                 /* Did the encode result in an error condition? */
920                 if (task->tk_status != 0)
921                         return;
922         }
923         xprt_transmit(task);
924         if (task->tk_status < 0)
925                 return;
926         /*
927          * On success, ensure that we call xprt_end_transmit() before sleeping
928          * in order to allow access to the socket to other RPC requests.
929          */
930         call_transmit_status(task);
931         if (task->tk_msg.rpc_proc->p_decode != NULL)
932                 return;
933         task->tk_action = rpc_exit_task;
934         rpc_wake_up_task(task);
935 }
936
937 /*
938  * 5a.  Handle cleanup after a transmission
939  */
940 static void
941 call_transmit_status(struct rpc_task *task)
942 {
943         task->tk_action = call_status;
944         /*
945          * Special case: if we've been waiting on the socket's write_space()
946          * callback, then don't call xprt_end_transmit().
947          */
948         if (task->tk_status == -EAGAIN)
949                 return;
950         xprt_end_transmit(task);
951         rpc_task_force_reencode(task);
952 }
953
954 /*
955  * 6.   Sort out the RPC call status
956  */
957 static void
958 call_status(struct rpc_task *task)
959 {
960         struct rpc_clnt *clnt = task->tk_client;
961         struct rpc_rqst *req = task->tk_rqstp;
962         int             status;
963
964         if (req->rq_received > 0 && !req->rq_bytes_sent)
965                 task->tk_status = req->rq_received;
966
967         dprintk("RPC: %4d call_status (status %d)\n", 
968                                 task->tk_pid, task->tk_status);
969
970         status = task->tk_status;
971         if (status >= 0) {
972                 task->tk_action = call_decode;
973                 return;
974         }
975
976         task->tk_status = 0;
977         switch(status) {
978         case -ETIMEDOUT:
979                 task->tk_action = call_timeout;
980                 break;
981         case -ECONNREFUSED:
982         case -ENOTCONN:
983                 rpc_force_rebind(clnt);
984                 task->tk_action = call_bind;
985                 break;
986         case -EAGAIN:
987                 task->tk_action = call_transmit;
988                 break;
989         case -EIO:
990                 /* shutdown or soft timeout */
991                 rpc_exit(task, status);
992                 break;
993         default:
994                 printk("%s: RPC call returned error %d\n",
995                                clnt->cl_protname, -status);
996                 rpc_exit(task, status);
997                 break;
998         }
999 }
1000
1001 /*
1002  * 6a.  Handle RPC timeout
1003  *      We do not release the request slot, so we keep using the
1004  *      same XID for all retransmits.
1005  */
1006 static void
1007 call_timeout(struct rpc_task *task)
1008 {
1009         struct rpc_clnt *clnt = task->tk_client;
1010
1011         if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1012                 dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
1013                 goto retry;
1014         }
1015
1016         dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
1017         task->tk_timeouts++;
1018
1019         if (RPC_IS_SOFT(task)) {
1020                 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1021                                 clnt->cl_protname, clnt->cl_server);
1022                 rpc_exit(task, -EIO);
1023                 return;
1024         }
1025
1026         if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1027                 task->tk_flags |= RPC_CALL_MAJORSEEN;
1028                 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1029                         clnt->cl_protname, clnt->cl_server);
1030         }
1031         rpc_force_rebind(clnt);
1032
1033 retry:
1034         clnt->cl_stats->rpcretrans++;
1035         task->tk_action = call_bind;
1036         task->tk_status = 0;
1037 }
1038
1039 /*
1040  * 7.   Decode the RPC reply
1041  */
1042 static void
1043 call_decode(struct rpc_task *task)
1044 {
1045         struct rpc_clnt *clnt = task->tk_client;
1046         struct rpc_rqst *req = task->tk_rqstp;
1047         kxdrproc_t      decode = task->tk_msg.rpc_proc->p_decode;
1048         u32             *p;
1049
1050         dprintk("RPC: %4d call_decode (status %d)\n", 
1051                                 task->tk_pid, task->tk_status);
1052
1053         if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1054                 printk(KERN_NOTICE "%s: server %s OK\n",
1055                         clnt->cl_protname, clnt->cl_server);
1056                 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1057         }
1058
1059         if (task->tk_status < 12) {
1060                 if (!RPC_IS_SOFT(task)) {
1061                         task->tk_action = call_bind;
1062                         clnt->cl_stats->rpcretrans++;
1063                         goto out_retry;
1064                 }
1065                 printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
1066                         clnt->cl_protname, task->tk_status);
1067                 rpc_exit(task, -EIO);
1068                 return;
1069         }
1070
1071         /*
1072          * Ensure that we see all writes made by xprt_complete_rqst()
1073          * before it changed req->rq_received.
1074          */
1075         smp_rmb();
1076         req->rq_rcv_buf.len = req->rq_private_buf.len;
1077
1078         /* Check that the softirq receive buffer is valid */
1079         WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1080                                 sizeof(req->rq_rcv_buf)) != 0);
1081
1082         /* Verify the RPC header */
1083         p = call_verify(task);
1084         if (IS_ERR(p)) {
1085                 if (p == ERR_PTR(-EAGAIN))
1086                         goto out_retry;
1087                 return;
1088         }
1089
1090         task->tk_action = rpc_exit_task;
1091
1092         if (decode)
1093                 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1094                                                       task->tk_msg.rpc_resp);
1095         dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
1096                                         task->tk_status);
1097         return;
1098 out_retry:
1099         req->rq_received = req->rq_private_buf.len = 0;
1100         task->tk_status = 0;
1101 }
1102
1103 /*
1104  * 8.   Refresh the credentials if rejected by the server
1105  */
1106 static void
1107 call_refresh(struct rpc_task *task)
1108 {
1109         dprintk("RPC: %4d call_refresh\n", task->tk_pid);
1110
1111         xprt_release(task);     /* Must do to obtain new XID */
1112         task->tk_action = call_refreshresult;
1113         task->tk_status = 0;
1114         task->tk_client->cl_stats->rpcauthrefresh++;
1115         rpcauth_refreshcred(task);
1116 }
1117
1118 /*
1119  * 8a.  Process the results of a credential refresh
1120  */
1121 static void
1122 call_refreshresult(struct rpc_task *task)
1123 {
1124         int status = task->tk_status;
1125         dprintk("RPC: %4d call_refreshresult (status %d)\n", 
1126                                 task->tk_pid, task->tk_status);
1127
1128         task->tk_status = 0;
1129         task->tk_action = call_reserve;
1130         if (status >= 0 && rpcauth_uptodatecred(task))
1131                 return;
1132         if (status == -EACCES) {
1133                 rpc_exit(task, -EACCES);
1134                 return;
1135         }
1136         task->tk_action = call_refresh;
1137         if (status != -ETIMEDOUT)
1138                 rpc_delay(task, 3*HZ);
1139         return;
1140 }
1141
1142 /*
1143  * Call header serialization
1144  */
1145 static u32 *
1146 call_header(struct rpc_task *task)
1147 {
1148         struct rpc_clnt *clnt = task->tk_client;
1149         struct rpc_rqst *req = task->tk_rqstp;
1150         u32             *p = req->rq_svec[0].iov_base;
1151
1152         /* FIXME: check buffer size? */
1153
1154         p = xprt_skip_transport_header(task->tk_xprt, p);
1155         *p++ = req->rq_xid;             /* XID */
1156         *p++ = htonl(RPC_CALL);         /* CALL */
1157         *p++ = htonl(RPC_VERSION);      /* RPC version */
1158         *p++ = htonl(clnt->cl_prog);    /* program number */
1159         *p++ = htonl(clnt->cl_vers);    /* program version */
1160         *p++ = htonl(task->tk_msg.rpc_proc->p_proc);    /* procedure */
1161         p = rpcauth_marshcred(task, p);
1162         req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1163         return p;
1164 }
1165
1166 /*
1167  * Reply header verification
1168  */
1169 static u32 *
1170 call_verify(struct rpc_task *task)
1171 {
1172         struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1173         int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1174         u32     *p = iov->iov_base, n;
1175         int error = -EACCES;
1176
1177         if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1178                 /* RFC-1014 says that the representation of XDR data must be a
1179                  * multiple of four bytes
1180                  * - if it isn't pointer subtraction in the NFS client may give
1181                  *   undefined results
1182                  */
1183                 printk(KERN_WARNING
1184                        "call_verify: XDR representation not a multiple of"
1185                        " 4 bytes: 0x%x\n", task->tk_rqstp->rq_rcv_buf.len);
1186                 goto out_eio;
1187         }
1188         if ((len -= 3) < 0)
1189                 goto out_overflow;
1190         p += 1; /* skip XID */
1191
1192         if ((n = ntohl(*p++)) != RPC_REPLY) {
1193                 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1194                 goto out_garbage;
1195         }
1196         if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1197                 if (--len < 0)
1198                         goto out_overflow;
1199                 switch ((n = ntohl(*p++))) {
1200                         case RPC_AUTH_ERROR:
1201                                 break;
1202                         case RPC_MISMATCH:
1203                                 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__);
1204                                 error = -EPROTONOSUPPORT;
1205                                 goto out_err;
1206                         default:
1207                                 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
1208                                 goto out_eio;
1209                 }
1210                 if (--len < 0)
1211                         goto out_overflow;
1212                 switch ((n = ntohl(*p++))) {
1213                 case RPC_AUTH_REJECTEDCRED:
1214                 case RPC_AUTH_REJECTEDVERF:
1215                 case RPCSEC_GSS_CREDPROBLEM:
1216                 case RPCSEC_GSS_CTXPROBLEM:
1217                         if (!task->tk_cred_retry)
1218                                 break;
1219                         task->tk_cred_retry--;
1220                         dprintk("RPC: %4d call_verify: retry stale creds\n",
1221                                                         task->tk_pid);
1222                         rpcauth_invalcred(task);
1223                         task->tk_action = call_refresh;
1224                         goto out_retry;
1225                 case RPC_AUTH_BADCRED:
1226                 case RPC_AUTH_BADVERF:
1227                         /* possibly garbled cred/verf? */
1228                         if (!task->tk_garb_retry)
1229                                 break;
1230                         task->tk_garb_retry--;
1231                         dprintk("RPC: %4d call_verify: retry garbled creds\n",
1232                                                         task->tk_pid);
1233                         task->tk_action = call_bind;
1234                         goto out_retry;
1235                 case RPC_AUTH_TOOWEAK:
1236                         printk(KERN_NOTICE "call_verify: server %s requires stronger "
1237                                "authentication.\n", task->tk_client->cl_server);
1238                         break;
1239                 default:
1240                         printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1241                         error = -EIO;
1242                 }
1243                 dprintk("RPC: %4d call_verify: call rejected %d\n",
1244                                                 task->tk_pid, n);
1245                 goto out_err;
1246         }
1247         if (!(p = rpcauth_checkverf(task, p))) {
1248                 printk(KERN_WARNING "call_verify: auth check failed\n");
1249                 goto out_garbage;               /* bad verifier, retry */
1250         }
1251         len = p - (u32 *)iov->iov_base - 1;
1252         if (len < 0)
1253                 goto out_overflow;
1254         switch ((n = ntohl(*p++))) {
1255         case RPC_SUCCESS:
1256                 return p;
1257         case RPC_PROG_UNAVAIL:
1258                 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1259                                 (unsigned int)task->tk_client->cl_prog,
1260                                 task->tk_client->cl_server);
1261                 error = -EPFNOSUPPORT;
1262                 goto out_err;
1263         case RPC_PROG_MISMATCH:
1264                 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1265                                 (unsigned int)task->tk_client->cl_prog,
1266                                 (unsigned int)task->tk_client->cl_vers,
1267                                 task->tk_client->cl_server);
1268                 error = -EPROTONOSUPPORT;
1269                 goto out_err;
1270         case RPC_PROC_UNAVAIL:
1271                 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1272                                 task->tk_msg.rpc_proc,
1273                                 task->tk_client->cl_prog,
1274                                 task->tk_client->cl_vers,
1275                                 task->tk_client->cl_server);
1276                 error = -EOPNOTSUPP;
1277                 goto out_err;
1278         case RPC_GARBAGE_ARGS:
1279                 dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
1280                 break;                  /* retry */
1281         default:
1282                 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1283                 /* Also retry */
1284         }
1285
1286 out_garbage:
1287         task->tk_client->cl_stats->rpcgarbage++;
1288         if (task->tk_garb_retry) {
1289                 task->tk_garb_retry--;
1290                 dprintk("RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
1291                 task->tk_action = call_bind;
1292 out_retry:
1293                 return ERR_PTR(-EAGAIN);
1294         }
1295         printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1296 out_eio:
1297         error = -EIO;
1298 out_err:
1299         rpc_exit(task, error);
1300         return ERR_PTR(error);
1301 out_overflow:
1302         printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1303         goto out_garbage;
1304 }
1305
1306 static int rpcproc_encode_null(void *rqstp, u32 *data, void *obj)
1307 {
1308         return 0;
1309 }
1310
1311 static int rpcproc_decode_null(void *rqstp, u32 *data, void *obj)
1312 {
1313         return 0;
1314 }
1315
1316 static struct rpc_procinfo rpcproc_null = {
1317         .p_encode = rpcproc_encode_null,
1318         .p_decode = rpcproc_decode_null,
1319 };
1320
1321 int rpc_ping(struct rpc_clnt *clnt, int flags)
1322 {
1323         struct rpc_message msg = {
1324                 .rpc_proc = &rpcproc_null,
1325         };
1326         int err;
1327         msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1328         err = rpc_call_sync(clnt, &msg, flags);
1329         put_rpccred(msg.rpc_cred);
1330         return err;
1331 }