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/etherdevice.h>
  51 #include <linux/skbuff.h>
  52 #include <linux/errno.h>
  53 #include <linux/init.h>
  54 #include <linux/if_ether.h>
  55 #include <net/dst.h>
  56 #include <net/arp.h>
  57 #include <net/sock.h>
  58 #include <net/ipv6.h>
  59 #include <net/ip.h>
  60 #include <net/dsa.h>
  61 #include <linux/uaccess.h>
  62
  63 __setup("ether=", netdev_boot_setup);
  64
  65 /**
  66  * eth_header - create the Ethernet header
  67  * @skb:        buffer to alter
  68  * @dev:        source device
  69  * @type:       Ethernet type field
  70  * @daddr: destination address (NULL leave destination address)
  71  * @saddr: source address (NULL use device source address)
  72  * @len:   packet length (<= skb->len)
  73  *
  74  *
  75  * Set the protocol type. For a packet of type ETH_P_802_3/2 we put the length
  76  * in here instead.
  77  */
  78 int eth_header(struct sk_buff *skb, struct net_device *dev,
  79                unsigned short type,
  80                const void *daddr, const void *saddr, unsigned int len)
  81 {
  82         struct ethhdr *eth = (struct ethhdr *)skb_push(skb, ETH_HLEN);
  83
  84         if (type != ETH_P_802_3 && type != ETH_P_802_2)
  85                 eth->h_proto = htons(type);
  86         else
  87                 eth->h_proto = htons(len);
  88
  89         /*
  90          *      Set the source hardware address.
  91          */
  92
  93         if (!saddr)
  94                 saddr = dev->dev_addr;
  95         memcpy(eth->h_source, saddr, ETH_ALEN);
  96
  97         if (daddr) {
  98                 memcpy(eth->h_dest, daddr, ETH_ALEN);
  99                 return ETH_HLEN;
 100         }
 101
 102         /*
 103          *      Anyway, the loopback-device should never use this function...
 104          */
 105
 106         if (dev->flags & (IFF_LOOPBACK | IFF_NOARP)) {
 107                 eth_zero_addr(eth->h_dest);
 108                 return ETH_HLEN;
 109         }
 110
 111         return -ETH_HLEN;
 112 }
 113 EXPORT_SYMBOL(eth_header);
 114
 115 /**
 116  * eth_get_headlen - determine the the length of header for an ethernet frame
 117  * @data: pointer to start of frame
 118  * @len: total length of frame
 119  *
 120  * Make a best effort attempt to pull the length for all of the headers for
 121  * a given frame in a linear buffer.
 122  */
 123 u32 eth_get_headlen(void *data, unsigned int len)
 124 {
 125         const struct ethhdr *eth = (const struct ethhdr *)data;
 126         struct flow_keys keys;
 127
 128         /* this should never happen, but better safe than sorry */
 129         if (len < sizeof(*eth))
 130                 return len;
 131
 132         /* parse any remaining L2/L3 headers, check for L4 */
 133         if (!__skb_flow_dissect(NULL, &keys, data,
 134                                 eth->h_proto, sizeof(*eth), len))
 135                 return max_t(u32, keys.thoff, sizeof(*eth));
 136
 137         /* parse for any L4 headers */
 138         return min_t(u32, __skb_get_poff(NULL, data, &keys, len), len);
 139 }
 140 EXPORT_SYMBOL(eth_get_headlen);
 141
 142 /**
 143  * eth_type_trans - determine the packet's protocol ID.
 144  * @skb: received socket data
 145  * @dev: receiving network device
 146  *
 147  * The rule here is that we
 148  * assume 802.3 if the type field is short enough to be a length.
 149  * This is normal practice and works for any 'now in use' protocol.
 150  */
 151 __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev)
 152 {
 153         unsigned short _service_access_point;
 154         const unsigned short *sap;
 155         const struct ethhdr *eth;
 156
 157         skb->dev = dev;
 158         skb_reset_mac_header(skb);
 159
 160         eth = (struct ethhdr *)skb->data;
 161         skb_pull_inline(skb, ETH_HLEN);
 162
 163         if (unlikely(is_multicast_ether_addr_64bits(eth->h_dest))) {
 164                 if (ether_addr_equal_64bits(eth->h_dest, dev->broadcast))
 165                         skb->pkt_type = PACKET_BROADCAST;
 166                 else
 167                         skb->pkt_type = PACKET_MULTICAST;
 168         }
 169         else if (unlikely(!ether_addr_equal_64bits(eth->h_dest,
 170                                                    dev->dev_addr)))
 171                 skb->pkt_type = PACKET_OTHERHOST;
 172
 173         /*
 174          * Some variants of DSA tagging don't have an ethertype field
 175          * at all, so we check here whether one of those tagging
 176          * variants has been configured on the receiving interface,
 177          * and if so, set skb->protocol without looking at the packet.
 178          */
 179         if (unlikely(netdev_uses_dsa(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         hh->hh_len = ETH_HLEN;
 238         return 0;
 239 }
 240 EXPORT_SYMBOL(eth_header_cache);
 241
 242 /**
 243  * eth_header_cache_update - update cache entry
 244  * @hh: destination cache entry
 245  * @dev: network device
 246  * @haddr: new hardware address
 247  *
 248  * Called by Address Resolution module to notify changes in address.
 249  */
 250 void eth_header_cache_update(struct hh_cache *hh,
 251                              const struct net_device *dev,
 252                              const unsigned char *haddr)
 253 {
 254         memcpy(((u8 *) hh->hh_data) + HH_DATA_OFF(sizeof(struct ethhdr)),
 255                haddr, ETH_ALEN);
 256 }
 257 EXPORT_SYMBOL(eth_header_cache_update);
 258
 259 /**
 260  * eth_prepare_mac_addr_change - prepare for mac change
 261  * @dev: network device
 262  * @p: socket address
 263  */
 264 int eth_prepare_mac_addr_change(struct net_device *dev, void *p)
 265 {
 266         struct sockaddr *addr = p;
 267
 268         if (!(dev->priv_flags & IFF_LIVE_ADDR_CHANGE) && netif_running(dev))
 269                 return -EBUSY;
 270         if (!is_valid_ether_addr(addr->sa_data))
 271                 return -EADDRNOTAVAIL;
 272         return 0;
 273 }
 274 EXPORT_SYMBOL(eth_prepare_mac_addr_change);
 275
 276 /**
 277  * eth_commit_mac_addr_change - commit mac change
 278  * @dev: network device
 279  * @p: socket address
 280  */
 281 void eth_commit_mac_addr_change(struct net_device *dev, void *p)
 282 {
 283         struct sockaddr *addr = p;
 284
 285         memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
 286 }
 287 EXPORT_SYMBOL(eth_commit_mac_addr_change);
 288
 289 /**
 290  * eth_mac_addr - set new Ethernet hardware address
 291  * @dev: network device
 292  * @p: socket address
 293  *
 294  * Change hardware address of device.
 295  *
 296  * This doesn't change hardware matching, so needs to be overridden
 297  * for most real devices.
 298  */
 299 int eth_mac_addr(struct net_device *dev, void *p)
 300 {
 301         int ret;
 302
 303         ret = eth_prepare_mac_addr_change(dev, p);
 304         if (ret < 0)
 305                 return ret;
 306         eth_commit_mac_addr_change(dev, p);
 307         return 0;
 308 }
 309 EXPORT_SYMBOL(eth_mac_addr);
 310
 311 /**
 312  * eth_change_mtu - set new MTU size
 313  * @dev: network device
 314  * @new_mtu: new Maximum Transfer Unit
 315  *
 316  * Allow changing MTU size. Needs to be overridden for devices
 317  * supporting jumbo frames.
 318  */
 319 int eth_change_mtu(struct net_device *dev, int new_mtu)
 320 {
 321         if (new_mtu < 68 || new_mtu > ETH_DATA_LEN)
 322                 return -EINVAL;
 323         dev->mtu = new_mtu;
 324         return 0;
 325 }
 326 EXPORT_SYMBOL(eth_change_mtu);
 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 };
 343
 344 /**
 345  * ether_setup - setup Ethernet network device
 346  * @dev: network device
 347  *
 348  * Fill in the fields of the device structure with Ethernet-generic values.
 349  */
 350 void ether_setup(struct net_device *dev)
 351 {
 352         dev->header_ops         = &eth_header_ops;
 353         dev->type               = ARPHRD_ETHER;
 354         dev->hard_header_len    = ETH_HLEN;
 355         dev->mtu                = ETH_DATA_LEN;
 356         dev->addr_len           = ETH_ALEN;
 357         dev->tx_queue_len       = 1000; /* Ethernet wants good queues */
 358         dev->flags              = IFF_BROADCAST|IFF_MULTICAST;
 359         dev->priv_flags         |= IFF_TX_SKB_SHARING;
 360
 361         eth_broadcast_addr(dev->broadcast);
 362
 363 }
 364 EXPORT_SYMBOL(ether_setup);
 365
 366 /**
 367  * alloc_etherdev_mqs - Allocates and sets up an Ethernet device
 368  * @sizeof_priv: Size of additional driver-private structure to be allocated
 369  *      for this Ethernet device
 370  * @txqs: The number of TX queues this device has.
 371  * @rxqs: The number of RX queues this device has.
 372  *
 373  * Fill in the fields of the device structure with Ethernet-generic
 374  * values. Basically does everything except registering the device.
 375  *
 376  * Constructs a new net device, complete with a private data area of
 377  * size (sizeof_priv).  A 32-byte (not bit) alignment is enforced for
 378  * this private data area.
 379  */
 380
 381 struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
 382                                       unsigned int rxqs)
 383 {
 384         return alloc_netdev_mqs(sizeof_priv, "eth%d", NET_NAME_UNKNOWN,
 385                                 ether_setup, txqs, rxqs);
 386 }
 387 EXPORT_SYMBOL(alloc_etherdev_mqs);
 388
 389 ssize_t sysfs_format_mac(char *buf, const unsigned char *addr, int len)
 390 {
 391         return scnprintf(buf, PAGE_SIZE, "%*phC\n", len, addr);
 392 }
 393 EXPORT_SYMBOL(sysfs_format_mac);
 394
 395 struct sk_buff **eth_gro_receive(struct sk_buff **head,
 396                                  struct sk_buff *skb)
 397 {
 398         struct sk_buff *p, **pp = NULL;
 399         struct ethhdr *eh, *eh2;
 400         unsigned int hlen, off_eth;
 401         const struct packet_offload *ptype;
 402         __be16 type;
 403         int flush = 1;
 404
 405         off_eth = skb_gro_offset(skb);
 406         hlen = off_eth + sizeof(*eh);
 407         eh = skb_gro_header_fast(skb, off_eth);
 408         if (skb_gro_header_hard(skb, hlen)) {
 409                 eh = skb_gro_header_slow(skb, hlen, off_eth);
 410                 if (unlikely(!eh))
 411                         goto out;
 412         }
 413
 414         flush = 0;
 415
 416         for (p = *head; p; p = p->next) {
 417                 if (!NAPI_GRO_CB(p)->same_flow)
 418                         continue;
 419
 420                 eh2 = (struct ethhdr *)(p->data + off_eth);
 421                 if (compare_ether_header(eh, eh2)) {
 422                         NAPI_GRO_CB(p)->same_flow = 0;
 423                         continue;
 424                 }
 425         }
 426
 427         type = eh->h_proto;
 428
 429         rcu_read_lock();
 430         ptype = gro_find_receive_by_type(type);
 431         if (ptype == NULL) {
 432                 flush = 1;
 433                 goto out_unlock;
 434         }
 435
 436         skb_gro_pull(skb, sizeof(*eh));
 437         skb_gro_postpull_rcsum(skb, eh, sizeof(*eh));
 438         pp = ptype->callbacks.gro_receive(head, skb);
 439
 440 out_unlock:
 441         rcu_read_unlock();
 442 out:
 443         NAPI_GRO_CB(skb)->flush |= flush;
 444
 445         return pp;
 446 }
 447 EXPORT_SYMBOL(eth_gro_receive);
 448
 449 int eth_gro_complete(struct sk_buff *skb, int nhoff)
 450 {
 451         struct ethhdr *eh = (struct ethhdr *)(skb->data + nhoff);
 452         __be16 type = eh->h_proto;
 453         struct packet_offload *ptype;
 454         int err = -ENOSYS;
 455
 456         if (skb->encapsulation)
 457                 skb_set_inner_mac_header(skb, nhoff);
 458
 459         rcu_read_lock();
 460         ptype = gro_find_complete_by_type(type);
 461         if (ptype != NULL)
 462                 err = ptype->callbacks.gro_complete(skb, nhoff +
 463                                                     sizeof(struct ethhdr));
 464
 465         rcu_read_unlock();
 466         return err;
 467 }
 468 EXPORT_SYMBOL(eth_gro_complete);
 469
 470 static struct packet_offload eth_packet_offload __read_mostly = {
 471         .type = cpu_to_be16(ETH_P_TEB),
 472         .callbacks = {
 473                 .gro_receive = eth_gro_receive,
 474                 .gro_complete = eth_gro_complete,
 475         },
 476 };
 477
 478 static int __init eth_offload_init(void)
 479 {
 480         dev_add_offload(&eth_packet_offload);
 481
 482         return 0;
 483 }
 484
 485 fs_initcall(eth_offload_init);