net/rxrpc/local_object.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /* Local endpoint object management
   3  *
   4  * Copyright (C) 2016 Red Hat, Inc. All Rights Reserved.
   5  * Written by David Howells (dhowells@redhat.com)
   6  */
   7
   8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
   9
  10 #include <linux/module.h>
  11 #include <linux/net.h>
  12 #include <linux/skbuff.h>
  13 #include <linux/slab.h>
  14 #include <linux/udp.h>
  15 #include <linux/ip.h>
  16 #include <linux/hashtable.h>
  17 #include <net/sock.h>
  18 #include <net/udp.h>
  19 #include <net/udp_tunnel.h>
  20 #include <net/af_rxrpc.h>
  21 #include "ar-internal.h"
  22
  23 static void rxrpc_local_processor(struct work_struct *);
  24 static void rxrpc_local_rcu(struct rcu_head *);
  25
  26 /*
  27  * Handle an ICMP/ICMP6 error turning up at the tunnel.  Push it through the
  28  * usual mechanism so that it gets parsed and presented through the UDP
  29  * socket's error_report().
  30  */
  31 static void rxrpc_encap_err_rcv(struct sock *sk, struct sk_buff *skb, int err,
  32                                 __be16 port, u32 info, u8 *payload)
  33 {
  34         if (ip_hdr(skb)->version == IPVERSION)
  35                 return ip_icmp_error(sk, skb, err, port, info, payload);
  36         return ipv6_icmp_error(sk, skb, err, port, info, payload);
  37 }
  38
  39 /*
  40  * Compare a local to an address.  Return -ve, 0 or +ve to indicate less than,
  41  * same or greater than.
  42  *
  43  * We explicitly don't compare the RxRPC service ID as we want to reject
  44  * conflicting uses by differing services.  Further, we don't want to share
  45  * addresses with different options (IPv6), so we don't compare those bits
  46  * either.
  47  */
  48 static long rxrpc_local_cmp_key(const struct rxrpc_local *local,
  49                                 const struct sockaddr_rxrpc *srx)
  50 {
  51         long diff;
  52
  53         diff = ((local->srx.transport_type - srx->transport_type) ?:
  54                 (local->srx.transport_len - srx->transport_len) ?:
  55                 (local->srx.transport.family - srx->transport.family));
  56         if (diff != 0)
  57                 return diff;
  58
  59         switch (srx->transport.family) {
  60         case AF_INET:
  61                 /* If the choice of UDP port is left up to the transport, then
  62                  * the endpoint record doesn't match.
  63                  */
  64                 return ((u16 __force)local->srx.transport.sin.sin_port -
  65                         (u16 __force)srx->transport.sin.sin_port) ?:
  66                         memcmp(&local->srx.transport.sin.sin_addr,
  67                                &srx->transport.sin.sin_addr,
  68                                sizeof(struct in_addr));
  69 #ifdef CONFIG_AF_RXRPC_IPV6
  70         case AF_INET6:
  71                 /* If the choice of UDP6 port is left up to the transport, then
  72                  * the endpoint record doesn't match.
  73                  */
  74                 return ((u16 __force)local->srx.transport.sin6.sin6_port -
  75                         (u16 __force)srx->transport.sin6.sin6_port) ?:
  76                         memcmp(&local->srx.transport.sin6.sin6_addr,
  77                                &srx->transport.sin6.sin6_addr,
  78                                sizeof(struct in6_addr));
  79 #endif
  80         default:
  81                 BUG();
  82         }
  83 }
  84
  85 /*
  86  * Allocate a new local endpoint.
  87  */
  88 static struct rxrpc_local *rxrpc_alloc_local(struct rxrpc_net *rxnet,
  89                                              const struct sockaddr_rxrpc *srx)
  90 {
  91         struct rxrpc_local *local;
  92
  93         local = kzalloc(sizeof(struct rxrpc_local), GFP_KERNEL);
  94         if (local) {
  95                 refcount_set(&local->ref, 1);
  96                 atomic_set(&local->active_users, 1);
  97                 local->rxnet = rxnet;
  98                 INIT_HLIST_NODE(&local->link);
  99                 INIT_WORK(&local->processor, rxrpc_local_processor);
 100                 init_rwsem(&local->defrag_sem);
 101                 skb_queue_head_init(&local->reject_queue);
 102                 skb_queue_head_init(&local->event_queue);
 103                 local->client_bundles = RB_ROOT;
 104                 spin_lock_init(&local->client_bundles_lock);
 105                 spin_lock_init(&local->lock);
 106                 rwlock_init(&local->services_lock);
 107                 local->debug_id = atomic_inc_return(&rxrpc_debug_id);
 108                 memcpy(&local->srx, srx, sizeof(*srx));
 109                 local->srx.srx_service = 0;
 110                 trace_rxrpc_local(local->debug_id, rxrpc_local_new, 1, NULL);
 111         }
 112
 113         _leave(" = %p", local);
 114         return local;
 115 }
 116
 117 /*
 118  * create the local socket
 119  * - must be called with rxrpc_local_mutex locked
 120  */
 121 static int rxrpc_open_socket(struct rxrpc_local *local, struct net *net)
 122 {
 123         struct udp_tunnel_sock_cfg tuncfg = {NULL};
 124         struct sockaddr_rxrpc *srx = &local->srx;
 125         struct udp_port_cfg udp_conf = {0};
 126         struct sock *usk;
 127         int ret;
 128
 129         _enter("%p{%d,%d}",
 130                local, srx->transport_type, srx->transport.family);
 131
 132         udp_conf.family = srx->transport.family;
 133         udp_conf.use_udp_checksums = true;
 134         if (udp_conf.family == AF_INET) {
 135                 udp_conf.local_ip = srx->transport.sin.sin_addr;
 136                 udp_conf.local_udp_port = srx->transport.sin.sin_port;
 137 #if IS_ENABLED(CONFIG_AF_RXRPC_IPV6)
 138         } else {
 139                 udp_conf.local_ip6 = srx->transport.sin6.sin6_addr;
 140                 udp_conf.local_udp_port = srx->transport.sin6.sin6_port;
 141                 udp_conf.use_udp6_tx_checksums = true;
 142                 udp_conf.use_udp6_rx_checksums = true;
 143 #endif
 144         }
 145         ret = udp_sock_create(net, &udp_conf, &local->socket);
 146         if (ret < 0) {
 147                 _leave(" = %d [socket]", ret);
 148                 return ret;
 149         }
 150
 151         tuncfg.encap_type = UDP_ENCAP_RXRPC;
 152         tuncfg.encap_rcv = rxrpc_input_packet;
 153         tuncfg.encap_err_rcv = rxrpc_encap_err_rcv;
 154         tuncfg.sk_user_data = local;
 155         setup_udp_tunnel_sock(net, local->socket, &tuncfg);
 156
 157         /* set the socket up */
 158         usk = local->socket->sk;
 159         usk->sk_error_report = rxrpc_error_report;
 160
 161         switch (srx->transport.family) {
 162         case AF_INET6:
 163                 /* we want to receive ICMPv6 errors */
 164                 ip6_sock_set_recverr(usk);
 165
 166                 /* Fall through and set IPv4 options too otherwise we don't get
 167                  * errors from IPv4 packets sent through the IPv6 socket.
 168                  */
 169                 fallthrough;
 170         case AF_INET:
 171                 /* we want to receive ICMP errors */
 172                 ip_sock_set_recverr(usk);
 173
 174                 /* we want to set the don't fragment bit */
 175                 ip_sock_set_mtu_discover(usk, IP_PMTUDISC_DO);
 176
 177                 /* We want receive timestamps. */
 178                 sock_enable_timestamps(usk);
 179                 break;
 180
 181         default:
 182                 BUG();
 183         }
 184
 185         _leave(" = 0");
 186         return 0;
 187 }
 188
 189 /*
 190  * Look up or create a new local endpoint using the specified local address.
 191  */
 192 struct rxrpc_local *rxrpc_lookup_local(struct net *net,
 193                                        const struct sockaddr_rxrpc *srx)
 194 {
 195         struct rxrpc_local *local;
 196         struct rxrpc_net *rxnet = rxrpc_net(net);
 197         struct hlist_node *cursor;
 198         const char *age;
 199         long diff;
 200         int ret;
 201
 202         _enter("{%d,%d,%pISp}",
 203                srx->transport_type, srx->transport.family, &srx->transport);
 204
 205         mutex_lock(&rxnet->local_mutex);
 206
 207         hlist_for_each(cursor, &rxnet->local_endpoints) {
 208                 local = hlist_entry(cursor, struct rxrpc_local, link);
 209
 210                 diff = rxrpc_local_cmp_key(local, srx);
 211                 if (diff != 0)
 212                         continue;
 213
 214                 /* Services aren't allowed to share transport sockets, so
 215                  * reject that here.  It is possible that the object is dying -
 216                  * but it may also still have the local transport address that
 217                  * we want bound.
 218                  */
 219                 if (srx->srx_service) {
 220                         local = NULL;
 221                         goto addr_in_use;
 222                 }
 223
 224                 /* Found a match.  We want to replace a dying object.
 225                  * Attempting to bind the transport socket may still fail if
 226                  * we're attempting to use a local address that the dying
 227                  * object is still using.
 228                  */
 229                 if (!rxrpc_use_local(local))
 230                         break;
 231
 232                 age = "old";
 233                 goto found;
 234         }
 235
 236         local = rxrpc_alloc_local(rxnet, srx);
 237         if (!local)
 238                 goto nomem;
 239
 240         ret = rxrpc_open_socket(local, net);
 241         if (ret < 0)
 242                 goto sock_error;
 243
 244         if (cursor) {
 245                 hlist_replace_rcu(cursor, &local->link);
 246                 cursor->pprev = NULL;
 247         } else {
 248                 hlist_add_head_rcu(&local->link, &rxnet->local_endpoints);
 249         }
 250         age = "new";
 251
 252 found:
 253         mutex_unlock(&rxnet->local_mutex);
 254
 255         _net("LOCAL %s %d {%pISp}",
 256              age, local->debug_id, &local->srx.transport);
 257
 258         _leave(" = %p", local);
 259         return local;
 260
 261 nomem:
 262         ret = -ENOMEM;
 263 sock_error:
 264         mutex_unlock(&rxnet->local_mutex);
 265         if (local)
 266                 call_rcu(&local->rcu, rxrpc_local_rcu);
 267         _leave(" = %d", ret);
 268         return ERR_PTR(ret);
 269
 270 addr_in_use:
 271         mutex_unlock(&rxnet->local_mutex);
 272         _leave(" = -EADDRINUSE");
 273         return ERR_PTR(-EADDRINUSE);
 274 }
 275
 276 /*
 277  * Get a ref on a local endpoint.
 278  */
 279 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *local)
 280 {
 281         const void *here = __builtin_return_address(0);
 282         int r;
 283
 284         __refcount_inc(&local->ref, &r);
 285         trace_rxrpc_local(local->debug_id, rxrpc_local_got, r + 1, here);
 286         return local;
 287 }
 288
 289 /*
 290  * Get a ref on a local endpoint unless its usage has already reached 0.
 291  */
 292 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
 293 {
 294         const void *here = __builtin_return_address(0);
 295         int r;
 296
 297         if (local) {
 298                 if (__refcount_inc_not_zero(&local->ref, &r))
 299                         trace_rxrpc_local(local->debug_id, rxrpc_local_got,
 300                                           r + 1, here);
 301                 else
 302                         local = NULL;
 303         }
 304         return local;
 305 }
 306
 307 /*
 308  * Queue a local endpoint and pass the caller's reference to the work item.
 309  */
 310 void rxrpc_queue_local(struct rxrpc_local *local)
 311 {
 312         const void *here = __builtin_return_address(0);
 313         unsigned int debug_id = local->debug_id;
 314         int r = refcount_read(&local->ref);
 315
 316         if (rxrpc_queue_work(&local->processor))
 317                 trace_rxrpc_local(debug_id, rxrpc_local_queued, r + 1, here);
 318         else
 319                 rxrpc_put_local(local);
 320 }
 321
 322 /*
 323  * Drop a ref on a local endpoint.
 324  */
 325 void rxrpc_put_local(struct rxrpc_local *local)
 326 {
 327         const void *here = __builtin_return_address(0);
 328         unsigned int debug_id;
 329         bool dead;
 330         int r;
 331
 332         if (local) {
 333                 debug_id = local->debug_id;
 334
 335                 dead = __refcount_dec_and_test(&local->ref, &r);
 336                 trace_rxrpc_local(debug_id, rxrpc_local_put, r, here);
 337
 338                 if (dead)
 339                         call_rcu(&local->rcu, rxrpc_local_rcu);
 340         }
 341 }
 342
 343 /*
 344  * Start using a local endpoint.
 345  */
 346 struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *local)
 347 {
 348         local = rxrpc_get_local_maybe(local);
 349         if (!local)
 350                 return NULL;
 351
 352         if (!__rxrpc_use_local(local)) {
 353                 rxrpc_put_local(local);
 354                 return NULL;
 355         }
 356
 357         return local;
 358 }
 359
 360 /*
 361  * Cease using a local endpoint.  Once the number of active users reaches 0, we
 362  * start the closure of the transport in the work processor.
 363  */
 364 void rxrpc_unuse_local(struct rxrpc_local *local)
 365 {
 366         if (local) {
 367                 if (__rxrpc_unuse_local(local)) {
 368                         rxrpc_get_local(local);
 369                         rxrpc_queue_local(local);
 370                 }
 371         }
 372 }
 373
 374 /*
 375  * Destroy a local endpoint's socket and then hand the record to RCU to dispose
 376  * of.
 377  *
 378  * Closing the socket cannot be done from bottom half context or RCU callback
 379  * context because it might sleep.
 380  */
 381 static void rxrpc_local_destroyer(struct rxrpc_local *local)
 382 {
 383         struct socket *socket = local->socket;
 384         struct rxrpc_net *rxnet = local->rxnet;
 385
 386         _enter("%d", local->debug_id);
 387
 388         local->dead = true;
 389
 390         mutex_lock(&rxnet->local_mutex);
 391         hlist_del_init_rcu(&local->link);
 392         mutex_unlock(&rxnet->local_mutex);
 393
 394         rxrpc_clean_up_local_conns(local);
 395         rxrpc_service_connection_reaper(&rxnet->service_conn_reaper);
 396         ASSERT(!local->service);
 397
 398         if (socket) {
 399                 local->socket = NULL;
 400                 kernel_sock_shutdown(socket, SHUT_RDWR);
 401                 socket->sk->sk_user_data = NULL;
 402                 sock_release(socket);
 403         }
 404
 405         /* At this point, there should be no more packets coming in to the
 406          * local endpoint.
 407          */
 408         rxrpc_purge_queue(&local->reject_queue);
 409         rxrpc_purge_queue(&local->event_queue);
 410 }
 411
 412 /*
 413  * Process events on an endpoint.  The work item carries a ref which
 414  * we must release.
 415  */
 416 static void rxrpc_local_processor(struct work_struct *work)
 417 {
 418         struct rxrpc_local *local =
 419                 container_of(work, struct rxrpc_local, processor);
 420         bool again;
 421
 422         if (local->dead)
 423                 return;
 424
 425         trace_rxrpc_local(local->debug_id, rxrpc_local_processing,
 426                           refcount_read(&local->ref), NULL);
 427
 428         do {
 429                 again = false;
 430                 if (!__rxrpc_use_local(local)) {
 431                         rxrpc_local_destroyer(local);
 432                         break;
 433                 }
 434
 435                 if (!skb_queue_empty(&local->reject_queue)) {
 436                         rxrpc_reject_packets(local);
 437                         again = true;
 438                 }
 439
 440                 if (!skb_queue_empty(&local->event_queue)) {
 441                         rxrpc_process_local_events(local);
 442                         again = true;
 443                 }
 444
 445                 __rxrpc_unuse_local(local);
 446         } while (again);
 447
 448         rxrpc_put_local(local);
 449 }
 450
 451 /*
 452  * Destroy a local endpoint after the RCU grace period expires.
 453  */
 454 static void rxrpc_local_rcu(struct rcu_head *rcu)
 455 {
 456         struct rxrpc_local *local = container_of(rcu, struct rxrpc_local, rcu);
 457
 458         _enter("%d", local->debug_id);
 459
 460         ASSERT(!work_pending(&local->processor));
 461
 462         _net("DESTROY LOCAL %d", local->debug_id);
 463         kfree(local);
 464         _leave("");
 465 }
 466
 467 /*
 468  * Verify the local endpoint list is empty by this point.
 469  */
 470 void rxrpc_destroy_all_locals(struct rxrpc_net *rxnet)
 471 {
 472         struct rxrpc_local *local;
 473
 474         _enter("");
 475
 476         flush_workqueue(rxrpc_workqueue);
 477
 478         if (!hlist_empty(&rxnet->local_endpoints)) {
 479                 mutex_lock(&rxnet->local_mutex);
 480                 hlist_for_each_entry(local, &rxnet->local_endpoints, link) {
 481                         pr_err("AF_RXRPC: Leaked local %p {%d}\n",
 482                                local, refcount_read(&local->ref));
 483                 }
 484                 mutex_unlock(&rxnet->local_mutex);
 485                 BUG();
 486         }
 487 }