net/sunrpc/xprt.c

   1 /*
   2  *  linux/net/sunrpc/xprt.c
   3  *
   4  *  This is a generic RPC call interface supporting congestion avoidance,
   5  *  and asynchronous calls.
   6  *
   7  *  The interface works like this:
   8  *
   9  *  -   When a process places a call, it allocates a request slot if
  10  *      one is available. Otherwise, it sleeps on the backlog queue
  11  *      (xprt_reserve).
  12  *  -   Next, the caller puts together the RPC message, stuffs it into
  13  *      the request struct, and calls xprt_transmit().
  14  *  -   xprt_transmit sends the message and installs the caller on the
  15  *      transport's wait list. At the same time, if a reply is expected,
  16  *      it installs a timer that is run after the packet's timeout has
  17  *      expired.
  18  *  -   When a packet arrives, the data_ready handler walks the list of
  19  *      pending requests for that transport. If a matching XID is found, the
  20  *      caller is woken up, and the timer removed.
  21  *  -   When no reply arrives within the timeout interval, the timer is
  22  *      fired by the kernel and runs xprt_timer(). It either adjusts the
  23  *      timeout values (minor timeout) or wakes up the caller with a status
  24  *      of -ETIMEDOUT.
  25  *  -   When the caller receives a notification from RPC that a reply arrived,
  26  *      it should release the RPC slot, and process the reply.
  27  *      If the call timed out, it may choose to retry the operation by
  28  *      adjusting the initial timeout value, and simply calling rpc_call
  29  *      again.
  30  *
  31  *  Support for async RPC is done through a set of RPC-specific scheduling
  32  *  primitives that `transparently' work for processes as well as async
  33  *  tasks that rely on callbacks.
  34  *
  35  *  Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
  36  *
  37  *  Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
  38  */
  39
  40 #include <linux/module.h>
  41
  42 #include <linux/types.h>
  43 #include <linux/interrupt.h>
  44 #include <linux/workqueue.h>
  45 #include <linux/net.h>
  46 #include <linux/ktime.h>
  47
  48 #include <linux/sunrpc/clnt.h>
  49 #include <linux/sunrpc/metrics.h>
  50 #include <linux/sunrpc/bc_xprt.h>
  51 #include <linux/rcupdate.h>
  52
  53 #include <trace/events/sunrpc.h>
  54
  55 #include "sunrpc.h"
  56
  57 /*
  58  * Local variables
  59  */
  60
  61 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
  62 # define RPCDBG_FACILITY        RPCDBG_XPRT
  63 #endif
  64
  65 /*
  66  * Local functions
  67  */
  68 static void      xprt_init(struct rpc_xprt *xprt, struct net *net);
  69 static void     xprt_request_init(struct rpc_task *, struct rpc_xprt *);
  70 static void     xprt_connect_status(struct rpc_task *task);
  71 static int      __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);
  72 static void     __xprt_put_cong(struct rpc_xprt *, struct rpc_rqst *);
  73 static void      xprt_destroy(struct rpc_xprt *xprt);
  74
  75 static DEFINE_SPINLOCK(xprt_list_lock);
  76 static LIST_HEAD(xprt_list);
  77
  78 /**
  79  * xprt_register_transport - register a transport implementation
  80  * @transport: transport to register
  81  *
  82  * If a transport implementation is loaded as a kernel module, it can
  83  * call this interface to make itself known to the RPC client.
  84  *
  85  * Returns:
  86  * 0:           transport successfully registered
  87  * -EEXIST:     transport already registered
  88  * -EINVAL:     transport module being unloaded
  89  */
  90 int xprt_register_transport(struct xprt_class *transport)
  91 {
  92         struct xprt_class *t;
  93         int result;
  94
  95         result = -EEXIST;
  96         spin_lock(&xprt_list_lock);
  97         list_for_each_entry(t, &xprt_list, list) {
  98                 /* don't register the same transport class twice */
  99                 if (t->ident == transport->ident)
 100                         goto out;
 101         }
 102
 103         list_add_tail(&transport->list, &xprt_list);
 104         printk(KERN_INFO "RPC: Registered %s transport module.\n",
 105                transport->name);
 106         result = 0;
 107
 108 out:
 109         spin_unlock(&xprt_list_lock);
 110         return result;
 111 }
 112 EXPORT_SYMBOL_GPL(xprt_register_transport);
 113
 114 /**
 115  * xprt_unregister_transport - unregister a transport implementation
 116  * @transport: transport to unregister
 117  *
 118  * Returns:
 119  * 0:           transport successfully unregistered
 120  * -ENOENT:     transport never registered
 121  */
 122 int xprt_unregister_transport(struct xprt_class *transport)
 123 {
 124         struct xprt_class *t;
 125         int result;
 126
 127         result = 0;
 128         spin_lock(&xprt_list_lock);
 129         list_for_each_entry(t, &xprt_list, list) {
 130                 if (t == transport) {
 131                         printk(KERN_INFO
 132                                 "RPC: Unregistered %s transport module.\n",
 133                                 transport->name);
 134                         list_del_init(&transport->list);
 135                         goto out;
 136                 }
 137         }
 138         result = -ENOENT;
 139
 140 out:
 141         spin_unlock(&xprt_list_lock);
 142         return result;
 143 }
 144 EXPORT_SYMBOL_GPL(xprt_unregister_transport);
 145
 146 /**
 147  * xprt_load_transport - load a transport implementation
 148  * @transport_name: transport to load
 149  *
 150  * Returns:
 151  * 0:           transport successfully loaded
 152  * -ENOENT:     transport module not available
 153  */
 154 int xprt_load_transport(const char *transport_name)
 155 {
 156         struct xprt_class *t;
 157         int result;
 158
 159         result = 0;
 160         spin_lock(&xprt_list_lock);
 161         list_for_each_entry(t, &xprt_list, list) {
 162                 if (strcmp(t->name, transport_name) == 0) {
 163                         spin_unlock(&xprt_list_lock);
 164                         goto out;
 165                 }
 166         }
 167         spin_unlock(&xprt_list_lock);
 168         result = request_module("xprt%s", transport_name);
 169 out:
 170         return result;
 171 }
 172 EXPORT_SYMBOL_GPL(xprt_load_transport);
 173
 174 /**
 175  * xprt_reserve_xprt - serialize write access to transports
 176  * @task: task that is requesting access to the transport
 177  * @xprt: pointer to the target transport
 178  *
 179  * This prevents mixing the payload of separate requests, and prevents
 180  * transport connects from colliding with writes.  No congestion control
 181  * is provided.
 182  */
 183 int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
 184 {
 185         struct rpc_rqst *req = task->tk_rqstp;
 186         int priority;
 187
 188         if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
 189                 if (task == xprt->snd_task)
 190                         return 1;
 191                 goto out_sleep;
 192         }
 193         xprt->snd_task = task;
 194         if (req != NULL)
 195                 req->rq_ntrans++;
 196
 197         return 1;
 198
 199 out_sleep:
 200         dprintk("RPC: %5u failed to lock transport %p\n",
 201                         task->tk_pid, xprt);
 202         task->tk_timeout = 0;
 203         task->tk_status = -EAGAIN;
 204         if (req == NULL)
 205                 priority = RPC_PRIORITY_LOW;
 206         else if (!req->rq_ntrans)
 207                 priority = RPC_PRIORITY_NORMAL;
 208         else
 209                 priority = RPC_PRIORITY_HIGH;
 210         rpc_sleep_on_priority(&xprt->sending, task, NULL, priority);
 211         return 0;
 212 }
 213 EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
 214
 215 static void xprt_clear_locked(struct rpc_xprt *xprt)
 216 {
 217         xprt->snd_task = NULL;
 218         if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state)) {
 219                 smp_mb__before_atomic();
 220                 clear_bit(XPRT_LOCKED, &xprt->state);
 221                 smp_mb__after_atomic();
 222         } else
 223                 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
 224 }
 225
 226 /*
 227  * xprt_reserve_xprt_cong - serialize write access to transports
 228  * @task: task that is requesting access to the transport
 229  *
 230  * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
 231  * integrated into the decision of whether a request is allowed to be
 232  * woken up and given access to the transport.
 233  */
 234 int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
 235 {
 236         struct rpc_rqst *req = task->tk_rqstp;
 237         int priority;
 238
 239         if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
 240                 if (task == xprt->snd_task)
 241                         return 1;
 242                 goto out_sleep;
 243         }
 244         if (req == NULL) {
 245                 xprt->snd_task = task;
 246                 return 1;
 247         }
 248         if (__xprt_get_cong(xprt, task)) {
 249                 xprt->snd_task = task;
 250                 req->rq_ntrans++;
 251                 return 1;
 252         }
 253         xprt_clear_locked(xprt);
 254 out_sleep:
 255         if (req)
 256                 __xprt_put_cong(xprt, req);
 257         dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
 258         task->tk_timeout = 0;
 259         task->tk_status = -EAGAIN;
 260         if (req == NULL)
 261                 priority = RPC_PRIORITY_LOW;
 262         else if (!req->rq_ntrans)
 263                 priority = RPC_PRIORITY_NORMAL;
 264         else
 265                 priority = RPC_PRIORITY_HIGH;
 266         rpc_sleep_on_priority(&xprt->sending, task, NULL, priority);
 267         return 0;
 268 }
 269 EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
 270
 271 static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
 272 {
 273         int retval;
 274
 275         spin_lock_bh(&xprt->transport_lock);
 276         retval = xprt->ops->reserve_xprt(xprt, task);
 277         spin_unlock_bh(&xprt->transport_lock);
 278         return retval;
 279 }
 280
 281 static bool __xprt_lock_write_func(struct rpc_task *task, void *data)
 282 {
 283         struct rpc_xprt *xprt = data;
 284         struct rpc_rqst *req;
 285
 286         req = task->tk_rqstp;
 287         xprt->snd_task = task;
 288         if (req)
 289                 req->rq_ntrans++;
 290         return true;
 291 }
 292
 293 static void __xprt_lock_write_next(struct rpc_xprt *xprt)
 294 {
 295         if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
 296                 return;
 297
 298         if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
 299                                 __xprt_lock_write_func, xprt))
 300                 return;
 301         xprt_clear_locked(xprt);
 302 }
 303
 304 static bool __xprt_lock_write_cong_func(struct rpc_task *task, void *data)
 305 {
 306         struct rpc_xprt *xprt = data;
 307         struct rpc_rqst *req;
 308
 309         req = task->tk_rqstp;
 310         if (req == NULL) {
 311                 xprt->snd_task = task;
 312                 return true;
 313         }
 314         if (__xprt_get_cong(xprt, task)) {
 315                 xprt->snd_task = task;
 316                 req->rq_ntrans++;
 317                 return true;
 318         }
 319         return false;
 320 }
 321
 322 static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
 323 {
 324         if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
 325                 return;
 326         if (RPCXPRT_CONGESTED(xprt))
 327                 goto out_unlock;
 328         if (rpc_wake_up_first_on_wq(xprtiod_workqueue, &xprt->sending,
 329                                 __xprt_lock_write_cong_func, xprt))
 330                 return;
 331 out_unlock:
 332         xprt_clear_locked(xprt);
 333 }
 334
 335 static void xprt_task_clear_bytes_sent(struct rpc_task *task)
 336 {
 337         if (task != NULL) {
 338                 struct rpc_rqst *req = task->tk_rqstp;
 339                 if (req != NULL)
 340                         req->rq_bytes_sent = 0;
 341         }
 342 }
 343
 344 /**
 345  * xprt_release_xprt - allow other requests to use a transport
 346  * @xprt: transport with other tasks potentially waiting
 347  * @task: task that is releasing access to the transport
 348  *
 349  * Note that "task" can be NULL.  No congestion control is provided.
 350  */
 351 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
 352 {
 353         if (xprt->snd_task == task) {
 354                 xprt_task_clear_bytes_sent(task);
 355                 xprt_clear_locked(xprt);
 356                 __xprt_lock_write_next(xprt);
 357         }
 358 }
 359 EXPORT_SYMBOL_GPL(xprt_release_xprt);
 360
 361 /**
 362  * xprt_release_xprt_cong - allow other requests to use a transport
 363  * @xprt: transport with other tasks potentially waiting
 364  * @task: task that is releasing access to the transport
 365  *
 366  * Note that "task" can be NULL.  Another task is awoken to use the
 367  * transport if the transport's congestion window allows it.
 368  */
 369 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
 370 {
 371         if (xprt->snd_task == task) {
 372                 xprt_task_clear_bytes_sent(task);
 373                 xprt_clear_locked(xprt);
 374                 __xprt_lock_write_next_cong(xprt);
 375         }
 376 }
 377 EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
 378
 379 static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
 380 {
 381         spin_lock_bh(&xprt->transport_lock);
 382         xprt->ops->release_xprt(xprt, task);
 383         spin_unlock_bh(&xprt->transport_lock);
 384 }
 385
 386 /*
 387  * Van Jacobson congestion avoidance. Check if the congestion window
 388  * overflowed. Put the task to sleep if this is the case.
 389  */
 390 static int
 391 __xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
 392 {
 393         struct rpc_rqst *req = task->tk_rqstp;
 394
 395         if (req->rq_cong)
 396                 return 1;
 397         dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
 398                         task->tk_pid, xprt->cong, xprt->cwnd);
 399         if (RPCXPRT_CONGESTED(xprt))
 400                 return 0;
 401         req->rq_cong = 1;
 402         xprt->cong += RPC_CWNDSCALE;
 403         return 1;
 404 }
 405
 406 /*
 407  * Adjust the congestion window, and wake up the next task
 408  * that has been sleeping due to congestion
 409  */
 410 static void
 411 __xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
 412 {
 413         if (!req->rq_cong)
 414                 return;
 415         req->rq_cong = 0;
 416         xprt->cong -= RPC_CWNDSCALE;
 417         __xprt_lock_write_next_cong(xprt);
 418 }
 419
 420 /**
 421  * xprt_release_rqst_cong - housekeeping when request is complete
 422  * @task: RPC request that recently completed
 423  *
 424  * Useful for transports that require congestion control.
 425  */
 426 void xprt_release_rqst_cong(struct rpc_task *task)
 427 {
 428         struct rpc_rqst *req = task->tk_rqstp;
 429
 430         __xprt_put_cong(req->rq_xprt, req);
 431 }
 432 EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
 433
 434 /**
 435  * xprt_adjust_cwnd - adjust transport congestion window
 436  * @xprt: pointer to xprt
 437  * @task: recently completed RPC request used to adjust window
 438  * @result: result code of completed RPC request
 439  *
 440  * The transport code maintains an estimate on the maximum number of out-
 441  * standing RPC requests, using a smoothed version of the congestion
 442  * avoidance implemented in 44BSD. This is basically the Van Jacobson
 443  * congestion algorithm: If a retransmit occurs, the congestion window is
 444  * halved; otherwise, it is incremented by 1/cwnd when
 445  *
 446  *      -       a reply is received and
 447  *      -       a full number of requests are outstanding and
 448  *      -       the congestion window hasn't been updated recently.
 449  */
 450 void xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result)
 451 {
 452         struct rpc_rqst *req = task->tk_rqstp;
 453         unsigned long cwnd = xprt->cwnd;
 454
 455         if (result >= 0 && cwnd <= xprt->cong) {
 456                 /* The (cwnd >> 1) term makes sure
 457                  * the result gets rounded properly. */
 458                 cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
 459                 if (cwnd > RPC_MAXCWND(xprt))
 460                         cwnd = RPC_MAXCWND(xprt);
 461                 __xprt_lock_write_next_cong(xprt);
 462         } else if (result == -ETIMEDOUT) {
 463                 cwnd >>= 1;
 464                 if (cwnd < RPC_CWNDSCALE)
 465                         cwnd = RPC_CWNDSCALE;
 466         }
 467         dprintk("RPC:       cong %ld, cwnd was %ld, now %ld\n",
 468                         xprt->cong, xprt->cwnd, cwnd);
 469         xprt->cwnd = cwnd;
 470         __xprt_put_cong(xprt, req);
 471 }
 472 EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
 473
 474 /**
 475  * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
 476  * @xprt: transport with waiting tasks
 477  * @status: result code to plant in each task before waking it
 478  *
 479  */
 480 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
 481 {
 482         if (status < 0)
 483                 rpc_wake_up_status(&xprt->pending, status);
 484         else
 485                 rpc_wake_up(&xprt->pending);
 486 }
 487 EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
 488
 489 /**
 490  * xprt_wait_for_buffer_space - wait for transport output buffer to clear
 491  * @task: task to be put to sleep
 492  * @action: function pointer to be executed after wait
 493  *
 494  * Note that we only set the timer for the case of RPC_IS_SOFT(), since
 495  * we don't in general want to force a socket disconnection due to
 496  * an incomplete RPC call transmission.
 497  */
 498 void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
 499 {
 500         struct rpc_rqst *req = task->tk_rqstp;
 501         struct rpc_xprt *xprt = req->rq_xprt;
 502
 503         task->tk_timeout = RPC_IS_SOFT(task) ? req->rq_timeout : 0;
 504         rpc_sleep_on(&xprt->pending, task, action);
 505 }
 506 EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
 507
 508 /**
 509  * xprt_write_space - wake the task waiting for transport output buffer space
 510  * @xprt: transport with waiting tasks
 511  *
 512  * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
 513  */
 514 void xprt_write_space(struct rpc_xprt *xprt)
 515 {
 516         spin_lock_bh(&xprt->transport_lock);
 517         if (xprt->snd_task) {
 518                 dprintk("RPC:       write space: waking waiting task on "
 519                                 "xprt %p\n", xprt);
 520                 rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
 521         }
 522         spin_unlock_bh(&xprt->transport_lock);
 523 }
 524 EXPORT_SYMBOL_GPL(xprt_write_space);
 525
 526 /**
 527  * xprt_set_retrans_timeout_def - set a request's retransmit timeout
 528  * @task: task whose timeout is to be set
 529  *
 530  * Set a request's retransmit timeout based on the transport's
 531  * default timeout parameters.  Used by transports that don't adjust
 532  * the retransmit timeout based on round-trip time estimation.
 533  */
 534 void xprt_set_retrans_timeout_def(struct rpc_task *task)
 535 {
 536         task->tk_timeout = task->tk_rqstp->rq_timeout;
 537 }
 538 EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
 539
 540 /**
 541  * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
 542  * @task: task whose timeout is to be set
 543  *
 544  * Set a request's retransmit timeout using the RTT estimator.
 545  */
 546 void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
 547 {
 548         int timer = task->tk_msg.rpc_proc->p_timer;
 549         struct rpc_clnt *clnt = task->tk_client;
 550         struct rpc_rtt *rtt = clnt->cl_rtt;
 551         struct rpc_rqst *req = task->tk_rqstp;
 552         unsigned long max_timeout = clnt->cl_timeout->to_maxval;
 553
 554         task->tk_timeout = rpc_calc_rto(rtt, timer);
 555         task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
 556         if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
 557                 task->tk_timeout = max_timeout;
 558 }
 559 EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
 560
 561 static void xprt_reset_majortimeo(struct rpc_rqst *req)
 562 {
 563         const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
 564
 565         req->rq_majortimeo = req->rq_timeout;
 566         if (to->to_exponential)
 567                 req->rq_majortimeo <<= to->to_retries;
 568         else
 569                 req->rq_majortimeo += to->to_increment * to->to_retries;
 570         if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
 571                 req->rq_majortimeo = to->to_maxval;
 572         req->rq_majortimeo += jiffies;
 573 }
 574
 575 /**
 576  * xprt_adjust_timeout - adjust timeout values for next retransmit
 577  * @req: RPC request containing parameters to use for the adjustment
 578  *
 579  */
 580 int xprt_adjust_timeout(struct rpc_rqst *req)
 581 {
 582         struct rpc_xprt *xprt = req->rq_xprt;
 583         const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
 584         int status = 0;
 585
 586         if (time_before(jiffies, req->rq_majortimeo)) {
 587                 if (to->to_exponential)
 588                         req->rq_timeout <<= 1;
 589                 else
 590                         req->rq_timeout += to->to_increment;
 591                 if (to->to_maxval && req->rq_timeout >= to->to_maxval)
 592                         req->rq_timeout = to->to_maxval;
 593                 req->rq_retries++;
 594         } else {
 595                 req->rq_timeout = to->to_initval;
 596                 req->rq_retries = 0;
 597                 xprt_reset_majortimeo(req);
 598                 /* Reset the RTT counters == "slow start" */
 599                 spin_lock_bh(&xprt->transport_lock);
 600                 rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
 601                 spin_unlock_bh(&xprt->transport_lock);
 602                 status = -ETIMEDOUT;
 603         }
 604
 605         if (req->rq_timeout == 0) {
 606                 printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
 607                 req->rq_timeout = 5 * HZ;
 608         }
 609         return status;
 610 }
 611
 612 static void xprt_autoclose(struct work_struct *work)
 613 {
 614         struct rpc_xprt *xprt =
 615                 container_of(work, struct rpc_xprt, task_cleanup);
 616
 617         clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
 618         xprt->ops->close(xprt);
 619         xprt_release_write(xprt, NULL);
 620         wake_up_bit(&xprt->state, XPRT_LOCKED);
 621 }
 622
 623 /**
 624  * xprt_disconnect_done - mark a transport as disconnected
 625  * @xprt: transport to flag for disconnect
 626  *
 627  */
 628 void xprt_disconnect_done(struct rpc_xprt *xprt)
 629 {
 630         dprintk("RPC:       disconnected transport %p\n", xprt);
 631         spin_lock_bh(&xprt->transport_lock);
 632         xprt_clear_connected(xprt);
 633         xprt_wake_pending_tasks(xprt, -EAGAIN);
 634         spin_unlock_bh(&xprt->transport_lock);
 635 }
 636 EXPORT_SYMBOL_GPL(xprt_disconnect_done);
 637
 638 /**
 639  * xprt_force_disconnect - force a transport to disconnect
 640  * @xprt: transport to disconnect
 641  *
 642  */
 643 void xprt_force_disconnect(struct rpc_xprt *xprt)
 644 {
 645         /* Don't race with the test_bit() in xprt_clear_locked() */
 646         spin_lock_bh(&xprt->transport_lock);
 647         set_bit(XPRT_CLOSE_WAIT, &xprt->state);
 648         /* Try to schedule an autoclose RPC call */
 649         if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
 650                 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
 651         xprt_wake_pending_tasks(xprt, -EAGAIN);
 652         spin_unlock_bh(&xprt->transport_lock);
 653 }
 654 EXPORT_SYMBOL_GPL(xprt_force_disconnect);
 655
 656 /**
 657  * xprt_conditional_disconnect - force a transport to disconnect
 658  * @xprt: transport to disconnect
 659  * @cookie: 'connection cookie'
 660  *
 661  * This attempts to break the connection if and only if 'cookie' matches
 662  * the current transport 'connection cookie'. It ensures that we don't
 663  * try to break the connection more than once when we need to retransmit
 664  * a batch of RPC requests.
 665  *
 666  */
 667 void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
 668 {
 669         /* Don't race with the test_bit() in xprt_clear_locked() */
 670         spin_lock_bh(&xprt->transport_lock);
 671         if (cookie != xprt->connect_cookie)
 672                 goto out;
 673         if (test_bit(XPRT_CLOSING, &xprt->state))
 674                 goto out;
 675         set_bit(XPRT_CLOSE_WAIT, &xprt->state);
 676         /* Try to schedule an autoclose RPC call */
 677         if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
 678                 queue_work(xprtiod_workqueue, &xprt->task_cleanup);
 679         xprt_wake_pending_tasks(xprt, -EAGAIN);
 680 out:
 681         spin_unlock_bh(&xprt->transport_lock);
 682 }
 683
 684 static bool
 685 xprt_has_timer(const struct rpc_xprt *xprt)
 686 {
 687         return xprt->idle_timeout != 0;
 688 }
 689
 690 static void
 691 xprt_schedule_autodisconnect(struct rpc_xprt *xprt)
 692         __must_hold(&xprt->transport_lock)
 693 {
 694         if (list_empty(&xprt->recv) && xprt_has_timer(xprt))
 695                 mod_timer(&xprt->timer, xprt->last_used + xprt->idle_timeout);
 696 }
 697
 698 static void
 699 xprt_init_autodisconnect(unsigned long data)
 700 {
 701         struct rpc_xprt *xprt = (struct rpc_xprt *)data;
 702
 703         spin_lock(&xprt->transport_lock);
 704         if (!list_empty(&xprt->recv))
 705                 goto out_abort;
 706         /* Reset xprt->last_used to avoid connect/autodisconnect cycling */
 707         xprt->last_used = jiffies;
 708         if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
 709                 goto out_abort;
 710         spin_unlock(&xprt->transport_lock);
 711         queue_work(xprtiod_workqueue, &xprt->task_cleanup);
 712         return;
 713 out_abort:
 714         spin_unlock(&xprt->transport_lock);
 715 }
 716
 717 bool xprt_lock_connect(struct rpc_xprt *xprt,
 718                 struct rpc_task *task,
 719                 void *cookie)
 720 {
 721         bool ret = false;
 722
 723         spin_lock_bh(&xprt->transport_lock);
 724         if (!test_bit(XPRT_LOCKED, &xprt->state))
 725                 goto out;
 726         if (xprt->snd_task != task)
 727                 goto out;
 728         xprt_task_clear_bytes_sent(task);
 729         xprt->snd_task = cookie;
 730         ret = true;
 731 out:
 732         spin_unlock_bh(&xprt->transport_lock);
 733         return ret;
 734 }
 735
 736 void xprt_unlock_connect(struct rpc_xprt *xprt, void *cookie)
 737 {
 738         spin_lock_bh(&xprt->transport_lock);
 739         if (xprt->snd_task != cookie)
 740                 goto out;
 741         if (!test_bit(XPRT_LOCKED, &xprt->state))
 742                 goto out;
 743         xprt->snd_task =NULL;
 744         xprt->ops->release_xprt(xprt, NULL);
 745         xprt_schedule_autodisconnect(xprt);
 746 out:
 747         spin_unlock_bh(&xprt->transport_lock);
 748         wake_up_bit(&xprt->state, XPRT_LOCKED);
 749 }
 750
 751 /**
 752  * xprt_connect - schedule a transport connect operation
 753  * @task: RPC task that is requesting the connect
 754  *
 755  */
 756 void xprt_connect(struct rpc_task *task)
 757 {
 758         struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
 759
 760         dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
 761                         xprt, (xprt_connected(xprt) ? "is" : "is not"));
 762
 763         if (!xprt_bound(xprt)) {
 764                 task->tk_status = -EAGAIN;
 765                 return;
 766         }
 767         if (!xprt_lock_write(xprt, task))
 768                 return;
 769
 770         if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
 771                 xprt->ops->close(xprt);
 772
 773         if (!xprt_connected(xprt)) {
 774                 task->tk_rqstp->rq_bytes_sent = 0;
 775                 task->tk_timeout = task->tk_rqstp->rq_timeout;
 776                 task->tk_rqstp->rq_connect_cookie = xprt->connect_cookie;
 777                 rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
 778
 779                 if (test_bit(XPRT_CLOSING, &xprt->state))
 780                         return;
 781                 if (xprt_test_and_set_connecting(xprt))
 782                         return;
 783                 xprt->stat.connect_start = jiffies;
 784                 xprt->ops->connect(xprt, task);
 785         }
 786         xprt_release_write(xprt, task);
 787 }
 788
 789 static void xprt_connect_status(struct rpc_task *task)
 790 {
 791         struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
 792
 793         if (task->tk_status == 0) {
 794                 xprt->stat.connect_count++;
 795                 xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
 796                 dprintk("RPC: %5u xprt_connect_status: connection established\n",
 797                                 task->tk_pid);
 798                 return;
 799         }
 800
 801         switch (task->tk_status) {
 802         case -ECONNREFUSED:
 803         case -ECONNRESET:
 804         case -ECONNABORTED:
 805         case -ENETUNREACH:
 806         case -EHOSTUNREACH:
 807         case -EPIPE:
 808         case -EAGAIN:
 809                 dprintk("RPC: %5u xprt_connect_status: retrying\n", task->tk_pid);
 810                 break;
 811         case -ETIMEDOUT:
 812                 dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
 813                                 "out\n", task->tk_pid);
 814                 break;
 815         default:
 816                 dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
 817                                 "server %s\n", task->tk_pid, -task->tk_status,
 818                                 xprt->servername);
 819                 task->tk_status = -EIO;
 820         }
 821 }
 822
 823 /**
 824  * xprt_lookup_rqst - find an RPC request corresponding to an XID
 825  * @xprt: transport on which the original request was transmitted
 826  * @xid: RPC XID of incoming reply
 827  *
 828  */
 829 struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
 830 {
 831         struct rpc_rqst *entry;
 832
 833         list_for_each_entry(entry, &xprt->recv, rq_list)
 834                 if (entry->rq_xid == xid) {
 835                         trace_xprt_lookup_rqst(xprt, xid, 0);
 836                         return entry;
 837                 }
 838
 839         dprintk("RPC:       xprt_lookup_rqst did not find xid %08x\n",
 840                         ntohl(xid));
 841         trace_xprt_lookup_rqst(xprt, xid, -ENOENT);
 842         xprt->stat.bad_xids++;
 843         return NULL;
 844 }
 845 EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
 846
 847 /**
 848  * xprt_pin_rqst - Pin a request on the transport receive list
 849  * @req: Request to pin
 850  *
 851  * Caller must ensure this is atomic with the call to xprt_lookup_rqst()
 852  * so should be holding the xprt transport lock.
 853  */
 854 void xprt_pin_rqst(struct rpc_rqst *req)
 855 {
 856         set_bit(RPC_TASK_MSG_RECV, &req->rq_task->tk_runstate);
 857 }
 858 EXPORT_SYMBOL_GPL(xprt_pin_rqst);
 859
 860 /**
 861  * xprt_unpin_rqst - Unpin a request on the transport receive list
 862  * @req: Request to pin
 863  *
 864  * Caller should be holding the xprt transport lock.
 865  */
 866 void xprt_unpin_rqst(struct rpc_rqst *req)
 867 {
 868         struct rpc_task *task = req->rq_task;
 869
 870         clear_bit(RPC_TASK_MSG_RECV, &task->tk_runstate);
 871         if (test_bit(RPC_TASK_MSG_RECV_WAIT, &task->tk_runstate))
 872                 wake_up_bit(&task->tk_runstate, RPC_TASK_MSG_RECV);
 873 }
 874 EXPORT_SYMBOL_GPL(xprt_unpin_rqst);
 875
 876 static void xprt_wait_on_pinned_rqst(struct rpc_rqst *req)
 877 __must_hold(&req->rq_xprt->recv_lock)
 878 {
 879         struct rpc_task *task = req->rq_task;
 880
 881         if (task && test_bit(RPC_TASK_MSG_RECV, &task->tk_runstate)) {
 882                 spin_unlock(&req->rq_xprt->recv_lock);
 883                 set_bit(RPC_TASK_MSG_RECV_WAIT, &task->tk_runstate);
 884                 wait_on_bit(&task->tk_runstate, RPC_TASK_MSG_RECV,
 885                                 TASK_UNINTERRUPTIBLE);
 886                 clear_bit(RPC_TASK_MSG_RECV_WAIT, &task->tk_runstate);
 887                 spin_lock(&req->rq_xprt->recv_lock);
 888         }
 889 }
 890
 891 static void xprt_update_rtt(struct rpc_task *task)
 892 {
 893         struct rpc_rqst *req = task->tk_rqstp;
 894         struct rpc_rtt *rtt = task->tk_client->cl_rtt;
 895         unsigned int timer = task->tk_msg.rpc_proc->p_timer;
 896         long m = usecs_to_jiffies(ktime_to_us(req->rq_rtt));
 897
 898         if (timer) {
 899                 if (req->rq_ntrans == 1)
 900                         rpc_update_rtt(rtt, timer, m);
 901                 rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
 902         }
 903 }
 904
 905 /**
 906  * xprt_complete_rqst - called when reply processing is complete
 907  * @task: RPC request that recently completed
 908  * @copied: actual number of bytes received from the transport
 909  *
 910  * Caller holds transport lock.
 911  */
 912 void xprt_complete_rqst(struct rpc_task *task, int copied)
 913 {
 914         struct rpc_rqst *req = task->tk_rqstp;
 915         struct rpc_xprt *xprt = req->rq_xprt;
 916
 917         dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
 918                         task->tk_pid, ntohl(req->rq_xid), copied);
 919         trace_xprt_complete_rqst(xprt, req->rq_xid, copied);
 920
 921         xprt->stat.recvs++;
 922         req->rq_rtt = ktime_sub(ktime_get(), req->rq_xtime);
 923         if (xprt->ops->timer != NULL)
 924                 xprt_update_rtt(task);
 925
 926         list_del_init(&req->rq_list);
 927         req->rq_private_buf.len = copied;
 928         /* Ensure all writes are done before we update */
 929         /* req->rq_reply_bytes_recvd */
 930         smp_wmb();
 931         req->rq_reply_bytes_recvd = copied;
 932         rpc_wake_up_queued_task(&xprt->pending, task);
 933 }
 934 EXPORT_SYMBOL_GPL(xprt_complete_rqst);
 935
 936 static void xprt_timer(struct rpc_task *task)
 937 {
 938         struct rpc_rqst *req = task->tk_rqstp;
 939         struct rpc_xprt *xprt = req->rq_xprt;
 940
 941         if (task->tk_status != -ETIMEDOUT)
 942                 return;
 943         dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
 944
 945         if (!req->rq_reply_bytes_recvd) {
 946                 if (xprt->ops->timer)
 947                         xprt->ops->timer(xprt, task);
 948         } else
 949                 task->tk_status = 0;
 950 }
 951
 952 /**
 953  * xprt_prepare_transmit - reserve the transport before sending a request
 954  * @task: RPC task about to send a request
 955  *
 956  */
 957 bool xprt_prepare_transmit(struct rpc_task *task)
 958 {
 959         struct rpc_rqst *req = task->tk_rqstp;
 960         struct rpc_xprt *xprt = req->rq_xprt;
 961         bool ret = false;
 962
 963         dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
 964
 965         spin_lock_bh(&xprt->transport_lock);
 966         if (!req->rq_bytes_sent) {
 967                 if (req->rq_reply_bytes_recvd) {
 968                         task->tk_status = req->rq_reply_bytes_recvd;
 969                         goto out_unlock;
 970                 }
 971                 if ((task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
 972                     && xprt_connected(xprt)
 973                     && req->rq_connect_cookie == xprt->connect_cookie) {
 974                         xprt->ops->set_retrans_timeout(task);
 975                         rpc_sleep_on(&xprt->pending, task, xprt_timer);
 976                         goto out_unlock;
 977                 }
 978         }
 979         if (!xprt->ops->reserve_xprt(xprt, task)) {
 980                 task->tk_status = -EAGAIN;
 981                 goto out_unlock;
 982         }
 983         ret = true;
 984 out_unlock:
 985         spin_unlock_bh(&xprt->transport_lock);
 986         return ret;
 987 }
 988
 989 void xprt_end_transmit(struct rpc_task *task)
 990 {
 991         xprt_release_write(task->tk_rqstp->rq_xprt, task);
 992 }
 993
 994 /**
 995  * xprt_transmit - send an RPC request on a transport
 996  * @task: controlling RPC task
 997  *
 998  * We have to copy the iovec because sendmsg fiddles with its contents.
 999  */
1000 void xprt_transmit(struct rpc_task *task)
1001 {
1002         struct rpc_rqst *req = task->tk_rqstp;
1003         struct rpc_xprt *xprt = req->rq_xprt;
1004         int status, numreqs;
1005
1006         dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
1007
1008         if (!req->rq_reply_bytes_recvd) {
1009                 if (list_empty(&req->rq_list) && rpc_reply_expected(task)) {
1010                         /*
1011                          * Add to the list only if we're expecting a reply
1012                          */
1013                         /* Update the softirq receive buffer */
1014                         memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
1015                                         sizeof(req->rq_private_buf));
1016                         /* Add request to the receive list */
1017                         spin_lock(&xprt->recv_lock);
1018                         list_add_tail(&req->rq_list, &xprt->recv);
1019                         spin_unlock(&xprt->recv_lock);
1020                         xprt_reset_majortimeo(req);
1021                         /* Turn off autodisconnect */
1022                         del_singleshot_timer_sync(&xprt->timer);
1023                 }
1024         } else if (!req->rq_bytes_sent)
1025                 return;
1026
1027         req->rq_xtime = ktime_get();
1028         status = xprt->ops->send_request(task);
1029         trace_xprt_transmit(xprt, req->rq_xid, status);
1030         if (status != 0) {
1031                 task->tk_status = status;
1032                 return;
1033         }
1034         xprt_inject_disconnect(xprt);
1035
1036         dprintk("RPC: %5u xmit complete\n", task->tk_pid);
1037         task->tk_flags |= RPC_TASK_SENT;
1038         spin_lock_bh(&xprt->transport_lock);
1039
1040         xprt->ops->set_retrans_timeout(task);
1041
1042         numreqs = atomic_read(&xprt->num_reqs);
1043         if (numreqs > xprt->stat.max_slots)
1044                 xprt->stat.max_slots = numreqs;
1045         xprt->stat.sends++;
1046         xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
1047         xprt->stat.bklog_u += xprt->backlog.qlen;
1048         xprt->stat.sending_u += xprt->sending.qlen;
1049         xprt->stat.pending_u += xprt->pending.qlen;
1050
1051         /* Don't race with disconnect */
1052         if (!xprt_connected(xprt))
1053                 task->tk_status = -ENOTCONN;
1054         else {
1055                 /*
1056                  * Sleep on the pending queue since
1057                  * we're expecting a reply.
1058                  */
1059                 if (!req->rq_reply_bytes_recvd && rpc_reply_expected(task))
1060                         rpc_sleep_on(&xprt->pending, task, xprt_timer);
1061                 req->rq_connect_cookie = xprt->connect_cookie;
1062         }
1063         spin_unlock_bh(&xprt->transport_lock);
1064 }
1065
1066 static void xprt_add_backlog(struct rpc_xprt *xprt, struct rpc_task *task)
1067 {
1068         set_bit(XPRT_CONGESTED, &xprt->state);
1069         rpc_sleep_on(&xprt->backlog, task, NULL);
1070 }
1071
1072 static void xprt_wake_up_backlog(struct rpc_xprt *xprt)
1073 {
1074         if (rpc_wake_up_next(&xprt->backlog) == NULL)
1075                 clear_bit(XPRT_CONGESTED, &xprt->state);
1076 }
1077
1078 static bool xprt_throttle_congested(struct rpc_xprt *xprt, struct rpc_task *task)
1079 {
1080         bool ret = false;
1081
1082         if (!test_bit(XPRT_CONGESTED, &xprt->state))
1083                 goto out;
1084         spin_lock(&xprt->reserve_lock);
1085         if (test_bit(XPRT_CONGESTED, &xprt->state)) {
1086                 rpc_sleep_on(&xprt->backlog, task, NULL);
1087                 ret = true;
1088         }
1089         spin_unlock(&xprt->reserve_lock);
1090 out:
1091         return ret;
1092 }
1093
1094 static struct rpc_rqst *xprt_dynamic_alloc_slot(struct rpc_xprt *xprt)
1095 {
1096         struct rpc_rqst *req = ERR_PTR(-EAGAIN);
1097
1098         if (!atomic_add_unless(&xprt->num_reqs, 1, xprt->max_reqs))
1099                 goto out;
1100         spin_unlock(&xprt->reserve_lock);
1101         req = kzalloc(sizeof(struct rpc_rqst), GFP_NOFS);
1102         spin_lock(&xprt->reserve_lock);
1103         if (req != NULL)
1104                 goto out;
1105         atomic_dec(&xprt->num_reqs);
1106         req = ERR_PTR(-ENOMEM);
1107 out:
1108         return req;
1109 }
1110
1111 static bool xprt_dynamic_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1112 {
1113         if (atomic_add_unless(&xprt->num_reqs, -1, xprt->min_reqs)) {
1114                 kfree(req);
1115                 return true;
1116         }
1117         return false;
1118 }
1119
1120 void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1121 {
1122         struct rpc_rqst *req;
1123
1124         spin_lock(&xprt->reserve_lock);
1125         if (!list_empty(&xprt->free)) {
1126                 req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
1127                 list_del(&req->rq_list);
1128                 goto out_init_req;
1129         }
1130         req = xprt_dynamic_alloc_slot(xprt);
1131         if (!IS_ERR(req))
1132                 goto out_init_req;
1133         switch (PTR_ERR(req)) {
1134         case -ENOMEM:
1135                 dprintk("RPC:       dynamic allocation of request slot "
1136                                 "failed! Retrying\n");
1137                 task->tk_status = -ENOMEM;
1138                 break;
1139         case -EAGAIN:
1140                 xprt_add_backlog(xprt, task);
1141                 dprintk("RPC:       waiting for request slot\n");
1142         default:
1143                 task->tk_status = -EAGAIN;
1144         }
1145         spin_unlock(&xprt->reserve_lock);
1146         return;
1147 out_init_req:
1148         task->tk_status = 0;
1149         task->tk_rqstp = req;
1150         xprt_request_init(task, xprt);
1151         spin_unlock(&xprt->reserve_lock);
1152 }
1153 EXPORT_SYMBOL_GPL(xprt_alloc_slot);
1154
1155 void xprt_lock_and_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task)
1156 {
1157         /* Note: grabbing the xprt_lock_write() ensures that we throttle
1158          * new slot allocation if the transport is congested (i.e. when
1159          * reconnecting a stream transport or when out of socket write
1160          * buffer space).
1161          */
1162         if (xprt_lock_write(xprt, task)) {
1163                 xprt_alloc_slot(xprt, task);
1164                 xprt_release_write(xprt, task);
1165         }
1166 }
1167 EXPORT_SYMBOL_GPL(xprt_lock_and_alloc_slot);
1168
1169 static void xprt_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
1170 {
1171         spin_lock(&xprt->reserve_lock);
1172         if (!xprt_dynamic_free_slot(xprt, req)) {
1173                 memset(req, 0, sizeof(*req));   /* mark unused */
1174                 list_add(&req->rq_list, &xprt->free);
1175         }
1176         xprt_wake_up_backlog(xprt);
1177         spin_unlock(&xprt->reserve_lock);
1178 }
1179
1180 static void xprt_free_all_slots(struct rpc_xprt *xprt)
1181 {
1182         struct rpc_rqst *req;
1183         while (!list_empty(&xprt->free)) {
1184                 req = list_first_entry(&xprt->free, struct rpc_rqst, rq_list);
1185                 list_del(&req->rq_list);
1186                 kfree(req);
1187         }
1188 }
1189
1190 struct rpc_xprt *xprt_alloc(struct net *net, size_t size,
1191                 unsigned int num_prealloc,
1192                 unsigned int max_alloc)
1193 {
1194         struct rpc_xprt *xprt;
1195         struct rpc_rqst *req;
1196         int i;
1197
1198         xprt = kzalloc(size, GFP_KERNEL);
1199         if (xprt == NULL)
1200                 goto out;
1201
1202         xprt_init(xprt, net);
1203
1204         for (i = 0; i < num_prealloc; i++) {
1205                 req = kzalloc(sizeof(struct rpc_rqst), GFP_KERNEL);
1206                 if (!req)
1207                         goto out_free;
1208                 list_add(&req->rq_list, &xprt->free);
1209         }
1210         if (max_alloc > num_prealloc)
1211                 xprt->max_reqs = max_alloc;
1212         else
1213                 xprt->max_reqs = num_prealloc;
1214         xprt->min_reqs = num_prealloc;
1215         atomic_set(&xprt->num_reqs, num_prealloc);
1216
1217         return xprt;
1218
1219 out_free:
1220         xprt_free(xprt);
1221 out:
1222         return NULL;
1223 }
1224 EXPORT_SYMBOL_GPL(xprt_alloc);
1225
1226 void xprt_free(struct rpc_xprt *xprt)
1227 {
1228         put_net(xprt->xprt_net);
1229         xprt_free_all_slots(xprt);
1230         kfree_rcu(xprt, rcu);
1231 }
1232 EXPORT_SYMBOL_GPL(xprt_free);
1233
1234 /**
1235  * xprt_reserve - allocate an RPC request slot
1236  * @task: RPC task requesting a slot allocation
1237  *
1238  * If the transport is marked as being congested, or if no more
1239  * slots are available, place the task on the transport's
1240  * backlog queue.
1241  */
1242 void xprt_reserve(struct rpc_task *task)
1243 {
1244         struct rpc_xprt *xprt = task->tk_xprt;
1245
1246         task->tk_status = 0;
1247         if (task->tk_rqstp != NULL)
1248                 return;
1249
1250         task->tk_timeout = 0;
1251         task->tk_status = -EAGAIN;
1252         if (!xprt_throttle_congested(xprt, task))
1253                 xprt->ops->alloc_slot(xprt, task);
1254 }
1255
1256 /**
1257  * xprt_retry_reserve - allocate an RPC request slot
1258  * @task: RPC task requesting a slot allocation
1259  *
1260  * If no more slots are available, place the task on the transport's
1261  * backlog queue.
1262  * Note that the only difference with xprt_reserve is that we now
1263  * ignore the value of the XPRT_CONGESTED flag.
1264  */
1265 void xprt_retry_reserve(struct rpc_task *task)
1266 {
1267         struct rpc_xprt *xprt = task->tk_xprt;
1268
1269         task->tk_status = 0;
1270         if (task->tk_rqstp != NULL)
1271                 return;
1272
1273         task->tk_timeout = 0;
1274         task->tk_status = -EAGAIN;
1275         xprt->ops->alloc_slot(xprt, task);
1276 }
1277
1278 static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
1279 {
1280         return (__force __be32)xprt->xid++;
1281 }
1282
1283 static inline void xprt_init_xid(struct rpc_xprt *xprt)
1284 {
1285         xprt->xid = prandom_u32();
1286 }
1287
1288 static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
1289 {
1290         struct rpc_rqst *req = task->tk_rqstp;
1291
1292         INIT_LIST_HEAD(&req->rq_list);
1293         req->rq_timeout = task->tk_client->cl_timeout->to_initval;
1294         req->rq_task    = task;
1295         req->rq_xprt    = xprt;
1296         req->rq_buffer  = NULL;
1297         req->rq_xid     = xprt_alloc_xid(xprt);
1298         req->rq_connect_cookie = xprt->connect_cookie - 1;
1299         req->rq_bytes_sent = 0;
1300         req->rq_snd_buf.len = 0;
1301         req->rq_snd_buf.buflen = 0;
1302         req->rq_rcv_buf.len = 0;
1303         req->rq_rcv_buf.buflen = 0;
1304         req->rq_release_snd_buf = NULL;
1305         xprt_reset_majortimeo(req);
1306         dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
1307                         req, ntohl(req->rq_xid));
1308 }
1309
1310 /**
1311  * xprt_release - release an RPC request slot
1312  * @task: task which is finished with the slot
1313  *
1314  */
1315 void xprt_release(struct rpc_task *task)
1316 {
1317         struct rpc_xprt *xprt;
1318         struct rpc_rqst *req = task->tk_rqstp;
1319
1320         if (req == NULL) {
1321                 if (task->tk_client) {
1322                         xprt = task->tk_xprt;
1323                         if (xprt->snd_task == task)
1324                                 xprt_release_write(xprt, task);
1325                 }
1326                 return;
1327         }
1328
1329         xprt = req->rq_xprt;
1330         if (task->tk_ops->rpc_count_stats != NULL)
1331                 task->tk_ops->rpc_count_stats(task, task->tk_calldata);
1332         else if (task->tk_client)
1333                 rpc_count_iostats(task, task->tk_client->cl_metrics);
1334         spin_lock(&xprt->recv_lock);
1335         if (!list_empty(&req->rq_list)) {
1336                 list_del_init(&req->rq_list);
1337                 xprt_wait_on_pinned_rqst(req);
1338         }
1339         spin_unlock(&xprt->recv_lock);
1340         spin_lock_bh(&xprt->transport_lock);
1341         xprt->ops->release_xprt(xprt, task);
1342         if (xprt->ops->release_request)
1343                 xprt->ops->release_request(task);
1344         xprt->last_used = jiffies;
1345         xprt_schedule_autodisconnect(xprt);
1346         spin_unlock_bh(&xprt->transport_lock);
1347         if (req->rq_buffer)
1348                 xprt->ops->buf_free(task);
1349         xprt_inject_disconnect(xprt);
1350         if (req->rq_cred != NULL)
1351                 put_rpccred(req->rq_cred);
1352         task->tk_rqstp = NULL;
1353         if (req->rq_release_snd_buf)
1354                 req->rq_release_snd_buf(req);
1355
1356         dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
1357         if (likely(!bc_prealloc(req)))
1358                 xprt_free_slot(xprt, req);
1359         else
1360                 xprt_free_bc_request(req);
1361 }
1362
1363 static void xprt_init(struct rpc_xprt *xprt, struct net *net)
1364 {
1365         kref_init(&xprt->kref);
1366
1367         spin_lock_init(&xprt->transport_lock);
1368         spin_lock_init(&xprt->reserve_lock);
1369         spin_lock_init(&xprt->recv_lock);
1370
1371         INIT_LIST_HEAD(&xprt->free);
1372         INIT_LIST_HEAD(&xprt->recv);
1373 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1374         spin_lock_init(&xprt->bc_pa_lock);
1375         INIT_LIST_HEAD(&xprt->bc_pa_list);
1376 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1377         INIT_LIST_HEAD(&xprt->xprt_switch);
1378
1379         xprt->last_used = jiffies;
1380         xprt->cwnd = RPC_INITCWND;
1381         xprt->bind_index = 0;
1382
1383         rpc_init_wait_queue(&xprt->binding, "xprt_binding");
1384         rpc_init_wait_queue(&xprt->pending, "xprt_pending");
1385         rpc_init_priority_wait_queue(&xprt->sending, "xprt_sending");
1386         rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
1387
1388         xprt_init_xid(xprt);
1389
1390         xprt->xprt_net = get_net(net);
1391 }
1392
1393 /**
1394  * xprt_create_transport - create an RPC transport
1395  * @args: rpc transport creation arguments
1396  *
1397  */
1398 struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
1399 {
1400         struct rpc_xprt *xprt;
1401         struct xprt_class *t;
1402
1403         spin_lock(&xprt_list_lock);
1404         list_for_each_entry(t, &xprt_list, list) {
1405                 if (t->ident == args->ident) {
1406                         spin_unlock(&xprt_list_lock);
1407                         goto found;
1408                 }
1409         }
1410         spin_unlock(&xprt_list_lock);
1411         dprintk("RPC: transport (%d) not supported\n", args->ident);
1412         return ERR_PTR(-EIO);
1413
1414 found:
1415         xprt = t->setup(args);
1416         if (IS_ERR(xprt)) {
1417                 dprintk("RPC:       xprt_create_transport: failed, %ld\n",
1418                                 -PTR_ERR(xprt));
1419                 goto out;
1420         }
1421         if (args->flags & XPRT_CREATE_NO_IDLE_TIMEOUT)
1422                 xprt->idle_timeout = 0;
1423         INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
1424         if (xprt_has_timer(xprt))
1425                 setup_timer(&xprt->timer, xprt_init_autodisconnect,
1426                             (unsigned long)xprt);
1427         else
1428                 init_timer(&xprt->timer);
1429
1430         if (strlen(args->servername) > RPC_MAXNETNAMELEN) {
1431                 xprt_destroy(xprt);
1432                 return ERR_PTR(-EINVAL);
1433         }
1434         xprt->servername = kstrdup(args->servername, GFP_KERNEL);
1435         if (xprt->servername == NULL) {
1436                 xprt_destroy(xprt);
1437                 return ERR_PTR(-ENOMEM);
1438         }
1439
1440         rpc_xprt_debugfs_register(xprt);
1441
1442         dprintk("RPC:       created transport %p with %u slots\n", xprt,
1443                         xprt->max_reqs);
1444 out:
1445         return xprt;
1446 }
1447
1448 static void xprt_destroy_cb(struct work_struct *work)
1449 {
1450         struct rpc_xprt *xprt =
1451                 container_of(work, struct rpc_xprt, task_cleanup);
1452
1453         rpc_xprt_debugfs_unregister(xprt);
1454         rpc_destroy_wait_queue(&xprt->binding);
1455         rpc_destroy_wait_queue(&xprt->pending);
1456         rpc_destroy_wait_queue(&xprt->sending);
1457         rpc_destroy_wait_queue(&xprt->backlog);
1458         kfree(xprt->servername);
1459         /*
1460          * Tear down transport state and free the rpc_xprt
1461          */
1462         xprt->ops->destroy(xprt);
1463 }
1464
1465 /**
1466  * xprt_destroy - destroy an RPC transport, killing off all requests.
1467  * @xprt: transport to destroy
1468  *
1469  */
1470 static void xprt_destroy(struct rpc_xprt *xprt)
1471 {
1472         dprintk("RPC:       destroying transport %p\n", xprt);
1473
1474         /*
1475          * Exclude transport connect/disconnect handlers and autoclose
1476          */
1477         wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_UNINTERRUPTIBLE);
1478
1479         del_timer_sync(&xprt->timer);
1480
1481         /*
1482          * Destroy sockets etc from the system workqueue so they can
1483          * safely flush receive work running on rpciod.
1484          */
1485         INIT_WORK(&xprt->task_cleanup, xprt_destroy_cb);
1486         schedule_work(&xprt->task_cleanup);
1487 }
1488
1489 static void xprt_destroy_kref(struct kref *kref)
1490 {
1491         xprt_destroy(container_of(kref, struct rpc_xprt, kref));
1492 }
1493
1494 /**
1495  * xprt_get - return a reference to an RPC transport.
1496  * @xprt: pointer to the transport
1497  *
1498  */
1499 struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
1500 {
1501         if (xprt != NULL && kref_get_unless_zero(&xprt->kref))
1502                 return xprt;
1503         return NULL;
1504 }
1505 EXPORT_SYMBOL_GPL(xprt_get);
1506
1507 /**
1508  * xprt_put - release a reference to an RPC transport.
1509  * @xprt: pointer to the transport
1510  *
1511  */
1512 void xprt_put(struct rpc_xprt *xprt)
1513 {
1514         if (xprt != NULL)
1515                 kref_put(&xprt->kref, xprt_destroy_kref);
1516 }
1517 EXPORT_SYMBOL_GPL(xprt_put);