net/rxrpc/conn_client.c

   1 /* Client connection-specific management code.
   2  *
   3  * Copyright (C) 2016 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public Licence
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the Licence, or (at your option) any later version.
  10  *
  11  *
  12  * Client connections need to be cached for a little while after they've made a
  13  * call so as to handle retransmitted DATA packets in case the server didn't
  14  * receive the final ACK or terminating ABORT we sent it.
  15  *
  16  * Client connections can be in one of a number of cache states:
  17  *
  18  *  (1) INACTIVE - The connection is not held in any list and may not have been
  19  *      exposed to the world.  If it has been previously exposed, it was
  20  *      discarded from the idle list after expiring.
  21  *
  22  *  (2) WAITING - The connection is waiting for the number of client conns to
  23  *      drop below the maximum capacity.  Calls may be in progress upon it from
  24  *      when it was active and got culled.
  25  *
  26  *      The connection is on the rxrpc_waiting_client_conns list which is kept
  27  *      in to-be-granted order.  Culled conns with waiters go to the back of
  28  *      the queue just like new conns.
  29  *
  30  *  (3) ACTIVE - The connection has at least one call in progress upon it, it
  31  *      may freely grant available channels to new calls and calls may be
  32  *      waiting on it for channels to become available.
  33  *
  34  *      The connection is on the rxnet->active_client_conns list which is kept
  35  *      in activation order for culling purposes.
  36  *
  37  *      rxrpc_nr_active_client_conns is held incremented also.
  38  *
  39  *  (4) UPGRADE - As for ACTIVE, but only one call may be in progress and is
  40  *      being used to probe for service upgrade.
  41  *
  42  *  (5) CULLED - The connection got summarily culled to try and free up
  43  *      capacity.  Calls currently in progress on the connection are allowed to
  44  *      continue, but new calls will have to wait.  There can be no waiters in
  45  *      this state - the conn would have to go to the WAITING state instead.
  46  *
  47  *  (6) IDLE - The connection has no calls in progress upon it and must have
  48  *      been exposed to the world (ie. the EXPOSED flag must be set).  When it
  49  *      expires, the EXPOSED flag is cleared and the connection transitions to
  50  *      the INACTIVE state.
  51  *
  52  *      The connection is on the rxnet->idle_client_conns list which is kept in
  53  *      order of how soon they'll expire.
  54  *
  55  * There are flags of relevance to the cache:
  56  *
  57  *  (1) EXPOSED - The connection ID got exposed to the world.  If this flag is
  58  *      set, an extra ref is added to the connection preventing it from being
  59  *      reaped when it has no calls outstanding.  This flag is cleared and the
  60  *      ref dropped when a conn is discarded from the idle list.
  61  *
  62  *      This allows us to move terminal call state retransmission to the
  63  *      connection and to discard the call immediately we think it is done
  64  *      with.  It also give us a chance to reuse the connection.
  65  *
  66  *  (2) DONT_REUSE - The connection should be discarded as soon as possible and
  67  *      should not be reused.  This is set when an exclusive connection is used
  68  *      or a call ID counter overflows.
  69  *
  70  * The caching state may only be changed if the cache lock is held.
  71  *
  72  * There are two idle client connection expiry durations.  If the total number
  73  * of connections is below the reap threshold, we use the normal duration; if
  74  * it's above, we use the fast duration.
  75  */
  76
  77 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  78
  79 #include <linux/slab.h>
  80 #include <linux/idr.h>
  81 #include <linux/timer.h>
  82 #include <linux/sched/signal.h>
  83
  84 #include "ar-internal.h"
  85
  86 __read_mostly unsigned int rxrpc_max_client_connections = 1000;
  87 __read_mostly unsigned int rxrpc_reap_client_connections = 900;
  88 __read_mostly unsigned long rxrpc_conn_idle_client_expiry = 2 * 60 * HZ;
  89 __read_mostly unsigned long rxrpc_conn_idle_client_fast_expiry = 2 * HZ;
  90
  91 /*
  92  * We use machine-unique IDs for our client connections.
  93  */
  94 DEFINE_IDR(rxrpc_client_conn_ids);
  95 static DEFINE_SPINLOCK(rxrpc_conn_id_lock);
  96
  97 static void rxrpc_cull_active_client_conns(struct rxrpc_net *);
  98
  99 /*
 100  * Get a connection ID and epoch for a client connection from the global pool.
 101  * The connection struct pointer is then recorded in the idr radix tree.  The
 102  * epoch doesn't change until the client is rebooted (or, at least, unless the
 103  * module is unloaded).
 104  */
 105 static int rxrpc_get_client_connection_id(struct rxrpc_connection *conn,
 106                                           gfp_t gfp)
 107 {
 108         struct rxrpc_net *rxnet = conn->params.local->rxnet;
 109         int id;
 110
 111         _enter("");
 112
 113         idr_preload(gfp);
 114         spin_lock(&rxrpc_conn_id_lock);
 115
 116         id = idr_alloc_cyclic(&rxrpc_client_conn_ids, conn,
 117                               1, 0x40000000, GFP_NOWAIT);
 118         if (id < 0)
 119                 goto error;
 120
 121         spin_unlock(&rxrpc_conn_id_lock);
 122         idr_preload_end();
 123
 124         conn->proto.epoch = rxnet->epoch;
 125         conn->proto.cid = id << RXRPC_CIDSHIFT;
 126         set_bit(RXRPC_CONN_HAS_IDR, &conn->flags);
 127         _leave(" [CID %x]", conn->proto.cid);
 128         return 0;
 129
 130 error:
 131         spin_unlock(&rxrpc_conn_id_lock);
 132         idr_preload_end();
 133         _leave(" = %d", id);
 134         return id;
 135 }
 136
 137 /*
 138  * Release a connection ID for a client connection from the global pool.
 139  */
 140 static void rxrpc_put_client_connection_id(struct rxrpc_connection *conn)
 141 {
 142         if (test_bit(RXRPC_CONN_HAS_IDR, &conn->flags)) {
 143                 spin_lock(&rxrpc_conn_id_lock);
 144                 idr_remove(&rxrpc_client_conn_ids,
 145                            conn->proto.cid >> RXRPC_CIDSHIFT);
 146                 spin_unlock(&rxrpc_conn_id_lock);
 147         }
 148 }
 149
 150 /*
 151  * Destroy the client connection ID tree.
 152  */
 153 void rxrpc_destroy_client_conn_ids(void)
 154 {
 155         struct rxrpc_connection *conn;
 156         int id;
 157
 158         if (!idr_is_empty(&rxrpc_client_conn_ids)) {
 159                 idr_for_each_entry(&rxrpc_client_conn_ids, conn, id) {
 160                         pr_err("AF_RXRPC: Leaked client conn %p {%d}\n",
 161                                conn, atomic_read(&conn->usage));
 162                 }
 163                 BUG();
 164         }
 165
 166         idr_destroy(&rxrpc_client_conn_ids);
 167 }
 168
 169 /*
 170  * Allocate a client connection.
 171  */
 172 static struct rxrpc_connection *
 173 rxrpc_alloc_client_connection(struct rxrpc_conn_parameters *cp, gfp_t gfp)
 174 {
 175         struct rxrpc_connection *conn;
 176         struct rxrpc_net *rxnet = cp->local->rxnet;
 177         int ret;
 178
 179         _enter("");
 180
 181         conn = rxrpc_alloc_connection(gfp);
 182         if (!conn) {
 183                 _leave(" = -ENOMEM");
 184                 return ERR_PTR(-ENOMEM);
 185         }
 186
 187         atomic_set(&conn->usage, 1);
 188         if (cp->exclusive)
 189                 __set_bit(RXRPC_CONN_DONT_REUSE, &conn->flags);
 190         if (cp->upgrade)
 191                 __set_bit(RXRPC_CONN_PROBING_FOR_UPGRADE, &conn->flags);
 192
 193         conn->params            = *cp;
 194         conn->out_clientflag    = RXRPC_CLIENT_INITIATED;
 195         conn->state             = RXRPC_CONN_CLIENT;
 196         conn->service_id        = cp->service_id;
 197
 198         ret = rxrpc_get_client_connection_id(conn, gfp);
 199         if (ret < 0)
 200                 goto error_0;
 201
 202         ret = rxrpc_init_client_conn_security(conn);
 203         if (ret < 0)
 204                 goto error_1;
 205
 206         ret = conn->security->prime_packet_security(conn);
 207         if (ret < 0)
 208                 goto error_2;
 209
 210         atomic_inc(&rxnet->nr_conns);
 211         write_lock(&rxnet->conn_lock);
 212         list_add_tail(&conn->proc_link, &rxnet->conn_proc_list);
 213         write_unlock(&rxnet->conn_lock);
 214
 215         /* We steal the caller's peer ref. */
 216         cp->peer = NULL;
 217         rxrpc_get_local(conn->params.local);
 218         key_get(conn->params.key);
 219
 220         trace_rxrpc_conn(conn, rxrpc_conn_new_client, atomic_read(&conn->usage),
 221                          __builtin_return_address(0));
 222         trace_rxrpc_client(conn, -1, rxrpc_client_alloc);
 223         _leave(" = %p", conn);
 224         return conn;
 225
 226 error_2:
 227         conn->security->clear(conn);
 228 error_1:
 229         rxrpc_put_client_connection_id(conn);
 230 error_0:
 231         kfree(conn);
 232         _leave(" = %d", ret);
 233         return ERR_PTR(ret);
 234 }
 235
 236 /*
 237  * Determine if a connection may be reused.
 238  */
 239 static bool rxrpc_may_reuse_conn(struct rxrpc_connection *conn)
 240 {
 241         struct rxrpc_net *rxnet = conn->params.local->rxnet;
 242         int id_cursor, id, distance, limit;
 243
 244         if (test_bit(RXRPC_CONN_DONT_REUSE, &conn->flags))
 245                 goto dont_reuse;
 246
 247         if (conn->proto.epoch != rxnet->epoch)
 248                 goto mark_dont_reuse;
 249
 250         /* The IDR tree gets very expensive on memory if the connection IDs are
 251          * widely scattered throughout the number space, so we shall want to
 252          * kill off connections that, say, have an ID more than about four
 253          * times the maximum number of client conns away from the current
 254          * allocation point to try and keep the IDs concentrated.
 255          */
 256         id_cursor = idr_get_cursor(&rxrpc_client_conn_ids);
 257         id = conn->proto.cid >> RXRPC_CIDSHIFT;
 258         distance = id - id_cursor;
 259         if (distance < 0)
 260                 distance = -distance;
 261         limit = max(rxrpc_max_client_connections * 4, 1024U);
 262         if (distance > limit)
 263                 goto mark_dont_reuse;
 264
 265         return true;
 266
 267 mark_dont_reuse:
 268         set_bit(RXRPC_CONN_DONT_REUSE, &conn->flags);
 269 dont_reuse:
 270         return false;
 271 }
 272
 273 /*
 274  * Create or find a client connection to use for a call.
 275  *
 276  * If we return with a connection, the call will be on its waiting list.  It's
 277  * left to the caller to assign a channel and wake up the call.
 278  */
 279 static int rxrpc_get_client_conn(struct rxrpc_sock *rx,
 280                                  struct rxrpc_call *call,
 281                                  struct rxrpc_conn_parameters *cp,
 282                                  struct sockaddr_rxrpc *srx,
 283                                  gfp_t gfp)
 284 {
 285         struct rxrpc_connection *conn, *candidate = NULL;
 286         struct rxrpc_local *local = cp->local;
 287         struct rb_node *p, **pp, *parent;
 288         long diff;
 289         int ret = -ENOMEM;
 290
 291         _enter("{%d,%lx},", call->debug_id, call->user_call_ID);
 292
 293         cp->peer = rxrpc_lookup_peer(rx, cp->local, srx, gfp);
 294         if (!cp->peer)
 295                 goto error;
 296
 297         call->cong_cwnd = cp->peer->cong_cwnd;
 298         if (call->cong_cwnd >= call->cong_ssthresh)
 299                 call->cong_mode = RXRPC_CALL_CONGEST_AVOIDANCE;
 300         else
 301                 call->cong_mode = RXRPC_CALL_SLOW_START;
 302
 303         /* If the connection is not meant to be exclusive, search the available
 304          * connections to see if the connection we want to use already exists.
 305          */
 306         if (!cp->exclusive) {
 307                 _debug("search 1");
 308                 spin_lock(&local->client_conns_lock);
 309                 p = local->client_conns.rb_node;
 310                 while (p) {
 311                         conn = rb_entry(p, struct rxrpc_connection, client_node);
 312
 313 #define cmp(X) ((long)conn->params.X - (long)cp->X)
 314                         diff = (cmp(peer) ?:
 315                                 cmp(key) ?:
 316                                 cmp(security_level) ?:
 317                                 cmp(upgrade));
 318 #undef cmp
 319                         if (diff < 0) {
 320                                 p = p->rb_left;
 321                         } else if (diff > 0) {
 322                                 p = p->rb_right;
 323                         } else {
 324                                 if (rxrpc_may_reuse_conn(conn) &&
 325                                     rxrpc_get_connection_maybe(conn))
 326                                         goto found_extant_conn;
 327                                 /* The connection needs replacing.  It's better
 328                                  * to effect that when we have something to
 329                                  * replace it with so that we don't have to
 330                                  * rebalance the tree twice.
 331                                  */
 332                                 break;
 333                         }
 334                 }
 335                 spin_unlock(&local->client_conns_lock);
 336         }
 337
 338         /* There wasn't a connection yet or we need an exclusive connection.
 339          * We need to create a candidate and then potentially redo the search
 340          * in case we're racing with another thread also trying to connect on a
 341          * shareable connection.
 342          */
 343         _debug("new conn");
 344         candidate = rxrpc_alloc_client_connection(cp, gfp);
 345         if (IS_ERR(candidate)) {
 346                 ret = PTR_ERR(candidate);
 347                 goto error_peer;
 348         }
 349
 350         /* Add the call to the new connection's waiting list in case we're
 351          * going to have to wait for the connection to come live.  It's our
 352          * connection, so we want first dibs on the channel slots.  We would
 353          * normally have to take channel_lock but we do this before anyone else
 354          * can see the connection.
 355          */
 356         list_add_tail(&call->chan_wait_link, &candidate->waiting_calls);
 357
 358         if (cp->exclusive) {
 359                 call->conn = candidate;
 360                 call->security_ix = candidate->security_ix;
 361                 call->service_id = candidate->service_id;
 362                 _leave(" = 0 [exclusive %d]", candidate->debug_id);
 363                 return 0;
 364         }
 365
 366         /* Publish the new connection for userspace to find.  We need to redo
 367          * the search before doing this lest we race with someone else adding a
 368          * conflicting instance.
 369          */
 370         _debug("search 2");
 371         spin_lock(&local->client_conns_lock);
 372
 373         pp = &local->client_conns.rb_node;
 374         parent = NULL;
 375         while (*pp) {
 376                 parent = *pp;
 377                 conn = rb_entry(parent, struct rxrpc_connection, client_node);
 378
 379 #define cmp(X) ((long)conn->params.X - (long)candidate->params.X)
 380                 diff = (cmp(peer) ?:
 381                         cmp(key) ?:
 382                         cmp(security_level) ?:
 383                         cmp(upgrade));
 384 #undef cmp
 385                 if (diff < 0) {
 386                         pp = &(*pp)->rb_left;
 387                 } else if (diff > 0) {
 388                         pp = &(*pp)->rb_right;
 389                 } else {
 390                         if (rxrpc_may_reuse_conn(conn) &&
 391                             rxrpc_get_connection_maybe(conn))
 392                                 goto found_extant_conn;
 393                         /* The old connection is from an outdated epoch. */
 394                         _debug("replace conn");
 395                         clear_bit(RXRPC_CONN_IN_CLIENT_CONNS, &conn->flags);
 396                         rb_replace_node(&conn->client_node,
 397                                         &candidate->client_node,
 398                                         &local->client_conns);
 399                         trace_rxrpc_client(conn, -1, rxrpc_client_replace);
 400                         goto candidate_published;
 401                 }
 402         }
 403
 404         _debug("new conn");
 405         rb_link_node(&candidate->client_node, parent, pp);
 406         rb_insert_color(&candidate->client_node, &local->client_conns);
 407
 408 candidate_published:
 409         set_bit(RXRPC_CONN_IN_CLIENT_CONNS, &candidate->flags);
 410         call->conn = candidate;
 411         call->security_ix = candidate->security_ix;
 412         call->service_id = candidate->service_id;
 413         spin_unlock(&local->client_conns_lock);
 414         _leave(" = 0 [new %d]", candidate->debug_id);
 415         return 0;
 416
 417         /* We come here if we found a suitable connection already in existence.
 418          * Discard any candidate we may have allocated, and try to get a
 419          * channel on this one.
 420          */
 421 found_extant_conn:
 422         _debug("found conn");
 423         spin_unlock(&local->client_conns_lock);
 424
 425         if (candidate) {
 426                 trace_rxrpc_client(candidate, -1, rxrpc_client_duplicate);
 427                 rxrpc_put_connection(candidate);
 428                 candidate = NULL;
 429         }
 430
 431         spin_lock(&conn->channel_lock);
 432         call->conn = conn;
 433         call->security_ix = conn->security_ix;
 434         call->service_id = conn->service_id;
 435         list_add(&call->chan_wait_link, &conn->waiting_calls);
 436         spin_unlock(&conn->channel_lock);
 437         _leave(" = 0 [extant %d]", conn->debug_id);
 438         return 0;
 439
 440 error_peer:
 441         rxrpc_put_peer(cp->peer);
 442         cp->peer = NULL;
 443 error:
 444         _leave(" = %d", ret);
 445         return ret;
 446 }
 447
 448 /*
 449  * Activate a connection.
 450  */
 451 static void rxrpc_activate_conn(struct rxrpc_net *rxnet,
 452                                 struct rxrpc_connection *conn)
 453 {
 454         if (test_bit(RXRPC_CONN_PROBING_FOR_UPGRADE, &conn->flags)) {
 455                 trace_rxrpc_client(conn, -1, rxrpc_client_to_upgrade);
 456                 conn->cache_state = RXRPC_CONN_CLIENT_UPGRADE;
 457         } else {
 458                 trace_rxrpc_client(conn, -1, rxrpc_client_to_active);
 459                 conn->cache_state = RXRPC_CONN_CLIENT_ACTIVE;
 460         }
 461         rxnet->nr_active_client_conns++;
 462         list_move_tail(&conn->cache_link, &rxnet->active_client_conns);
 463 }
 464
 465 /*
 466  * Attempt to animate a connection for a new call.
 467  *
 468  * If it's not exclusive, the connection is in the endpoint tree, and we're in
 469  * the conn's list of those waiting to grab a channel.  There is, however, a
 470  * limit on the number of live connections allowed at any one time, so we may
 471  * have to wait for capacity to become available.
 472  *
 473  * Note that a connection on the waiting queue might *also* have active
 474  * channels if it has been culled to make space and then re-requested by a new
 475  * call.
 476  */
 477 static void rxrpc_animate_client_conn(struct rxrpc_net *rxnet,
 478                                       struct rxrpc_connection *conn)
 479 {
 480         unsigned int nr_conns;
 481
 482         _enter("%d,%d", conn->debug_id, conn->cache_state);
 483
 484         if (conn->cache_state == RXRPC_CONN_CLIENT_ACTIVE ||
 485             conn->cache_state == RXRPC_CONN_CLIENT_UPGRADE)
 486                 goto out;
 487
 488         spin_lock(&rxnet->client_conn_cache_lock);
 489
 490         nr_conns = rxnet->nr_client_conns;
 491         if (!test_and_set_bit(RXRPC_CONN_COUNTED, &conn->flags)) {
 492                 trace_rxrpc_client(conn, -1, rxrpc_client_count);
 493                 rxnet->nr_client_conns = nr_conns + 1;
 494         }
 495
 496         switch (conn->cache_state) {
 497         case RXRPC_CONN_CLIENT_ACTIVE:
 498         case RXRPC_CONN_CLIENT_UPGRADE:
 499         case RXRPC_CONN_CLIENT_WAITING:
 500                 break;
 501
 502         case RXRPC_CONN_CLIENT_INACTIVE:
 503         case RXRPC_CONN_CLIENT_CULLED:
 504         case RXRPC_CONN_CLIENT_IDLE:
 505                 if (nr_conns >= rxrpc_max_client_connections)
 506                         goto wait_for_capacity;
 507                 goto activate_conn;
 508
 509         default:
 510                 BUG();
 511         }
 512
 513 out_unlock:
 514         spin_unlock(&rxnet->client_conn_cache_lock);
 515 out:
 516         _leave(" [%d]", conn->cache_state);
 517         return;
 518
 519 activate_conn:
 520         _debug("activate");
 521         rxrpc_activate_conn(rxnet, conn);
 522         goto out_unlock;
 523
 524 wait_for_capacity:
 525         _debug("wait");
 526         trace_rxrpc_client(conn, -1, rxrpc_client_to_waiting);
 527         conn->cache_state = RXRPC_CONN_CLIENT_WAITING;
 528         list_move_tail(&conn->cache_link, &rxnet->waiting_client_conns);
 529         goto out_unlock;
 530 }
 531
 532 /*
 533  * Deactivate a channel.
 534  */
 535 static void rxrpc_deactivate_one_channel(struct rxrpc_connection *conn,
 536                                          unsigned int channel)
 537 {
 538         struct rxrpc_channel *chan = &conn->channels[channel];
 539
 540         rcu_assign_pointer(chan->call, NULL);
 541         conn->active_chans &= ~(1 << channel);
 542 }
 543
 544 /*
 545  * Assign a channel to the call at the front of the queue and wake the call up.
 546  * We don't increment the callNumber counter until this number has been exposed
 547  * to the world.
 548  */
 549 static void rxrpc_activate_one_channel(struct rxrpc_connection *conn,
 550                                        unsigned int channel)
 551 {
 552         struct rxrpc_channel *chan = &conn->channels[channel];
 553         struct rxrpc_call *call = list_entry(conn->waiting_calls.next,
 554                                              struct rxrpc_call, chan_wait_link);
 555         u32 call_id = chan->call_counter + 1;
 556
 557         trace_rxrpc_client(conn, channel, rxrpc_client_chan_activate);
 558
 559         /* Cancel the final ACK on the previous call if it hasn't been sent yet
 560          * as the DATA packet will implicitly ACK it.
 561          */
 562         clear_bit(RXRPC_CONN_FINAL_ACK_0 + channel, &conn->flags);
 563
 564         write_lock_bh(&call->state_lock);
 565         call->state = RXRPC_CALL_CLIENT_SEND_REQUEST;
 566         write_unlock_bh(&call->state_lock);
 567
 568         rxrpc_see_call(call);
 569         list_del_init(&call->chan_wait_link);
 570         conn->active_chans |= 1 << channel;
 571         call->peer      = rxrpc_get_peer(conn->params.peer);
 572         call->cid       = conn->proto.cid | channel;
 573         call->call_id   = call_id;
 574
 575         trace_rxrpc_connect_call(call);
 576         _net("CONNECT call %08x:%08x as call %d on conn %d",
 577              call->cid, call->call_id, call->debug_id, conn->debug_id);
 578
 579         /* Paired with the read barrier in rxrpc_wait_for_channel().  This
 580          * orders cid and epoch in the connection wrt to call_id without the
 581          * need to take the channel_lock.
 582          *
 583          * We provisionally assign a callNumber at this point, but we don't
 584          * confirm it until the call is about to be exposed.
 585          *
 586          * TODO: Pair with a barrier in the data_ready handler when that looks
 587          * at the call ID through a connection channel.
 588          */
 589         smp_wmb();
 590         chan->call_id   = call_id;
 591         chan->call_debug_id = call->debug_id;
 592         rcu_assign_pointer(chan->call, call);
 593         wake_up(&call->waitq);
 594 }
 595
 596 /*
 597  * Assign channels and callNumbers to waiting calls with channel_lock
 598  * held by caller.
 599  */
 600 static void rxrpc_activate_channels_locked(struct rxrpc_connection *conn)
 601 {
 602         u8 avail, mask;
 603
 604         switch (conn->cache_state) {
 605         case RXRPC_CONN_CLIENT_ACTIVE:
 606                 mask = RXRPC_ACTIVE_CHANS_MASK;
 607                 break;
 608         case RXRPC_CONN_CLIENT_UPGRADE:
 609                 mask = 0x01;
 610                 break;
 611         default:
 612                 return;
 613         }
 614
 615         while (!list_empty(&conn->waiting_calls) &&
 616                (avail = ~conn->active_chans,
 617                 avail &= mask,
 618                 avail != 0))
 619                 rxrpc_activate_one_channel(conn, __ffs(avail));
 620 }
 621
 622 /*
 623  * Assign channels and callNumbers to waiting calls.
 624  */
 625 static void rxrpc_activate_channels(struct rxrpc_connection *conn)
 626 {
 627         _enter("%d", conn->debug_id);
 628
 629         trace_rxrpc_client(conn, -1, rxrpc_client_activate_chans);
 630
 631         if (conn->active_chans == RXRPC_ACTIVE_CHANS_MASK)
 632                 return;
 633
 634         spin_lock(&conn->channel_lock);
 635         rxrpc_activate_channels_locked(conn);
 636         spin_unlock(&conn->channel_lock);
 637         _leave("");
 638 }
 639
 640 /*
 641  * Wait for a callNumber and a channel to be granted to a call.
 642  */
 643 static int rxrpc_wait_for_channel(struct rxrpc_call *call, gfp_t gfp)
 644 {
 645         int ret = 0;
 646
 647         _enter("%d", call->debug_id);
 648
 649         if (!call->call_id) {
 650                 DECLARE_WAITQUEUE(myself, current);
 651
 652                 if (!gfpflags_allow_blocking(gfp)) {
 653                         ret = -EAGAIN;
 654                         goto out;
 655                 }
 656
 657                 add_wait_queue_exclusive(&call->waitq, &myself);
 658                 for (;;) {
 659                         set_current_state(TASK_INTERRUPTIBLE);
 660                         if (call->call_id)
 661                                 break;
 662                         if (signal_pending(current)) {
 663                                 ret = -ERESTARTSYS;
 664                                 break;
 665                         }
 666                         schedule();
 667                 }
 668                 remove_wait_queue(&call->waitq, &myself);
 669                 __set_current_state(TASK_RUNNING);
 670         }
 671
 672         /* Paired with the write barrier in rxrpc_activate_one_channel(). */
 673         smp_rmb();
 674
 675 out:
 676         _leave(" = %d", ret);
 677         return ret;
 678 }
 679
 680 /*
 681  * find a connection for a call
 682  * - called in process context with IRQs enabled
 683  */
 684 int rxrpc_connect_call(struct rxrpc_sock *rx,
 685                        struct rxrpc_call *call,
 686                        struct rxrpc_conn_parameters *cp,
 687                        struct sockaddr_rxrpc *srx,
 688                        gfp_t gfp)
 689 {
 690         struct rxrpc_net *rxnet = cp->local->rxnet;
 691         int ret;
 692
 693         _enter("{%d,%lx},", call->debug_id, call->user_call_ID);
 694
 695         rxrpc_discard_expired_client_conns(&rxnet->client_conn_reaper);
 696         rxrpc_cull_active_client_conns(rxnet);
 697
 698         ret = rxrpc_get_client_conn(rx, call, cp, srx, gfp);
 699         if (ret < 0)
 700                 goto out;
 701
 702         rxrpc_animate_client_conn(rxnet, call->conn);
 703         rxrpc_activate_channels(call->conn);
 704
 705         ret = rxrpc_wait_for_channel(call, gfp);
 706         if (ret < 0) {
 707                 rxrpc_disconnect_client_call(call);
 708                 goto out;
 709         }
 710
 711         spin_lock_bh(&call->conn->params.peer->lock);
 712         hlist_add_head_rcu(&call->error_link,
 713                            &call->conn->params.peer->error_targets);
 714         spin_unlock_bh(&call->conn->params.peer->lock);
 715
 716 out:
 717         _leave(" = %d", ret);
 718         return ret;
 719 }
 720
 721 /*
 722  * Note that a connection is about to be exposed to the world.  Once it is
 723  * exposed, we maintain an extra ref on it that stops it from being summarily
 724  * discarded before it's (a) had a chance to deal with retransmission and (b)
 725  * had a chance at re-use (the per-connection security negotiation is
 726  * expensive).
 727  */
 728 static void rxrpc_expose_client_conn(struct rxrpc_connection *conn,
 729                                      unsigned int channel)
 730 {
 731         if (!test_and_set_bit(RXRPC_CONN_EXPOSED, &conn->flags)) {
 732                 trace_rxrpc_client(conn, channel, rxrpc_client_exposed);
 733                 rxrpc_get_connection(conn);
 734         }
 735 }
 736
 737 /*
 738  * Note that a call, and thus a connection, is about to be exposed to the
 739  * world.
 740  */
 741 void rxrpc_expose_client_call(struct rxrpc_call *call)
 742 {
 743         unsigned int channel = call->cid & RXRPC_CHANNELMASK;
 744         struct rxrpc_connection *conn = call->conn;
 745         struct rxrpc_channel *chan = &conn->channels[channel];
 746
 747         if (!test_and_set_bit(RXRPC_CALL_EXPOSED, &call->flags)) {
 748                 /* Mark the call ID as being used.  If the callNumber counter
 749                  * exceeds ~2 billion, we kill the connection after its
 750                  * outstanding calls have finished so that the counter doesn't
 751                  * wrap.
 752                  */
 753                 chan->call_counter++;
 754                 if (chan->call_counter >= INT_MAX)
 755                         set_bit(RXRPC_CONN_DONT_REUSE, &conn->flags);
 756                 rxrpc_expose_client_conn(conn, channel);
 757         }
 758 }
 759
 760 /*
 761  * Set the reap timer.
 762  */
 763 static void rxrpc_set_client_reap_timer(struct rxrpc_net *rxnet)
 764 {
 765         unsigned long now = jiffies;
 766         unsigned long reap_at = now + rxrpc_conn_idle_client_expiry;
 767
 768         if (rxnet->live)
 769                 timer_reduce(&rxnet->client_conn_reap_timer, reap_at);
 770 }
 771
 772 /*
 773  * Disconnect a client call.
 774  */
 775 void rxrpc_disconnect_client_call(struct rxrpc_call *call)
 776 {
 777         unsigned int channel = call->cid & RXRPC_CHANNELMASK;
 778         struct rxrpc_connection *conn = call->conn;
 779         struct rxrpc_channel *chan = &conn->channels[channel];
 780         struct rxrpc_net *rxnet = conn->params.local->rxnet;
 781
 782         trace_rxrpc_client(conn, channel, rxrpc_client_chan_disconnect);
 783         call->conn = NULL;
 784
 785         spin_lock(&conn->channel_lock);
 786
 787         /* Calls that have never actually been assigned a channel can simply be
 788          * discarded.  If the conn didn't get used either, it will follow
 789          * immediately unless someone else grabs it in the meantime.
 790          */
 791         if (!list_empty(&call->chan_wait_link)) {
 792                 _debug("call is waiting");
 793                 ASSERTCMP(call->call_id, ==, 0);
 794                 ASSERT(!test_bit(RXRPC_CALL_EXPOSED, &call->flags));
 795                 list_del_init(&call->chan_wait_link);
 796
 797                 trace_rxrpc_client(conn, channel, rxrpc_client_chan_unstarted);
 798
 799                 /* We must deactivate or idle the connection if it's now
 800                  * waiting for nothing.
 801                  */
 802                 spin_lock(&rxnet->client_conn_cache_lock);
 803                 if (conn->cache_state == RXRPC_CONN_CLIENT_WAITING &&
 804                     list_empty(&conn->waiting_calls) &&
 805                     !conn->active_chans)
 806                         goto idle_connection;
 807                 goto out;
 808         }
 809
 810         ASSERTCMP(rcu_access_pointer(chan->call), ==, call);
 811
 812         /* If a client call was exposed to the world, we save the result for
 813          * retransmission.
 814          *
 815          * We use a barrier here so that the call number and abort code can be
 816          * read without needing to take a lock.
 817          *
 818          * TODO: Make the incoming packet handler check this and handle
 819          * terminal retransmission without requiring access to the call.
 820          */
 821         if (test_bit(RXRPC_CALL_EXPOSED, &call->flags)) {
 822                 _debug("exposed %u,%u", call->call_id, call->abort_code);
 823                 __rxrpc_disconnect_call(conn, call);
 824         }
 825
 826         /* See if we can pass the channel directly to another call. */
 827         if (conn->cache_state == RXRPC_CONN_CLIENT_ACTIVE &&
 828             !list_empty(&conn->waiting_calls)) {
 829                 trace_rxrpc_client(conn, channel, rxrpc_client_chan_pass);
 830                 rxrpc_activate_one_channel(conn, channel);
 831                 goto out_2;
 832         }
 833
 834         /* Schedule the final ACK to be transmitted in a short while so that it
 835          * can be skipped if we find a follow-on call.  The first DATA packet
 836          * of the follow on call will implicitly ACK this call.
 837          */
 838         if (call->completion == RXRPC_CALL_SUCCEEDED &&
 839             test_bit(RXRPC_CALL_EXPOSED, &call->flags)) {
 840                 unsigned long final_ack_at = jiffies + 2;
 841
 842                 WRITE_ONCE(chan->final_ack_at, final_ack_at);
 843                 smp_wmb(); /* vs rxrpc_process_delayed_final_acks() */
 844                 set_bit(RXRPC_CONN_FINAL_ACK_0 + channel, &conn->flags);
 845                 rxrpc_reduce_conn_timer(conn, final_ack_at);
 846         }
 847
 848         /* Things are more complex and we need the cache lock.  We might be
 849          * able to simply idle the conn or it might now be lurking on the wait
 850          * list.  It might even get moved back to the active list whilst we're
 851          * waiting for the lock.
 852          */
 853         spin_lock(&rxnet->client_conn_cache_lock);
 854
 855         switch (conn->cache_state) {
 856         case RXRPC_CONN_CLIENT_UPGRADE:
 857                 /* Deal with termination of a service upgrade probe. */
 858                 if (test_bit(RXRPC_CONN_EXPOSED, &conn->flags)) {
 859                         clear_bit(RXRPC_CONN_PROBING_FOR_UPGRADE, &conn->flags);
 860                         trace_rxrpc_client(conn, channel, rxrpc_client_to_active);
 861                         conn->cache_state = RXRPC_CONN_CLIENT_ACTIVE;
 862                         rxrpc_activate_channels_locked(conn);
 863                 }
 864                 /* fall through */
 865         case RXRPC_CONN_CLIENT_ACTIVE:
 866                 if (list_empty(&conn->waiting_calls)) {
 867                         rxrpc_deactivate_one_channel(conn, channel);
 868                         if (!conn->active_chans) {
 869                                 rxnet->nr_active_client_conns--;
 870                                 goto idle_connection;
 871                         }
 872                         goto out;
 873                 }
 874
 875                 trace_rxrpc_client(conn, channel, rxrpc_client_chan_pass);
 876                 rxrpc_activate_one_channel(conn, channel);
 877                 goto out;
 878
 879         case RXRPC_CONN_CLIENT_CULLED:
 880                 rxrpc_deactivate_one_channel(conn, channel);
 881                 ASSERT(list_empty(&conn->waiting_calls));
 882                 if (!conn->active_chans)
 883                         goto idle_connection;
 884                 goto out;
 885
 886         case RXRPC_CONN_CLIENT_WAITING:
 887                 rxrpc_deactivate_one_channel(conn, channel);
 888                 goto out;
 889
 890         default:
 891                 BUG();
 892         }
 893
 894 out:
 895         spin_unlock(&rxnet->client_conn_cache_lock);
 896 out_2:
 897         spin_unlock(&conn->channel_lock);
 898         rxrpc_put_connection(conn);
 899         _leave("");
 900         return;
 901
 902 idle_connection:
 903         /* As no channels remain active, the connection gets deactivated
 904          * immediately or moved to the idle list for a short while.
 905          */
 906         if (test_bit(RXRPC_CONN_EXPOSED, &conn->flags)) {
 907                 trace_rxrpc_client(conn, channel, rxrpc_client_to_idle);
 908                 conn->idle_timestamp = jiffies;
 909                 conn->cache_state = RXRPC_CONN_CLIENT_IDLE;
 910                 list_move_tail(&conn->cache_link, &rxnet->idle_client_conns);
 911                 if (rxnet->idle_client_conns.next == &conn->cache_link &&
 912                     !rxnet->kill_all_client_conns)
 913                         rxrpc_set_client_reap_timer(rxnet);
 914         } else {
 915                 trace_rxrpc_client(conn, channel, rxrpc_client_to_inactive);
 916                 conn->cache_state = RXRPC_CONN_CLIENT_INACTIVE;
 917                 list_del_init(&conn->cache_link);
 918         }
 919         goto out;
 920 }
 921
 922 /*
 923  * Clean up a dead client connection.
 924  */
 925 static struct rxrpc_connection *
 926 rxrpc_put_one_client_conn(struct rxrpc_connection *conn)
 927 {
 928         struct rxrpc_connection *next = NULL;
 929         struct rxrpc_local *local = conn->params.local;
 930         struct rxrpc_net *rxnet = local->rxnet;
 931         unsigned int nr_conns;
 932
 933         trace_rxrpc_client(conn, -1, rxrpc_client_cleanup);
 934
 935         if (test_bit(RXRPC_CONN_IN_CLIENT_CONNS, &conn->flags)) {
 936                 spin_lock(&local->client_conns_lock);
 937                 if (test_and_clear_bit(RXRPC_CONN_IN_CLIENT_CONNS,
 938                                        &conn->flags))
 939                         rb_erase(&conn->client_node, &local->client_conns);
 940                 spin_unlock(&local->client_conns_lock);
 941         }
 942
 943         rxrpc_put_client_connection_id(conn);
 944
 945         ASSERTCMP(conn->cache_state, ==, RXRPC_CONN_CLIENT_INACTIVE);
 946
 947         if (test_bit(RXRPC_CONN_COUNTED, &conn->flags)) {
 948                 trace_rxrpc_client(conn, -1, rxrpc_client_uncount);
 949                 spin_lock(&rxnet->client_conn_cache_lock);
 950                 nr_conns = --rxnet->nr_client_conns;
 951
 952                 if (nr_conns < rxrpc_max_client_connections &&
 953                     !list_empty(&rxnet->waiting_client_conns)) {
 954                         next = list_entry(rxnet->waiting_client_conns.next,
 955                                           struct rxrpc_connection, cache_link);
 956                         rxrpc_get_connection(next);
 957                         rxrpc_activate_conn(rxnet, next);
 958                 }
 959
 960                 spin_unlock(&rxnet->client_conn_cache_lock);
 961         }
 962
 963         rxrpc_kill_connection(conn);
 964         if (next)
 965                 rxrpc_activate_channels(next);
 966
 967         /* We need to get rid of the temporary ref we took upon next, but we
 968          * can't call rxrpc_put_connection() recursively.
 969          */
 970         return next;
 971 }
 972
 973 /*
 974  * Clean up a dead client connections.
 975  */
 976 void rxrpc_put_client_conn(struct rxrpc_connection *conn)
 977 {
 978         const void *here = __builtin_return_address(0);
 979         int n;
 980
 981         do {
 982                 n = atomic_dec_return(&conn->usage);
 983                 trace_rxrpc_conn(conn, rxrpc_conn_put_client, n, here);
 984                 if (n > 0)
 985                         return;
 986                 ASSERTCMP(n, >=, 0);
 987
 988                 conn = rxrpc_put_one_client_conn(conn);
 989         } while (conn);
 990 }
 991
 992 /*
 993  * Kill the longest-active client connections to make room for new ones.
 994  */
 995 static void rxrpc_cull_active_client_conns(struct rxrpc_net *rxnet)
 996 {
 997         struct rxrpc_connection *conn;
 998         unsigned int nr_conns = rxnet->nr_client_conns;
 999         unsigned int nr_active, limit;
1000
1001         _enter("");
1002
1003         ASSERTCMP(nr_conns, >=, 0);
1004         if (nr_conns < rxrpc_max_client_connections) {
1005                 _leave(" [ok]");
1006                 return;
1007         }
1008         limit = rxrpc_reap_client_connections;
1009
1010         spin_lock(&rxnet->client_conn_cache_lock);
1011         nr_active = rxnet->nr_active_client_conns;
1012
1013         while (nr_active > limit) {
1014                 ASSERT(!list_empty(&rxnet->active_client_conns));
1015                 conn = list_entry(rxnet->active_client_conns.next,
1016                                   struct rxrpc_connection, cache_link);
1017                 ASSERTIFCMP(conn->cache_state != RXRPC_CONN_CLIENT_ACTIVE,
1018                             conn->cache_state, ==, RXRPC_CONN_CLIENT_UPGRADE);
1019
1020                 if (list_empty(&conn->waiting_calls)) {
1021                         trace_rxrpc_client(conn, -1, rxrpc_client_to_culled);
1022                         conn->cache_state = RXRPC_CONN_CLIENT_CULLED;
1023                         list_del_init(&conn->cache_link);
1024                 } else {
1025                         trace_rxrpc_client(conn, -1, rxrpc_client_to_waiting);
1026                         conn->cache_state = RXRPC_CONN_CLIENT_WAITING;
1027                         list_move_tail(&conn->cache_link,
1028                                        &rxnet->waiting_client_conns);
1029                 }
1030
1031                 nr_active--;
1032         }
1033
1034         rxnet->nr_active_client_conns = nr_active;
1035         spin_unlock(&rxnet->client_conn_cache_lock);
1036         ASSERTCMP(nr_active, >=, 0);
1037         _leave(" [culled]");
1038 }
1039
1040 /*
1041  * Discard expired client connections from the idle list.  Each conn in the
1042  * idle list has been exposed and holds an extra ref because of that.
1043  *
1044  * This may be called from conn setup or from a work item so cannot be
1045  * considered non-reentrant.
1046  */
1047 void rxrpc_discard_expired_client_conns(struct work_struct *work)
1048 {
1049         struct rxrpc_connection *conn;
1050         struct rxrpc_net *rxnet =
1051                 container_of(work, struct rxrpc_net, client_conn_reaper);
1052         unsigned long expiry, conn_expires_at, now;
1053         unsigned int nr_conns;
1054
1055         _enter("");
1056
1057         if (list_empty(&rxnet->idle_client_conns)) {
1058                 _leave(" [empty]");
1059                 return;
1060         }
1061
1062         /* Don't double up on the discarding */
1063         if (!spin_trylock(&rxnet->client_conn_discard_lock)) {
1064                 _leave(" [already]");
1065                 return;
1066         }
1067
1068         /* We keep an estimate of what the number of conns ought to be after
1069          * we've discarded some so that we don't overdo the discarding.
1070          */
1071         nr_conns = rxnet->nr_client_conns;
1072
1073 next:
1074         spin_lock(&rxnet->client_conn_cache_lock);
1075
1076         if (list_empty(&rxnet->idle_client_conns))
1077                 goto out;
1078
1079         conn = list_entry(rxnet->idle_client_conns.next,
1080                           struct rxrpc_connection, cache_link);
1081         ASSERT(test_bit(RXRPC_CONN_EXPOSED, &conn->flags));
1082
1083         if (!rxnet->kill_all_client_conns) {
1084                 /* If the number of connections is over the reap limit, we
1085                  * expedite discard by reducing the expiry timeout.  We must,
1086                  * however, have at least a short grace period to be able to do
1087                  * final-ACK or ABORT retransmission.
1088                  */
1089                 expiry = rxrpc_conn_idle_client_expiry;
1090                 if (nr_conns > rxrpc_reap_client_connections)
1091                         expiry = rxrpc_conn_idle_client_fast_expiry;
1092                 if (conn->params.local->service_closed)
1093                         expiry = rxrpc_closed_conn_expiry * HZ;
1094
1095                 conn_expires_at = conn->idle_timestamp + expiry;
1096
1097                 now = READ_ONCE(jiffies);
1098                 if (time_after(conn_expires_at, now))
1099                         goto not_yet_expired;
1100         }
1101
1102         trace_rxrpc_client(conn, -1, rxrpc_client_discard);
1103         if (!test_and_clear_bit(RXRPC_CONN_EXPOSED, &conn->flags))
1104                 BUG();
1105         conn->cache_state = RXRPC_CONN_CLIENT_INACTIVE;
1106         list_del_init(&conn->cache_link);
1107
1108         spin_unlock(&rxnet->client_conn_cache_lock);
1109
1110         /* When we cleared the EXPOSED flag, we took on responsibility for the
1111          * reference that that had on the usage count.  We deal with that here.
1112          * If someone re-sets the flag and re-gets the ref, that's fine.
1113          */
1114         rxrpc_put_connection(conn);
1115         nr_conns--;
1116         goto next;
1117
1118 not_yet_expired:
1119         /* The connection at the front of the queue hasn't yet expired, so
1120          * schedule the work item for that point if we discarded something.
1121          *
1122          * We don't worry if the work item is already scheduled - it can look
1123          * after rescheduling itself at a later time.  We could cancel it, but
1124          * then things get messier.
1125          */
1126         _debug("not yet");
1127         if (!rxnet->kill_all_client_conns)
1128                 timer_reduce(&rxnet->client_conn_reap_timer,
1129                              conn_expires_at);
1130
1131 out:
1132         spin_unlock(&rxnet->client_conn_cache_lock);
1133         spin_unlock(&rxnet->client_conn_discard_lock);
1134         _leave("");
1135 }
1136
1137 /*
1138  * Preemptively destroy all the client connection records rather than waiting
1139  * for them to time out
1140  */
1141 void rxrpc_destroy_all_client_connections(struct rxrpc_net *rxnet)
1142 {
1143         _enter("");
1144
1145         spin_lock(&rxnet->client_conn_cache_lock);
1146         rxnet->kill_all_client_conns = true;
1147         spin_unlock(&rxnet->client_conn_cache_lock);
1148
1149         del_timer_sync(&rxnet->client_conn_reap_timer);
1150
1151         if (!rxrpc_queue_work(&rxnet->client_conn_reaper))
1152                 _debug("destroy: queue failed");
1153
1154         _leave("");
1155 }