net/rxrpc/conn_object.c

   1 /* RxRPC virtual connection handler, common bits.
   2  *
   3  * Copyright (C) 2007, 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 License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  13
  14 #include <linux/module.h>
  15 #include <linux/slab.h>
  16 #include <linux/net.h>
  17 #include <linux/skbuff.h>
  18 #include "ar-internal.h"
  19
  20 /*
  21  * Time till a connection expires after last use (in seconds).
  22  */
  23 unsigned int rxrpc_connection_expiry = 10 * 60;
  24
  25 static void rxrpc_destroy_connection(struct rcu_head *);
  26
  27 /*
  28  * allocate a new connection
  29  */
  30 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t gfp)
  31 {
  32         struct rxrpc_connection *conn;
  33
  34         _enter("");
  35
  36         conn = kzalloc(sizeof(struct rxrpc_connection), gfp);
  37         if (conn) {
  38                 INIT_LIST_HEAD(&conn->cache_link);
  39                 spin_lock_init(&conn->channel_lock);
  40                 INIT_LIST_HEAD(&conn->waiting_calls);
  41                 INIT_WORK(&conn->processor, &rxrpc_process_connection);
  42                 INIT_LIST_HEAD(&conn->proc_link);
  43                 INIT_LIST_HEAD(&conn->link);
  44                 skb_queue_head_init(&conn->rx_queue);
  45                 conn->security = &rxrpc_no_security;
  46                 spin_lock_init(&conn->state_lock);
  47                 conn->debug_id = atomic_inc_return(&rxrpc_debug_id);
  48                 conn->size_align = 4;
  49                 conn->idle_timestamp = jiffies;
  50         }
  51
  52         _leave(" = %p{%d}", conn, conn ? conn->debug_id : 0);
  53         return conn;
  54 }
  55
  56 /*
  57  * Look up a connection in the cache by protocol parameters.
  58  *
  59  * If successful, a pointer to the connection is returned, but no ref is taken.
  60  * NULL is returned if there is no match.
  61  *
  62  * The caller must be holding the RCU read lock.
  63  */
  64 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *local,
  65                                                    struct sk_buff *skb)
  66 {
  67         struct rxrpc_connection *conn;
  68         struct rxrpc_conn_proto k;
  69         struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
  70         struct sockaddr_rxrpc srx;
  71         struct rxrpc_peer *peer;
  72
  73         _enter(",%x", sp->hdr.cid & RXRPC_CIDMASK);
  74
  75         if (rxrpc_extract_addr_from_skb(&srx, skb) < 0)
  76                 goto not_found;
  77
  78         k.epoch = sp->hdr.epoch;
  79         k.cid   = sp->hdr.cid & RXRPC_CIDMASK;
  80
  81         /* We may have to handle mixing IPv4 and IPv6 */
  82         if (srx.transport.family != local->srx.transport.family) {
  83                 pr_warn_ratelimited("AF_RXRPC: Protocol mismatch %u not %u\n",
  84                                     srx.transport.family,
  85                                     local->srx.transport.family);
  86                 goto not_found;
  87         }
  88
  89         k.epoch = sp->hdr.epoch;
  90         k.cid   = sp->hdr.cid & RXRPC_CIDMASK;
  91
  92         if (sp->hdr.flags & RXRPC_CLIENT_INITIATED) {
  93                 /* We need to look up service connections by the full protocol
  94                  * parameter set.  We look up the peer first as an intermediate
  95                  * step and then the connection from the peer's tree.
  96                  */
  97                 peer = rxrpc_lookup_peer_rcu(local, &srx);
  98                 if (!peer)
  99                         goto not_found;
 100                 conn = rxrpc_find_service_conn_rcu(peer, skb);
 101                 if (!conn || atomic_read(&conn->usage) == 0)
 102                         goto not_found;
 103                 _leave(" = %p", conn);
 104                 return conn;
 105         } else {
 106                 /* Look up client connections by connection ID alone as their
 107                  * IDs are unique for this machine.
 108                  */
 109                 conn = idr_find(&rxrpc_client_conn_ids,
 110                                 sp->hdr.cid >> RXRPC_CIDSHIFT);
 111                 if (!conn || atomic_read(&conn->usage) == 0) {
 112                         _debug("no conn");
 113                         goto not_found;
 114                 }
 115
 116                 if (conn->proto.epoch != k.epoch ||
 117                     conn->params.local != local)
 118                         goto not_found;
 119
 120                 peer = conn->params.peer;
 121                 switch (srx.transport.family) {
 122                 case AF_INET:
 123                         if (peer->srx.transport.sin.sin_port !=
 124                             srx.transport.sin.sin_port ||
 125                             peer->srx.transport.sin.sin_addr.s_addr !=
 126                             srx.transport.sin.sin_addr.s_addr)
 127                                 goto not_found;
 128                         break;
 129 #ifdef CONFIG_AF_RXRPC_IPV6
 130                 case AF_INET6:
 131                         if (peer->srx.transport.sin6.sin6_port !=
 132                             srx.transport.sin6.sin6_port ||
 133                             memcmp(&peer->srx.transport.sin6.sin6_addr,
 134                                    &srx.transport.sin6.sin6_addr,
 135                                    sizeof(struct in6_addr)) != 0)
 136                                 goto not_found;
 137                         break;
 138 #endif
 139                 default:
 140                         BUG();
 141                 }
 142
 143                 _leave(" = %p", conn);
 144                 return conn;
 145         }
 146
 147 not_found:
 148         _leave(" = NULL");
 149         return NULL;
 150 }
 151
 152 /*
 153  * Disconnect a call and clear any channel it occupies when that call
 154  * terminates.  The caller must hold the channel_lock and must release the
 155  * call's ref on the connection.
 156  */
 157 void __rxrpc_disconnect_call(struct rxrpc_connection *conn,
 158                              struct rxrpc_call *call)
 159 {
 160         struct rxrpc_channel *chan =
 161                 &conn->channels[call->cid & RXRPC_CHANNELMASK];
 162
 163         _enter("%d,%x", conn->debug_id, call->cid);
 164
 165         if (rcu_access_pointer(chan->call) == call) {
 166                 /* Save the result of the call so that we can repeat it if necessary
 167                  * through the channel, whilst disposing of the actual call record.
 168                  */
 169                 trace_rxrpc_disconnect_call(call);
 170                 chan->last_service_id = call->service_id;
 171                 if (call->abort_code) {
 172                         chan->last_abort = call->abort_code;
 173                         chan->last_type = RXRPC_PACKET_TYPE_ABORT;
 174                 } else {
 175                         chan->last_seq = call->rx_hard_ack;
 176                         chan->last_type = RXRPC_PACKET_TYPE_ACK;
 177                 }
 178                 /* Sync with rxrpc_conn_retransmit(). */
 179                 smp_wmb();
 180                 chan->last_call = chan->call_id;
 181                 chan->call_id = chan->call_counter;
 182
 183                 rcu_assign_pointer(chan->call, NULL);
 184         }
 185
 186         _leave("");
 187 }
 188
 189 /*
 190  * Disconnect a call and clear any channel it occupies when that call
 191  * terminates.
 192  */
 193 void rxrpc_disconnect_call(struct rxrpc_call *call)
 194 {
 195         struct rxrpc_connection *conn = call->conn;
 196
 197         spin_lock_bh(&conn->params.peer->lock);
 198         hlist_del_init(&call->error_link);
 199         spin_unlock_bh(&conn->params.peer->lock);
 200
 201         if (rxrpc_is_client_call(call))
 202                 return rxrpc_disconnect_client_call(call);
 203
 204         spin_lock(&conn->channel_lock);
 205         __rxrpc_disconnect_call(conn, call);
 206         spin_unlock(&conn->channel_lock);
 207
 208         call->conn = NULL;
 209         conn->idle_timestamp = jiffies;
 210         rxrpc_put_connection(conn);
 211 }
 212
 213 /*
 214  * Kill off a connection.
 215  */
 216 void rxrpc_kill_connection(struct rxrpc_connection *conn)
 217 {
 218         struct rxrpc_net *rxnet = conn->params.local->rxnet;
 219
 220         ASSERT(!rcu_access_pointer(conn->channels[0].call) &&
 221                !rcu_access_pointer(conn->channels[1].call) &&
 222                !rcu_access_pointer(conn->channels[2].call) &&
 223                !rcu_access_pointer(conn->channels[3].call));
 224         ASSERT(list_empty(&conn->cache_link));
 225
 226         write_lock(&rxnet->conn_lock);
 227         list_del_init(&conn->proc_link);
 228         write_unlock(&rxnet->conn_lock);
 229
 230         /* Drain the Rx queue.  Note that even though we've unpublished, an
 231          * incoming packet could still be being added to our Rx queue, so we
 232          * will need to drain it again in the RCU cleanup handler.
 233          */
 234         rxrpc_purge_queue(&conn->rx_queue);
 235
 236         /* Leave final destruction to RCU.  The connection processor work item
 237          * must carry a ref on the connection to prevent us getting here whilst
 238          * it is queued or running.
 239          */
 240         call_rcu(&conn->rcu, rxrpc_destroy_connection);
 241 }
 242
 243 /*
 244  * Queue a connection's work processor, getting a ref to pass to the work
 245  * queue.
 246  */
 247 bool rxrpc_queue_conn(struct rxrpc_connection *conn)
 248 {
 249         const void *here = __builtin_return_address(0);
 250         int n = __atomic_add_unless(&conn->usage, 1, 0);
 251         if (n == 0)
 252                 return false;
 253         if (rxrpc_queue_work(&conn->processor))
 254                 trace_rxrpc_conn(conn, rxrpc_conn_queued, n + 1, here);
 255         else
 256                 rxrpc_put_connection(conn);
 257         return true;
 258 }
 259
 260 /*
 261  * Note the re-emergence of a connection.
 262  */
 263 void rxrpc_see_connection(struct rxrpc_connection *conn)
 264 {
 265         const void *here = __builtin_return_address(0);
 266         if (conn) {
 267                 int n = atomic_read(&conn->usage);
 268
 269                 trace_rxrpc_conn(conn, rxrpc_conn_seen, n, here);
 270         }
 271 }
 272
 273 /*
 274  * Get a ref on a connection.
 275  */
 276 void rxrpc_get_connection(struct rxrpc_connection *conn)
 277 {
 278         const void *here = __builtin_return_address(0);
 279         int n = atomic_inc_return(&conn->usage);
 280
 281         trace_rxrpc_conn(conn, rxrpc_conn_got, n, here);
 282 }
 283
 284 /*
 285  * Try to get a ref on a connection.
 286  */
 287 struct rxrpc_connection *
 288 rxrpc_get_connection_maybe(struct rxrpc_connection *conn)
 289 {
 290         const void *here = __builtin_return_address(0);
 291
 292         if (conn) {
 293                 int n = __atomic_add_unless(&conn->usage, 1, 0);
 294                 if (n > 0)
 295                         trace_rxrpc_conn(conn, rxrpc_conn_got, n + 1, here);
 296                 else
 297                         conn = NULL;
 298         }
 299         return conn;
 300 }
 301
 302 /*
 303  * Release a service connection
 304  */
 305 void rxrpc_put_service_conn(struct rxrpc_connection *conn)
 306 {
 307         struct rxrpc_net *rxnet;
 308         const void *here = __builtin_return_address(0);
 309         int n;
 310
 311         n = atomic_dec_return(&conn->usage);
 312         trace_rxrpc_conn(conn, rxrpc_conn_put_service, n, here);
 313         ASSERTCMP(n, >=, 0);
 314         if (n == 0) {
 315                 rxnet = conn->params.local->rxnet;
 316                 rxrpc_queue_delayed_work(&rxnet->service_conn_reaper, 0);
 317         }
 318 }
 319
 320 /*
 321  * destroy a virtual connection
 322  */
 323 static void rxrpc_destroy_connection(struct rcu_head *rcu)
 324 {
 325         struct rxrpc_connection *conn =
 326                 container_of(rcu, struct rxrpc_connection, rcu);
 327
 328         _enter("{%d,u=%d}", conn->debug_id, atomic_read(&conn->usage));
 329
 330         ASSERTCMP(atomic_read(&conn->usage), ==, 0);
 331
 332         _net("DESTROY CONN %d", conn->debug_id);
 333
 334         rxrpc_purge_queue(&conn->rx_queue);
 335
 336         conn->security->clear(conn);
 337         key_put(conn->params.key);
 338         key_put(conn->server_key);
 339         rxrpc_put_peer(conn->params.peer);
 340         rxrpc_put_local(conn->params.local);
 341
 342         kfree(conn);
 343         _leave("");
 344 }
 345
 346 /*
 347  * reap dead service connections
 348  */
 349 void rxrpc_service_connection_reaper(struct work_struct *work)
 350 {
 351         struct rxrpc_connection *conn, *_p;
 352         struct rxrpc_net *rxnet =
 353                 container_of(to_delayed_work(work),
 354                              struct rxrpc_net, service_conn_reaper);
 355         unsigned long reap_older_than, earliest, idle_timestamp, now;
 356
 357         LIST_HEAD(graveyard);
 358
 359         _enter("");
 360
 361         now = jiffies;
 362         reap_older_than = now - rxrpc_connection_expiry * HZ;
 363         earliest = ULONG_MAX;
 364
 365         write_lock(&rxnet->conn_lock);
 366         list_for_each_entry_safe(conn, _p, &rxnet->service_conns, link) {
 367                 ASSERTCMP(atomic_read(&conn->usage), >, 0);
 368                 if (likely(atomic_read(&conn->usage) > 1))
 369                         continue;
 370                 if (conn->state == RXRPC_CONN_SERVICE_PREALLOC)
 371                         continue;
 372
 373                 idle_timestamp = READ_ONCE(conn->idle_timestamp);
 374                 _debug("reap CONN %d { u=%d,t=%ld }",
 375                        conn->debug_id, atomic_read(&conn->usage),
 376                        (long)reap_older_than - (long)idle_timestamp);
 377
 378                 if (time_after(idle_timestamp, reap_older_than)) {
 379                         if (time_before(idle_timestamp, earliest))
 380                                 earliest = idle_timestamp;
 381                         continue;
 382                 }
 383
 384                 /* The usage count sits at 1 whilst the object is unused on the
 385                  * list; we reduce that to 0 to make the object unavailable.
 386                  */
 387                 if (atomic_cmpxchg(&conn->usage, 1, 0) != 1)
 388                         continue;
 389
 390                 if (rxrpc_conn_is_client(conn))
 391                         BUG();
 392                 else
 393                         rxrpc_unpublish_service_conn(conn);
 394
 395                 list_move_tail(&conn->link, &graveyard);
 396         }
 397         write_unlock(&rxnet->conn_lock);
 398
 399         if (earliest != ULONG_MAX) {
 400                 _debug("reschedule reaper %ld", (long) earliest - now);
 401                 ASSERT(time_after(earliest, now));
 402                 rxrpc_queue_delayed_work(&rxnet->client_conn_reaper,
 403                                          earliest - now);
 404         }
 405
 406         while (!list_empty(&graveyard)) {
 407                 conn = list_entry(graveyard.next, struct rxrpc_connection,
 408                                   link);
 409                 list_del_init(&conn->link);
 410
 411                 ASSERTCMP(atomic_read(&conn->usage), ==, 0);
 412                 rxrpc_kill_connection(conn);
 413         }
 414
 415         _leave("");
 416 }
 417
 418 /*
 419  * preemptively destroy all the service connection records rather than
 420  * waiting for them to time out
 421  */
 422 void rxrpc_destroy_all_connections(struct rxrpc_net *rxnet)
 423 {
 424         struct rxrpc_connection *conn, *_p;
 425         bool leak = false;
 426
 427         _enter("");
 428
 429         rxrpc_destroy_all_client_connections(rxnet);
 430
 431         rxrpc_connection_expiry = 0;
 432         cancel_delayed_work(&rxnet->client_conn_reaper);
 433         rxrpc_queue_delayed_work(&rxnet->client_conn_reaper, 0);
 434         flush_workqueue(rxrpc_workqueue);
 435
 436         write_lock(&rxnet->conn_lock);
 437         list_for_each_entry_safe(conn, _p, &rxnet->service_conns, link) {
 438                 pr_err("AF_RXRPC: Leaked conn %p {%d}\n",
 439                        conn, atomic_read(&conn->usage));
 440                 leak = true;
 441         }
 442         write_unlock(&rxnet->conn_lock);
 443         BUG_ON(leak);
 444
 445         ASSERT(list_empty(&rxnet->conn_proc_list));
 446
 447         _leave("");
 448 }