net/tipc/eth_media.c

   1 /*
   2  * net/tipc/eth_media.c: Ethernet bearer support for TIPC
   3  *
   4  * Copyright (c) 2001-2007, Ericsson AB
   5  * Copyright (c) 2005-2008, 2011, 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 "bearer.h"
  39
  40 #define MAX_ETH_BEARERS         MAX_BEARERS
  41
  42 #define ETH_ADDR_OFFSET 4       /* message header offset of MAC address */
  43
  44 /**
  45  * struct eth_bearer - Ethernet bearer data structure
  46  * @bearer: ptr to associated "generic" bearer structure
  47  * @dev: ptr to associated Ethernet network device
  48  * @tipc_packet_type: used in binding TIPC to Ethernet driver
  49  */
  50
  51 struct eth_bearer {
  52         struct tipc_bearer *bearer;
  53         struct net_device *dev;
  54         struct packet_type tipc_packet_type;
  55 };
  56
  57 static struct eth_bearer eth_bearers[MAX_ETH_BEARERS];
  58 static int eth_started;
  59 static struct notifier_block notifier;
  60
  61 /**
  62  * eth_media_addr_set - initialize Ethernet media address structure
  63  */
  64
  65 static void eth_media_addr_set(struct tipc_media_addr *a, char *mac)
  66 {
  67         a->type = htonl(TIPC_MEDIA_TYPE_ETH);
  68         memcpy(&a->dev_addr.eth_addr, mac, ETH_ALEN);
  69 }
  70
  71 /**
  72  * send_msg - send a TIPC message out over an Ethernet interface
  73  */
  74
  75 static int send_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr,
  76                     struct tipc_media_addr *dest)
  77 {
  78         struct sk_buff *clone;
  79         struct net_device *dev;
  80         int delta;
  81
  82         clone = skb_clone(buf, GFP_ATOMIC);
  83         if (!clone)
  84                 return 0;
  85
  86         dev = ((struct eth_bearer *)(tb_ptr->usr_handle))->dev;
  87         delta = dev->hard_header_len - skb_headroom(buf);
  88
  89         if ((delta > 0) &&
  90             pskb_expand_head(clone, SKB_DATA_ALIGN(delta), 0, GFP_ATOMIC)) {
  91                 kfree_skb(clone);
  92                 return 0;
  93         }
  94
  95         skb_reset_network_header(clone);
  96         clone->dev = dev;
  97         dev_hard_header(clone, dev, ETH_P_TIPC, &dest->dev_addr.eth_addr,
  98                         dev->dev_addr, clone->len);
  99         dev_queue_xmit(clone);
 100         return 0;
 101 }
 102
 103 /**
 104  * recv_msg - handle incoming TIPC message from an Ethernet interface
 105  *
 106  * Accept only packets explicitly sent to this node, or broadcast packets;
 107  * ignores packets sent using Ethernet multicast, and traffic sent to other
 108  * nodes (which can happen if interface is running in promiscuous mode).
 109  */
 110
 111 static int recv_msg(struct sk_buff *buf, struct net_device *dev,
 112                     struct packet_type *pt, struct net_device *orig_dev)
 113 {
 114         struct eth_bearer *eb_ptr = (struct eth_bearer *)pt->af_packet_priv;
 115
 116         if (!net_eq(dev_net(dev), &init_net)) {
 117                 kfree_skb(buf);
 118                 return 0;
 119         }
 120
 121         if (likely(eb_ptr->bearer)) {
 122                 if (likely(buf->pkt_type <= PACKET_BROADCAST)) {
 123                         buf->next = NULL;
 124                         tipc_recv_msg(buf, eb_ptr->bearer);
 125                         return 0;
 126                 }
 127         }
 128         kfree_skb(buf);
 129         return 0;
 130 }
 131
 132 /**
 133  * enable_bearer - attach TIPC bearer to an Ethernet interface
 134  */
 135
 136 static int enable_bearer(struct tipc_bearer *tb_ptr)
 137 {
 138         struct net_device *dev = NULL;
 139         struct net_device *pdev = NULL;
 140         struct eth_bearer *eb_ptr = &eth_bearers[0];
 141         struct eth_bearer *stop = &eth_bearers[MAX_ETH_BEARERS];
 142         char *driver_name = strchr((const char *)tb_ptr->name, ':') + 1;
 143         int pending_dev = 0;
 144
 145         /* Find unused Ethernet bearer structure */
 146
 147         while (eb_ptr->dev) {
 148                 if (!eb_ptr->bearer)
 149                         pending_dev++;
 150                 if (++eb_ptr == stop)
 151                         return pending_dev ? -EAGAIN : -EDQUOT;
 152         }
 153
 154         /* Find device with specified name */
 155
 156         read_lock(&dev_base_lock);
 157         for_each_netdev(&init_net, pdev) {
 158                 if (!strncmp(pdev->name, driver_name, IFNAMSIZ)) {
 159                         dev = pdev;
 160                         dev_hold(dev);
 161                         break;
 162                 }
 163         }
 164         read_unlock(&dev_base_lock);
 165         if (!dev)
 166                 return -ENODEV;
 167
 168         /* Create Ethernet bearer for device */
 169
 170         eb_ptr->dev = dev;
 171         eb_ptr->tipc_packet_type.type = htons(ETH_P_TIPC);
 172         eb_ptr->tipc_packet_type.dev = dev;
 173         eb_ptr->tipc_packet_type.func = recv_msg;
 174         eb_ptr->tipc_packet_type.af_packet_priv = eb_ptr;
 175         INIT_LIST_HEAD(&(eb_ptr->tipc_packet_type.list));
 176         dev_add_pack(&eb_ptr->tipc_packet_type);
 177
 178         /* Associate TIPC bearer with Ethernet bearer */
 179
 180         eb_ptr->bearer = tb_ptr;
 181         tb_ptr->usr_handle = (void *)eb_ptr;
 182         tb_ptr->mtu = dev->mtu;
 183         tb_ptr->blocked = 0;
 184         eth_media_addr_set(&tb_ptr->addr, (char *)dev->dev_addr);
 185         return 0;
 186 }
 187
 188 /**
 189  * disable_bearer - detach TIPC bearer from an Ethernet interface
 190  *
 191  * We really should do dev_remove_pack() here, but this function can not be
 192  * called at tasklet level. => Use eth_bearer->bearer as a flag to throw away
 193  * incoming buffers, & postpone dev_remove_pack() to eth_media_stop() on exit.
 194  */
 195
 196 static void disable_bearer(struct tipc_bearer *tb_ptr)
 197 {
 198         ((struct eth_bearer *)tb_ptr->usr_handle)->bearer = NULL;
 199 }
 200
 201 /**
 202  * recv_notification - handle device updates from OS
 203  *
 204  * Change the state of the Ethernet bearer (if any) associated with the
 205  * specified device.
 206  */
 207
 208 static int recv_notification(struct notifier_block *nb, unsigned long evt,
 209                              void *dv)
 210 {
 211         struct net_device *dev = (struct net_device *)dv;
 212         struct eth_bearer *eb_ptr = &eth_bearers[0];
 213         struct eth_bearer *stop = &eth_bearers[MAX_ETH_BEARERS];
 214
 215         if (!net_eq(dev_net(dev), &init_net))
 216                 return NOTIFY_DONE;
 217
 218         while ((eb_ptr->dev != dev)) {
 219                 if (++eb_ptr == stop)
 220                         return NOTIFY_DONE;     /* couldn't find device */
 221         }
 222         if (!eb_ptr->bearer)
 223                 return NOTIFY_DONE;             /* bearer had been disabled */
 224
 225         eb_ptr->bearer->mtu = dev->mtu;
 226
 227         switch (evt) {
 228         case NETDEV_CHANGE:
 229                 if (netif_carrier_ok(dev))
 230                         tipc_continue(eb_ptr->bearer);
 231                 else
 232                         tipc_block_bearer(eb_ptr->bearer->name);
 233                 break;
 234         case NETDEV_UP:
 235                 tipc_continue(eb_ptr->bearer);
 236                 break;
 237         case NETDEV_DOWN:
 238                 tipc_block_bearer(eb_ptr->bearer->name);
 239                 break;
 240         case NETDEV_CHANGEMTU:
 241         case NETDEV_CHANGEADDR:
 242                 tipc_block_bearer(eb_ptr->bearer->name);
 243                 tipc_continue(eb_ptr->bearer);
 244                 break;
 245         case NETDEV_UNREGISTER:
 246         case NETDEV_CHANGENAME:
 247                 tipc_disable_bearer(eb_ptr->bearer->name);
 248                 break;
 249         }
 250         return NOTIFY_OK;
 251 }
 252
 253 /**
 254  * eth_addr2str - convert Ethernet address to string
 255  */
 256
 257 static int eth_addr2str(struct tipc_media_addr *a, char *str_buf, int str_size)
 258 {
 259         unchar *addr = (unchar *)&a->dev_addr;
 260
 261         if (str_size < 18)      /* 18 = strlen("aa:bb:cc:dd:ee:ff\0") */
 262                 return 1;
 263
 264         sprintf(str_buf, "%pM", addr);
 265         return 0;
 266 }
 267
 268 /**
 269  * eth_str2addr - convert string to Ethernet address
 270  */
 271
 272 static int eth_str2addr(struct tipc_media_addr *a, char *str_buf)
 273 {
 274         char mac[ETH_ALEN];
 275         int r;
 276
 277         r = sscanf(str_buf, "%02x:%02x:%02x:%02x:%02x:%02x",
 278                        (u32 *)&mac[0], (u32 *)&mac[1], (u32 *)&mac[2],
 279                        (u32 *)&mac[3], (u32 *)&mac[4], (u32 *)&mac[5]);
 280
 281         if (r != ETH_ALEN)
 282                 return 1;
 283
 284         eth_media_addr_set(a, mac);
 285         return 0;
 286 }
 287
 288 /**
 289  * eth_str2addr - convert Ethernet address format to message header format
 290  */
 291
 292 static int eth_addr2msg(struct tipc_media_addr *a, char *msg_area)
 293 {
 294         memset(msg_area, 0, TIPC_MEDIA_ADDR_SIZE);
 295         msg_area[TIPC_MEDIA_TYPE_OFFSET] = TIPC_MEDIA_TYPE_ETH;
 296         memcpy(msg_area + ETH_ADDR_OFFSET, a->dev_addr.eth_addr, ETH_ALEN);
 297         return 0;
 298 }
 299
 300 /**
 301  * eth_str2addr - convert message header address format to Ethernet format
 302  */
 303
 304 static int eth_msg2addr(struct tipc_media_addr *a, char *msg_area)
 305 {
 306         if (msg_area[TIPC_MEDIA_TYPE_OFFSET] != TIPC_MEDIA_TYPE_ETH)
 307                 return 1;
 308
 309         eth_media_addr_set(a, msg_area + ETH_ADDR_OFFSET);
 310         return 0;
 311 }
 312
 313 /*
 314  * Ethernet media registration info
 315  */
 316
 317 static struct media eth_media_info = {
 318         .send_msg       = send_msg,
 319         .enable_bearer  = enable_bearer,
 320         .disable_bearer = disable_bearer,
 321         .addr2str       = eth_addr2str,
 322         .str2addr       = eth_str2addr,
 323         .addr2msg       = eth_addr2msg,
 324         .msg2addr       = eth_msg2addr,
 325         .bcast_addr     = { htonl(TIPC_MEDIA_TYPE_ETH),
 326                             { {0xff, 0xff, 0xff, 0xff, 0xff, 0xff} } },
 327         .priority       = TIPC_DEF_LINK_PRI,
 328         .tolerance      = TIPC_DEF_LINK_TOL,
 329         .window         = TIPC_DEF_LINK_WIN,
 330         .type_id        = TIPC_MEDIA_TYPE_ETH,
 331         .name           = "eth"
 332 };
 333
 334 /**
 335  * tipc_eth_media_start - activate Ethernet bearer support
 336  *
 337  * Register Ethernet media type with TIPC bearer code.  Also register
 338  * with OS for notifications about device state changes.
 339  */
 340
 341 int tipc_eth_media_start(void)
 342 {
 343         int res;
 344
 345         if (eth_started)
 346                 return -EINVAL;
 347
 348         memset(eth_bearers, 0, sizeof(eth_bearers));
 349
 350         res = tipc_register_media(&eth_media_info);
 351         if (res)
 352                 return res;
 353
 354         notifier.notifier_call = &recv_notification;
 355         notifier.priority = 0;
 356         res = register_netdevice_notifier(&notifier);
 357         if (!res)
 358                 eth_started = 1;
 359         return res;
 360 }
 361
 362 /**
 363  * tipc_eth_media_stop - deactivate Ethernet bearer support
 364  */
 365
 366 void tipc_eth_media_stop(void)
 367 {
 368         int i;
 369
 370         if (!eth_started)
 371                 return;
 372
 373         unregister_netdevice_notifier(&notifier);
 374         for (i = 0; i < MAX_ETH_BEARERS ; i++) {
 375                 if (eth_bearers[i].bearer) {
 376                         eth_bearers[i].bearer->blocked = 1;
 377                         eth_bearers[i].bearer = NULL;
 378                 }
 379                 if (eth_bearers[i].dev) {
 380                         dev_remove_pack(&eth_bearers[i].tipc_packet_type);
 381                         dev_put(eth_bearers[i].dev);
 382                 }
 383         }
 384         memset(&eth_bearers, 0, sizeof(eth_bearers));
 385         eth_started = 0;
 386 }