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/kallsyms.h>
  29 #include <linux/mm.h>
  30 #include <linux/namei.h>
  31 #include <linux/mount.h>
  32 #include <linux/slab.h>
  33 #include <linux/utsname.h>
  34 #include <linux/workqueue.h>
  35 #include <linux/in6.h>
  36
  37 #include <linux/sunrpc/clnt.h>
  38 #include <linux/sunrpc/rpc_pipe_fs.h>
  39 #include <linux/sunrpc/metrics.h>
  40 #include <linux/sunrpc/bc_xprt.h>
  41
  42 #include "sunrpc.h"
  43
  44 #ifdef RPC_DEBUG
  45 # define RPCDBG_FACILITY        RPCDBG_CALL
  46 #endif
  47
  48 #define dprint_status(t)                                        \
  49         dprintk("RPC: %5u %s (status %d)\n", t->tk_pid,         \
  50                         __func__, t->tk_status)
  51
  52 /*
  53  * All RPC clients are linked into this list
  54  */
  55 static LIST_HEAD(all_clients);
  56 static DEFINE_SPINLOCK(rpc_client_lock);
  57
  58 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
  59
  60
  61 static void     call_start(struct rpc_task *task);
  62 static void     call_reserve(struct rpc_task *task);
  63 static void     call_reserveresult(struct rpc_task *task);
  64 static void     call_allocate(struct rpc_task *task);
  65 static void     call_decode(struct rpc_task *task);
  66 static void     call_bind(struct rpc_task *task);
  67 static void     call_bind_status(struct rpc_task *task);
  68 static void     call_transmit(struct rpc_task *task);
  69 #if defined(CONFIG_NFS_V4_1)
  70 static void     call_bc_transmit(struct rpc_task *task);
  71 #endif /* CONFIG_NFS_V4_1 */
  72 static void     call_status(struct rpc_task *task);
  73 static void     call_transmit_status(struct rpc_task *task);
  74 static void     call_refresh(struct rpc_task *task);
  75 static void     call_refreshresult(struct rpc_task *task);
  76 static void     call_timeout(struct rpc_task *task);
  77 static void     call_connect(struct rpc_task *task);
  78 static void     call_connect_status(struct rpc_task *task);
  79
  80 static __be32   *rpc_encode_header(struct rpc_task *task);
  81 static __be32   *rpc_verify_header(struct rpc_task *task);
  82 static int      rpc_ping(struct rpc_clnt *clnt);
  83
  84 static void rpc_register_client(struct rpc_clnt *clnt)
  85 {
  86         spin_lock(&rpc_client_lock);
  87         list_add(&clnt->cl_clients, &all_clients);
  88         spin_unlock(&rpc_client_lock);
  89 }
  90
  91 static void rpc_unregister_client(struct rpc_clnt *clnt)
  92 {
  93         spin_lock(&rpc_client_lock);
  94         list_del(&clnt->cl_clients);
  95         spin_unlock(&rpc_client_lock);
  96 }
  97
  98 static int
  99 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
 100 {
 101         static uint32_t clntid;
 102         struct nameidata nd;
 103         struct path path;
 104         char name[15];
 105         struct qstr q = {
 106                 .name = name,
 107         };
 108         int error;
 109
 110         clnt->cl_path.mnt = ERR_PTR(-ENOENT);
 111         clnt->cl_path.dentry = ERR_PTR(-ENOENT);
 112         if (dir_name == NULL)
 113                 return 0;
 114
 115         path.mnt = rpc_get_mount();
 116         if (IS_ERR(path.mnt))
 117                 return PTR_ERR(path.mnt);
 118         error = vfs_path_lookup(path.mnt->mnt_root, path.mnt, dir_name, 0, &nd);
 119         if (error)
 120                 goto err;
 121
 122         for (;;) {
 123                 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
 124                 name[sizeof(name) - 1] = '\0';
 125                 q.hash = full_name_hash(q.name, q.len);
 126                 path.dentry = rpc_create_client_dir(nd.path.dentry, &q, clnt);
 127                 if (!IS_ERR(path.dentry))
 128                         break;
 129                 error = PTR_ERR(path.dentry);
 130                 if (error != -EEXIST) {
 131                         printk(KERN_INFO "RPC: Couldn't create pipefs entry"
 132                                         " %s/%s, error %d\n",
 133                                         dir_name, name, error);
 134                         goto err_path_put;
 135                 }
 136         }
 137         path_put(&nd.path);
 138         clnt->cl_path = path;
 139         return 0;
 140 err_path_put:
 141         path_put(&nd.path);
 142 err:
 143         rpc_put_mount();
 144         return error;
 145 }
 146
 147 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
 148 {
 149         struct rpc_program      *program = args->program;
 150         struct rpc_version      *version;
 151         struct rpc_clnt         *clnt = NULL;
 152         struct rpc_auth         *auth;
 153         int err;
 154         size_t len;
 155
 156         /* sanity check the name before trying to print it */
 157         err = -EINVAL;
 158         len = strlen(args->servername);
 159         if (len > RPC_MAXNETNAMELEN)
 160                 goto out_no_rpciod;
 161         len++;
 162
 163         dprintk("RPC:       creating %s client for %s (xprt %p)\n",
 164                         program->name, args->servername, xprt);
 165
 166         err = rpciod_up();
 167         if (err)
 168                 goto out_no_rpciod;
 169         err = -EINVAL;
 170         if (!xprt)
 171                 goto out_no_xprt;
 172
 173         if (args->version >= program->nrvers)
 174                 goto out_err;
 175         version = program->version[args->version];
 176         if (version == NULL)
 177                 goto out_err;
 178
 179         err = -ENOMEM;
 180         clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
 181         if (!clnt)
 182                 goto out_err;
 183         clnt->cl_parent = clnt;
 184
 185         clnt->cl_server = clnt->cl_inline_name;
 186         if (len > sizeof(clnt->cl_inline_name)) {
 187                 char *buf = kmalloc(len, GFP_KERNEL);
 188                 if (buf != NULL)
 189                         clnt->cl_server = buf;
 190                 else
 191                         len = sizeof(clnt->cl_inline_name);
 192         }
 193         strlcpy(clnt->cl_server, args->servername, len);
 194
 195         clnt->cl_xprt     = xprt;
 196         clnt->cl_procinfo = version->procs;
 197         clnt->cl_maxproc  = version->nrprocs;
 198         clnt->cl_protname = program->name;
 199         clnt->cl_prog     = args->prognumber ? : program->number;
 200         clnt->cl_vers     = version->number;
 201         clnt->cl_stats    = program->stats;
 202         clnt->cl_metrics  = rpc_alloc_iostats(clnt);
 203         err = -ENOMEM;
 204         if (clnt->cl_metrics == NULL)
 205                 goto out_no_stats;
 206         clnt->cl_program  = program;
 207         INIT_LIST_HEAD(&clnt->cl_tasks);
 208         spin_lock_init(&clnt->cl_lock);
 209
 210         if (!xprt_bound(clnt->cl_xprt))
 211                 clnt->cl_autobind = 1;
 212
 213         clnt->cl_timeout = xprt->timeout;
 214         if (args->timeout != NULL) {
 215                 memcpy(&clnt->cl_timeout_default, args->timeout,
 216                                 sizeof(clnt->cl_timeout_default));
 217                 clnt->cl_timeout = &clnt->cl_timeout_default;
 218         }
 219
 220         clnt->cl_rtt = &clnt->cl_rtt_default;
 221         rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
 222         clnt->cl_principal = NULL;
 223         if (args->client_name) {
 224                 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
 225                 if (!clnt->cl_principal)
 226                         goto out_no_principal;
 227         }
 228
 229         kref_init(&clnt->cl_kref);
 230
 231         err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
 232         if (err < 0)
 233                 goto out_no_path;
 234
 235         auth = rpcauth_create(args->authflavor, clnt);
 236         if (IS_ERR(auth)) {
 237                 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
 238                                 args->authflavor);
 239                 err = PTR_ERR(auth);
 240                 goto out_no_auth;
 241         }
 242
 243         /* save the nodename */
 244         clnt->cl_nodelen = strlen(init_utsname()->nodename);
 245         if (clnt->cl_nodelen > UNX_MAXNODENAME)
 246                 clnt->cl_nodelen = UNX_MAXNODENAME;
 247         memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
 248         rpc_register_client(clnt);
 249         return clnt;
 250
 251 out_no_auth:
 252         if (!IS_ERR(clnt->cl_path.dentry)) {
 253                 rpc_remove_client_dir(clnt->cl_path.dentry);
 254                 rpc_put_mount();
 255         }
 256 out_no_path:
 257         kfree(clnt->cl_principal);
 258 out_no_principal:
 259         rpc_free_iostats(clnt->cl_metrics);
 260 out_no_stats:
 261         if (clnt->cl_server != clnt->cl_inline_name)
 262                 kfree(clnt->cl_server);
 263         kfree(clnt);
 264 out_err:
 265         xprt_put(xprt);
 266 out_no_xprt:
 267         rpciod_down();
 268 out_no_rpciod:
 269         return ERR_PTR(err);
 270 }
 271
 272 /*
 273  * rpc_create - create an RPC client and transport with one call
 274  * @args: rpc_clnt create argument structure
 275  *
 276  * Creates and initializes an RPC transport and an RPC client.
 277  *
 278  * It can ping the server in order to determine if it is up, and to see if
 279  * it supports this program and version.  RPC_CLNT_CREATE_NOPING disables
 280  * this behavior so asynchronous tasks can also use rpc_create.
 281  */
 282 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
 283 {
 284         struct rpc_xprt *xprt;
 285         struct rpc_clnt *clnt;
 286         struct xprt_create xprtargs = {
 287                 .ident = args->protocol,
 288                 .srcaddr = args->saddress,
 289                 .dstaddr = args->address,
 290                 .addrlen = args->addrsize,
 291                 .bc_xprt = args->bc_xprt,
 292         };
 293         char servername[48];
 294
 295         /*
 296          * If the caller chooses not to specify a hostname, whip
 297          * up a string representation of the passed-in address.
 298          */
 299         if (args->servername == NULL) {
 300                 servername[0] = '\0';
 301                 switch (args->address->sa_family) {
 302                 case AF_INET: {
 303                         struct sockaddr_in *sin =
 304                                         (struct sockaddr_in *)args->address;
 305                         snprintf(servername, sizeof(servername), "%pI4",
 306                                  &sin->sin_addr.s_addr);
 307                         break;
 308                 }
 309                 case AF_INET6: {
 310                         struct sockaddr_in6 *sin =
 311                                         (struct sockaddr_in6 *)args->address;
 312                         snprintf(servername, sizeof(servername), "%pI6",
 313                                  &sin->sin6_addr);
 314                         break;
 315                 }
 316                 default:
 317                         /* caller wants default server name, but
 318                          * address family isn't recognized. */
 319                         return ERR_PTR(-EINVAL);
 320                 }
 321                 args->servername = servername;
 322         }
 323
 324         xprt = xprt_create_transport(&xprtargs);
 325         if (IS_ERR(xprt))
 326                 return (struct rpc_clnt *)xprt;
 327
 328         /*
 329          * By default, kernel RPC client connects from a reserved port.
 330          * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
 331          * but it is always enabled for rpciod, which handles the connect
 332          * operation.
 333          */
 334         xprt->resvport = 1;
 335         if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
 336                 xprt->resvport = 0;
 337
 338         clnt = rpc_new_client(args, xprt);
 339         if (IS_ERR(clnt))
 340                 return clnt;
 341
 342         if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
 343                 int err = rpc_ping(clnt);
 344                 if (err != 0) {
 345                         rpc_shutdown_client(clnt);
 346                         return ERR_PTR(err);
 347                 }
 348         }
 349
 350         clnt->cl_softrtry = 1;
 351         if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
 352                 clnt->cl_softrtry = 0;
 353
 354         if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
 355                 clnt->cl_autobind = 1;
 356         if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
 357                 clnt->cl_discrtry = 1;
 358         if (!(args->flags & RPC_CLNT_CREATE_QUIET))
 359                 clnt->cl_chatty = 1;
 360
 361         return clnt;
 362 }
 363 EXPORT_SYMBOL_GPL(rpc_create);
 364
 365 /*
 366  * This function clones the RPC client structure. It allows us to share the
 367  * same transport while varying parameters such as the authentication
 368  * flavour.
 369  */
 370 struct rpc_clnt *
 371 rpc_clone_client(struct rpc_clnt *clnt)
 372 {
 373         struct rpc_clnt *new;
 374         int err = -ENOMEM;
 375
 376         new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
 377         if (!new)
 378                 goto out_no_clnt;
 379         new->cl_parent = clnt;
 380         /* Turn off autobind on clones */
 381         new->cl_autobind = 0;
 382         INIT_LIST_HEAD(&new->cl_tasks);
 383         spin_lock_init(&new->cl_lock);
 384         rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
 385         new->cl_metrics = rpc_alloc_iostats(clnt);
 386         if (new->cl_metrics == NULL)
 387                 goto out_no_stats;
 388         if (clnt->cl_principal) {
 389                 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
 390                 if (new->cl_principal == NULL)
 391                         goto out_no_principal;
 392         }
 393         kref_init(&new->cl_kref);
 394         err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
 395         if (err != 0)
 396                 goto out_no_path;
 397         if (new->cl_auth)
 398                 atomic_inc(&new->cl_auth->au_count);
 399         xprt_get(clnt->cl_xprt);
 400         kref_get(&clnt->cl_kref);
 401         rpc_register_client(new);
 402         rpciod_up();
 403         return new;
 404 out_no_path:
 405         kfree(new->cl_principal);
 406 out_no_principal:
 407         rpc_free_iostats(new->cl_metrics);
 408 out_no_stats:
 409         kfree(new);
 410 out_no_clnt:
 411         dprintk("RPC:       %s: returned error %d\n", __func__, err);
 412         return ERR_PTR(err);
 413 }
 414 EXPORT_SYMBOL_GPL(rpc_clone_client);
 415
 416 /*
 417  * Properly shut down an RPC client, terminating all outstanding
 418  * requests.
 419  */
 420 void rpc_shutdown_client(struct rpc_clnt *clnt)
 421 {
 422         dprintk("RPC:       shutting down %s client for %s\n",
 423                         clnt->cl_protname, clnt->cl_server);
 424
 425         while (!list_empty(&clnt->cl_tasks)) {
 426                 rpc_killall_tasks(clnt);
 427                 wait_event_timeout(destroy_wait,
 428                         list_empty(&clnt->cl_tasks), 1*HZ);
 429         }
 430
 431         rpc_release_client(clnt);
 432 }
 433 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
 434
 435 /*
 436  * Free an RPC client
 437  */
 438 static void
 439 rpc_free_client(struct kref *kref)
 440 {
 441         struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
 442
 443         dprintk("RPC:       destroying %s client for %s\n",
 444                         clnt->cl_protname, clnt->cl_server);
 445         if (!IS_ERR(clnt->cl_path.dentry)) {
 446                 rpc_remove_client_dir(clnt->cl_path.dentry);
 447                 rpc_put_mount();
 448         }
 449         if (clnt->cl_parent != clnt) {
 450                 rpc_release_client(clnt->cl_parent);
 451                 goto out_free;
 452         }
 453         if (clnt->cl_server != clnt->cl_inline_name)
 454                 kfree(clnt->cl_server);
 455 out_free:
 456         rpc_unregister_client(clnt);
 457         rpc_free_iostats(clnt->cl_metrics);
 458         kfree(clnt->cl_principal);
 459         clnt->cl_metrics = NULL;
 460         xprt_put(clnt->cl_xprt);
 461         rpciod_down();
 462         kfree(clnt);
 463 }
 464
 465 /*
 466  * Free an RPC client
 467  */
 468 static void
 469 rpc_free_auth(struct kref *kref)
 470 {
 471         struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
 472
 473         if (clnt->cl_auth == NULL) {
 474                 rpc_free_client(kref);
 475                 return;
 476         }
 477
 478         /*
 479          * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
 480          *       release remaining GSS contexts. This mechanism ensures
 481          *       that it can do so safely.
 482          */
 483         kref_init(kref);
 484         rpcauth_release(clnt->cl_auth);
 485         clnt->cl_auth = NULL;
 486         kref_put(kref, rpc_free_client);
 487 }
 488
 489 /*
 490  * Release reference to the RPC client
 491  */
 492 void
 493 rpc_release_client(struct rpc_clnt *clnt)
 494 {
 495         dprintk("RPC:       rpc_release_client(%p)\n", clnt);
 496
 497         if (list_empty(&clnt->cl_tasks))
 498                 wake_up(&destroy_wait);
 499         kref_put(&clnt->cl_kref, rpc_free_auth);
 500 }
 501
 502 /**
 503  * rpc_bind_new_program - bind a new RPC program to an existing client
 504  * @old: old rpc_client
 505  * @program: rpc program to set
 506  * @vers: rpc program version
 507  *
 508  * Clones the rpc client and sets up a new RPC program. This is mainly
 509  * of use for enabling different RPC programs to share the same transport.
 510  * The Sun NFSv2/v3 ACL protocol can do this.
 511  */
 512 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
 513                                       struct rpc_program *program,
 514                                       u32 vers)
 515 {
 516         struct rpc_clnt *clnt;
 517         struct rpc_version *version;
 518         int err;
 519
 520         BUG_ON(vers >= program->nrvers || !program->version[vers]);
 521         version = program->version[vers];
 522         clnt = rpc_clone_client(old);
 523         if (IS_ERR(clnt))
 524                 goto out;
 525         clnt->cl_procinfo = version->procs;
 526         clnt->cl_maxproc  = version->nrprocs;
 527         clnt->cl_protname = program->name;
 528         clnt->cl_prog     = program->number;
 529         clnt->cl_vers     = version->number;
 530         clnt->cl_stats    = program->stats;
 531         err = rpc_ping(clnt);
 532         if (err != 0) {
 533                 rpc_shutdown_client(clnt);
 534                 clnt = ERR_PTR(err);
 535         }
 536 out:
 537         return clnt;
 538 }
 539 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
 540
 541 /*
 542  * Default callback for async RPC calls
 543  */
 544 static void
 545 rpc_default_callback(struct rpc_task *task, void *data)
 546 {
 547 }
 548
 549 static const struct rpc_call_ops rpc_default_ops = {
 550         .rpc_call_done = rpc_default_callback,
 551 };
 552
 553 /**
 554  * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
 555  * @task_setup_data: pointer to task initialisation data
 556  */
 557 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
 558 {
 559         struct rpc_task *task;
 560
 561         task = rpc_new_task(task_setup_data);
 562         if (IS_ERR(task))
 563                 goto out;
 564
 565         atomic_inc(&task->tk_count);
 566         rpc_execute(task);
 567 out:
 568         return task;
 569 }
 570 EXPORT_SYMBOL_GPL(rpc_run_task);
 571
 572 /**
 573  * rpc_call_sync - Perform a synchronous RPC call
 574  * @clnt: pointer to RPC client
 575  * @msg: RPC call parameters
 576  * @flags: RPC call flags
 577  */
 578 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
 579 {
 580         struct rpc_task *task;
 581         struct rpc_task_setup task_setup_data = {
 582                 .rpc_client = clnt,
 583                 .rpc_message = msg,
 584                 .callback_ops = &rpc_default_ops,
 585                 .flags = flags,
 586         };
 587         int status;
 588
 589         BUG_ON(flags & RPC_TASK_ASYNC);
 590
 591         task = rpc_run_task(&task_setup_data);
 592         if (IS_ERR(task))
 593                 return PTR_ERR(task);
 594         status = task->tk_status;
 595         rpc_put_task(task);
 596         return status;
 597 }
 598 EXPORT_SYMBOL_GPL(rpc_call_sync);
 599
 600 /**
 601  * rpc_call_async - Perform an asynchronous RPC call
 602  * @clnt: pointer to RPC client
 603  * @msg: RPC call parameters
 604  * @flags: RPC call flags
 605  * @tk_ops: RPC call ops
 606  * @data: user call data
 607  */
 608 int
 609 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
 610                const struct rpc_call_ops *tk_ops, void *data)
 611 {
 612         struct rpc_task *task;
 613         struct rpc_task_setup task_setup_data = {
 614                 .rpc_client = clnt,
 615                 .rpc_message = msg,
 616                 .callback_ops = tk_ops,
 617                 .callback_data = data,
 618                 .flags = flags|RPC_TASK_ASYNC,
 619         };
 620
 621         task = rpc_run_task(&task_setup_data);
 622         if (IS_ERR(task))
 623                 return PTR_ERR(task);
 624         rpc_put_task(task);
 625         return 0;
 626 }
 627 EXPORT_SYMBOL_GPL(rpc_call_async);
 628
 629 #if defined(CONFIG_NFS_V4_1)
 630 /**
 631  * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
 632  * rpc_execute against it
 633  * @req: RPC request
 634  * @tk_ops: RPC call ops
 635  */
 636 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
 637                                 const struct rpc_call_ops *tk_ops)
 638 {
 639         struct rpc_task *task;
 640         struct xdr_buf *xbufp = &req->rq_snd_buf;
 641         struct rpc_task_setup task_setup_data = {
 642                 .callback_ops = tk_ops,
 643         };
 644
 645         dprintk("RPC: rpc_run_bc_task req= %p\n", req);
 646         /*
 647          * Create an rpc_task to send the data
 648          */
 649         task = rpc_new_task(&task_setup_data);
 650         if (IS_ERR(task)) {
 651                 xprt_free_bc_request(req);
 652                 goto out;
 653         }
 654         task->tk_rqstp = req;
 655
 656         /*
 657          * Set up the xdr_buf length.
 658          * This also indicates that the buffer is XDR encoded already.
 659          */
 660         xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
 661                         xbufp->tail[0].iov_len;
 662
 663         task->tk_action = call_bc_transmit;
 664         atomic_inc(&task->tk_count);
 665         BUG_ON(atomic_read(&task->tk_count) != 2);
 666         rpc_execute(task);
 667
 668 out:
 669         dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
 670         return task;
 671 }
 672 #endif /* CONFIG_NFS_V4_1 */
 673
 674 void
 675 rpc_call_start(struct rpc_task *task)
 676 {
 677         task->tk_action = call_start;
 678 }
 679 EXPORT_SYMBOL_GPL(rpc_call_start);
 680
 681 /**
 682  * rpc_peeraddr - extract remote peer address from clnt's xprt
 683  * @clnt: RPC client structure
 684  * @buf: target buffer
 685  * @bufsize: length of target buffer
 686  *
 687  * Returns the number of bytes that are actually in the stored address.
 688  */
 689 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
 690 {
 691         size_t bytes;
 692         struct rpc_xprt *xprt = clnt->cl_xprt;
 693
 694         bytes = sizeof(xprt->addr);
 695         if (bytes > bufsize)
 696                 bytes = bufsize;
 697         memcpy(buf, &clnt->cl_xprt->addr, bytes);
 698         return xprt->addrlen;
 699 }
 700 EXPORT_SYMBOL_GPL(rpc_peeraddr);
 701
 702 /**
 703  * rpc_peeraddr2str - return remote peer address in printable format
 704  * @clnt: RPC client structure
 705  * @format: address format
 706  *
 707  */
 708 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
 709                              enum rpc_display_format_t format)
 710 {
 711         struct rpc_xprt *xprt = clnt->cl_xprt;
 712
 713         if (xprt->address_strings[format] != NULL)
 714                 return xprt->address_strings[format];
 715         else
 716                 return "unprintable";
 717 }
 718 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
 719
 720 void
 721 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
 722 {
 723         struct rpc_xprt *xprt = clnt->cl_xprt;
 724         if (xprt->ops->set_buffer_size)
 725                 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
 726 }
 727 EXPORT_SYMBOL_GPL(rpc_setbufsize);
 728
 729 /*
 730  * Return size of largest payload RPC client can support, in bytes
 731  *
 732  * For stream transports, this is one RPC record fragment (see RFC
 733  * 1831), as we don't support multi-record requests yet.  For datagram
 734  * transports, this is the size of an IP packet minus the IP, UDP, and
 735  * RPC header sizes.
 736  */
 737 size_t rpc_max_payload(struct rpc_clnt *clnt)
 738 {
 739         return clnt->cl_xprt->max_payload;
 740 }
 741 EXPORT_SYMBOL_GPL(rpc_max_payload);
 742
 743 /**
 744  * rpc_force_rebind - force transport to check that remote port is unchanged
 745  * @clnt: client to rebind
 746  *
 747  */
 748 void rpc_force_rebind(struct rpc_clnt *clnt)
 749 {
 750         if (clnt->cl_autobind)
 751                 xprt_clear_bound(clnt->cl_xprt);
 752 }
 753 EXPORT_SYMBOL_GPL(rpc_force_rebind);
 754
 755 /*
 756  * Restart an (async) RPC call from the call_prepare state.
 757  * Usually called from within the exit handler.
 758  */
 759 int
 760 rpc_restart_call_prepare(struct rpc_task *task)
 761 {
 762         if (RPC_ASSASSINATED(task))
 763                 return 0;
 764         task->tk_action = rpc_prepare_task;
 765         return 1;
 766 }
 767 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
 768
 769 /*
 770  * Restart an (async) RPC call. Usually called from within the
 771  * exit handler.
 772  */
 773 int
 774 rpc_restart_call(struct rpc_task *task)
 775 {
 776         if (RPC_ASSASSINATED(task))
 777                 return 0;
 778         task->tk_action = call_start;
 779         return 1;
 780 }
 781 EXPORT_SYMBOL_GPL(rpc_restart_call);
 782
 783 #ifdef RPC_DEBUG
 784 static const char *rpc_proc_name(const struct rpc_task *task)
 785 {
 786         const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
 787
 788         if (proc) {
 789                 if (proc->p_name)
 790                         return proc->p_name;
 791                 else
 792                         return "NULL";
 793         } else
 794                 return "no proc";
 795 }
 796 #endif
 797
 798 /*
 799  * 0.  Initial state
 800  *
 801  *     Other FSM states can be visited zero or more times, but
 802  *     this state is visited exactly once for each RPC.
 803  */
 804 static void
 805 call_start(struct rpc_task *task)
 806 {
 807         struct rpc_clnt *clnt = task->tk_client;
 808
 809         dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
 810                         clnt->cl_protname, clnt->cl_vers,
 811                         rpc_proc_name(task),
 812                         (RPC_IS_ASYNC(task) ? "async" : "sync"));
 813
 814         /* Increment call count */
 815         task->tk_msg.rpc_proc->p_count++;
 816         clnt->cl_stats->rpccnt++;
 817         task->tk_action = call_reserve;
 818 }
 819
 820 /*
 821  * 1.   Reserve an RPC call slot
 822  */
 823 static void
 824 call_reserve(struct rpc_task *task)
 825 {
 826         dprint_status(task);
 827
 828         if (!rpcauth_uptodatecred(task)) {
 829                 task->tk_action = call_refresh;
 830                 return;
 831         }
 832
 833         task->tk_status  = 0;
 834         task->tk_action  = call_reserveresult;
 835         xprt_reserve(task);
 836 }
 837
 838 /*
 839  * 1b.  Grok the result of xprt_reserve()
 840  */
 841 static void
 842 call_reserveresult(struct rpc_task *task)
 843 {
 844         int status = task->tk_status;
 845
 846         dprint_status(task);
 847
 848         /*
 849          * After a call to xprt_reserve(), we must have either
 850          * a request slot or else an error status.
 851          */
 852         task->tk_status = 0;
 853         if (status >= 0) {
 854                 if (task->tk_rqstp) {
 855                         task->tk_action = call_allocate;
 856                         return;
 857                 }
 858
 859                 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
 860                                 __func__, status);
 861                 rpc_exit(task, -EIO);
 862                 return;
 863         }
 864
 865         /*
 866          * Even though there was an error, we may have acquired
 867          * a request slot somehow.  Make sure not to leak it.
 868          */
 869         if (task->tk_rqstp) {
 870                 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
 871                                 __func__, status);
 872                 xprt_release(task);
 873         }
 874
 875         switch (status) {
 876         case -EAGAIN:   /* woken up; retry */
 877                 task->tk_action = call_reserve;
 878                 return;
 879         case -EIO:      /* probably a shutdown */
 880                 break;
 881         default:
 882                 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
 883                                 __func__, status);
 884                 break;
 885         }
 886         rpc_exit(task, status);
 887 }
 888
 889 /*
 890  * 2.   Allocate the buffer. For details, see sched.c:rpc_malloc.
 891  *      (Note: buffer memory is freed in xprt_release).
 892  */
 893 static void
 894 call_allocate(struct rpc_task *task)
 895 {
 896         unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
 897         struct rpc_rqst *req = task->tk_rqstp;
 898         struct rpc_xprt *xprt = task->tk_xprt;
 899         struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
 900
 901         dprint_status(task);
 902
 903         task->tk_status = 0;
 904         task->tk_action = call_bind;
 905
 906         if (req->rq_buffer)
 907                 return;
 908
 909         if (proc->p_proc != 0) {
 910                 BUG_ON(proc->p_arglen == 0);
 911                 if (proc->p_decode != NULL)
 912                         BUG_ON(proc->p_replen == 0);
 913         }
 914
 915         /*
 916          * Calculate the size (in quads) of the RPC call
 917          * and reply headers, and convert both values
 918          * to byte sizes.
 919          */
 920         req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
 921         req->rq_callsize <<= 2;
 922         req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
 923         req->rq_rcvsize <<= 2;
 924
 925         req->rq_buffer = xprt->ops->buf_alloc(task,
 926                                         req->rq_callsize + req->rq_rcvsize);
 927         if (req->rq_buffer != NULL)
 928                 return;
 929
 930         dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
 931
 932         if (RPC_IS_ASYNC(task) || !signalled()) {
 933                 task->tk_action = call_allocate;
 934                 rpc_delay(task, HZ>>4);
 935                 return;
 936         }
 937
 938         rpc_exit(task, -ERESTARTSYS);
 939 }
 940
 941 static inline int
 942 rpc_task_need_encode(struct rpc_task *task)
 943 {
 944         return task->tk_rqstp->rq_snd_buf.len == 0;
 945 }
 946
 947 static inline void
 948 rpc_task_force_reencode(struct rpc_task *task)
 949 {
 950         task->tk_rqstp->rq_snd_buf.len = 0;
 951         task->tk_rqstp->rq_bytes_sent = 0;
 952 }
 953
 954 static inline void
 955 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
 956 {
 957         buf->head[0].iov_base = start;
 958         buf->head[0].iov_len = len;
 959         buf->tail[0].iov_len = 0;
 960         buf->page_len = 0;
 961         buf->flags = 0;
 962         buf->len = 0;
 963         buf->buflen = len;
 964 }
 965
 966 /*
 967  * 3.   Encode arguments of an RPC call
 968  */
 969 static void
 970 rpc_xdr_encode(struct rpc_task *task)
 971 {
 972         struct rpc_rqst *req = task->tk_rqstp;
 973         kxdrproc_t      encode;
 974         __be32          *p;
 975
 976         dprint_status(task);
 977
 978         rpc_xdr_buf_init(&req->rq_snd_buf,
 979                          req->rq_buffer,
 980                          req->rq_callsize);
 981         rpc_xdr_buf_init(&req->rq_rcv_buf,
 982                          (char *)req->rq_buffer + req->rq_callsize,
 983                          req->rq_rcvsize);
 984
 985         p = rpc_encode_header(task);
 986         if (p == NULL) {
 987                 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
 988                 rpc_exit(task, -EIO);
 989                 return;
 990         }
 991
 992         encode = task->tk_msg.rpc_proc->p_encode;
 993         if (encode == NULL)
 994                 return;
 995
 996         task->tk_status = rpcauth_wrap_req(task, encode, req, p,
 997                         task->tk_msg.rpc_argp);
 998 }
 999
1000 /*
1001  * 4.   Get the server port number if not yet set
1002  */
1003 static void
1004 call_bind(struct rpc_task *task)
1005 {
1006         struct rpc_xprt *xprt = task->tk_xprt;
1007
1008         dprint_status(task);
1009
1010         task->tk_action = call_connect;
1011         if (!xprt_bound(xprt)) {
1012                 task->tk_action = call_bind_status;
1013                 task->tk_timeout = xprt->bind_timeout;
1014                 xprt->ops->rpcbind(task);
1015         }
1016 }
1017
1018 /*
1019  * 4a.  Sort out bind result
1020  */
1021 static void
1022 call_bind_status(struct rpc_task *task)
1023 {
1024         int status = -EIO;
1025
1026         if (task->tk_status >= 0) {
1027                 dprint_status(task);
1028                 task->tk_status = 0;
1029                 task->tk_action = call_connect;
1030                 return;
1031         }
1032
1033         switch (task->tk_status) {
1034         case -ENOMEM:
1035                 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1036                 rpc_delay(task, HZ >> 2);
1037                 goto retry_timeout;
1038         case -EACCES:
1039                 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1040                                 "unavailable\n", task->tk_pid);
1041                 /* fail immediately if this is an RPC ping */
1042                 if (task->tk_msg.rpc_proc->p_proc == 0) {
1043                         status = -EOPNOTSUPP;
1044                         break;
1045                 }
1046                 rpc_delay(task, 3*HZ);
1047                 goto retry_timeout;
1048         case -ETIMEDOUT:
1049                 dprintk("RPC: %5u rpcbind request timed out\n",
1050                                 task->tk_pid);
1051                 goto retry_timeout;
1052         case -EPFNOSUPPORT:
1053                 /* server doesn't support any rpcbind version we know of */
1054                 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1055                                 task->tk_pid);
1056                 break;
1057         case -EPROTONOSUPPORT:
1058                 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1059                                 task->tk_pid);
1060                 task->tk_status = 0;
1061                 task->tk_action = call_bind;
1062                 return;
1063         case -ECONNREFUSED:             /* connection problems */
1064         case -ECONNRESET:
1065         case -ENOTCONN:
1066         case -EHOSTDOWN:
1067         case -EHOSTUNREACH:
1068         case -ENETUNREACH:
1069         case -EPIPE:
1070                 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1071                                 task->tk_pid, task->tk_status);
1072                 if (!RPC_IS_SOFTCONN(task)) {
1073                         rpc_delay(task, 5*HZ);
1074                         goto retry_timeout;
1075                 }
1076                 status = task->tk_status;
1077                 break;
1078         default:
1079                 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1080                                 task->tk_pid, -task->tk_status);
1081         }
1082
1083         rpc_exit(task, status);
1084         return;
1085
1086 retry_timeout:
1087         task->tk_action = call_timeout;
1088 }
1089
1090 /*
1091  * 4b.  Connect to the RPC server
1092  */
1093 static void
1094 call_connect(struct rpc_task *task)
1095 {
1096         struct rpc_xprt *xprt = task->tk_xprt;
1097
1098         dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1099                         task->tk_pid, xprt,
1100                         (xprt_connected(xprt) ? "is" : "is not"));
1101
1102         task->tk_action = call_transmit;
1103         if (!xprt_connected(xprt)) {
1104                 task->tk_action = call_connect_status;
1105                 if (task->tk_status < 0)
1106                         return;
1107                 xprt_connect(task);
1108         }
1109 }
1110
1111 /*
1112  * 4c.  Sort out connect result
1113  */
1114 static void
1115 call_connect_status(struct rpc_task *task)
1116 {
1117         struct rpc_clnt *clnt = task->tk_client;
1118         int status = task->tk_status;
1119
1120         dprint_status(task);
1121
1122         task->tk_status = 0;
1123         if (status >= 0 || status == -EAGAIN) {
1124                 clnt->cl_stats->netreconn++;
1125                 task->tk_action = call_transmit;
1126                 return;
1127         }
1128
1129         switch (status) {
1130                 /* if soft mounted, test if we've timed out */
1131         case -ETIMEDOUT:
1132                 task->tk_action = call_timeout;
1133                 break;
1134         default:
1135                 rpc_exit(task, -EIO);
1136         }
1137 }
1138
1139 /*
1140  * 5.   Transmit the RPC request, and wait for reply
1141  */
1142 static void
1143 call_transmit(struct rpc_task *task)
1144 {
1145         dprint_status(task);
1146
1147         task->tk_action = call_status;
1148         if (task->tk_status < 0)
1149                 return;
1150         task->tk_status = xprt_prepare_transmit(task);
1151         if (task->tk_status != 0)
1152                 return;
1153         task->tk_action = call_transmit_status;
1154         /* Encode here so that rpcsec_gss can use correct sequence number. */
1155         if (rpc_task_need_encode(task)) {
1156                 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1157                 rpc_xdr_encode(task);
1158                 /* Did the encode result in an error condition? */
1159                 if (task->tk_status != 0) {
1160                         /* Was the error nonfatal? */
1161                         if (task->tk_status == -EAGAIN)
1162                                 rpc_delay(task, HZ >> 4);
1163                         else
1164                                 rpc_exit(task, task->tk_status);
1165                         return;
1166                 }
1167         }
1168         xprt_transmit(task);
1169         if (task->tk_status < 0)
1170                 return;
1171         /*
1172          * On success, ensure that we call xprt_end_transmit() before sleeping
1173          * in order to allow access to the socket to other RPC requests.
1174          */
1175         call_transmit_status(task);
1176         if (rpc_reply_expected(task))
1177                 return;
1178         task->tk_action = rpc_exit_task;
1179         rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1180 }
1181
1182 /*
1183  * 5a.  Handle cleanup after a transmission
1184  */
1185 static void
1186 call_transmit_status(struct rpc_task *task)
1187 {
1188         task->tk_action = call_status;
1189
1190         /*
1191          * Common case: success.  Force the compiler to put this
1192          * test first.
1193          */
1194         if (task->tk_status == 0) {
1195                 xprt_end_transmit(task);
1196                 rpc_task_force_reencode(task);
1197                 return;
1198         }
1199
1200         switch (task->tk_status) {
1201         case -EAGAIN:
1202                 break;
1203         default:
1204                 dprint_status(task);
1205                 xprt_end_transmit(task);
1206                 rpc_task_force_reencode(task);
1207                 break;
1208                 /*
1209                  * Special cases: if we've been waiting on the
1210                  * socket's write_space() callback, or if the
1211                  * socket just returned a connection error,
1212                  * then hold onto the transport lock.
1213                  */
1214         case -ECONNREFUSED:
1215         case -EHOSTDOWN:
1216         case -EHOSTUNREACH:
1217         case -ENETUNREACH:
1218                 if (RPC_IS_SOFTCONN(task)) {
1219                         xprt_end_transmit(task);
1220                         rpc_exit(task, task->tk_status);
1221                         break;
1222                 }
1223         case -ECONNRESET:
1224         case -ENOTCONN:
1225         case -EPIPE:
1226                 rpc_task_force_reencode(task);
1227         }
1228 }
1229
1230 #if defined(CONFIG_NFS_V4_1)
1231 /*
1232  * 5b.  Send the backchannel RPC reply.  On error, drop the reply.  In
1233  * addition, disconnect on connectivity errors.
1234  */
1235 static void
1236 call_bc_transmit(struct rpc_task *task)
1237 {
1238         struct rpc_rqst *req = task->tk_rqstp;
1239
1240         BUG_ON(task->tk_status != 0);
1241         task->tk_status = xprt_prepare_transmit(task);
1242         if (task->tk_status == -EAGAIN) {
1243                 /*
1244                  * Could not reserve the transport. Try again after the
1245                  * transport is released.
1246                  */
1247                 task->tk_status = 0;
1248                 task->tk_action = call_bc_transmit;
1249                 return;
1250         }
1251
1252         task->tk_action = rpc_exit_task;
1253         if (task->tk_status < 0) {
1254                 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1255                         "error: %d\n", task->tk_status);
1256                 return;
1257         }
1258
1259         xprt_transmit(task);
1260         xprt_end_transmit(task);
1261         dprint_status(task);
1262         switch (task->tk_status) {
1263         case 0:
1264                 /* Success */
1265                 break;
1266         case -EHOSTDOWN:
1267         case -EHOSTUNREACH:
1268         case -ENETUNREACH:
1269         case -ETIMEDOUT:
1270                 /*
1271                  * Problem reaching the server.  Disconnect and let the
1272                  * forechannel reestablish the connection.  The server will
1273                  * have to retransmit the backchannel request and we'll
1274                  * reprocess it.  Since these ops are idempotent, there's no
1275                  * need to cache our reply at this time.
1276                  */
1277                 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1278                         "error: %d\n", task->tk_status);
1279                 xprt_conditional_disconnect(task->tk_xprt,
1280                         req->rq_connect_cookie);
1281                 break;
1282         default:
1283                 /*
1284                  * We were unable to reply and will have to drop the
1285                  * request.  The server should reconnect and retransmit.
1286                  */
1287                 BUG_ON(task->tk_status == -EAGAIN);
1288                 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1289                         "error: %d\n", task->tk_status);
1290                 break;
1291         }
1292         rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1293 }
1294 #endif /* CONFIG_NFS_V4_1 */
1295
1296 /*
1297  * 6.   Sort out the RPC call status
1298  */
1299 static void
1300 call_status(struct rpc_task *task)
1301 {
1302         struct rpc_clnt *clnt = task->tk_client;
1303         struct rpc_rqst *req = task->tk_rqstp;
1304         int             status;
1305
1306         if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1307                 task->tk_status = req->rq_reply_bytes_recvd;
1308
1309         dprint_status(task);
1310
1311         status = task->tk_status;
1312         if (status >= 0) {
1313                 task->tk_action = call_decode;
1314                 return;
1315         }
1316
1317         task->tk_status = 0;
1318         switch(status) {
1319         case -EHOSTDOWN:
1320         case -EHOSTUNREACH:
1321         case -ENETUNREACH:
1322                 /*
1323                  * Delay any retries for 3 seconds, then handle as if it
1324                  * were a timeout.
1325                  */
1326                 rpc_delay(task, 3*HZ);
1327         case -ETIMEDOUT:
1328                 task->tk_action = call_timeout;
1329                 if (task->tk_client->cl_discrtry)
1330                         xprt_conditional_disconnect(task->tk_xprt,
1331                                         req->rq_connect_cookie);
1332                 break;
1333         case -ECONNRESET:
1334         case -ECONNREFUSED:
1335                 rpc_force_rebind(clnt);
1336                 rpc_delay(task, 3*HZ);
1337         case -EPIPE:
1338         case -ENOTCONN:
1339                 task->tk_action = call_bind;
1340                 break;
1341         case -EAGAIN:
1342                 task->tk_action = call_transmit;
1343                 break;
1344         case -EIO:
1345                 /* shutdown or soft timeout */
1346                 rpc_exit(task, status);
1347                 break;
1348         default:
1349                 if (clnt->cl_chatty)
1350                         printk("%s: RPC call returned error %d\n",
1351                                clnt->cl_protname, -status);
1352                 rpc_exit(task, status);
1353         }
1354 }
1355
1356 /*
1357  * 6a.  Handle RPC timeout
1358  *      We do not release the request slot, so we keep using the
1359  *      same XID for all retransmits.
1360  */
1361 static void
1362 call_timeout(struct rpc_task *task)
1363 {
1364         struct rpc_clnt *clnt = task->tk_client;
1365
1366         if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1367                 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1368                 goto retry;
1369         }
1370
1371         dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1372         task->tk_timeouts++;
1373
1374         if (RPC_IS_SOFTCONN(task)) {
1375                 rpc_exit(task, -ETIMEDOUT);
1376                 return;
1377         }
1378         if (RPC_IS_SOFT(task)) {
1379                 if (clnt->cl_chatty)
1380                         printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1381                                 clnt->cl_protname, clnt->cl_server);
1382                 rpc_exit(task, -EIO);
1383                 return;
1384         }
1385
1386         if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1387                 task->tk_flags |= RPC_CALL_MAJORSEEN;
1388                 if (clnt->cl_chatty)
1389                         printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1390                         clnt->cl_protname, clnt->cl_server);
1391         }
1392         rpc_force_rebind(clnt);
1393         /*
1394          * Did our request time out due to an RPCSEC_GSS out-of-sequence
1395          * event? RFC2203 requires the server to drop all such requests.
1396          */
1397         rpcauth_invalcred(task);
1398
1399 retry:
1400         clnt->cl_stats->rpcretrans++;
1401         task->tk_action = call_bind;
1402         task->tk_status = 0;
1403 }
1404
1405 /*
1406  * 7.   Decode the RPC reply
1407  */
1408 static void
1409 call_decode(struct rpc_task *task)
1410 {
1411         struct rpc_clnt *clnt = task->tk_client;
1412         struct rpc_rqst *req = task->tk_rqstp;
1413         kxdrproc_t      decode = task->tk_msg.rpc_proc->p_decode;
1414         __be32          *p;
1415
1416         dprintk("RPC: %5u call_decode (status %d)\n",
1417                         task->tk_pid, task->tk_status);
1418
1419         if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1420                 if (clnt->cl_chatty)
1421                         printk(KERN_NOTICE "%s: server %s OK\n",
1422                                 clnt->cl_protname, clnt->cl_server);
1423                 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1424         }
1425
1426         /*
1427          * Ensure that we see all writes made by xprt_complete_rqst()
1428          * before it changed req->rq_reply_bytes_recvd.
1429          */
1430         smp_rmb();
1431         req->rq_rcv_buf.len = req->rq_private_buf.len;
1432
1433         /* Check that the softirq receive buffer is valid */
1434         WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1435                                 sizeof(req->rq_rcv_buf)) != 0);
1436
1437         if (req->rq_rcv_buf.len < 12) {
1438                 if (!RPC_IS_SOFT(task)) {
1439                         task->tk_action = call_bind;
1440                         clnt->cl_stats->rpcretrans++;
1441                         goto out_retry;
1442                 }
1443                 dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
1444                                 clnt->cl_protname, task->tk_status);
1445                 task->tk_action = call_timeout;
1446                 goto out_retry;
1447         }
1448
1449         p = rpc_verify_header(task);
1450         if (IS_ERR(p)) {
1451                 if (p == ERR_PTR(-EAGAIN))
1452                         goto out_retry;
1453                 return;
1454         }
1455
1456         task->tk_action = rpc_exit_task;
1457
1458         if (decode) {
1459                 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1460                                                       task->tk_msg.rpc_resp);
1461         }
1462         dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1463                         task->tk_status);
1464         return;
1465 out_retry:
1466         task->tk_status = 0;
1467         /* Note: rpc_verify_header() may have freed the RPC slot */
1468         if (task->tk_rqstp == req) {
1469                 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1470                 if (task->tk_client->cl_discrtry)
1471                         xprt_conditional_disconnect(task->tk_xprt,
1472                                         req->rq_connect_cookie);
1473         }
1474 }
1475
1476 /*
1477  * 8.   Refresh the credentials if rejected by the server
1478  */
1479 static void
1480 call_refresh(struct rpc_task *task)
1481 {
1482         dprint_status(task);
1483
1484         task->tk_action = call_refreshresult;
1485         task->tk_status = 0;
1486         task->tk_client->cl_stats->rpcauthrefresh++;
1487         rpcauth_refreshcred(task);
1488 }
1489
1490 /*
1491  * 8a.  Process the results of a credential refresh
1492  */
1493 static void
1494 call_refreshresult(struct rpc_task *task)
1495 {
1496         int status = task->tk_status;
1497
1498         dprint_status(task);
1499
1500         task->tk_status = 0;
1501         task->tk_action = call_reserve;
1502         if (status >= 0 && rpcauth_uptodatecred(task))
1503                 return;
1504         if (status == -EACCES) {
1505                 rpc_exit(task, -EACCES);
1506                 return;
1507         }
1508         task->tk_action = call_refresh;
1509         if (status != -ETIMEDOUT)
1510                 rpc_delay(task, 3*HZ);
1511 }
1512
1513 static __be32 *
1514 rpc_encode_header(struct rpc_task *task)
1515 {
1516         struct rpc_clnt *clnt = task->tk_client;
1517         struct rpc_rqst *req = task->tk_rqstp;
1518         __be32          *p = req->rq_svec[0].iov_base;
1519
1520         /* FIXME: check buffer size? */
1521
1522         p = xprt_skip_transport_header(task->tk_xprt, p);
1523         *p++ = req->rq_xid;             /* XID */
1524         *p++ = htonl(RPC_CALL);         /* CALL */
1525         *p++ = htonl(RPC_VERSION);      /* RPC version */
1526         *p++ = htonl(clnt->cl_prog);    /* program number */
1527         *p++ = htonl(clnt->cl_vers);    /* program version */
1528         *p++ = htonl(task->tk_msg.rpc_proc->p_proc);    /* procedure */
1529         p = rpcauth_marshcred(task, p);
1530         req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1531         return p;
1532 }
1533
1534 static __be32 *
1535 rpc_verify_header(struct rpc_task *task)
1536 {
1537         struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1538         int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1539         __be32  *p = iov->iov_base;
1540         u32 n;
1541         int error = -EACCES;
1542
1543         if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1544                 /* RFC-1014 says that the representation of XDR data must be a
1545                  * multiple of four bytes
1546                  * - if it isn't pointer subtraction in the NFS client may give
1547                  *   undefined results
1548                  */
1549                 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1550                        " 4 bytes: 0x%x\n", task->tk_pid, __func__,
1551                        task->tk_rqstp->rq_rcv_buf.len);
1552                 goto out_eio;
1553         }
1554         if ((len -= 3) < 0)
1555                 goto out_overflow;
1556
1557         p += 1; /* skip XID */
1558         if ((n = ntohl(*p++)) != RPC_REPLY) {
1559                 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1560                         task->tk_pid, __func__, n);
1561                 goto out_garbage;
1562         }
1563
1564         if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1565                 if (--len < 0)
1566                         goto out_overflow;
1567                 switch ((n = ntohl(*p++))) {
1568                         case RPC_AUTH_ERROR:
1569                                 break;
1570                         case RPC_MISMATCH:
1571                                 dprintk("RPC: %5u %s: RPC call version "
1572                                                 "mismatch!\n",
1573                                                 task->tk_pid, __func__);
1574                                 error = -EPROTONOSUPPORT;
1575                                 goto out_err;
1576                         default:
1577                                 dprintk("RPC: %5u %s: RPC call rejected, "
1578                                                 "unknown error: %x\n",
1579                                                 task->tk_pid, __func__, n);
1580                                 goto out_eio;
1581                 }
1582                 if (--len < 0)
1583                         goto out_overflow;
1584                 switch ((n = ntohl(*p++))) {
1585                 case RPC_AUTH_REJECTEDCRED:
1586                 case RPC_AUTH_REJECTEDVERF:
1587                 case RPCSEC_GSS_CREDPROBLEM:
1588                 case RPCSEC_GSS_CTXPROBLEM:
1589                         if (!task->tk_cred_retry)
1590                                 break;
1591                         task->tk_cred_retry--;
1592                         dprintk("RPC: %5u %s: retry stale creds\n",
1593                                         task->tk_pid, __func__);
1594                         rpcauth_invalcred(task);
1595                         /* Ensure we obtain a new XID! */
1596                         xprt_release(task);
1597                         task->tk_action = call_refresh;
1598                         goto out_retry;
1599                 case RPC_AUTH_BADCRED:
1600                 case RPC_AUTH_BADVERF:
1601                         /* possibly garbled cred/verf? */
1602                         if (!task->tk_garb_retry)
1603                                 break;
1604                         task->tk_garb_retry--;
1605                         dprintk("RPC: %5u %s: retry garbled creds\n",
1606                                         task->tk_pid, __func__);
1607                         task->tk_action = call_bind;
1608                         goto out_retry;
1609                 case RPC_AUTH_TOOWEAK:
1610                         printk(KERN_NOTICE "RPC: server %s requires stronger "
1611                                "authentication.\n", task->tk_client->cl_server);
1612                         break;
1613                 default:
1614                         dprintk("RPC: %5u %s: unknown auth error: %x\n",
1615                                         task->tk_pid, __func__, n);
1616                         error = -EIO;
1617                 }
1618                 dprintk("RPC: %5u %s: call rejected %d\n",
1619                                 task->tk_pid, __func__, n);
1620                 goto out_err;
1621         }
1622         if (!(p = rpcauth_checkverf(task, p))) {
1623                 dprintk("RPC: %5u %s: auth check failed\n",
1624                                 task->tk_pid, __func__);
1625                 goto out_garbage;               /* bad verifier, retry */
1626         }
1627         len = p - (__be32 *)iov->iov_base - 1;
1628         if (len < 0)
1629                 goto out_overflow;
1630         switch ((n = ntohl(*p++))) {
1631         case RPC_SUCCESS:
1632                 return p;
1633         case RPC_PROG_UNAVAIL:
1634                 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1635                                 task->tk_pid, __func__,
1636                                 (unsigned int)task->tk_client->cl_prog,
1637                                 task->tk_client->cl_server);
1638                 error = -EPFNOSUPPORT;
1639                 goto out_err;
1640         case RPC_PROG_MISMATCH:
1641                 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1642                                 "server %s\n", task->tk_pid, __func__,
1643                                 (unsigned int)task->tk_client->cl_prog,
1644                                 (unsigned int)task->tk_client->cl_vers,
1645                                 task->tk_client->cl_server);
1646                 error = -EPROTONOSUPPORT;
1647                 goto out_err;
1648         case RPC_PROC_UNAVAIL:
1649                 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1650                                 "version %u on server %s\n",
1651                                 task->tk_pid, __func__,
1652                                 rpc_proc_name(task),
1653                                 task->tk_client->cl_prog,
1654                                 task->tk_client->cl_vers,
1655                                 task->tk_client->cl_server);
1656                 error = -EOPNOTSUPP;
1657                 goto out_err;
1658         case RPC_GARBAGE_ARGS:
1659                 dprintk("RPC: %5u %s: server saw garbage\n",
1660                                 task->tk_pid, __func__);
1661                 break;                  /* retry */
1662         default:
1663                 dprintk("RPC: %5u %s: server accept status: %x\n",
1664                                 task->tk_pid, __func__, n);
1665                 /* Also retry */
1666         }
1667
1668 out_garbage:
1669         task->tk_client->cl_stats->rpcgarbage++;
1670         if (task->tk_garb_retry) {
1671                 task->tk_garb_retry--;
1672                 dprintk("RPC: %5u %s: retrying\n",
1673                                 task->tk_pid, __func__);
1674                 task->tk_action = call_bind;
1675 out_retry:
1676                 return ERR_PTR(-EAGAIN);
1677         }
1678 out_eio:
1679         error = -EIO;
1680 out_err:
1681         rpc_exit(task, error);
1682         dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1683                         __func__, error);
1684         return ERR_PTR(error);
1685 out_overflow:
1686         dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1687                         __func__);
1688         goto out_garbage;
1689 }
1690
1691 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1692 {
1693         return 0;
1694 }
1695
1696 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1697 {
1698         return 0;
1699 }
1700
1701 static struct rpc_procinfo rpcproc_null = {
1702         .p_encode = rpcproc_encode_null,
1703         .p_decode = rpcproc_decode_null,
1704 };
1705
1706 static int rpc_ping(struct rpc_clnt *clnt)
1707 {
1708         struct rpc_message msg = {
1709                 .rpc_proc = &rpcproc_null,
1710         };
1711         int err;
1712         msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1713         err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
1714         put_rpccred(msg.rpc_cred);
1715         return err;
1716 }
1717
1718 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1719 {
1720         struct rpc_message msg = {
1721                 .rpc_proc = &rpcproc_null,
1722                 .rpc_cred = cred,
1723         };
1724         struct rpc_task_setup task_setup_data = {
1725                 .rpc_client = clnt,
1726                 .rpc_message = &msg,
1727                 .callback_ops = &rpc_default_ops,
1728                 .flags = flags,
1729         };
1730         return rpc_run_task(&task_setup_data);
1731 }
1732 EXPORT_SYMBOL_GPL(rpc_call_null);
1733
1734 #ifdef RPC_DEBUG
1735 static void rpc_show_header(void)
1736 {
1737         printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1738                 "-timeout ---ops--\n");
1739 }
1740
1741 static void rpc_show_task(const struct rpc_clnt *clnt,
1742                           const struct rpc_task *task)
1743 {
1744         const char *rpc_waitq = "none";
1745         char *p, action[KSYM_SYMBOL_LEN];
1746
1747         if (RPC_IS_QUEUED(task))
1748                 rpc_waitq = rpc_qname(task->tk_waitqueue);
1749
1750         /* map tk_action pointer to a function name; then trim off
1751          * the "+0x0 [sunrpc]" */
1752         sprint_symbol(action, (unsigned long)task->tk_action);
1753         p = strchr(action, '+');
1754         if (p)
1755                 *p = '\0';
1756
1757         printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1758                 task->tk_pid, task->tk_flags, task->tk_status,
1759                 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1760                 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1761                 action, rpc_waitq);
1762 }
1763
1764 void rpc_show_tasks(void)
1765 {
1766         struct rpc_clnt *clnt;
1767         struct rpc_task *task;
1768         int header = 0;
1769
1770         spin_lock(&rpc_client_lock);
1771         list_for_each_entry(clnt, &all_clients, cl_clients) {
1772                 spin_lock(&clnt->cl_lock);
1773                 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
1774                         if (!header) {
1775                                 rpc_show_header();
1776                                 header++;
1777                         }
1778                         rpc_show_task(clnt, task);
1779                 }
1780                 spin_unlock(&clnt->cl_lock);
1781         }
1782         spin_unlock(&rpc_client_lock);
1783 }
1784 #endif