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