net/ethernet/eth.c

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