net/tipc/bearer.c

   1 /*
   2  * net/tipc/bearer.c: TIPC bearer code
   3  *
   4  * Copyright (c) 1996-2006, 2013, Ericsson AB
   5  * Copyright (c) 2004-2006, 2010-2013, Wind River Systems
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the names of the copyright holders nor the names of its
  17  *    contributors may be used to endorse or promote products derived from
  18  *    this software without specific prior written permission.
  19  *
  20  * Alternatively, this software may be distributed under the terms of the
  21  * GNU General Public License ("GPL") version 2 as published by the Free
  22  * Software Foundation.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include "core.h"
  38 #include "config.h"
  39 #include "bearer.h"
  40 #include "discover.h"
  41
  42 #define MAX_ADDR_STR 60
  43
  44 static struct tipc_media * const media_info_array[] = {
  45         &eth_media_info,
  46 #ifdef CONFIG_TIPC_MEDIA_IB
  47         &ib_media_info,
  48 #endif
  49         NULL
  50 };
  51
  52 struct tipc_bearer tipc_bearers[MAX_BEARERS];
  53
  54 static void bearer_disable(struct tipc_bearer *b_ptr, bool shutting_down);
  55
  56 /**
  57  * tipc_media_find - locates specified media object by name
  58  */
  59 struct tipc_media *tipc_media_find(const char *name)
  60 {
  61         u32 i;
  62
  63         for (i = 0; media_info_array[i] != NULL; i++) {
  64                 if (!strcmp(media_info_array[i]->name, name))
  65                         break;
  66         }
  67         return media_info_array[i];
  68 }
  69
  70 /**
  71  * media_find_id - locates specified media object by type identifier
  72  */
  73 static struct tipc_media *media_find_id(u8 type)
  74 {
  75         u32 i;
  76
  77         for (i = 0; media_info_array[i] != NULL; i++) {
  78                 if (media_info_array[i]->type_id == type)
  79                         break;
  80         }
  81         return media_info_array[i];
  82 }
  83
  84 /**
  85  * tipc_media_addr_printf - record media address in print buffer
  86  */
  87 void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a)
  88 {
  89         char addr_str[MAX_ADDR_STR];
  90         struct tipc_media *m_ptr;
  91         int ret;
  92
  93         m_ptr = media_find_id(a->media_id);
  94
  95         if (m_ptr && !m_ptr->addr2str(a, addr_str, sizeof(addr_str)))
  96                 ret = tipc_snprintf(buf, len, "%s(%s)", m_ptr->name, addr_str);
  97         else {
  98                 u32 i;
  99
 100                 ret = tipc_snprintf(buf, len, "UNKNOWN(%u)", a->media_id);
 101                 for (i = 0; i < sizeof(a->value); i++)
 102                         ret += tipc_snprintf(buf - ret, len + ret,
 103                                             "-%02x", a->value[i]);
 104         }
 105 }
 106
 107 /**
 108  * tipc_media_get_names - record names of registered media in buffer
 109  */
 110 struct sk_buff *tipc_media_get_names(void)
 111 {
 112         struct sk_buff *buf;
 113         int i;
 114
 115         buf = tipc_cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
 116         if (!buf)
 117                 return NULL;
 118
 119         for (i = 0; media_info_array[i] != NULL; i++) {
 120                 tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME,
 121                                     media_info_array[i]->name,
 122                                     strlen(media_info_array[i]->name) + 1);
 123         }
 124         return buf;
 125 }
 126
 127 /**
 128  * bearer_name_validate - validate & (optionally) deconstruct bearer name
 129  * @name: ptr to bearer name string
 130  * @name_parts: ptr to area for bearer name components (or NULL if not needed)
 131  *
 132  * Returns 1 if bearer name is valid, otherwise 0.
 133  */
 134 static int bearer_name_validate(const char *name,
 135                                 struct tipc_bearer_names *name_parts)
 136 {
 137         char name_copy[TIPC_MAX_BEARER_NAME];
 138         char *media_name;
 139         char *if_name;
 140         u32 media_len;
 141         u32 if_len;
 142
 143         /* copy bearer name & ensure length is OK */
 144         name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
 145         /* need above in case non-Posix strncpy() doesn't pad with nulls */
 146         strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
 147         if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
 148                 return 0;
 149
 150         /* ensure all component parts of bearer name are present */
 151         media_name = name_copy;
 152         if_name = strchr(media_name, ':');
 153         if (if_name == NULL)
 154                 return 0;
 155         *(if_name++) = 0;
 156         media_len = if_name - media_name;
 157         if_len = strlen(if_name) + 1;
 158
 159         /* validate component parts of bearer name */
 160         if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) ||
 161             (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME))
 162                 return 0;
 163
 164         /* return bearer name components, if necessary */
 165         if (name_parts) {
 166                 strcpy(name_parts->media_name, media_name);
 167                 strcpy(name_parts->if_name, if_name);
 168         }
 169         return 1;
 170 }
 171
 172 /**
 173  * tipc_bearer_find - locates bearer object with matching bearer name
 174  */
 175 struct tipc_bearer *tipc_bearer_find(const char *name)
 176 {
 177         struct tipc_bearer *b_ptr;
 178         u32 i;
 179
 180         for (i = 0, b_ptr = tipc_bearers; i < MAX_BEARERS; i++, b_ptr++) {
 181                 if (b_ptr->active && (!strcmp(b_ptr->name, name)))
 182                         return b_ptr;
 183         }
 184         return NULL;
 185 }
 186
 187 /**
 188  * tipc_bearer_get_names - record names of bearers in buffer
 189  */
 190 struct sk_buff *tipc_bearer_get_names(void)
 191 {
 192         struct sk_buff *buf;
 193         struct tipc_bearer *b;
 194         int i, j;
 195
 196         buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
 197         if (!buf)
 198                 return NULL;
 199
 200         read_lock_bh(&tipc_net_lock);
 201         for (i = 0; media_info_array[i] != NULL; i++) {
 202                 for (j = 0; j < MAX_BEARERS; j++) {
 203                         b = &tipc_bearers[j];
 204                         if (b->active && (b->media == media_info_array[i])) {
 205                                 tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
 206                                                     b->name,
 207                                                     strlen(b->name) + 1);
 208                         }
 209                 }
 210         }
 211         read_unlock_bh(&tipc_net_lock);
 212         return buf;
 213 }
 214
 215 void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest)
 216 {
 217         tipc_nmap_add(&b_ptr->nodes, dest);
 218         tipc_bcbearer_sort();
 219         tipc_disc_add_dest(b_ptr->link_req);
 220 }
 221
 222 void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest)
 223 {
 224         tipc_nmap_remove(&b_ptr->nodes, dest);
 225         tipc_bcbearer_sort();
 226         tipc_disc_remove_dest(b_ptr->link_req);
 227 }
 228
 229 /**
 230  * tipc_enable_bearer - enable bearer with the given name
 231  */
 232 int tipc_enable_bearer(const char *name, u32 disc_domain, u32 priority)
 233 {
 234         struct tipc_bearer *b_ptr;
 235         struct tipc_media *m_ptr;
 236         struct tipc_bearer_names b_names;
 237         char addr_string[16];
 238         u32 bearer_id;
 239         u32 with_this_prio;
 240         u32 i;
 241         int res = -EINVAL;
 242
 243         if (!tipc_own_addr) {
 244                 pr_warn("Bearer <%s> rejected, not supported in standalone mode\n",
 245                         name);
 246                 return -ENOPROTOOPT;
 247         }
 248         if (!bearer_name_validate(name, &b_names)) {
 249                 pr_warn("Bearer <%s> rejected, illegal name\n", name);
 250                 return -EINVAL;
 251         }
 252         if (tipc_addr_domain_valid(disc_domain) &&
 253             (disc_domain != tipc_own_addr)) {
 254                 if (tipc_in_scope(disc_domain, tipc_own_addr)) {
 255                         disc_domain = tipc_own_addr & TIPC_CLUSTER_MASK;
 256                         res = 0;   /* accept any node in own cluster */
 257                 } else if (in_own_cluster_exact(disc_domain))
 258                         res = 0;   /* accept specified node in own cluster */
 259         }
 260         if (res) {
 261                 pr_warn("Bearer <%s> rejected, illegal discovery domain\n",
 262                         name);
 263                 return -EINVAL;
 264         }
 265         if ((priority > TIPC_MAX_LINK_PRI) &&
 266             (priority != TIPC_MEDIA_LINK_PRI)) {
 267                 pr_warn("Bearer <%s> rejected, illegal priority\n", name);
 268                 return -EINVAL;
 269         }
 270
 271         write_lock_bh(&tipc_net_lock);
 272
 273         m_ptr = tipc_media_find(b_names.media_name);
 274         if (!m_ptr) {
 275                 pr_warn("Bearer <%s> rejected, media <%s> not registered\n",
 276                         name, b_names.media_name);
 277                 goto exit;
 278         }
 279
 280         if (priority == TIPC_MEDIA_LINK_PRI)
 281                 priority = m_ptr->priority;
 282
 283 restart:
 284         bearer_id = MAX_BEARERS;
 285         with_this_prio = 1;
 286         for (i = MAX_BEARERS; i-- != 0; ) {
 287                 if (!tipc_bearers[i].active) {
 288                         bearer_id = i;
 289                         continue;
 290                 }
 291                 if (!strcmp(name, tipc_bearers[i].name)) {
 292                         pr_warn("Bearer <%s> rejected, already enabled\n",
 293                                 name);
 294                         goto exit;
 295                 }
 296                 if ((tipc_bearers[i].priority == priority) &&
 297                     (++with_this_prio > 2)) {
 298                         if (priority-- == 0) {
 299                                 pr_warn("Bearer <%s> rejected, duplicate priority\n",
 300                                         name);
 301                                 goto exit;
 302                         }
 303                         pr_warn("Bearer <%s> priority adjustment required %u->%u\n",
 304                                 name, priority + 1, priority);
 305                         goto restart;
 306                 }
 307         }
 308         if (bearer_id >= MAX_BEARERS) {
 309                 pr_warn("Bearer <%s> rejected, bearer limit reached (%u)\n",
 310                         name, MAX_BEARERS);
 311                 goto exit;
 312         }
 313
 314         b_ptr = &tipc_bearers[bearer_id];
 315         strcpy(b_ptr->name, name);
 316         b_ptr->media = m_ptr;
 317         res = m_ptr->enable_media(b_ptr);
 318         if (res) {
 319                 pr_warn("Bearer <%s> rejected, enable failure (%d)\n",
 320                         name, -res);
 321                 goto exit;
 322         }
 323
 324         b_ptr->identity = bearer_id;
 325         b_ptr->tolerance = m_ptr->tolerance;
 326         b_ptr->window = m_ptr->window;
 327         b_ptr->net_plane = bearer_id + 'A';
 328         b_ptr->active = 1;
 329         b_ptr->priority = priority;
 330
 331         res = tipc_disc_create(b_ptr, &b_ptr->bcast_addr, disc_domain);
 332         if (res) {
 333                 bearer_disable(b_ptr, false);
 334                 pr_warn("Bearer <%s> rejected, discovery object creation failed\n",
 335                         name);
 336                 goto exit;
 337         }
 338         pr_info("Enabled bearer <%s>, discovery domain %s, priority %u\n",
 339                 name,
 340                 tipc_addr_string_fill(addr_string, disc_domain), priority);
 341 exit:
 342         write_unlock_bh(&tipc_net_lock);
 343         return res;
 344 }
 345
 346 /**
 347  * tipc_reset_bearer - Reset all links established over this bearer
 348  */
 349 static int tipc_reset_bearer(struct tipc_bearer *b_ptr)
 350 {
 351         read_lock_bh(&tipc_net_lock);
 352         pr_info("Resetting bearer <%s>\n", b_ptr->name);
 353         tipc_link_reset_list(b_ptr->identity);
 354         read_unlock_bh(&tipc_net_lock);
 355         return 0;
 356 }
 357
 358 /**
 359  * bearer_disable
 360  *
 361  * Note: This routine assumes caller holds tipc_net_lock.
 362  */
 363 static void bearer_disable(struct tipc_bearer *b_ptr, bool shutting_down)
 364 {
 365         pr_info("Disabling bearer <%s>\n", b_ptr->name);
 366         b_ptr->media->disable_media(b_ptr);
 367
 368         tipc_link_delete_list(b_ptr->identity, shutting_down);
 369         if (b_ptr->link_req)
 370                 tipc_disc_delete(b_ptr->link_req);
 371         memset(b_ptr, 0, sizeof(struct tipc_bearer));
 372 }
 373
 374 int tipc_disable_bearer(const char *name)
 375 {
 376         struct tipc_bearer *b_ptr;
 377         int res;
 378
 379         write_lock_bh(&tipc_net_lock);
 380         b_ptr = tipc_bearer_find(name);
 381         if (b_ptr == NULL) {
 382                 pr_warn("Attempt to disable unknown bearer <%s>\n", name);
 383                 res = -EINVAL;
 384         } else {
 385                 bearer_disable(b_ptr, false);
 386                 res = 0;
 387         }
 388         write_unlock_bh(&tipc_net_lock);
 389         return res;
 390 }
 391
 392
 393 /* tipc_l2_media_addr_set - initialize Ethernet media address structure
 394  *
 395  * Media-dependent "value" field stores MAC address in first 6 bytes
 396  * and zeroes out the remaining bytes.
 397  */
 398 void tipc_l2_media_addr_set(const struct tipc_bearer *b,
 399                             struct tipc_media_addr *a, char *mac)
 400 {
 401         int len = b->media->hwaddr_len;
 402
 403         if (unlikely(sizeof(a->value) < len)) {
 404                 WARN_ONCE(1, "Media length invalid\n");
 405                 return;
 406         }
 407
 408         memcpy(a->value, mac, len);
 409         memset(a->value + len, 0, sizeof(a->value) - len);
 410         a->media_id = b->media->type_id;
 411         a->broadcast = !memcmp(mac, b->bcast_addr.value, len);
 412 }
 413
 414 int tipc_enable_l2_media(struct tipc_bearer *b)
 415 {
 416         struct net_device *dev;
 417         char *driver_name = strchr((const char *)b->name, ':') + 1;
 418
 419         /* Find device with specified name */
 420         dev = dev_get_by_name(&init_net, driver_name);
 421         if (!dev)
 422                 return -ENODEV;
 423
 424         /* Associate TIPC bearer with Ethernet bearer */
 425         b->media_ptr = dev;
 426         memset(b->bcast_addr.value, 0, sizeof(b->bcast_addr.value));
 427         memcpy(b->bcast_addr.value, dev->broadcast, b->media->hwaddr_len);
 428         b->bcast_addr.media_id = b->media->type_id;
 429         b->bcast_addr.broadcast = 1;
 430         b->mtu = dev->mtu;
 431         tipc_l2_media_addr_set(b, &b->addr, (char *)dev->dev_addr);
 432         rcu_assign_pointer(dev->tipc_ptr, b);
 433         return 0;
 434 }
 435
 436 /* tipc_disable_l2_media - detach TIPC bearer from an Ethernet interface
 437  *
 438  * Mark Ethernet bearer as inactive so that incoming buffers are thrown away,
 439  * then get worker thread to complete bearer cleanup.  (Can't do cleanup
 440  * here because cleanup code needs to sleep and caller holds spinlocks.)
 441  */
 442 void tipc_disable_l2_media(struct tipc_bearer *b)
 443 {
 444         struct net_device *dev = (struct net_device *)b->media_ptr;
 445         RCU_INIT_POINTER(dev->tipc_ptr, NULL);
 446         dev_put(dev);
 447 }
 448
 449 /**
 450  * tipc_l2_send_msg - send a TIPC packet out over an Ethernet interface
 451  * @buf: the packet to be sent
 452  * @b_ptr: the bearer through which the packet is to be sent
 453  * @dest: peer destination address
 454  */
 455 int tipc_l2_send_msg(struct sk_buff *buf, struct tipc_bearer *b,
 456                      struct tipc_media_addr *dest)
 457 {
 458         struct sk_buff *clone;
 459         int delta;
 460         struct net_device *dev = (struct net_device *)b->media_ptr;
 461
 462         clone = skb_clone(buf, GFP_ATOMIC);
 463         if (!clone)
 464                 return 0;
 465
 466         delta = dev->hard_header_len - skb_headroom(buf);
 467         if ((delta > 0) &&
 468             pskb_expand_head(clone, SKB_DATA_ALIGN(delta), 0, GFP_ATOMIC)) {
 469                 kfree_skb(clone);
 470                 return 0;
 471         }
 472
 473         skb_reset_network_header(clone);
 474         clone->dev = dev;
 475         clone->protocol = htons(ETH_P_TIPC);
 476         dev_hard_header(clone, dev, ETH_P_TIPC, dest->value,
 477                         dev->dev_addr, clone->len);
 478         dev_queue_xmit(clone);
 479         return 0;
 480 }
 481
 482 /* tipc_bearer_send- sends buffer to destination over bearer
 483  *
 484  * IMPORTANT:
 485  * The media send routine must not alter the buffer being passed in
 486  * as it may be needed for later retransmission!
 487  */
 488 void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf,
 489                       struct tipc_media_addr *dest)
 490 {
 491         b->media->send_msg(buf, b, dest);
 492 }
 493
 494 /**
 495  * tipc_l2_rcv_msg - handle incoming TIPC message from an interface
 496  * @buf: the received packet
 497  * @dev: the net device that the packet was received on
 498  * @pt: the packet_type structure which was used to register this handler
 499  * @orig_dev: the original receive net device in case the device is a bond
 500  *
 501  * Accept only packets explicitly sent to this node, or broadcast packets;
 502  * ignores packets sent using interface multicast, and traffic sent to other
 503  * nodes (which can happen if interface is running in promiscuous mode).
 504  */
 505 static int tipc_l2_rcv_msg(struct sk_buff *buf, struct net_device *dev,
 506                            struct packet_type *pt, struct net_device *orig_dev)
 507 {
 508         struct tipc_bearer *b_ptr;
 509
 510         if (!net_eq(dev_net(dev), &init_net)) {
 511                 kfree_skb(buf);
 512                 return NET_RX_DROP;
 513         }
 514
 515         rcu_read_lock();
 516         b_ptr = rcu_dereference(dev->tipc_ptr);
 517         if (likely(b_ptr)) {
 518                 if (likely(buf->pkt_type <= PACKET_BROADCAST)) {
 519                         buf->next = NULL;
 520                         tipc_rcv(buf, b_ptr);
 521                         rcu_read_unlock();
 522                         return NET_RX_SUCCESS;
 523                 }
 524         }
 525         rcu_read_unlock();
 526
 527         kfree_skb(buf);
 528         return NET_RX_DROP;
 529 }
 530
 531 /**
 532  * tipc_l2_device_event - handle device events from network device
 533  * @nb: the context of the notification
 534  * @evt: the type of event
 535  * @ptr: the net device that the event was on
 536  *
 537  * This function is called by the Ethernet driver in case of link
 538  * change event.
 539  */
 540 static int tipc_l2_device_event(struct notifier_block *nb, unsigned long evt,
 541                                 void *ptr)
 542 {
 543         struct tipc_bearer *b_ptr;
 544         struct net_device *dev = netdev_notifier_info_to_dev(ptr);
 545
 546         if (!net_eq(dev_net(dev), &init_net))
 547                 return NOTIFY_DONE;
 548
 549         rcu_read_lock();
 550         b_ptr = rcu_dereference(dev->tipc_ptr);
 551         if (!b_ptr) {
 552                 rcu_read_unlock();
 553                 return NOTIFY_DONE;
 554         }
 555
 556         b_ptr->mtu = dev->mtu;
 557
 558         switch (evt) {
 559         case NETDEV_CHANGE:
 560                 if (netif_carrier_ok(dev))
 561                         break;
 562         case NETDEV_DOWN:
 563         case NETDEV_CHANGEMTU:
 564         case NETDEV_CHANGEADDR:
 565                 tipc_reset_bearer(b_ptr);
 566                 break;
 567         case NETDEV_UNREGISTER:
 568         case NETDEV_CHANGENAME:
 569                 tipc_disable_bearer(b_ptr->name);
 570                 break;
 571         }
 572         rcu_read_unlock();
 573
 574         return NOTIFY_OK;
 575 }
 576
 577 static struct packet_type tipc_packet_type __read_mostly = {
 578         .type = htons(ETH_P_TIPC),
 579         .func = tipc_l2_rcv_msg,
 580 };
 581
 582 static struct notifier_block notifier = {
 583         .notifier_call  = tipc_l2_device_event,
 584         .priority       = 0,
 585 };
 586
 587 int tipc_bearer_setup(void)
 588 {
 589         int err;
 590
 591         err = register_netdevice_notifier(&notifier);
 592         if (err)
 593                 return err;
 594         dev_add_pack(&tipc_packet_type);
 595         return 0;
 596 }
 597
 598 void tipc_bearer_cleanup(void)
 599 {
 600         unregister_netdevice_notifier(&notifier);
 601         dev_remove_pack(&tipc_packet_type);
 602 }
 603
 604 void tipc_bearer_stop(void)
 605 {
 606         u32 i;
 607
 608         for (i = 0; i < MAX_BEARERS; i++) {
 609                 if (tipc_bearers[i].active)
 610                         bearer_disable(&tipc_bearers[i], true);
 611         }
 612 }