net/ethernet/eth.c

   1 /*
   2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
   3  *              operating system.  INET is implemented using the  BSD Socket
   4  *              interface as the means of communication with the user level.
   5  *
   6  *              Ethernet-type device handling.
   7  *
   8  * Version:     @(#)eth.c       1.0.7   05/25/93
   9  *
  10  * Authors:     Ross Biro
  11  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12  *              Mark Evans, <evansmp@uhura.aston.ac.uk>
  13  *              Florian  La Roche, <rzsfl@rz.uni-sb.de>
  14  *              Alan Cox, <gw4pts@gw4pts.ampr.org>
  15  *
  16  * Fixes:
  17  *              Mr Linux        : Arp problems
  18  *              Alan Cox        : Generic queue tidyup (very tiny here)
  19  *              Alan Cox        : eth_header ntohs should be htons
  20  *              Alan Cox        : eth_rebuild_header missing an htons and
  21  *                                minor other things.
  22  *              Tegge           : Arp bug fixes.
  23  *              Florian         : Removed many unnecessary functions, code cleanup
  24  *                                and changes for new arp and skbuff.
  25  *              Alan Cox        : Redid header building to reflect new format.
  26  *              Alan Cox        : ARP only when compiled with CONFIG_INET
  27  *              Greg Page       : 802.2 and SNAP stuff.
  28  *              Alan Cox        : MAC layer pointers/new format.
  29  *              Paul Gortmaker  : eth_copy_and_sum shouldn't csum padding.
  30  *              Alan Cox        : Protect against forwarding explosions with
  31  *                                older network drivers and IFF_ALLMULTI.
  32  *      Christer Weinigel       : Better rebuild header message.
  33  *             Andrew Morton    : 26Feb01: kill ether_setup() - use netdev_boot_setup().
  34  *
  35  *              This program is free software; you can redistribute it and/or
  36  *              modify it under the terms of the GNU General Public License
  37  *              as published by the Free Software Foundation; either version
  38  *              2 of the License, or (at your option) any later version.
  39  */
  40 #include <linux/module.h>
  41 #include <linux/types.h>
  42 #include <linux/kernel.h>
  43 #include <linux/string.h>
  44 #include <linux/mm.h>
  45 #include <linux/socket.h>
  46 #include <linux/in.h>
  47 #include <linux/inet.h>
  48 #include <linux/ip.h>
  49 #include <linux/netdevice.h>
  50 #include <linux/nvmem-consumer.h>
  51 #include <linux/etherdevice.h>
  52 #include <linux/skbuff.h>
  53 #include <linux/errno.h>
  54 #include <linux/init.h>
  55 #include <linux/if_ether.h>
  56 #include <linux/of_net.h>
  57 #include <linux/pci.h>
  58 #include <net/dst.h>
  59 #include <net/arp.h>
  60 #include <net/sock.h>
  61 #include <net/ipv6.h>
  62 #include <net/ip.h>
  63 #include <net/dsa.h>
  64 #include <net/flow_dissector.h>
  65 #include <linux/uaccess.h>
  66 #include <net/pkt_sched.h>
  67
  68 __setup("ether=", netdev_boot_setup);
  69
  70 /**
  71  * eth_header - create the Ethernet header
  72  * @skb:        buffer to alter
  73  * @dev:        source device
  74  * @type:       Ethernet type field
  75  * @daddr: destination address (NULL leave destination address)
  76  * @saddr: source address (NULL use device source address)
  77  * @len:   packet length (<= skb->len)
  78  *
  79  *
  80  * Set the protocol type. For a packet of type ETH_P_802_3/2 we put the length
  81  * in here instead.
  82  */
  83 int eth_header(struct sk_buff *skb, struct net_device *dev,
  84                unsigned short type,
  85                const void *daddr, const void *saddr, unsigned int len)
  86 {
  87         struct ethhdr *eth = skb_push(skb, ETH_HLEN);
  88
  89         if (type != ETH_P_802_3 && type != ETH_P_802_2)
  90                 eth->h_proto = htons(type);
  91         else
  92                 eth->h_proto = htons(len);
  93
  94         /*
  95          *      Set the source hardware address.
  96          */
  97
  98         if (!saddr)
  99                 saddr = dev->dev_addr;
 100         memcpy(eth->h_source, saddr, ETH_ALEN);
 101
 102         if (daddr) {
 103                 memcpy(eth->h_dest, daddr, ETH_ALEN);
 104                 return ETH_HLEN;
 105         }
 106
 107         /*
 108          *      Anyway, the loopback-device should never use this function...
 109          */
 110
 111         if (dev->flags & (IFF_LOOPBACK | IFF_NOARP)) {
 112                 eth_zero_addr(eth->h_dest);
 113                 return ETH_HLEN;
 114         }
 115
 116         return -ETH_HLEN;
 117 }
 118 EXPORT_SYMBOL(eth_header);
 119
 120 /**
 121  * eth_get_headlen - determine the length of header for an ethernet frame
 122  * @data: pointer to start of frame
 123  * @len: total length of frame
 124  *
 125  * Make a best effort attempt to pull the length for all of the headers for
 126  * a given frame in a linear buffer.
 127  */
 128 u32 eth_get_headlen(void *data, unsigned int len)
 129 {
 130         const unsigned int flags = FLOW_DISSECTOR_F_PARSE_1ST_FRAG;
 131         const struct ethhdr *eth = (const struct ethhdr *)data;
 132         struct flow_keys_basic keys;
 133
 134         /* this should never happen, but better safe than sorry */
 135         if (unlikely(len < sizeof(*eth)))
 136                 return len;
 137
 138         /* parse any remaining L2/L3 headers, check for L4 */
 139         if (!skb_flow_dissect_flow_keys_basic(NULL, &keys, data, eth->h_proto,
 140                                               sizeof(*eth), len, flags))
 141                 return max_t(u32, keys.control.thoff, sizeof(*eth));
 142
 143         /* parse for any L4 headers */
 144         return min_t(u32, __skb_get_poff(NULL, data, &keys, len), len);
 145 }
 146 EXPORT_SYMBOL(eth_get_headlen);
 147
 148 /**
 149  * eth_type_trans - determine the packet's protocol ID.
 150  * @skb: received socket data
 151  * @dev: receiving network device
 152  *
 153  * The rule here is that we
 154  * assume 802.3 if the type field is short enough to be a length.
 155  * This is normal practice and works for any 'now in use' protocol.
 156  */
 157 __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev)
 158 {
 159         unsigned short _service_access_point;
 160         const unsigned short *sap;
 161         const struct ethhdr *eth;
 162
 163         skb->dev = dev;
 164         skb_reset_mac_header(skb);
 165
 166         eth = (struct ethhdr *)skb->data;
 167         skb_pull_inline(skb, ETH_HLEN);
 168
 169         if (unlikely(!ether_addr_equal_64bits(eth->h_dest,
 170                                               dev->dev_addr))) {
 171                 if (unlikely(is_multicast_ether_addr_64bits(eth->h_dest))) {
 172                         if (ether_addr_equal_64bits(eth->h_dest, dev->broadcast))
 173                                 skb->pkt_type = PACKET_BROADCAST;
 174                         else
 175                                 skb->pkt_type = PACKET_MULTICAST;
 176                 } else {
 177                         skb->pkt_type = PACKET_OTHERHOST;
 178                 }
 179         }
 180
 181         /*
 182          * Some variants of DSA tagging don't have an ethertype field
 183          * at all, so we check here whether one of those tagging
 184          * variants has been configured on the receiving interface,
 185          * and if so, set skb->protocol without looking at the packet.
 186          */
 187         if (unlikely(netdev_uses_dsa(dev)))
 188                 return htons(ETH_P_XDSA);
 189
 190         if (likely(eth_proto_is_802_3(eth->h_proto)))
 191                 return eth->h_proto;
 192
 193         /*
 194          *      This is a magic hack to spot IPX packets. Older Novell breaks
 195          *      the protocol design and runs IPX over 802.3 without an 802.2 LLC
 196          *      layer. We look for FFFF which isn't a used 802.2 SSAP/DSAP. This
 197          *      won't work for fault tolerant netware but does for the rest.
 198          */
 199         sap = skb_header_pointer(skb, 0, sizeof(*sap), &_service_access_point);
 200         if (sap && *sap == 0xFFFF)
 201                 return htons(ETH_P_802_3);
 202
 203         /*
 204          *      Real 802.2 LLC
 205          */
 206         return htons(ETH_P_802_2);
 207 }
 208 EXPORT_SYMBOL(eth_type_trans);
 209
 210 /**
 211  * eth_header_parse - extract hardware address from packet
 212  * @skb: packet to extract header from
 213  * @haddr: destination buffer
 214  */
 215 int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr)
 216 {
 217         const struct ethhdr *eth = eth_hdr(skb);
 218         memcpy(haddr, eth->h_source, ETH_ALEN);
 219         return ETH_ALEN;
 220 }
 221 EXPORT_SYMBOL(eth_header_parse);
 222
 223 /**
 224  * eth_header_cache - fill cache entry from neighbour
 225  * @neigh: source neighbour
 226  * @hh: destination cache entry
 227  * @type: Ethernet type field
 228  *
 229  * Create an Ethernet header template from the neighbour.
 230  */
 231 int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type)
 232 {
 233         struct ethhdr *eth;
 234         const struct net_device *dev = neigh->dev;
 235
 236         eth = (struct ethhdr *)
 237             (((u8 *) hh->hh_data) + (HH_DATA_OFF(sizeof(*eth))));
 238
 239         if (type == htons(ETH_P_802_3))
 240                 return -1;
 241
 242         eth->h_proto = type;
 243         memcpy(eth->h_source, dev->dev_addr, ETH_ALEN);
 244         memcpy(eth->h_dest, neigh->ha, ETH_ALEN);
 245         hh->hh_len = ETH_HLEN;
 246         return 0;
 247 }
 248 EXPORT_SYMBOL(eth_header_cache);
 249
 250 /**
 251  * eth_header_cache_update - update cache entry
 252  * @hh: destination cache entry
 253  * @dev: network device
 254  * @haddr: new hardware address
 255  *
 256  * Called by Address Resolution module to notify changes in address.
 257  */
 258 void eth_header_cache_update(struct hh_cache *hh,
 259                              const struct net_device *dev,
 260                              const unsigned char *haddr)
 261 {
 262         memcpy(((u8 *) hh->hh_data) + HH_DATA_OFF(sizeof(struct ethhdr)),
 263                haddr, ETH_ALEN);
 264 }
 265 EXPORT_SYMBOL(eth_header_cache_update);
 266
 267 /**
 268  * eth_prepare_mac_addr_change - prepare for mac change
 269  * @dev: network device
 270  * @p: socket address
 271  */
 272 int eth_prepare_mac_addr_change(struct net_device *dev, void *p)
 273 {
 274         struct sockaddr *addr = p;
 275
 276         if (!(dev->priv_flags & IFF_LIVE_ADDR_CHANGE) && netif_running(dev))
 277                 return -EBUSY;
 278         if (!is_valid_ether_addr(addr->sa_data))
 279                 return -EADDRNOTAVAIL;
 280         return 0;
 281 }
 282 EXPORT_SYMBOL(eth_prepare_mac_addr_change);
 283
 284 /**
 285  * eth_commit_mac_addr_change - commit mac change
 286  * @dev: network device
 287  * @p: socket address
 288  */
 289 void eth_commit_mac_addr_change(struct net_device *dev, void *p)
 290 {
 291         struct sockaddr *addr = p;
 292
 293         memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
 294 }
 295 EXPORT_SYMBOL(eth_commit_mac_addr_change);
 296
 297 /**
 298  * eth_mac_addr - set new Ethernet hardware address
 299  * @dev: network device
 300  * @p: socket address
 301  *
 302  * Change hardware address of device.
 303  *
 304  * This doesn't change hardware matching, so needs to be overridden
 305  * for most real devices.
 306  */
 307 int eth_mac_addr(struct net_device *dev, void *p)
 308 {
 309         int ret;
 310
 311         ret = eth_prepare_mac_addr_change(dev, p);
 312         if (ret < 0)
 313                 return ret;
 314         eth_commit_mac_addr_change(dev, p);
 315         return 0;
 316 }
 317 EXPORT_SYMBOL(eth_mac_addr);
 318
 319 /**
 320  * eth_change_mtu - set new MTU size
 321  * @dev: network device
 322  * @new_mtu: new Maximum Transfer Unit
 323  *
 324  * Allow changing MTU size. Needs to be overridden for devices
 325  * supporting jumbo frames.
 326  */
 327 int eth_change_mtu(struct net_device *dev, int new_mtu)
 328 {
 329         netdev_warn(dev, "%s is deprecated\n", __func__);
 330         dev->mtu = new_mtu;
 331         return 0;
 332 }
 333 EXPORT_SYMBOL(eth_change_mtu);
 334
 335 int eth_validate_addr(struct net_device *dev)
 336 {
 337         if (!is_valid_ether_addr(dev->dev_addr))
 338                 return -EADDRNOTAVAIL;
 339
 340         return 0;
 341 }
 342 EXPORT_SYMBOL(eth_validate_addr);
 343
 344 const struct header_ops eth_header_ops ____cacheline_aligned = {
 345         .create         = eth_header,
 346         .parse          = eth_header_parse,
 347         .cache          = eth_header_cache,
 348         .cache_update   = eth_header_cache_update,
 349 };
 350
 351 /**
 352  * ether_setup - setup Ethernet network device
 353  * @dev: network device
 354  *
 355  * Fill in the fields of the device structure with Ethernet-generic values.
 356  */
 357 void ether_setup(struct net_device *dev)
 358 {
 359         dev->header_ops         = &eth_header_ops;
 360         dev->type               = ARPHRD_ETHER;
 361         dev->hard_header_len    = ETH_HLEN;
 362         dev->min_header_len     = ETH_HLEN;
 363         dev->mtu                = ETH_DATA_LEN;
 364         dev->min_mtu            = ETH_MIN_MTU;
 365         dev->max_mtu            = ETH_DATA_LEN;
 366         dev->addr_len           = ETH_ALEN;
 367         dev->tx_queue_len       = DEFAULT_TX_QUEUE_LEN;
 368         dev->flags              = IFF_BROADCAST|IFF_MULTICAST;
 369         dev->priv_flags         |= IFF_TX_SKB_SHARING;
 370
 371         eth_broadcast_addr(dev->broadcast);
 372
 373 }
 374 EXPORT_SYMBOL(ether_setup);
 375
 376 /**
 377  * alloc_etherdev_mqs - Allocates and sets up an Ethernet device
 378  * @sizeof_priv: Size of additional driver-private structure to be allocated
 379  *      for this Ethernet device
 380  * @txqs: The number of TX queues this device has.
 381  * @rxqs: The number of RX queues this device has.
 382  *
 383  * Fill in the fields of the device structure with Ethernet-generic
 384  * values. Basically does everything except registering the device.
 385  *
 386  * Constructs a new net device, complete with a private data area of
 387  * size (sizeof_priv).  A 32-byte (not bit) alignment is enforced for
 388  * this private data area.
 389  */
 390
 391 struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
 392                                       unsigned int rxqs)
 393 {
 394         return alloc_netdev_mqs(sizeof_priv, "eth%d", NET_NAME_UNKNOWN,
 395                                 ether_setup, txqs, rxqs);
 396 }
 397 EXPORT_SYMBOL(alloc_etherdev_mqs);
 398
 399 static void devm_free_netdev(struct device *dev, void *res)
 400 {
 401         free_netdev(*(struct net_device **)res);
 402 }
 403
 404 struct net_device *devm_alloc_etherdev_mqs(struct device *dev, int sizeof_priv,
 405                                            unsigned int txqs, unsigned int rxqs)
 406 {
 407         struct net_device **dr;
 408         struct net_device *netdev;
 409
 410         dr = devres_alloc(devm_free_netdev, sizeof(*dr), GFP_KERNEL);
 411         if (!dr)
 412                 return NULL;
 413
 414         netdev = alloc_etherdev_mqs(sizeof_priv, txqs, rxqs);
 415         if (!netdev) {
 416                 devres_free(dr);
 417                 return NULL;
 418         }
 419
 420         *dr = netdev;
 421         devres_add(dev, dr);
 422
 423         return netdev;
 424 }
 425 EXPORT_SYMBOL(devm_alloc_etherdev_mqs);
 426
 427 ssize_t sysfs_format_mac(char *buf, const unsigned char *addr, int len)
 428 {
 429         return scnprintf(buf, PAGE_SIZE, "%*phC\n", len, addr);
 430 }
 431 EXPORT_SYMBOL(sysfs_format_mac);
 432
 433 struct sk_buff *eth_gro_receive(struct list_head *head, struct sk_buff *skb)
 434 {
 435         const struct packet_offload *ptype;
 436         unsigned int hlen, off_eth;
 437         struct sk_buff *pp = NULL;
 438         struct ethhdr *eh, *eh2;
 439         struct sk_buff *p;
 440         __be16 type;
 441         int flush = 1;
 442
 443         off_eth = skb_gro_offset(skb);
 444         hlen = off_eth + sizeof(*eh);
 445         eh = skb_gro_header_fast(skb, off_eth);
 446         if (skb_gro_header_hard(skb, hlen)) {
 447                 eh = skb_gro_header_slow(skb, hlen, off_eth);
 448                 if (unlikely(!eh))
 449                         goto out;
 450         }
 451
 452         flush = 0;
 453
 454         list_for_each_entry(p, head, list) {
 455                 if (!NAPI_GRO_CB(p)->same_flow)
 456                         continue;
 457
 458                 eh2 = (struct ethhdr *)(p->data + off_eth);
 459                 if (compare_ether_header(eh, eh2)) {
 460                         NAPI_GRO_CB(p)->same_flow = 0;
 461                         continue;
 462                 }
 463         }
 464
 465         type = eh->h_proto;
 466
 467         rcu_read_lock();
 468         ptype = gro_find_receive_by_type(type);
 469         if (ptype == NULL) {
 470                 flush = 1;
 471                 goto out_unlock;
 472         }
 473
 474         skb_gro_pull(skb, sizeof(*eh));
 475         skb_gro_postpull_rcsum(skb, eh, sizeof(*eh));
 476         pp = call_gro_receive(ptype->callbacks.gro_receive, head, skb);
 477
 478 out_unlock:
 479         rcu_read_unlock();
 480 out:
 481         skb_gro_flush_final(skb, pp, flush);
 482
 483         return pp;
 484 }
 485 EXPORT_SYMBOL(eth_gro_receive);
 486
 487 int eth_gro_complete(struct sk_buff *skb, int nhoff)
 488 {
 489         struct ethhdr *eh = (struct ethhdr *)(skb->data + nhoff);
 490         __be16 type = eh->h_proto;
 491         struct packet_offload *ptype;
 492         int err = -ENOSYS;
 493
 494         if (skb->encapsulation)
 495                 skb_set_inner_mac_header(skb, nhoff);
 496
 497         rcu_read_lock();
 498         ptype = gro_find_complete_by_type(type);
 499         if (ptype != NULL)
 500                 err = ptype->callbacks.gro_complete(skb, nhoff +
 501                                                     sizeof(struct ethhdr));
 502
 503         rcu_read_unlock();
 504         return err;
 505 }
 506 EXPORT_SYMBOL(eth_gro_complete);
 507
 508 static struct packet_offload eth_packet_offload __read_mostly = {
 509         .type = cpu_to_be16(ETH_P_TEB),
 510         .priority = 10,
 511         .callbacks = {
 512                 .gro_receive = eth_gro_receive,
 513                 .gro_complete = eth_gro_complete,
 514         },
 515 };
 516
 517 static int __init eth_offload_init(void)
 518 {
 519         dev_add_offload(&eth_packet_offload);
 520
 521         return 0;
 522 }
 523
 524 fs_initcall(eth_offload_init);
 525
 526 unsigned char * __weak arch_get_platform_mac_address(void)
 527 {
 528         return NULL;
 529 }
 530
 531 int eth_platform_get_mac_address(struct device *dev, u8 *mac_addr)
 532 {
 533         const unsigned char *addr;
 534         struct device_node *dp;
 535
 536         if (dev_is_pci(dev))
 537                 dp = pci_device_to_OF_node(to_pci_dev(dev));
 538         else
 539                 dp = dev->of_node;
 540
 541         addr = NULL;
 542         if (dp)
 543                 addr = of_get_mac_address(dp);
 544         if (!addr)
 545                 addr = arch_get_platform_mac_address();
 546
 547         if (!addr)
 548                 return -ENODEV;
 549
 550         ether_addr_copy(mac_addr, addr);
 551         return 0;
 552 }
 553 EXPORT_SYMBOL(eth_platform_get_mac_address);
 554
 555 /**
 556  * Obtain the MAC address from an nvmem cell named 'mac-address' associated
 557  * with given device.
 558  *
 559  * @dev:        Device with which the mac-address cell is associated.
 560  * @addrbuf:    Buffer to which the MAC address will be copied on success.
 561  *
 562  * Returns 0 on success or a negative error number on failure.
 563  */
 564 int nvmem_get_mac_address(struct device *dev, void *addrbuf)
 565 {
 566         struct nvmem_cell *cell;
 567         const void *mac;
 568         size_t len;
 569
 570         cell = nvmem_cell_get(dev, "mac-address");
 571         if (IS_ERR(cell))
 572                 return PTR_ERR(cell);
 573
 574         mac = nvmem_cell_read(cell, &len);
 575         nvmem_cell_put(cell);
 576
 577         if (IS_ERR(mac))
 578                 return PTR_ERR(mac);
 579
 580         if (len != ETH_ALEN || !is_valid_ether_addr(mac)) {
 581                 kfree(mac);
 582                 return -EINVAL;
 583         }
 584
 585         ether_addr_copy(addrbuf, mac);
 586         kfree(mac);
 587
 588         return 0;
 589 }
 590 EXPORT_SYMBOL(nvmem_get_mac_address);