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