include/linux/netdevice.h

   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  *              Definitions for the Interfaces handler.
   7  *
   8  * Version:     @(#)dev.h       1.0.10  08/12/93
   9  *
  10  * Authors:     Ross Biro
  11  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12  *              Corey Minyard <wf-rch!minyard@relay.EU.net>
  13  *              Donald J. Becker, <becker@cesdis.gsfc.nasa.gov>
  14  *              Alan Cox, <alan@lxorguk.ukuu.org.uk>
  15  *              Bjorn Ekwall. <bj0rn@blox.se>
  16  *              Pekka Riikonen <priikone@poseidon.pspt.fi>
  17  *
  18  *              This program is free software; you can redistribute it and/or
  19  *              modify it under the terms of the GNU General Public License
  20  *              as published by the Free Software Foundation; either version
  21  *              2 of the License, or (at your option) any later version.
  22  *
  23  *              Moved to /usr/include/linux for NET3
  24  */
  25 #ifndef _LINUX_NETDEVICE_H
  26 #define _LINUX_NETDEVICE_H
  27
  28 #include <linux/timer.h>
  29 #include <linux/bug.h>
  30 #include <linux/delay.h>
  31 #include <linux/atomic.h>
  32 #include <linux/prefetch.h>
  33 #include <asm/cache.h>
  34 #include <asm/byteorder.h>
  35
  36 #include <linux/percpu.h>
  37 #include <linux/rculist.h>
  38 #include <linux/dmaengine.h>
  39 #include <linux/workqueue.h>
  40 #include <linux/dynamic_queue_limits.h>
  41
  42 #include <linux/ethtool.h>
  43 #include <net/net_namespace.h>
  44 #include <net/dsa.h>
  45 #ifdef CONFIG_DCB
  46 #include <net/dcbnl.h>
  47 #endif
  48 #include <net/netprio_cgroup.h>
  49
  50 #include <linux/netdev_features.h>
  51 #include <linux/neighbour.h>
  52 #include <uapi/linux/netdevice.h>
  53 #include <uapi/linux/if_bonding.h>
  54 #include <uapi/linux/pkt_cls.h>
  55 #include <linux/hashtable.h>
  56
  57 struct netpoll_info;
  58 struct device;
  59 struct phy_device;
  60 /* 802.11 specific */
  61 struct wireless_dev;
  62 /* 802.15.4 specific */
  63 struct wpan_dev;
  64 struct mpls_dev;
  65 /* UDP Tunnel offloads */
  66 struct udp_tunnel_info;
  67 struct bpf_prog;
  68
  69 void netdev_set_default_ethtool_ops(struct net_device *dev,
  70                                     const struct ethtool_ops *ops);
  71
  72 /* Backlog congestion levels */
  73 #define NET_RX_SUCCESS          0       /* keep 'em coming, baby */
  74 #define NET_RX_DROP             1       /* packet dropped */
  75
  76 /*
  77  * Transmit return codes: transmit return codes originate from three different
  78  * namespaces:
  79  *
  80  * - qdisc return codes
  81  * - driver transmit return codes
  82  * - errno values
  83  *
  84  * Drivers are allowed to return any one of those in their hard_start_xmit()
  85  * function. Real network devices commonly used with qdiscs should only return
  86  * the driver transmit return codes though - when qdiscs are used, the actual
  87  * transmission happens asynchronously, so the value is not propagated to
  88  * higher layers. Virtual network devices transmit synchronously; in this case
  89  * the driver transmit return codes are consumed by dev_queue_xmit(), and all
  90  * others are propagated to higher layers.
  91  */
  92
  93 /* qdisc ->enqueue() return codes. */
  94 #define NET_XMIT_SUCCESS        0x00
  95 #define NET_XMIT_DROP           0x01    /* skb dropped                  */
  96 #define NET_XMIT_CN             0x02    /* congestion notification      */
  97 #define NET_XMIT_MASK           0x0f    /* qdisc flags in net/sch_generic.h */
  98
  99 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
 100  * indicates that the device will soon be dropping packets, or already drops
 101  * some packets of the same priority; prompting us to send less aggressively. */
 102 #define net_xmit_eval(e)        ((e) == NET_XMIT_CN ? 0 : (e))
 103 #define net_xmit_errno(e)       ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
 104
 105 /* Driver transmit return codes */
 106 #define NETDEV_TX_MASK          0xf0
 107
 108 enum netdev_tx {
 109         __NETDEV_TX_MIN  = INT_MIN,     /* make sure enum is signed */
 110         NETDEV_TX_OK     = 0x00,        /* driver took care of packet */
 111         NETDEV_TX_BUSY   = 0x10,        /* driver tx path was busy*/
 112 };
 113 typedef enum netdev_tx netdev_tx_t;
 114
 115 /*
 116  * Current order: NETDEV_TX_MASK > NET_XMIT_MASK >= 0 is significant;
 117  * hard_start_xmit() return < NET_XMIT_MASK means skb was consumed.
 118  */
 119 static inline bool dev_xmit_complete(int rc)
 120 {
 121         /*
 122          * Positive cases with an skb consumed by a driver:
 123          * - successful transmission (rc == NETDEV_TX_OK)
 124          * - error while transmitting (rc < 0)
 125          * - error while queueing to a different device (rc & NET_XMIT_MASK)
 126          */
 127         if (likely(rc < NET_XMIT_MASK))
 128                 return true;
 129
 130         return false;
 131 }
 132
 133 /*
 134  *      Compute the worst-case header length according to the protocols
 135  *      used.
 136  */
 137
 138 #if defined(CONFIG_HYPERV_NET)
 139 # define LL_MAX_HEADER 128
 140 #elif defined(CONFIG_WLAN) || IS_ENABLED(CONFIG_AX25)
 141 # if defined(CONFIG_MAC80211_MESH)
 142 #  define LL_MAX_HEADER 128
 143 # else
 144 #  define LL_MAX_HEADER 96
 145 # endif
 146 #else
 147 # define LL_MAX_HEADER 32
 148 #endif
 149
 150 #if !IS_ENABLED(CONFIG_NET_IPIP) && !IS_ENABLED(CONFIG_NET_IPGRE) && \
 151     !IS_ENABLED(CONFIG_IPV6_SIT) && !IS_ENABLED(CONFIG_IPV6_TUNNEL)
 152 #define MAX_HEADER LL_MAX_HEADER
 153 #else
 154 #define MAX_HEADER (LL_MAX_HEADER + 48)
 155 #endif
 156
 157 /*
 158  *      Old network device statistics. Fields are native words
 159  *      (unsigned long) so they can be read and written atomically.
 160  */
 161
 162 struct net_device_stats {
 163         unsigned long   rx_packets;
 164         unsigned long   tx_packets;
 165         unsigned long   rx_bytes;
 166         unsigned long   tx_bytes;
 167         unsigned long   rx_errors;
 168         unsigned long   tx_errors;
 169         unsigned long   rx_dropped;
 170         unsigned long   tx_dropped;
 171         unsigned long   multicast;
 172         unsigned long   collisions;
 173         unsigned long   rx_length_errors;
 174         unsigned long   rx_over_errors;
 175         unsigned long   rx_crc_errors;
 176         unsigned long   rx_frame_errors;
 177         unsigned long   rx_fifo_errors;
 178         unsigned long   rx_missed_errors;
 179         unsigned long   tx_aborted_errors;
 180         unsigned long   tx_carrier_errors;
 181         unsigned long   tx_fifo_errors;
 182         unsigned long   tx_heartbeat_errors;
 183         unsigned long   tx_window_errors;
 184         unsigned long   rx_compressed;
 185         unsigned long   tx_compressed;
 186 };
 187
 188
 189 #include <linux/cache.h>
 190 #include <linux/skbuff.h>
 191
 192 #ifdef CONFIG_RPS
 193 #include <linux/static_key.h>
 194 extern struct static_key rps_needed;
 195 #endif
 196
 197 struct neighbour;
 198 struct neigh_parms;
 199 struct sk_buff;
 200
 201 struct netdev_hw_addr {
 202         struct list_head        list;
 203         unsigned char           addr[MAX_ADDR_LEN];
 204         unsigned char           type;
 205 #define NETDEV_HW_ADDR_T_LAN            1
 206 #define NETDEV_HW_ADDR_T_SAN            2
 207 #define NETDEV_HW_ADDR_T_SLAVE          3
 208 #define NETDEV_HW_ADDR_T_UNICAST        4
 209 #define NETDEV_HW_ADDR_T_MULTICAST      5
 210         bool                    global_use;
 211         int                     sync_cnt;
 212         int                     refcount;
 213         int                     synced;
 214         struct rcu_head         rcu_head;
 215 };
 216
 217 struct netdev_hw_addr_list {
 218         struct list_head        list;
 219         int                     count;
 220 };
 221
 222 #define netdev_hw_addr_list_count(l) ((l)->count)
 223 #define netdev_hw_addr_list_empty(l) (netdev_hw_addr_list_count(l) == 0)
 224 #define netdev_hw_addr_list_for_each(ha, l) \
 225         list_for_each_entry(ha, &(l)->list, list)
 226
 227 #define netdev_uc_count(dev) netdev_hw_addr_list_count(&(dev)->uc)
 228 #define netdev_uc_empty(dev) netdev_hw_addr_list_empty(&(dev)->uc)
 229 #define netdev_for_each_uc_addr(ha, dev) \
 230         netdev_hw_addr_list_for_each(ha, &(dev)->uc)
 231
 232 #define netdev_mc_count(dev) netdev_hw_addr_list_count(&(dev)->mc)
 233 #define netdev_mc_empty(dev) netdev_hw_addr_list_empty(&(dev)->mc)
 234 #define netdev_for_each_mc_addr(ha, dev) \
 235         netdev_hw_addr_list_for_each(ha, &(dev)->mc)
 236
 237 struct hh_cache {
 238         u16             hh_len;
 239         u16             __pad;
 240         seqlock_t       hh_lock;
 241
 242         /* cached hardware header; allow for machine alignment needs.        */
 243 #define HH_DATA_MOD     16
 244 #define HH_DATA_OFF(__len) \
 245         (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
 246 #define HH_DATA_ALIGN(__len) \
 247         (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
 248         unsigned long   hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
 249 };
 250
 251 /* Reserve HH_DATA_MOD byte-aligned hard_header_len, but at least that much.
 252  * Alternative is:
 253  *   dev->hard_header_len ? (dev->hard_header_len +
 254  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
 255  *
 256  * We could use other alignment values, but we must maintain the
 257  * relationship HH alignment <= LL alignment.
 258  */
 259 #define LL_RESERVED_SPACE(dev) \
 260         ((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 261 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
 262         ((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 263
 264 struct header_ops {
 265         int     (*create) (struct sk_buff *skb, struct net_device *dev,
 266                            unsigned short type, const void *daddr,
 267                            const void *saddr, unsigned int len);
 268         int     (*parse)(const struct sk_buff *skb, unsigned char *haddr);
 269         int     (*cache)(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
 270         void    (*cache_update)(struct hh_cache *hh,
 271                                 const struct net_device *dev,
 272                                 const unsigned char *haddr);
 273         bool    (*validate)(const char *ll_header, unsigned int len);
 274 };
 275
 276 /* These flag bits are private to the generic network queueing
 277  * layer; they may not be explicitly referenced by any other
 278  * code.
 279  */
 280
 281 enum netdev_state_t {
 282         __LINK_STATE_START,
 283         __LINK_STATE_PRESENT,
 284         __LINK_STATE_NOCARRIER,
 285         __LINK_STATE_LINKWATCH_PENDING,
 286         __LINK_STATE_DORMANT,
 287 };
 288
 289
 290 /*
 291  * This structure holds boot-time configured netdevice settings. They
 292  * are then used in the device probing.
 293  */
 294 struct netdev_boot_setup {
 295         char name[IFNAMSIZ];
 296         struct ifmap map;
 297 };
 298 #define NETDEV_BOOT_SETUP_MAX 8
 299
 300 int __init netdev_boot_setup(char *str);
 301
 302 /*
 303  * Structure for NAPI scheduling similar to tasklet but with weighting
 304  */
 305 struct napi_struct {
 306         /* The poll_list must only be managed by the entity which
 307          * changes the state of the NAPI_STATE_SCHED bit.  This means
 308          * whoever atomically sets that bit can add this napi_struct
 309          * to the per-CPU poll_list, and whoever clears that bit
 310          * can remove from the list right before clearing the bit.
 311          */
 312         struct list_head        poll_list;
 313
 314         unsigned long           state;
 315         int                     weight;
 316         unsigned int            gro_count;
 317         int                     (*poll)(struct napi_struct *, int);
 318 #ifdef CONFIG_NETPOLL
 319         spinlock_t              poll_lock;
 320         int                     poll_owner;
 321 #endif
 322         struct net_device       *dev;
 323         struct sk_buff          *gro_list;
 324         struct sk_buff          *skb;
 325         struct hrtimer          timer;
 326         struct list_head        dev_list;
 327         struct hlist_node       napi_hash_node;
 328         unsigned int            napi_id;
 329 };
 330
 331 enum {
 332         NAPI_STATE_SCHED,       /* Poll is scheduled */
 333         NAPI_STATE_DISABLE,     /* Disable pending */
 334         NAPI_STATE_NPSVC,       /* Netpoll - don't dequeue from poll_list */
 335         NAPI_STATE_HASHED,      /* In NAPI hash (busy polling possible) */
 336         NAPI_STATE_NO_BUSY_POLL,/* Do not add in napi_hash, no busy polling */
 337 };
 338
 339 enum gro_result {
 340         GRO_MERGED,
 341         GRO_MERGED_FREE,
 342         GRO_HELD,
 343         GRO_NORMAL,
 344         GRO_DROP,
 345 };
 346 typedef enum gro_result gro_result_t;
 347
 348 /*
 349  * enum rx_handler_result - Possible return values for rx_handlers.
 350  * @RX_HANDLER_CONSUMED: skb was consumed by rx_handler, do not process it
 351  * further.
 352  * @RX_HANDLER_ANOTHER: Do another round in receive path. This is indicated in
 353  * case skb->dev was changed by rx_handler.
 354  * @RX_HANDLER_EXACT: Force exact delivery, no wildcard.
 355  * @RX_HANDLER_PASS: Do nothing, pass the skb as if no rx_handler was called.
 356  *
 357  * rx_handlers are functions called from inside __netif_receive_skb(), to do
 358  * special processing of the skb, prior to delivery to protocol handlers.
 359  *
 360  * Currently, a net_device can only have a single rx_handler registered. Trying
 361  * to register a second rx_handler will return -EBUSY.
 362  *
 363  * To register a rx_handler on a net_device, use netdev_rx_handler_register().
 364  * To unregister a rx_handler on a net_device, use
 365  * netdev_rx_handler_unregister().
 366  *
 367  * Upon return, rx_handler is expected to tell __netif_receive_skb() what to
 368  * do with the skb.
 369  *
 370  * If the rx_handler consumed the skb in some way, it should return
 371  * RX_HANDLER_CONSUMED. This is appropriate when the rx_handler arranged for
 372  * the skb to be delivered in some other way.
 373  *
 374  * If the rx_handler changed skb->dev, to divert the skb to another
 375  * net_device, it should return RX_HANDLER_ANOTHER. The rx_handler for the
 376  * new device will be called if it exists.
 377  *
 378  * If the rx_handler decides the skb should be ignored, it should return
 379  * RX_HANDLER_EXACT. The skb will only be delivered to protocol handlers that
 380  * are registered on exact device (ptype->dev == skb->dev).
 381  *
 382  * If the rx_handler didn't change skb->dev, but wants the skb to be normally
 383  * delivered, it should return RX_HANDLER_PASS.
 384  *
 385  * A device without a registered rx_handler will behave as if rx_handler
 386  * returned RX_HANDLER_PASS.
 387  */
 388
 389 enum rx_handler_result {
 390         RX_HANDLER_CONSUMED,
 391         RX_HANDLER_ANOTHER,
 392         RX_HANDLER_EXACT,
 393         RX_HANDLER_PASS,
 394 };
 395 typedef enum rx_handler_result rx_handler_result_t;
 396 typedef rx_handler_result_t rx_handler_func_t(struct sk_buff **pskb);
 397
 398 void __napi_schedule(struct napi_struct *n);
 399 void __napi_schedule_irqoff(struct napi_struct *n);
 400
 401 static inline bool napi_disable_pending(struct napi_struct *n)
 402 {
 403         return test_bit(NAPI_STATE_DISABLE, &n->state);
 404 }
 405
 406 /**
 407  *      napi_schedule_prep - check if NAPI can be scheduled
 408  *      @n: NAPI context
 409  *
 410  * Test if NAPI routine is already running, and if not mark
 411  * it as running.  This is used as a condition variable to
 412  * insure only one NAPI poll instance runs.  We also make
 413  * sure there is no pending NAPI disable.
 414  */
 415 static inline bool napi_schedule_prep(struct napi_struct *n)
 416 {
 417         return !napi_disable_pending(n) &&
 418                 !test_and_set_bit(NAPI_STATE_SCHED, &n->state);
 419 }
 420
 421 /**
 422  *      napi_schedule - schedule NAPI poll
 423  *      @n: NAPI context
 424  *
 425  * Schedule NAPI poll routine to be called if it is not already
 426  * running.
 427  */
 428 static inline void napi_schedule(struct napi_struct *n)
 429 {
 430         if (napi_schedule_prep(n))
 431                 __napi_schedule(n);
 432 }
 433
 434 /**
 435  *      napi_schedule_irqoff - schedule NAPI poll
 436  *      @n: NAPI context
 437  *
 438  * Variant of napi_schedule(), assuming hard irqs are masked.
 439  */
 440 static inline void napi_schedule_irqoff(struct napi_struct *n)
 441 {
 442         if (napi_schedule_prep(n))
 443                 __napi_schedule_irqoff(n);
 444 }
 445
 446 /* Try to reschedule poll. Called by dev->poll() after napi_complete().  */
 447 static inline bool napi_reschedule(struct napi_struct *napi)
 448 {
 449         if (napi_schedule_prep(napi)) {
 450                 __napi_schedule(napi);
 451                 return true;
 452         }
 453         return false;
 454 }
 455
 456 void __napi_complete(struct napi_struct *n);
 457 void napi_complete_done(struct napi_struct *n, int work_done);
 458 /**
 459  *      napi_complete - NAPI processing complete
 460  *      @n: NAPI context
 461  *
 462  * Mark NAPI processing as complete.
 463  * Consider using napi_complete_done() instead.
 464  */
 465 static inline void napi_complete(struct napi_struct *n)
 466 {
 467         return napi_complete_done(n, 0);
 468 }
 469
 470 /**
 471  *      napi_hash_add - add a NAPI to global hashtable
 472  *      @napi: NAPI context
 473  *
 474  * Generate a new napi_id and store a @napi under it in napi_hash.
 475  * Used for busy polling (CONFIG_NET_RX_BUSY_POLL).
 476  * Note: This is normally automatically done from netif_napi_add(),
 477  * so might disappear in a future Linux version.
 478  */
 479 void napi_hash_add(struct napi_struct *napi);
 480
 481 /**
 482  *      napi_hash_del - remove a NAPI from global table
 483  *      @napi: NAPI context
 484  *
 485  * Warning: caller must observe RCU grace period
 486  * before freeing memory containing @napi, if
 487  * this function returns true.
 488  * Note: core networking stack automatically calls it
 489  * from netif_napi_del().
 490  * Drivers might want to call this helper to combine all
 491  * the needed RCU grace periods into a single one.
 492  */
 493 bool napi_hash_del(struct napi_struct *napi);
 494
 495 /**
 496  *      napi_disable - prevent NAPI from scheduling
 497  *      @n: NAPI context
 498  *
 499  * Stop NAPI from being scheduled on this context.
 500  * Waits till any outstanding processing completes.
 501  */
 502 void napi_disable(struct napi_struct *n);
 503
 504 /**
 505  *      napi_enable - enable NAPI scheduling
 506  *      @n: NAPI context
 507  *
 508  * Resume NAPI from being scheduled on this context.
 509  * Must be paired with napi_disable.
 510  */
 511 static inline void napi_enable(struct napi_struct *n)
 512 {
 513         BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
 514         smp_mb__before_atomic();
 515         clear_bit(NAPI_STATE_SCHED, &n->state);
 516         clear_bit(NAPI_STATE_NPSVC, &n->state);
 517 }
 518
 519 /**
 520  *      napi_synchronize - wait until NAPI is not running
 521  *      @n: NAPI context
 522  *
 523  * Wait until NAPI is done being scheduled on this context.
 524  * Waits till any outstanding processing completes but
 525  * does not disable future activations.
 526  */
 527 static inline void napi_synchronize(const struct napi_struct *n)
 528 {
 529         if (IS_ENABLED(CONFIG_SMP))
 530                 while (test_bit(NAPI_STATE_SCHED, &n->state))
 531                         msleep(1);
 532         else
 533                 barrier();
 534 }
 535
 536 enum netdev_queue_state_t {
 537         __QUEUE_STATE_DRV_XOFF,
 538         __QUEUE_STATE_STACK_XOFF,
 539         __QUEUE_STATE_FROZEN,
 540 };
 541
 542 #define QUEUE_STATE_DRV_XOFF    (1 << __QUEUE_STATE_DRV_XOFF)
 543 #define QUEUE_STATE_STACK_XOFF  (1 << __QUEUE_STATE_STACK_XOFF)
 544 #define QUEUE_STATE_FROZEN      (1 << __QUEUE_STATE_FROZEN)
 545
 546 #define QUEUE_STATE_ANY_XOFF    (QUEUE_STATE_DRV_XOFF | QUEUE_STATE_STACK_XOFF)
 547 #define QUEUE_STATE_ANY_XOFF_OR_FROZEN (QUEUE_STATE_ANY_XOFF | \
 548                                         QUEUE_STATE_FROZEN)
 549 #define QUEUE_STATE_DRV_XOFF_OR_FROZEN (QUEUE_STATE_DRV_XOFF | \
 550                                         QUEUE_STATE_FROZEN)
 551
 552 /*
 553  * __QUEUE_STATE_DRV_XOFF is used by drivers to stop the transmit queue.  The
 554  * netif_tx_* functions below are used to manipulate this flag.  The
 555  * __QUEUE_STATE_STACK_XOFF flag is used by the stack to stop the transmit
 556  * queue independently.  The netif_xmit_*stopped functions below are called
 557  * to check if the queue has been stopped by the driver or stack (either
 558  * of the XOFF bits are set in the state).  Drivers should not need to call
 559  * netif_xmit*stopped functions, they should only be using netif_tx_*.
 560  */
 561
 562 struct netdev_queue {
 563 /*
 564  * read-mostly part
 565  */
 566         struct net_device       *dev;
 567         struct Qdisc __rcu      *qdisc;
 568         struct Qdisc            *qdisc_sleeping;
 569 #ifdef CONFIG_SYSFS
 570         struct kobject          kobj;
 571 #endif
 572 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
 573         int                     numa_node;
 574 #endif
 575         unsigned long           tx_maxrate;
 576         /*
 577          * Number of TX timeouts for this queue
 578          * (/sys/class/net/DEV/Q/trans_timeout)
 579          */
 580         unsigned long           trans_timeout;
 581 /*
 582  * write-mostly part
 583  */
 584         spinlock_t              _xmit_lock ____cacheline_aligned_in_smp;
 585         int                     xmit_lock_owner;
 586         /*
 587          * Time (in jiffies) of last Tx
 588          */
 589         unsigned long           trans_start;
 590
 591         unsigned long           state;
 592
 593 #ifdef CONFIG_BQL
 594         struct dql              dql;
 595 #endif
 596 } ____cacheline_aligned_in_smp;
 597
 598 static inline int netdev_queue_numa_node_read(const struct netdev_queue *q)
 599 {
 600 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
 601         return q->numa_node;
 602 #else
 603         return NUMA_NO_NODE;
 604 #endif
 605 }
 606
 607 static inline void netdev_queue_numa_node_write(struct netdev_queue *q, int node)
 608 {
 609 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
 610         q->numa_node = node;
 611 #endif
 612 }
 613
 614 #ifdef CONFIG_RPS
 615 /*
 616  * This structure holds an RPS map which can be of variable length.  The
 617  * map is an array of CPUs.
 618  */
 619 struct rps_map {
 620         unsigned int len;
 621         struct rcu_head rcu;
 622         u16 cpus[0];
 623 };
 624 #define RPS_MAP_SIZE(_num) (sizeof(struct rps_map) + ((_num) * sizeof(u16)))
 625
 626 /*
 627  * The rps_dev_flow structure contains the mapping of a flow to a CPU, the
 628  * tail pointer for that CPU's input queue at the time of last enqueue, and
 629  * a hardware filter index.
 630  */
 631 struct rps_dev_flow {
 632         u16 cpu;
 633         u16 filter;
 634         unsigned int last_qtail;
 635 };
 636 #define RPS_NO_FILTER 0xffff
 637
 638 /*
 639  * The rps_dev_flow_table structure contains a table of flow mappings.
 640  */
 641 struct rps_dev_flow_table {
 642         unsigned int mask;
 643         struct rcu_head rcu;
 644         struct rps_dev_flow flows[0];
 645 };
 646 #define RPS_DEV_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_dev_flow_table) + \
 647     ((_num) * sizeof(struct rps_dev_flow)))
 648
 649 /*
 650  * The rps_sock_flow_table contains mappings of flows to the last CPU
 651  * on which they were processed by the application (set in recvmsg).
 652  * Each entry is a 32bit value. Upper part is the high-order bits
 653  * of flow hash, lower part is CPU number.
 654  * rps_cpu_mask is used to partition the space, depending on number of
 655  * possible CPUs : rps_cpu_mask = roundup_pow_of_two(nr_cpu_ids) - 1
 656  * For example, if 64 CPUs are possible, rps_cpu_mask = 0x3f,
 657  * meaning we use 32-6=26 bits for the hash.
 658  */
 659 struct rps_sock_flow_table {
 660         u32     mask;
 661
 662         u32     ents[0] ____cacheline_aligned_in_smp;
 663 };
 664 #define RPS_SOCK_FLOW_TABLE_SIZE(_num) (offsetof(struct rps_sock_flow_table, ents[_num]))
 665
 666 #define RPS_NO_CPU 0xffff
 667
 668 extern u32 rps_cpu_mask;
 669 extern struct rps_sock_flow_table __rcu *rps_sock_flow_table;
 670
 671 static inline void rps_record_sock_flow(struct rps_sock_flow_table *table,
 672                                         u32 hash)
 673 {
 674         if (table && hash) {
 675                 unsigned int index = hash & table->mask;
 676                 u32 val = hash & ~rps_cpu_mask;
 677
 678                 /* We only give a hint, preemption can change CPU under us */
 679                 val |= raw_smp_processor_id();
 680
 681                 if (table->ents[index] != val)
 682                         table->ents[index] = val;
 683         }
 684 }
 685
 686 #ifdef CONFIG_RFS_ACCEL
 687 bool rps_may_expire_flow(struct net_device *dev, u16 rxq_index, u32 flow_id,
 688                          u16 filter_id);
 689 #endif
 690 #endif /* CONFIG_RPS */
 691
 692 /* This structure contains an instance of an RX queue. */
 693 struct netdev_rx_queue {
 694 #ifdef CONFIG_RPS
 695         struct rps_map __rcu            *rps_map;
 696         struct rps_dev_flow_table __rcu *rps_flow_table;
 697 #endif
 698         struct kobject                  kobj;
 699         struct net_device               *dev;
 700 } ____cacheline_aligned_in_smp;
 701
 702 /*
 703  * RX queue sysfs structures and functions.
 704  */
 705 struct rx_queue_attribute {
 706         struct attribute attr;
 707         ssize_t (*show)(struct netdev_rx_queue *queue,
 708             struct rx_queue_attribute *attr, char *buf);
 709         ssize_t (*store)(struct netdev_rx_queue *queue,
 710             struct rx_queue_attribute *attr, const char *buf, size_t len);
 711 };
 712
 713 #ifdef CONFIG_XPS
 714 /*
 715  * This structure holds an XPS map which can be of variable length.  The
 716  * map is an array of queues.
 717  */
 718 struct xps_map {
 719         unsigned int len;
 720         unsigned int alloc_len;
 721         struct rcu_head rcu;
 722         u16 queues[0];
 723 };
 724 #define XPS_MAP_SIZE(_num) (sizeof(struct xps_map) + ((_num) * sizeof(u16)))
 725 #define XPS_MIN_MAP_ALLOC ((L1_CACHE_ALIGN(offsetof(struct xps_map, queues[1])) \
 726        - sizeof(struct xps_map)) / sizeof(u16))
 727
 728 /*
 729  * This structure holds all XPS maps for device.  Maps are indexed by CPU.
 730  */
 731 struct xps_dev_maps {
 732         struct rcu_head rcu;
 733         struct xps_map __rcu *cpu_map[0];
 734 };
 735 #define XPS_DEV_MAPS_SIZE (sizeof(struct xps_dev_maps) +                \
 736     (nr_cpu_ids * sizeof(struct xps_map *)))
 737 #endif /* CONFIG_XPS */
 738
 739 #define TC_MAX_QUEUE    16
 740 #define TC_BITMASK      15
 741 /* HW offloaded queuing disciplines txq count and offset maps */
 742 struct netdev_tc_txq {
 743         u16 count;
 744         u16 offset;
 745 };
 746
 747 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
 748 /*
 749  * This structure is to hold information about the device
 750  * configured to run FCoE protocol stack.
 751  */
 752 struct netdev_fcoe_hbainfo {
 753         char    manufacturer[64];
 754         char    serial_number[64];
 755         char    hardware_version[64];
 756         char    driver_version[64];
 757         char    optionrom_version[64];
 758         char    firmware_version[64];
 759         char    model[256];
 760         char    model_description[256];
 761 };
 762 #endif
 763
 764 #define MAX_PHYS_ITEM_ID_LEN 32
 765
 766 /* This structure holds a unique identifier to identify some
 767  * physical item (port for example) used by a netdevice.
 768  */
 769 struct netdev_phys_item_id {
 770         unsigned char id[MAX_PHYS_ITEM_ID_LEN];
 771         unsigned char id_len;
 772 };
 773
 774 static inline bool netdev_phys_item_id_same(struct netdev_phys_item_id *a,
 775                                             struct netdev_phys_item_id *b)
 776 {
 777         return a->id_len == b->id_len &&
 778                memcmp(a->id, b->id, a->id_len) == 0;
 779 }
 780
 781 typedef u16 (*select_queue_fallback_t)(struct net_device *dev,
 782                                        struct sk_buff *skb);
 783
 784 /* These structures hold the attributes of qdisc and classifiers
 785  * that are being passed to the netdevice through the setup_tc op.
 786  */
 787 enum {
 788         TC_SETUP_MQPRIO,
 789         TC_SETUP_CLSU32,
 790         TC_SETUP_CLSFLOWER,
 791         TC_SETUP_MATCHALL,
 792         TC_SETUP_CLSBPF,
 793 };
 794
 795 struct tc_cls_u32_offload;
 796
 797 struct tc_to_netdev {
 798         unsigned int type;
 799         union {
 800                 u8 tc;
 801                 struct tc_cls_u32_offload *cls_u32;
 802                 struct tc_cls_flower_offload *cls_flower;
 803                 struct tc_cls_matchall_offload *cls_mall;
 804                 struct tc_cls_bpf_offload *cls_bpf;
 805         };
 806 };
 807
 808 /* These structures hold the attributes of xdp state that are being passed
 809  * to the netdevice through the xdp op.
 810  */
 811 enum xdp_netdev_command {
 812         /* Set or clear a bpf program used in the earliest stages of packet
 813          * rx. The prog will have been loaded as BPF_PROG_TYPE_XDP. The callee
 814          * is responsible for calling bpf_prog_put on any old progs that are
 815          * stored. In case of error, the callee need not release the new prog
 816          * reference, but on success it takes ownership and must bpf_prog_put
 817          * when it is no longer used.
 818          */
 819         XDP_SETUP_PROG,
 820         /* Check if a bpf program is set on the device.  The callee should
 821          * return true if a program is currently attached and running.
 822          */
 823         XDP_QUERY_PROG,
 824 };
 825
 826 struct netdev_xdp {
 827         enum xdp_netdev_command command;
 828         union {
 829                 /* XDP_SETUP_PROG */
 830                 struct bpf_prog *prog;
 831                 /* XDP_QUERY_PROG */
 832                 bool prog_attached;
 833         };
 834 };
 835
 836 /*
 837  * This structure defines the management hooks for network devices.
 838  * The following hooks can be defined; unless noted otherwise, they are
 839  * optional and can be filled with a null pointer.
 840  *
 841  * int (*ndo_init)(struct net_device *dev);
 842  *     This function is called once when a network device is registered.
 843  *     The network device can use this for any late stage initialization
 844  *     or semantic validation. It can fail with an error code which will
 845  *     be propagated back to register_netdev.
 846  *
 847  * void (*ndo_uninit)(struct net_device *dev);
 848  *     This function is called when device is unregistered or when registration
 849  *     fails. It is not called if init fails.
 850  *
 851  * int (*ndo_open)(struct net_device *dev);
 852  *     This function is called when a network device transitions to the up
 853  *     state.
 854  *
 855  * int (*ndo_stop)(struct net_device *dev);
 856  *     This function is called when a network device transitions to the down
 857  *     state.
 858  *
 859  * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
 860  *                               struct net_device *dev);
 861  *      Called when a packet needs to be transmitted.
 862  *      Returns NETDEV_TX_OK.  Can return NETDEV_TX_BUSY, but you should stop
 863  *      the queue before that can happen; it's for obsolete devices and weird
 864  *      corner cases, but the stack really does a non-trivial amount
 865  *      of useless work if you return NETDEV_TX_BUSY.
 866  *      Required; cannot be NULL.
 867  *
 868  * netdev_features_t (*ndo_features_check)(struct sk_buff *skb,
 869  *                                         struct net_device *dev
 870  *                                         netdev_features_t features);
 871  *      Called by core transmit path to determine if device is capable of
 872  *      performing offload operations on a given packet. This is to give
 873  *      the device an opportunity to implement any restrictions that cannot
 874  *      be otherwise expressed by feature flags. The check is called with
 875  *      the set of features that the stack has calculated and it returns
 876  *      those the driver believes to be appropriate.
 877  *
 878  * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb,
 879  *                         void *accel_priv, select_queue_fallback_t fallback);
 880  *      Called to decide which queue to use when device supports multiple
 881  *      transmit queues.
 882  *
 883  * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
 884  *      This function is called to allow device receiver to make
 885  *      changes to configuration when multicast or promiscuous is enabled.
 886  *
 887  * void (*ndo_set_rx_mode)(struct net_device *dev);
 888  *      This function is called device changes address list filtering.
 889  *      If driver handles unicast address filtering, it should set
 890  *      IFF_UNICAST_FLT in its priv_flags.
 891  *
 892  * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
 893  *      This function  is called when the Media Access Control address
 894  *      needs to be changed. If this interface is not defined, the
 895  *      MAC address can not be changed.
 896  *
 897  * int (*ndo_validate_addr)(struct net_device *dev);
 898  *      Test if Media Access Control address is valid for the device.
 899  *
 900  * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
 901  *      Called when a user requests an ioctl which can't be handled by
 902  *      the generic interface code. If not defined ioctls return
 903  *      not supported error code.
 904  *
 905  * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
 906  *      Used to set network devices bus interface parameters. This interface
 907  *      is retained for legacy reasons; new devices should use the bus
 908  *      interface (PCI) for low level management.
 909  *
 910  * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
 911  *      Called when a user wants to change the Maximum Transfer Unit
 912  *      of a device. If not defined, any request to change MTU will
 913  *      will return an error.
 914  *
 915  * void (*ndo_tx_timeout)(struct net_device *dev);
 916  *      Callback used when the transmitter has not made any progress
 917  *      for dev->watchdog ticks.
 918  *
 919  * struct rtnl_link_stats64* (*ndo_get_stats64)(struct net_device *dev,
 920  *                      struct rtnl_link_stats64 *storage);
 921  * struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
 922  *      Called when a user wants to get the network device usage
 923  *      statistics. Drivers must do one of the following:
 924  *      1. Define @ndo_get_stats64 to fill in a zero-initialised
 925  *         rtnl_link_stats64 structure passed by the caller.
 926  *      2. Define @ndo_get_stats to update a net_device_stats structure
 927  *         (which should normally be dev->stats) and return a pointer to
 928  *         it. The structure may be changed asynchronously only if each
 929  *         field is written atomically.
 930  *      3. Update dev->stats asynchronously and atomically, and define
 931  *         neither operation.
 932  *
 933  * bool (*ndo_has_offload_stats)(int attr_id)
 934  *      Return true if this device supports offload stats of this attr_id.
 935  *
 936  * int (*ndo_get_offload_stats)(int attr_id, const struct net_device *dev,
 937  *      void *attr_data)
 938  *      Get statistics for offload operations by attr_id. Write it into the
 939  *      attr_data pointer.
 940  *
 941  * int (*ndo_vlan_rx_add_vid)(struct net_device *dev, __be16 proto, u16 vid);
 942  *      If device supports VLAN filtering this function is called when a
 943  *      VLAN id is registered.
 944  *
 945  * int (*ndo_vlan_rx_kill_vid)(struct net_device *dev, __be16 proto, u16 vid);
 946  *      If device supports VLAN filtering this function is called when a
 947  *      VLAN id is unregistered.
 948  *
 949  * void (*ndo_poll_controller)(struct net_device *dev);
 950  *
 951  *      SR-IOV management functions.
 952  * int (*ndo_set_vf_mac)(struct net_device *dev, int vf, u8* mac);
 953  * int (*ndo_set_vf_vlan)(struct net_device *dev, int vf, u16 vlan,
 954  *                        u8 qos, __be16 proto);
 955  * int (*ndo_set_vf_rate)(struct net_device *dev, int vf, int min_tx_rate,
 956  *                        int max_tx_rate);
 957  * int (*ndo_set_vf_spoofchk)(struct net_device *dev, int vf, bool setting);
 958  * int (*ndo_set_vf_trust)(struct net_device *dev, int vf, bool setting);
 959  * int (*ndo_get_vf_config)(struct net_device *dev,
 960  *                          int vf, struct ifla_vf_info *ivf);
 961  * int (*ndo_set_vf_link_state)(struct net_device *dev, int vf, int link_state);
 962  * int (*ndo_set_vf_port)(struct net_device *dev, int vf,
 963  *                        struct nlattr *port[]);
 964  *
 965  *      Enable or disable the VF ability to query its RSS Redirection Table and
 966  *      Hash Key. This is needed since on some devices VF share this information
 967  *      with PF and querying it may introduce a theoretical security risk.
 968  * int (*ndo_set_vf_rss_query_en)(struct net_device *dev, int vf, bool setting);
 969  * int (*ndo_get_vf_port)(struct net_device *dev, int vf, struct sk_buff *skb);
 970  * int (*ndo_setup_tc)(struct net_device *dev, u8 tc)
 971  *      Called to setup 'tc' number of traffic classes in the net device. This
 972  *      is always called from the stack with the rtnl lock held and netif tx
 973  *      queues stopped. This allows the netdevice to perform queue management
 974  *      safely.
 975  *
 976  *      Fiber Channel over Ethernet (FCoE) offload functions.
 977  * int (*ndo_fcoe_enable)(struct net_device *dev);
 978  *      Called when the FCoE protocol stack wants to start using LLD for FCoE
 979  *      so the underlying device can perform whatever needed configuration or
 980  *      initialization to support acceleration of FCoE traffic.
 981  *
 982  * int (*ndo_fcoe_disable)(struct net_device *dev);
 983  *      Called when the FCoE protocol stack wants to stop using LLD for FCoE
 984  *      so the underlying device can perform whatever needed clean-ups to
 985  *      stop supporting acceleration of FCoE traffic.
 986  *
 987  * int (*ndo_fcoe_ddp_setup)(struct net_device *dev, u16 xid,
 988  *                           struct scatterlist *sgl, unsigned int sgc);
 989  *      Called when the FCoE Initiator wants to initialize an I/O that
 990  *      is a possible candidate for Direct Data Placement (DDP). The LLD can
 991  *      perform necessary setup and returns 1 to indicate the device is set up
 992  *      successfully to perform DDP on this I/O, otherwise this returns 0.
 993  *
 994  * int (*ndo_fcoe_ddp_done)(struct net_device *dev,  u16 xid);
 995  *      Called when the FCoE Initiator/Target is done with the DDPed I/O as
 996  *      indicated by the FC exchange id 'xid', so the underlying device can
 997  *      clean up and reuse resources for later DDP requests.
 998  *
 999  * int (*ndo_fcoe_ddp_target)(struct net_device *dev, u16 xid,
1000  *                            struct scatterlist *sgl, unsigned int sgc);
1001  *      Called when the FCoE Target wants to initialize an I/O that
1002  *      is a possible candidate for Direct Data Placement (DDP). The LLD can
1003  *      perform necessary setup and returns 1 to indicate the device is set up
1004  *      successfully to perform DDP on this I/O, otherwise this returns 0.
1005  *
1006  * int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1007  *                             struct netdev_fcoe_hbainfo *hbainfo);
1008  *      Called when the FCoE Protocol stack wants information on the underlying
1009  *      device. This information is utilized by the FCoE protocol stack to
1010  *      register attributes with Fiber Channel management service as per the
1011  *      FC-GS Fabric Device Management Information(FDMI) specification.
1012  *
1013  * int (*ndo_fcoe_get_wwn)(struct net_device *dev, u64 *wwn, int type);
1014  *      Called when the underlying device wants to override default World Wide
1015  *      Name (WWN) generation mechanism in FCoE protocol stack to pass its own
1016  *      World Wide Port Name (WWPN) or World Wide Node Name (WWNN) to the FCoE
1017  *      protocol stack to use.
1018  *
1019  *      RFS acceleration.
1020  * int (*ndo_rx_flow_steer)(struct net_device *dev, const struct sk_buff *skb,
1021  *                          u16 rxq_index, u32 flow_id);
1022  *      Set hardware filter for RFS.  rxq_index is the target queue index;
1023  *      flow_id is a flow ID to be passed to rps_may_expire_flow() later.
1024  *      Return the filter ID on success, or a negative error code.
1025  *
1026  *      Slave management functions (for bridge, bonding, etc).
1027  * int (*ndo_add_slave)(struct net_device *dev, struct net_device *slave_dev);
1028  *      Called to make another netdev an underling.
1029  *
1030  * int (*ndo_del_slave)(struct net_device *dev, struct net_device *slave_dev);
1031  *      Called to release previously enslaved netdev.
1032  *
1033  *      Feature/offload setting functions.
1034  * netdev_features_t (*ndo_fix_features)(struct net_device *dev,
1035  *              netdev_features_t features);
1036  *      Adjusts the requested feature flags according to device-specific
1037  *      constraints, and returns the resulting flags. Must not modify
1038  *      the device state.
1039  *
1040  * int (*ndo_set_features)(struct net_device *dev, netdev_features_t features);
1041  *      Called to update device configuration to new features. Passed
1042  *      feature set might be less than what was returned by ndo_fix_features()).
1043  *      Must return >0 or -errno if it changed dev->features itself.
1044  *
1045  * int (*ndo_fdb_add)(struct ndmsg *ndm, struct nlattr *tb[],
1046  *                    struct net_device *dev,
1047  *                    const unsigned char *addr, u16 vid, u16 flags)
1048  *      Adds an FDB entry to dev for addr.
1049  * int (*ndo_fdb_del)(struct ndmsg *ndm, struct nlattr *tb[],
1050  *                    struct net_device *dev,
1051  *                    const unsigned char *addr, u16 vid)
1052  *      Deletes the FDB entry from dev coresponding to addr.
1053  * int (*ndo_fdb_dump)(struct sk_buff *skb, struct netlink_callback *cb,
1054  *                     struct net_device *dev, struct net_device *filter_dev,
1055  *                     int *idx)
1056  *      Used to add FDB entries to dump requests. Implementers should add
1057  *      entries to skb and update idx with the number of entries.
1058  *
1059  * int (*ndo_bridge_setlink)(struct net_device *dev, struct nlmsghdr *nlh,
1060  *                           u16 flags)
1061  * int (*ndo_bridge_getlink)(struct sk_buff *skb, u32 pid, u32 seq,
1062  *                           struct net_device *dev, u32 filter_mask,
1063  *                           int nlflags)
1064  * int (*ndo_bridge_dellink)(struct net_device *dev, struct nlmsghdr *nlh,
1065  *                           u16 flags);
1066  *
1067  * int (*ndo_change_carrier)(struct net_device *dev, bool new_carrier);
1068  *      Called to change device carrier. Soft-devices (like dummy, team, etc)
1069  *      which do not represent real hardware may define this to allow their
1070  *      userspace components to manage their virtual carrier state. Devices
1071  *      that determine carrier state from physical hardware properties (eg
1072  *      network cables) or protocol-dependent mechanisms (eg
1073  *      USB_CDC_NOTIFY_NETWORK_CONNECTION) should NOT implement this function.
1074  *
1075  * int (*ndo_get_phys_port_id)(struct net_device *dev,
1076  *                             struct netdev_phys_item_id *ppid);
1077  *      Called to get ID of physical port of this device. If driver does
1078  *      not implement this, it is assumed that the hw is not able to have
1079  *      multiple net devices on single physical port.
1080  *
1081  * void (*ndo_udp_tunnel_add)(struct net_device *dev,
1082  *                            struct udp_tunnel_info *ti);
1083  *      Called by UDP tunnel to notify a driver about the UDP port and socket
1084  *      address family that a UDP tunnel is listnening to. It is called only
1085  *      when a new port starts listening. The operation is protected by the
1086  *      RTNL.
1087  *
1088  * void (*ndo_udp_tunnel_del)(struct net_device *dev,
1089  *                            struct udp_tunnel_info *ti);
1090  *      Called by UDP tunnel to notify the driver about a UDP port and socket
1091  *      address family that the UDP tunnel is not listening to anymore. The
1092  *      operation is protected by the RTNL.
1093  *
1094  * void* (*ndo_dfwd_add_station)(struct net_device *pdev,
1095  *                               struct net_device *dev)
1096  *      Called by upper layer devices to accelerate switching or other
1097  *      station functionality into hardware. 'pdev is the lowerdev
1098  *      to use for the offload and 'dev' is the net device that will
1099  *      back the offload. Returns a pointer to the private structure
1100  *      the upper layer will maintain.
1101  * void (*ndo_dfwd_del_station)(struct net_device *pdev, void *priv)
1102  *      Called by upper layer device to delete the station created
1103  *      by 'ndo_dfwd_add_station'. 'pdev' is the net device backing
1104  *      the station and priv is the structure returned by the add
1105  *      operation.
1106  * netdev_tx_t (*ndo_dfwd_start_xmit)(struct sk_buff *skb,
1107  *                                    struct net_device *dev,
1108  *                                    void *priv);
1109  *      Callback to use for xmit over the accelerated station. This
1110  *      is used in place of ndo_start_xmit on accelerated net
1111  *      devices.
1112  * int (*ndo_set_tx_maxrate)(struct net_device *dev,
1113  *                           int queue_index, u32 maxrate);
1114  *      Called when a user wants to set a max-rate limitation of specific
1115  *      TX queue.
1116  * int (*ndo_get_iflink)(const struct net_device *dev);
1117  *      Called to get the iflink value of this device.
1118  * void (*ndo_change_proto_down)(struct net_device *dev,
1119  *                               bool proto_down);
1120  *      This function is used to pass protocol port error state information
1121  *      to the switch driver. The switch driver can react to the proto_down
1122  *      by doing a phys down on the associated switch port.
1123  * int (*ndo_fill_metadata_dst)(struct net_device *dev, struct sk_buff *skb);
1124  *      This function is used to get egress tunnel information for given skb.
1125  *      This is useful for retrieving outer tunnel header parameters while
1126  *      sampling packet.
1127  * void (*ndo_set_rx_headroom)(struct net_device *dev, int needed_headroom);
1128  *      This function is used to specify the headroom that the skb must
1129  *      consider when allocation skb during packet reception. Setting
1130  *      appropriate rx headroom value allows avoiding skb head copy on
1131  *      forward. Setting a negative value resets the rx headroom to the
1132  *      default value.
1133  * int (*ndo_xdp)(struct net_device *dev, struct netdev_xdp *xdp);
1134  *      This function is used to set or query state related to XDP on the
1135  *      netdevice. See definition of enum xdp_netdev_command for details.
1136  *
1137  */
1138 struct net_device_ops {
1139         int                     (*ndo_init)(struct net_device *dev);
1140         void                    (*ndo_uninit)(struct net_device *dev);
1141         int                     (*ndo_open)(struct net_device *dev);
1142         int                     (*ndo_stop)(struct net_device *dev);
1143         netdev_tx_t             (*ndo_start_xmit)(struct sk_buff *skb,
1144                                                   struct net_device *dev);
1145         netdev_features_t       (*ndo_features_check)(struct sk_buff *skb,
1146                                                       struct net_device *dev,
1147                                                       netdev_features_t features);
1148         u16                     (*ndo_select_queue)(struct net_device *dev,
1149                                                     struct sk_buff *skb,
1150                                                     void *accel_priv,
1151                                                     select_queue_fallback_t fallback);
1152         void                    (*ndo_change_rx_flags)(struct net_device *dev,
1153                                                        int flags);
1154         void                    (*ndo_set_rx_mode)(struct net_device *dev);
1155         int                     (*ndo_set_mac_address)(struct net_device *dev,
1156                                                        void *addr);
1157         int                     (*ndo_validate_addr)(struct net_device *dev);
1158         int                     (*ndo_do_ioctl)(struct net_device *dev,
1159                                                 struct ifreq *ifr, int cmd);
1160         int                     (*ndo_set_config)(struct net_device *dev,
1161                                                   struct ifmap *map);
1162         int                     (*ndo_change_mtu)(struct net_device *dev,
1163                                                   int new_mtu);
1164         int                     (*ndo_neigh_setup)(struct net_device *dev,
1165                                                    struct neigh_parms *);
1166         void                    (*ndo_tx_timeout) (struct net_device *dev);
1167
1168         struct rtnl_link_stats64* (*ndo_get_stats64)(struct net_device *dev,
1169                                                      struct rtnl_link_stats64 *storage);
1170         bool                    (*ndo_has_offload_stats)(int attr_id);
1171         int                     (*ndo_get_offload_stats)(int attr_id,
1172                                                          const struct net_device *dev,
1173                                                          void *attr_data);
1174         struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
1175
1176         int                     (*ndo_vlan_rx_add_vid)(struct net_device *dev,
1177                                                        __be16 proto, u16 vid);
1178         int                     (*ndo_vlan_rx_kill_vid)(struct net_device *dev,
1179                                                         __be16 proto, u16 vid);
1180 #ifdef CONFIG_NET_POLL_CONTROLLER
1181         void                    (*ndo_poll_controller)(struct net_device *dev);
1182         int                     (*ndo_netpoll_setup)(struct net_device *dev,
1183                                                      struct netpoll_info *info);
1184         void                    (*ndo_netpoll_cleanup)(struct net_device *dev);
1185 #endif
1186 #ifdef CONFIG_NET_RX_BUSY_POLL
1187         int                     (*ndo_busy_poll)(struct napi_struct *dev);
1188 #endif
1189         int                     (*ndo_set_vf_mac)(struct net_device *dev,
1190                                                   int queue, u8 *mac);
1191         int                     (*ndo_set_vf_vlan)(struct net_device *dev,
1192                                                    int queue, u16 vlan,
1193                                                    u8 qos, __be16 proto);
1194         int                     (*ndo_set_vf_rate)(struct net_device *dev,
1195                                                    int vf, int min_tx_rate,
1196                                                    int max_tx_rate);
1197         int                     (*ndo_set_vf_spoofchk)(struct net_device *dev,
1198                                                        int vf, bool setting);
1199         int                     (*ndo_set_vf_trust)(struct net_device *dev,
1200                                                     int vf, bool setting);
1201         int                     (*ndo_get_vf_config)(struct net_device *dev,
1202                                                      int vf,
1203                                                      struct ifla_vf_info *ivf);
1204         int                     (*ndo_set_vf_link_state)(struct net_device *dev,
1205                                                          int vf, int link_state);
1206         int                     (*ndo_get_vf_stats)(struct net_device *dev,
1207                                                     int vf,
1208                                                     struct ifla_vf_stats
1209                                                     *vf_stats);
1210         int                     (*ndo_set_vf_port)(struct net_device *dev,
1211                                                    int vf,
1212                                                    struct nlattr *port[]);
1213         int                     (*ndo_get_vf_port)(struct net_device *dev,
1214                                                    int vf, struct sk_buff *skb);
1215         int                     (*ndo_set_vf_guid)(struct net_device *dev,
1216                                                    int vf, u64 guid,
1217                                                    int guid_type);
1218         int                     (*ndo_set_vf_rss_query_en)(
1219                                                    struct net_device *dev,
1220                                                    int vf, bool setting);
1221         int                     (*ndo_setup_tc)(struct net_device *dev,
1222                                                 u32 handle,
1223                                                 __be16 protocol,
1224                                                 struct tc_to_netdev *tc);
1225 #if IS_ENABLED(CONFIG_FCOE)
1226         int                     (*ndo_fcoe_enable)(struct net_device *dev);
1227         int                     (*ndo_fcoe_disable)(struct net_device *dev);
1228         int                     (*ndo_fcoe_ddp_setup)(struct net_device *dev,
1229                                                       u16 xid,
1230                                                       struct scatterlist *sgl,
1231                                                       unsigned int sgc);
1232         int                     (*ndo_fcoe_ddp_done)(struct net_device *dev,
1233                                                      u16 xid);
1234         int                     (*ndo_fcoe_ddp_target)(struct net_device *dev,
1235                                                        u16 xid,
1236                                                        struct scatterlist *sgl,
1237                                                        unsigned int sgc);
1238         int                     (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1239                                                         struct netdev_fcoe_hbainfo *hbainfo);
1240 #endif
1241
1242 #if IS_ENABLED(CONFIG_LIBFCOE)
1243 #define NETDEV_FCOE_WWNN 0
1244 #define NETDEV_FCOE_WWPN 1
1245         int                     (*ndo_fcoe_get_wwn)(struct net_device *dev,
1246                                                     u64 *wwn, int type);
1247 #endif
1248
1249 #ifdef CONFIG_RFS_ACCEL
1250         int                     (*ndo_rx_flow_steer)(struct net_device *dev,
1251                                                      const struct sk_buff *skb,
1252                                                      u16 rxq_index,
1253                                                      u32 flow_id);
1254 #endif
1255         int                     (*ndo_add_slave)(struct net_device *dev,
1256                                                  struct net_device *slave_dev);
1257         int                     (*ndo_del_slave)(struct net_device *dev,
1258                                                  struct net_device *slave_dev);
1259         netdev_features_t       (*ndo_fix_features)(struct net_device *dev,
1260                                                     netdev_features_t features);
1261         int                     (*ndo_set_features)(struct net_device *dev,
1262                                                     netdev_features_t features);
1263         int                     (*ndo_neigh_construct)(struct net_device *dev,
1264                                                        struct neighbour *n);
1265         void                    (*ndo_neigh_destroy)(struct net_device *dev,
1266                                                      struct neighbour *n);
1267
1268         int                     (*ndo_fdb_add)(struct ndmsg *ndm,
1269                                                struct nlattr *tb[],
1270                                                struct net_device *dev,
1271                                                const unsigned char *addr,
1272                                                u16 vid,
1273                                                u16 flags);
1274         int                     (*ndo_fdb_del)(struct ndmsg *ndm,
1275                                                struct nlattr *tb[],
1276                                                struct net_device *dev,
1277                                                const unsigned char *addr,
1278                                                u16 vid);
1279         int                     (*ndo_fdb_dump)(struct sk_buff *skb,
1280                                                 struct netlink_callback *cb,
1281                                                 struct net_device *dev,
1282                                                 struct net_device *filter_dev,
1283                                                 int *idx);
1284
1285         int                     (*ndo_bridge_setlink)(struct net_device *dev,
1286                                                       struct nlmsghdr *nlh,
1287                                                       u16 flags);
1288         int                     (*ndo_bridge_getlink)(struct sk_buff *skb,
1289                                                       u32 pid, u32 seq,
1290                                                       struct net_device *dev,
1291                                                       u32 filter_mask,
1292                                                       int nlflags);
1293         int                     (*ndo_bridge_dellink)(struct net_device *dev,
1294                                                       struct nlmsghdr *nlh,
1295                                                       u16 flags);
1296         int                     (*ndo_change_carrier)(struct net_device *dev,
1297                                                       bool new_carrier);
1298         int                     (*ndo_get_phys_port_id)(struct net_device *dev,
1299                                                         struct netdev_phys_item_id *ppid);
1300         int                     (*ndo_get_phys_port_name)(struct net_device *dev,
1301                                                           char *name, size_t len);
1302         void                    (*ndo_udp_tunnel_add)(struct net_device *dev,
1303                                                       struct udp_tunnel_info *ti);
1304         void                    (*ndo_udp_tunnel_del)(struct net_device *dev,
1305                                                       struct udp_tunnel_info *ti);
1306         void*                   (*ndo_dfwd_add_station)(struct net_device *pdev,
1307                                                         struct net_device *dev);
1308         void                    (*ndo_dfwd_del_station)(struct net_device *pdev,
1309                                                         void *priv);
1310
1311         netdev_tx_t             (*ndo_dfwd_start_xmit) (struct sk_buff *skb,
1312                                                         struct net_device *dev,
1313                                                         void *priv);
1314         int                     (*ndo_get_lock_subclass)(struct net_device *dev);
1315         int                     (*ndo_set_tx_maxrate)(struct net_device *dev,
1316                                                       int queue_index,
1317                                                       u32 maxrate);
1318         int                     (*ndo_get_iflink)(const struct net_device *dev);
1319         int                     (*ndo_change_proto_down)(struct net_device *dev,
1320                                                          bool proto_down);
1321         int                     (*ndo_fill_metadata_dst)(struct net_device *dev,
1322                                                        struct sk_buff *skb);
1323         void                    (*ndo_set_rx_headroom)(struct net_device *dev,
1324                                                        int needed_headroom);
1325         int                     (*ndo_xdp)(struct net_device *dev,
1326                                            struct netdev_xdp *xdp);
1327 };
1328
1329 /**
1330  * enum net_device_priv_flags - &struct net_device priv_flags
1331  *
1332  * These are the &struct net_device, they are only set internally
1333  * by drivers and used in the kernel. These flags are invisible to
1334  * userspace; this means that the order of these flags can change
1335  * during any kernel release.
1336  *
1337  * You should have a pretty good reason to be extending these flags.
1338  *
1339  * @IFF_802_1Q_VLAN: 802.1Q VLAN device
1340  * @IFF_EBRIDGE: Ethernet bridging device
1341  * @IFF_BONDING: bonding master or slave
1342  * @IFF_ISATAP: ISATAP interface (RFC4214)
1343  * @IFF_WAN_HDLC: WAN HDLC device
1344  * @IFF_XMIT_DST_RELEASE: dev_hard_start_xmit() is allowed to
1345  *      release skb->dst
1346  * @IFF_DONT_BRIDGE: disallow bridging this ether dev
1347  * @IFF_DISABLE_NETPOLL: disable netpoll at run-time
1348  * @IFF_MACVLAN_PORT: device used as macvlan port
1349  * @IFF_BRIDGE_PORT: device used as bridge port
1350  * @IFF_OVS_DATAPATH: device used as Open vSwitch datapath port
1351  * @IFF_TX_SKB_SHARING: The interface supports sharing skbs on transmit
1352  * @IFF_UNICAST_FLT: Supports unicast filtering
1353  * @IFF_TEAM_PORT: device used as team port
1354  * @IFF_SUPP_NOFCS: device supports sending custom FCS
1355  * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
1356  *      change when it's running
1357  * @IFF_MACVLAN: Macvlan device
1358  * @IFF_XMIT_DST_RELEASE_PERM: IFF_XMIT_DST_RELEASE not taking into account
1359  *      underlying stacked devices
1360  * @IFF_IPVLAN_MASTER: IPvlan master device
1361  * @IFF_IPVLAN_SLAVE: IPvlan slave device
1362  * @IFF_L3MDEV_MASTER: device is an L3 master device
1363  * @IFF_NO_QUEUE: device can run without qdisc attached
1364  * @IFF_OPENVSWITCH: device is a Open vSwitch master
1365  * @IFF_L3MDEV_SLAVE: device is enslaved to an L3 master device
1366  * @IFF_TEAM: device is a team device
1367  * @IFF_RXFH_CONFIGURED: device has had Rx Flow indirection table configured
1368  * @IFF_PHONY_HEADROOM: the headroom value is controlled by an external
1369  *      entity (i.e. the master device for bridged veth)
1370  * @IFF_MACSEC: device is a MACsec device
1371  * @IFF_L3MDEV_RX_HANDLER: only invoke the rx handler of L3 master device
1372  */
1373 enum netdev_priv_flags {
1374         IFF_802_1Q_VLAN                 = 1<<0,
1375         IFF_EBRIDGE                     = 1<<1,
1376         IFF_BONDING                     = 1<<2,
1377         IFF_ISATAP                      = 1<<3,
1378         IFF_WAN_HDLC                    = 1<<4,
1379         IFF_XMIT_DST_RELEASE            = 1<<5,
1380         IFF_DONT_BRIDGE                 = 1<<6,
1381         IFF_DISABLE_NETPOLL             = 1<<7,
1382         IFF_MACVLAN_PORT                = 1<<8,
1383         IFF_BRIDGE_PORT                 = 1<<9,
1384         IFF_OVS_DATAPATH                = 1<<10,
1385         IFF_TX_SKB_SHARING              = 1<<11,
1386         IFF_UNICAST_FLT                 = 1<<12,
1387         IFF_TEAM_PORT                   = 1<<13,
1388         IFF_SUPP_NOFCS                  = 1<<14,
1389         IFF_LIVE_ADDR_CHANGE            = 1<<15,
1390         IFF_MACVLAN                     = 1<<16,
1391         IFF_XMIT_DST_RELEASE_PERM       = 1<<17,
1392         IFF_IPVLAN_MASTER               = 1<<18,
1393         IFF_IPVLAN_SLAVE                = 1<<19,
1394         IFF_L3MDEV_MASTER               = 1<<20,
1395         IFF_NO_QUEUE                    = 1<<21,
1396         IFF_OPENVSWITCH                 = 1<<22,
1397         IFF_L3MDEV_SLAVE                = 1<<23,
1398         IFF_TEAM                        = 1<<24,
1399         IFF_RXFH_CONFIGURED             = 1<<25,
1400         IFF_PHONY_HEADROOM              = 1<<26,
1401         IFF_MACSEC                      = 1<<27,
1402         IFF_L3MDEV_RX_HANDLER           = 1<<28,
1403 };
1404
1405 #define IFF_802_1Q_VLAN                 IFF_802_1Q_VLAN
1406 #define IFF_EBRIDGE                     IFF_EBRIDGE
1407 #define IFF_BONDING                     IFF_BONDING
1408 #define IFF_ISATAP                      IFF_ISATAP
1409 #define IFF_WAN_HDLC                    IFF_WAN_HDLC
1410 #define IFF_XMIT_DST_RELEASE            IFF_XMIT_DST_RELEASE
1411 #define IFF_DONT_BRIDGE                 IFF_DONT_BRIDGE
1412 #define IFF_DISABLE_NETPOLL             IFF_DISABLE_NETPOLL
1413 #define IFF_MACVLAN_PORT                IFF_MACVLAN_PORT
1414 #define IFF_BRIDGE_PORT                 IFF_BRIDGE_PORT
1415 #define IFF_OVS_DATAPATH                IFF_OVS_DATAPATH
1416 #define IFF_TX_SKB_SHARING              IFF_TX_SKB_SHARING
1417 #define IFF_UNICAST_FLT                 IFF_UNICAST_FLT
1418 #define IFF_TEAM_PORT                   IFF_TEAM_PORT
1419 #define IFF_SUPP_NOFCS                  IFF_SUPP_NOFCS
1420 #define IFF_LIVE_ADDR_CHANGE            IFF_LIVE_ADDR_CHANGE
1421 #define IFF_MACVLAN                     IFF_MACVLAN
1422 #define IFF_XMIT_DST_RELEASE_PERM       IFF_XMIT_DST_RELEASE_PERM
1423 #define IFF_IPVLAN_MASTER               IFF_IPVLAN_MASTER
1424 #define IFF_IPVLAN_SLAVE                IFF_IPVLAN_SLAVE
1425 #define IFF_L3MDEV_MASTER               IFF_L3MDEV_MASTER
1426 #define IFF_NO_QUEUE                    IFF_NO_QUEUE
1427 #define IFF_OPENVSWITCH                 IFF_OPENVSWITCH
1428 #define IFF_L3MDEV_SLAVE                IFF_L3MDEV_SLAVE
1429 #define IFF_TEAM                        IFF_TEAM
1430 #define IFF_RXFH_CONFIGURED             IFF_RXFH_CONFIGURED
1431 #define IFF_MACSEC                      IFF_MACSEC
1432 #define IFF_L3MDEV_RX_HANDLER           IFF_L3MDEV_RX_HANDLER
1433
1434 /**
1435  *      struct net_device - The DEVICE structure.
1436  *              Actually, this whole structure is a big mistake.  It mixes I/O
1437  *              data with strictly "high-level" data, and it has to know about
1438  *              almost every data structure used in the INET module.
1439  *
1440  *      @name:  This is the first field of the "visible" part of this structure
1441  *              (i.e. as seen by users in the "Space.c" file).  It is the name
1442  *              of the interface.
1443  *
1444  *      @name_hlist:    Device name hash chain, please keep it close to name[]
1445  *      @ifalias:       SNMP alias
1446  *      @mem_end:       Shared memory end
1447  *      @mem_start:     Shared memory start
1448  *      @base_addr:     Device I/O address
1449  *      @irq:           Device IRQ number
1450  *
1451  *      @carrier_changes:       Stats to monitor carrier on<->off transitions
1452  *
1453  *      @state:         Generic network queuing layer state, see netdev_state_t
1454  *      @dev_list:      The global list of network devices
1455  *      @napi_list:     List entry used for polling NAPI devices
1456  *      @unreg_list:    List entry  when we are unregistering the
1457  *                      device; see the function unregister_netdev
1458  *      @close_list:    List entry used when we are closing the device
1459  *      @ptype_all:     Device-specific packet handlers for all protocols
1460  *      @ptype_specific: Device-specific, protocol-specific packet handlers
1461  *
1462  *      @adj_list:      Directly linked devices, like slaves for bonding
1463  *      @all_adj_list:  All linked devices, *including* neighbours
1464  *      @features:      Currently active device features
1465  *      @hw_features:   User-changeable features
1466  *
1467  *      @wanted_features:       User-requested features
1468  *      @vlan_features:         Mask of features inheritable by VLAN devices
1469  *
1470  *      @hw_enc_features:       Mask of features inherited by encapsulating devices
1471  *                              This field indicates what encapsulation
1472  *                              offloads the hardware is capable of doing,
1473  *                              and drivers will need to set them appropriately.
1474  *
1475  *      @mpls_features: Mask of features inheritable by MPLS
1476  *
1477  *      @ifindex:       interface index
1478  *      @group:         The group the device belongs to
1479  *
1480  *      @stats:         Statistics struct, which was left as a legacy, use
1481  *                      rtnl_link_stats64 instead
1482  *
1483  *      @rx_dropped:    Dropped packets by core network,
1484  *                      do not use this in drivers
1485  *      @tx_dropped:    Dropped packets by core network,
1486  *                      do not use this in drivers
1487  *      @rx_nohandler:  nohandler dropped packets by core network on
1488  *                      inactive devices, do not use this in drivers
1489  *
1490  *      @wireless_handlers:     List of functions to handle Wireless Extensions,
1491  *                              instead of ioctl,
1492  *                              see <net/iw_handler.h> for details.
1493  *      @wireless_data: Instance data managed by the core of wireless extensions
1494  *
1495  *      @netdev_ops:    Includes several pointers to callbacks,
1496  *                      if one wants to override the ndo_*() functions
1497  *      @ethtool_ops:   Management operations
1498  *      @ndisc_ops:     Includes callbacks for different IPv6 neighbour
1499  *                      discovery handling. Necessary for e.g. 6LoWPAN.
1500  *      @header_ops:    Includes callbacks for creating,parsing,caching,etc
1501  *                      of Layer 2 headers.
1502  *
1503  *      @flags:         Interface flags (a la BSD)
1504  *      @priv_flags:    Like 'flags' but invisible to userspace,
1505  *                      see if.h for the definitions
1506  *      @gflags:        Global flags ( kept as legacy )
1507  *      @padded:        How much padding added by alloc_netdev()
1508  *      @operstate:     RFC2863 operstate
1509  *      @link_mode:     Mapping policy to operstate
1510  *      @if_port:       Selectable AUI, TP, ...
1511  *      @dma:           DMA channel
1512  *      @mtu:           Interface MTU value
1513  *      @type:          Interface hardware type
1514  *      @hard_header_len: Maximum hardware header length.
1515  *      @min_header_len:  Minimum hardware header length
1516  *
1517  *      @needed_headroom: Extra headroom the hardware may need, but not in all
1518  *                        cases can this be guaranteed
1519  *      @needed_tailroom: Extra tailroom the hardware may need, but not in all
1520  *                        cases can this be guaranteed. Some cases also use
1521  *                        LL_MAX_HEADER instead to allocate the skb
1522  *
1523  *      interface address info:
1524  *
1525  *      @perm_addr:             Permanent hw address
1526  *      @addr_assign_type:      Hw address assignment type
1527  *      @addr_len:              Hardware address length
1528  *      @neigh_priv_len:        Used in neigh_alloc()
1529  *      @dev_id:                Used to differentiate devices that share
1530  *                              the same link layer address
1531  *      @dev_port:              Used to differentiate devices that share
1532  *                              the same function
1533  *      @addr_list_lock:        XXX: need comments on this one
1534  *      @uc_promisc:            Counter that indicates promiscuous mode
1535  *                              has been enabled due to the need to listen to
1536  *                              additional unicast addresses in a device that
1537  *                              does not implement ndo_set_rx_mode()
1538  *      @uc:                    unicast mac addresses
1539  *      @mc:                    multicast mac addresses
1540  *      @dev_addrs:             list of device hw addresses
1541  *      @queues_kset:           Group of all Kobjects in the Tx and RX queues
1542  *      @promiscuity:           Number of times the NIC is told to work in
1543  *                              promiscuous mode; if it becomes 0 the NIC will
1544  *                              exit promiscuous mode
1545  *      @allmulti:              Counter, enables or disables allmulticast mode
1546  *
1547  *      @vlan_info:     VLAN info
1548  *      @dsa_ptr:       dsa specific data
1549  *      @tipc_ptr:      TIPC specific data
1550  *      @atalk_ptr:     AppleTalk link
1551  *      @ip_ptr:        IPv4 specific data
1552  *      @dn_ptr:        DECnet specific data
1553  *      @ip6_ptr:       IPv6 specific data
1554  *      @ax25_ptr:      AX.25 specific data
1555  *      @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
1556  *
1557  *      @last_rx:       Time of last Rx
1558  *      @dev_addr:      Hw address (before bcast,
1559  *                      because most packets are unicast)
1560  *
1561  *      @_rx:                   Array of RX queues
1562  *      @num_rx_queues:         Number of RX queues
1563  *                              allocated at register_netdev() time
1564  *      @real_num_rx_queues:    Number of RX queues currently active in device
1565  *
1566  *      @rx_handler:            handler for received packets
1567  *      @rx_handler_data:       XXX: need comments on this one
1568  *      @ingress_queue:         XXX: need comments on this one
1569  *      @broadcast:             hw bcast address
1570  *
1571  *      @rx_cpu_rmap:   CPU reverse-mapping for RX completion interrupts,
1572  *                      indexed by RX queue number. Assigned by driver.
1573  *                      This must only be set if the ndo_rx_flow_steer
1574  *                      operation is defined
1575  *      @index_hlist:           Device index hash chain
1576  *
1577  *      @_tx:                   Array of TX queues
1578  *      @num_tx_queues:         Number of TX queues allocated at alloc_netdev_mq() time
1579  *      @real_num_tx_queues:    Number of TX queues currently active in device
1580  *      @qdisc:                 Root qdisc from userspace point of view
1581  *      @tx_queue_len:          Max frames per queue allowed
1582  *      @tx_global_lock:        XXX: need comments on this one
1583  *
1584  *      @xps_maps:      XXX: need comments on this one
1585  *
1586  *      @watchdog_timeo:        Represents the timeout that is used by
1587  *                              the watchdog (see dev_watchdog())
1588  *      @watchdog_timer:        List of timers
1589  *
1590  *      @pcpu_refcnt:           Number of references to this device
1591  *      @todo_list:             Delayed register/unregister
1592  *      @link_watch_list:       XXX: need comments on this one
1593  *
1594  *      @reg_state:             Register/unregister state machine
1595  *      @dismantle:             Device is going to be freed
1596  *      @rtnl_link_state:       This enum represents the phases of creating
1597  *                              a new link
1598  *
1599  *      @destructor:            Called from unregister,
1600  *                              can be used to call free_netdev
1601  *      @npinfo:                XXX: need comments on this one
1602  *      @nd_net:                Network namespace this network device is inside
1603  *
1604  *      @ml_priv:       Mid-layer private
1605  *      @lstats:        Loopback statistics
1606  *      @tstats:        Tunnel statistics
1607  *      @dstats:        Dummy statistics
1608  *      @vstats:        Virtual ethernet statistics
1609  *
1610  *      @garp_port:     GARP
1611  *      @mrp_port:      MRP
1612  *
1613  *      @dev:           Class/net/name entry
1614  *      @sysfs_groups:  Space for optional device, statistics and wireless
1615  *                      sysfs groups
1616  *
1617  *      @sysfs_rx_queue_group:  Space for optional per-rx queue attributes
1618  *      @rtnl_link_ops: Rtnl_link_ops
1619  *
1620  *      @gso_max_size:  Maximum size of generic segmentation offload
1621  *      @gso_max_segs:  Maximum number of segments that can be passed to the
1622  *                      NIC for GSO
1623  *
1624  *      @dcbnl_ops:     Data Center Bridging netlink ops
1625  *      @num_tc:        Number of traffic classes in the net device
1626  *      @tc_to_txq:     XXX: need comments on this one
1627  *      @prio_tc_map:   XXX: need comments on this one
1628  *
1629  *      @fcoe_ddp_xid:  Max exchange id for FCoE LRO by ddp
1630  *
1631  *      @priomap:       XXX: need comments on this one
1632  *      @phydev:        Physical device may attach itself
1633  *                      for hardware timestamping
1634  *
1635  *      @qdisc_tx_busylock: lockdep class annotating Qdisc->busylock spinlock
1636  *      @qdisc_running_key: lockdep class annotating Qdisc->running seqcount
1637  *
1638  *      @proto_down:    protocol port state information can be sent to the
1639  *                      switch driver and used to set the phys state of the
1640  *                      switch port.
1641  *
1642  *      FIXME: cleanup struct net_device such that network protocol info
1643  *      moves out.
1644  */
1645
1646 struct net_device {
1647         char                    name[IFNAMSIZ];
1648         struct hlist_node       name_hlist;
1649         char                    *ifalias;
1650         /*
1651          *      I/O specific fields
1652          *      FIXME: Merge these and struct ifmap into one
1653          */
1654         unsigned long           mem_end;
1655         unsigned long           mem_start;
1656         unsigned long           base_addr;
1657         int                     irq;
1658
1659         atomic_t                carrier_changes;
1660
1661         /*
1662          *      Some hardware also needs these fields (state,dev_list,
1663          *      napi_list,unreg_list,close_list) but they are not
1664          *      part of the usual set specified in Space.c.
1665          */
1666
1667         unsigned long           state;
1668
1669         struct list_head        dev_list;
1670         struct list_head        napi_list;
1671         struct list_head        unreg_list;
1672         struct list_head        close_list;
1673         struct list_head        ptype_all;
1674         struct list_head        ptype_specific;
1675
1676         struct {
1677                 struct list_head upper;
1678                 struct list_head lower;
1679         } adj_list;
1680
1681         struct {
1682                 struct list_head upper;
1683                 struct list_head lower;
1684         } all_adj_list;
1685
1686         netdev_features_t       features;
1687         netdev_features_t       hw_features;
1688         netdev_features_t       wanted_features;
1689         netdev_features_t       vlan_features;
1690         netdev_features_t       hw_enc_features;
1691         netdev_features_t       mpls_features;
1692         netdev_features_t       gso_partial_features;
1693
1694         int                     ifindex;
1695         int                     group;
1696
1697         struct net_device_stats stats;
1698
1699         atomic_long_t           rx_dropped;
1700         atomic_long_t           tx_dropped;
1701         atomic_long_t           rx_nohandler;
1702
1703 #ifdef CONFIG_WIRELESS_EXT
1704         const struct iw_handler_def *wireless_handlers;
1705         struct iw_public_data   *wireless_data;
1706 #endif
1707         const struct net_device_ops *netdev_ops;
1708         const struct ethtool_ops *ethtool_ops;
1709 #ifdef CONFIG_NET_SWITCHDEV
1710         const struct switchdev_ops *switchdev_ops;
1711 #endif
1712 #ifdef CONFIG_NET_L3_MASTER_DEV
1713         const struct l3mdev_ops *l3mdev_ops;
1714 #endif
1715 #if IS_ENABLED(CONFIG_IPV6)
1716         const struct ndisc_ops *ndisc_ops;
1717 #endif
1718
1719         const struct header_ops *header_ops;
1720
1721         unsigned int            flags;
1722         unsigned int            priv_flags;
1723
1724         unsigned short          gflags;
1725         unsigned short          padded;
1726
1727         unsigned char           operstate;
1728         unsigned char           link_mode;
1729
1730         unsigned char           if_port;
1731         unsigned char           dma;
1732
1733         /* Note : dev->mtu is often read without holding a lock.
1734          * Writers usually hold RTNL.
1735          * It is recommended to use READ_ONCE() to annotate the reads,
1736          * and to use WRITE_ONCE() to annotate the writes.
1737          */
1738         unsigned int            mtu;
1739         unsigned short          type;
1740         unsigned short          hard_header_len;
1741         unsigned short          min_header_len;
1742
1743         unsigned short          needed_headroom;
1744         unsigned short          needed_tailroom;
1745
1746         /* Interface address info. */
1747         unsigned char           perm_addr[MAX_ADDR_LEN];
1748         unsigned char           addr_assign_type;
1749         unsigned char           addr_len;
1750         unsigned short          neigh_priv_len;
1751         unsigned short          dev_id;
1752         unsigned short          dev_port;
1753         spinlock_t              addr_list_lock;
1754         unsigned char           name_assign_type;
1755         bool                    uc_promisc;
1756         struct netdev_hw_addr_list      uc;
1757         struct netdev_hw_addr_list      mc;
1758         struct netdev_hw_addr_list      dev_addrs;
1759
1760 #ifdef CONFIG_SYSFS
1761         struct kset             *queues_kset;
1762 #endif
1763         unsigned int            promiscuity;
1764         unsigned int            allmulti;
1765
1766
1767         /* Protocol-specific pointers */
1768
1769 #if IS_ENABLED(CONFIG_VLAN_8021Q)
1770         struct vlan_info __rcu  *vlan_info;
1771 #endif
1772 #if IS_ENABLED(CONFIG_NET_DSA)
1773         struct dsa_switch_tree  *dsa_ptr;
1774 #endif
1775 #if IS_ENABLED(CONFIG_TIPC)
1776         struct tipc_bearer __rcu *tipc_ptr;
1777 #endif
1778         void                    *atalk_ptr;
1779         struct in_device __rcu  *ip_ptr;
1780         struct dn_dev __rcu     *dn_ptr;
1781         struct inet6_dev __rcu  *ip6_ptr;
1782         void                    *ax25_ptr;
1783         struct wireless_dev     *ieee80211_ptr;
1784         struct wpan_dev         *ieee802154_ptr;
1785 #if IS_ENABLED(CONFIG_MPLS_ROUTING)
1786         struct mpls_dev __rcu   *mpls_ptr;
1787 #endif
1788
1789 /*
1790  * Cache lines mostly used on receive path (including eth_type_trans())
1791  */
1792         unsigned long           last_rx;
1793
1794         /* Interface address info used in eth_type_trans() */
1795         unsigned char           *dev_addr;
1796
1797 #ifdef CONFIG_SYSFS
1798         struct netdev_rx_queue  *_rx;
1799
1800         unsigned int            num_rx_queues;
1801         unsigned int            real_num_rx_queues;
1802 #endif
1803
1804         unsigned long           gro_flush_timeout;
1805         rx_handler_func_t __rcu *rx_handler;
1806         void __rcu              *rx_handler_data;
1807
1808 #ifdef CONFIG_NET_CLS_ACT
1809         struct tcf_proto __rcu  *ingress_cl_list;
1810 #endif
1811         struct netdev_queue __rcu *ingress_queue;
1812 #ifdef CONFIG_NETFILTER_INGRESS
1813         struct nf_hook_entry __rcu *nf_hooks_ingress;
1814 #endif
1815
1816         unsigned char           broadcast[MAX_ADDR_LEN];
1817 #ifdef CONFIG_RFS_ACCEL
1818         struct cpu_rmap         *rx_cpu_rmap;
1819 #endif
1820         struct hlist_node       index_hlist;
1821
1822 /*
1823  * Cache lines mostly used on transmit path
1824  */
1825         struct netdev_queue     *_tx ____cacheline_aligned_in_smp;
1826         unsigned int            num_tx_queues;
1827         unsigned int            real_num_tx_queues;
1828         struct Qdisc            *qdisc;
1829 #ifdef CONFIG_NET_SCHED
1830         DECLARE_HASHTABLE       (qdisc_hash, 4);
1831 #endif
1832         unsigned long           tx_queue_len;
1833         spinlock_t              tx_global_lock;
1834         int                     watchdog_timeo;
1835
1836 #ifdef CONFIG_XPS
1837         struct xps_dev_maps __rcu *xps_maps;
1838 #endif
1839 #ifdef CONFIG_NET_CLS_ACT
1840         struct tcf_proto __rcu  *egress_cl_list;
1841 #endif
1842
1843         /* These may be needed for future network-power-down code. */
1844         struct timer_list       watchdog_timer;
1845
1846         int __percpu            *pcpu_refcnt;
1847         struct list_head        todo_list;
1848
1849         struct list_head        link_watch_list;
1850
1851         enum { NETREG_UNINITIALIZED=0,
1852                NETREG_REGISTERED,       /* completed register_netdevice */
1853                NETREG_UNREGISTERING,    /* called unregister_netdevice */
1854                NETREG_UNREGISTERED,     /* completed unregister todo */
1855                NETREG_RELEASED,         /* called free_netdev */
1856                NETREG_DUMMY,            /* dummy device for NAPI poll */
1857         } reg_state:8;
1858
1859         bool dismantle;
1860
1861         enum {
1862                 RTNL_LINK_INITIALIZED,
1863                 RTNL_LINK_INITIALIZING,
1864         } rtnl_link_state:16;
1865
1866         void (*destructor)(struct net_device *dev);
1867
1868 #ifdef CONFIG_NETPOLL
1869         struct netpoll_info __rcu       *npinfo;
1870 #endif
1871
1872         possible_net_t                  nd_net;
1873
1874         /* mid-layer private */
1875         union {
1876                 void                                    *ml_priv;
1877                 struct pcpu_lstats __percpu             *lstats;
1878                 struct pcpu_sw_netstats __percpu        *tstats;
1879                 struct pcpu_dstats __percpu             *dstats;
1880                 struct pcpu_vstats __percpu             *vstats;
1881         };
1882
1883         struct garp_port __rcu  *garp_port;
1884         struct mrp_port __rcu   *mrp_port;
1885
1886         struct device           dev;
1887         const struct attribute_group *sysfs_groups[4];
1888         const struct attribute_group *sysfs_rx_queue_group;
1889
1890         const struct rtnl_link_ops *rtnl_link_ops;
1891
1892         /* for setting kernel sock attribute on TCP connection setup */
1893 #define GSO_MAX_SIZE            65536
1894         unsigned int            gso_max_size;
1895 #define GSO_MAX_SEGS            65535
1896         u16                     gso_max_segs;
1897
1898 #ifdef CONFIG_DCB
1899         const struct dcbnl_rtnl_ops *dcbnl_ops;
1900 #endif
1901         u8                      num_tc;
1902         struct netdev_tc_txq    tc_to_txq[TC_MAX_QUEUE];
1903         u8                      prio_tc_map[TC_BITMASK + 1];
1904
1905 #if IS_ENABLED(CONFIG_FCOE)
1906         unsigned int            fcoe_ddp_xid;
1907 #endif
1908 #if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
1909         struct netprio_map __rcu *priomap;
1910 #endif
1911         struct phy_device       *phydev;
1912         struct lock_class_key   *qdisc_tx_busylock;
1913         struct lock_class_key   *qdisc_running_key;
1914         bool                    proto_down;
1915 };
1916 #define to_net_dev(d) container_of(d, struct net_device, dev)
1917
1918 #define NETDEV_ALIGN            32
1919
1920 static inline
1921 int netdev_get_prio_tc_map(const struct net_device *dev, u32 prio)
1922 {
1923         return dev->prio_tc_map[prio & TC_BITMASK];
1924 }
1925
1926 static inline
1927 int netdev_set_prio_tc_map(struct net_device *dev, u8 prio, u8 tc)
1928 {
1929         if (tc >= dev->num_tc)
1930                 return -EINVAL;
1931
1932         dev->prio_tc_map[prio & TC_BITMASK] = tc & TC_BITMASK;
1933         return 0;
1934 }
1935
1936 static inline
1937 void netdev_reset_tc(struct net_device *dev)
1938 {
1939         dev->num_tc = 0;
1940         memset(dev->tc_to_txq, 0, sizeof(dev->tc_to_txq));
1941         memset(dev->prio_tc_map, 0, sizeof(dev->prio_tc_map));
1942 }
1943
1944 static inline
1945 int netdev_set_tc_queue(struct net_device *dev, u8 tc, u16 count, u16 offset)
1946 {
1947         if (tc >= dev->num_tc)
1948                 return -EINVAL;
1949
1950         dev->tc_to_txq[tc].count = count;
1951         dev->tc_to_txq[tc].offset = offset;
1952         return 0;
1953 }
1954
1955 static inline
1956 int netdev_set_num_tc(struct net_device *dev, u8 num_tc)
1957 {
1958         if (num_tc > TC_MAX_QUEUE)
1959                 return -EINVAL;
1960
1961         dev->num_tc = num_tc;
1962         return 0;
1963 }
1964
1965 static inline
1966 int netdev_get_num_tc(struct net_device *dev)
1967 {
1968         return dev->num_tc;
1969 }
1970
1971 static inline
1972 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
1973                                          unsigned int index)
1974 {
1975         return &dev->_tx[index];
1976 }
1977
1978 static inline struct netdev_queue *skb_get_tx_queue(const struct net_device *dev,
1979                                                     const struct sk_buff *skb)
1980 {
1981         return netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
1982 }
1983
1984 static inline void netdev_for_each_tx_queue(struct net_device *dev,
1985                                             void (*f)(struct net_device *,
1986                                                       struct netdev_queue *,
1987                                                       void *),
1988                                             void *arg)
1989 {
1990         unsigned int i;
1991
1992         for (i = 0; i < dev->num_tx_queues; i++)
1993                 f(dev, &dev->_tx[i], arg);
1994 }
1995
1996 #define netdev_lockdep_set_classes(dev)                         \
1997 {                                                               \
1998         static struct lock_class_key qdisc_tx_busylock_key;     \
1999         static struct lock_class_key qdisc_running_key;         \
2000         static struct lock_class_key qdisc_xmit_lock_key;       \
2001         static struct lock_class_key dev_addr_list_lock_key;    \
2002         unsigned int i;                                         \
2003                                                                 \
2004         (dev)->qdisc_tx_busylock = &qdisc_tx_busylock_key;      \
2005         (dev)->qdisc_running_key = &qdisc_running_key;          \
2006         lockdep_set_class(&(dev)->addr_list_lock,               \
2007                           &dev_addr_list_lock_key);             \
2008         for (i = 0; i < (dev)->num_tx_queues; i++)              \
2009                 lockdep_set_class(&(dev)->_tx[i]._xmit_lock,    \
2010                                   &qdisc_xmit_lock_key);        \
2011 }
2012
2013 struct netdev_queue *netdev_pick_tx(struct net_device *dev,
2014                                     struct sk_buff *skb,
2015                                     void *accel_priv);
2016
2017 /* returns the headroom that the master device needs to take in account
2018  * when forwarding to this dev
2019  */
2020 static inline unsigned netdev_get_fwd_headroom(struct net_device *dev)
2021 {
2022         return dev->priv_flags & IFF_PHONY_HEADROOM ? 0 : dev->needed_headroom;
2023 }
2024
2025 static inline void netdev_set_rx_headroom(struct net_device *dev, int new_hr)
2026 {
2027         if (dev->netdev_ops->ndo_set_rx_headroom)
2028                 dev->netdev_ops->ndo_set_rx_headroom(dev, new_hr);
2029 }
2030
2031 /* set the device rx headroom to the dev's default */
2032 static inline void netdev_reset_rx_headroom(struct net_device *dev)
2033 {
2034         netdev_set_rx_headroom(dev, -1);
2035 }
2036
2037 /*
2038  * Net namespace inlines
2039  */
2040 static inline
2041 struct net *dev_net(const struct net_device *dev)
2042 {
2043         return read_pnet(&dev->nd_net);
2044 }
2045
2046 static inline
2047 void dev_net_set(struct net_device *dev, struct net *net)
2048 {
2049         write_pnet(&dev->nd_net, net);
2050 }
2051
2052 static inline bool netdev_uses_dsa(struct net_device *dev)
2053 {
2054 #if IS_ENABLED(CONFIG_NET_DSA)
2055         if (dev->dsa_ptr != NULL)
2056                 return dsa_uses_tagged_protocol(dev->dsa_ptr);
2057 #endif
2058         return false;
2059 }
2060
2061 /**
2062  *      netdev_priv - access network device private data
2063  *      @dev: network device
2064  *
2065  * Get network device private data
2066  */
2067 static inline void *netdev_priv(const struct net_device *dev)
2068 {
2069         return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
2070 }
2071
2072 /* Set the sysfs physical device reference for the network logical device
2073  * if set prior to registration will cause a symlink during initialization.
2074  */
2075 #define SET_NETDEV_DEV(net, pdev)       ((net)->dev.parent = (pdev))
2076
2077 /* Set the sysfs device type for the network logical device to allow
2078  * fine-grained identification of different network device types. For
2079  * example Ethernet, Wireless LAN, Bluetooth, WiMAX etc.
2080  */
2081 #define SET_NETDEV_DEVTYPE(net, devtype)        ((net)->dev.type = (devtype))
2082
2083 /* Default NAPI poll() weight
2084  * Device drivers are strongly advised to not use bigger value
2085  */
2086 #define NAPI_POLL_WEIGHT 64
2087
2088 /**
2089  *      netif_napi_add - initialize a NAPI context
2090  *      @dev:  network device
2091  *      @napi: NAPI context
2092  *      @poll: polling function
2093  *      @weight: default weight
2094  *
2095  * netif_napi_add() must be used to initialize a NAPI context prior to calling
2096  * *any* of the other NAPI-related functions.
2097  */
2098 void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
2099                     int (*poll)(struct napi_struct *, int), int weight);
2100
2101 /**
2102  *      netif_tx_napi_add - initialize a NAPI context
2103  *      @dev:  network device
2104  *      @napi: NAPI context
2105  *      @poll: polling function
2106  *      @weight: default weight
2107  *
2108  * This variant of netif_napi_add() should be used from drivers using NAPI
2109  * to exclusively poll a TX queue.
2110  * This will avoid we add it into napi_hash[], thus polluting this hash table.
2111  */
2112 static inline void netif_tx_napi_add(struct net_device *dev,
2113                                      struct napi_struct *napi,
2114                                      int (*poll)(struct napi_struct *, int),
2115                                      int weight)
2116 {
2117         set_bit(NAPI_STATE_NO_BUSY_POLL, &napi->state);
2118         netif_napi_add(dev, napi, poll, weight);
2119 }
2120
2121 /**
2122  *  netif_napi_del - remove a NAPI context
2123  *  @napi: NAPI context
2124  *
2125  *  netif_napi_del() removes a NAPI context from the network device NAPI list
2126  */
2127 void netif_napi_del(struct napi_struct *napi);
2128
2129 struct napi_gro_cb {
2130         /* Virtual address of skb_shinfo(skb)->frags[0].page + offset. */
2131         void    *frag0;
2132
2133         /* Length of frag0. */
2134         unsigned int frag0_len;
2135
2136         /* This indicates where we are processing relative to skb->data. */
2137         int     data_offset;
2138
2139         /* This is non-zero if the packet cannot be merged with the new skb. */
2140         u16     flush;
2141
2142         /* Save the IP ID here and check when we get to the transport layer */
2143         u16     flush_id;
2144
2145         /* Number of segments aggregated. */
2146         u16     count;
2147
2148         /* Start offset for remote checksum offload */
2149         u16     gro_remcsum_start;
2150
2151         /* jiffies when first packet was created/queued */
2152         unsigned long age;
2153
2154         /* Used in ipv6_gro_receive() and foo-over-udp */
2155         u16     proto;
2156
2157         /* This is non-zero if the packet may be of the same flow. */
2158         u8      same_flow:1;
2159
2160         /* Used in tunnel GRO receive */
2161         u8      encap_mark:1;
2162
2163         /* GRO checksum is valid */
2164         u8      csum_valid:1;
2165
2166         /* Number of checksums via CHECKSUM_UNNECESSARY */
2167         u8      csum_cnt:3;
2168
2169         /* Free the skb? */
2170         u8      free:2;
2171 #define NAPI_GRO_FREE             1
2172 #define NAPI_GRO_FREE_STOLEN_HEAD 2
2173
2174         /* Used in foo-over-udp, set in udp[46]_gro_receive */
2175         u8      is_ipv6:1;
2176
2177         /* Used in GRE, set in fou/gue_gro_receive */
2178         u8      is_fou:1;
2179
2180         /* Used to determine if flush_id can be ignored */
2181         u8      is_atomic:1;
2182
2183         /* Number of gro_receive callbacks this packet already went through */
2184         u8 recursion_counter:4;
2185
2186         /* 1 bit hole */
2187
2188         /* used to support CHECKSUM_COMPLETE for tunneling protocols */
2189         __wsum  csum;
2190
2191         /* used in skb_gro_receive() slow path */
2192         struct sk_buff *last;
2193 };
2194
2195 #define NAPI_GRO_CB(skb) ((struct napi_gro_cb *)(skb)->cb)
2196
2197 #define GRO_RECURSION_LIMIT 15
2198 static inline int gro_recursion_inc_test(struct sk_buff *skb)
2199 {
2200         return ++NAPI_GRO_CB(skb)->recursion_counter == GRO_RECURSION_LIMIT;
2201 }
2202
2203 typedef struct sk_buff **(*gro_receive_t)(struct sk_buff **, struct sk_buff *);
2204 static inline struct sk_buff **call_gro_receive(gro_receive_t cb,
2205                                                 struct sk_buff **head,
2206                                                 struct sk_buff *skb)
2207 {
2208         if (unlikely(gro_recursion_inc_test(skb))) {
2209                 NAPI_GRO_CB(skb)->flush |= 1;
2210                 return NULL;
2211         }
2212
2213         return cb(head, skb);
2214 }
2215
2216 typedef struct sk_buff **(*gro_receive_sk_t)(struct sock *, struct sk_buff **,
2217                                              struct sk_buff *);
2218 static inline struct sk_buff **call_gro_receive_sk(gro_receive_sk_t cb,
2219                                                    struct sock *sk,
2220                                                    struct sk_buff **head,
2221                                                    struct sk_buff *skb)
2222 {
2223         if (unlikely(gro_recursion_inc_test(skb))) {
2224                 NAPI_GRO_CB(skb)->flush |= 1;
2225                 return NULL;
2226         }
2227
2228         return cb(sk, head, skb);
2229 }
2230
2231 struct packet_type {
2232         __be16                  type;   /* This is really htons(ether_type). */
2233         struct net_device       *dev;   /* NULL is wildcarded here           */
2234         int                     (*func) (struct sk_buff *,
2235                                          struct net_device *,
2236                                          struct packet_type *,
2237                                          struct net_device *);
2238         bool                    (*id_match)(struct packet_type *ptype,
2239                                             struct sock *sk);
2240         void                    *af_packet_priv;
2241         struct list_head        list;
2242 };
2243
2244 struct offload_callbacks {
2245         struct sk_buff          *(*gso_segment)(struct sk_buff *skb,
2246                                                 netdev_features_t features);
2247         struct sk_buff          **(*gro_receive)(struct sk_buff **head,
2248                                                  struct sk_buff *skb);
2249         int                     (*gro_complete)(struct sk_buff *skb, int nhoff);
2250 };
2251
2252 struct packet_offload {
2253         __be16                   type;  /* This is really htons(ether_type). */
2254         u16                      priority;
2255         struct offload_callbacks callbacks;
2256         struct list_head         list;
2257 };
2258
2259 /* often modified stats are per-CPU, other are shared (netdev->stats) */
2260 struct pcpu_sw_netstats {
2261         u64     rx_packets;
2262         u64     rx_bytes;
2263         u64     tx_packets;
2264         u64     tx_bytes;
2265         struct u64_stats_sync   syncp;
2266 };
2267
2268 #define __netdev_alloc_pcpu_stats(type, gfp)                            \
2269 ({                                                                      \
2270         typeof(type) __percpu *pcpu_stats = alloc_percpu_gfp(type, gfp);\
2271         if (pcpu_stats) {                                               \
2272                 int __cpu;                                              \
2273                 for_each_possible_cpu(__cpu) {                          \
2274                         typeof(type) *stat;                             \
2275                         stat = per_cpu_ptr(pcpu_stats, __cpu);          \
2276                         u64_stats_init(&stat->syncp);                   \
2277                 }                                                       \
2278         }                                                               \
2279         pcpu_stats;                                                     \
2280 })
2281
2282 #define netdev_alloc_pcpu_stats(type)                                   \
2283         __netdev_alloc_pcpu_stats(type, GFP_KERNEL)
2284
2285 enum netdev_lag_tx_type {
2286         NETDEV_LAG_TX_TYPE_UNKNOWN,
2287         NETDEV_LAG_TX_TYPE_RANDOM,
2288         NETDEV_LAG_TX_TYPE_BROADCAST,
2289         NETDEV_LAG_TX_TYPE_ROUNDROBIN,
2290         NETDEV_LAG_TX_TYPE_ACTIVEBACKUP,
2291         NETDEV_LAG_TX_TYPE_HASH,
2292 };
2293
2294 struct netdev_lag_upper_info {
2295         enum netdev_lag_tx_type tx_type;
2296 };
2297
2298 struct netdev_lag_lower_state_info {
2299         u8 link_up : 1,
2300            tx_enabled : 1;
2301 };
2302
2303 #include <linux/notifier.h>
2304
2305 /* netdevice notifier chain. Please remember to update the rtnetlink
2306  * notification exclusion list in rtnetlink_event() when adding new
2307  * types.
2308  */
2309 #define NETDEV_UP       0x0001  /* For now you can't veto a device up/down */
2310 #define NETDEV_DOWN     0x0002
2311 #define NETDEV_REBOOT   0x0003  /* Tell a protocol stack a network interface
2312                                    detected a hardware crash and restarted
2313                                    - we can use this eg to kick tcp sessions
2314                                    once done */
2315 #define NETDEV_CHANGE   0x0004  /* Notify device state change */
2316 #define NETDEV_REGISTER 0x0005
2317 #define NETDEV_UNREGISTER       0x0006
2318 #define NETDEV_CHANGEMTU        0x0007 /* notify after mtu change happened */
2319 #define NETDEV_CHANGEADDR       0x0008
2320 #define NETDEV_GOING_DOWN       0x0009
2321 #define NETDEV_CHANGENAME       0x000A
2322 #define NETDEV_FEAT_CHANGE      0x000B
2323 #define NETDEV_BONDING_FAILOVER 0x000C
2324 #define NETDEV_PRE_UP           0x000D
2325 #define NETDEV_PRE_TYPE_CHANGE  0x000E
2326 #define NETDEV_POST_TYPE_CHANGE 0x000F
2327 #define NETDEV_POST_INIT        0x0010
2328 #define NETDEV_UNREGISTER_FINAL 0x0011
2329 #define NETDEV_RELEASE          0x0012
2330 #define NETDEV_NOTIFY_PEERS     0x0013
2331 #define NETDEV_JOIN             0x0014
2332 #define NETDEV_CHANGEUPPER      0x0015
2333 #define NETDEV_RESEND_IGMP      0x0016
2334 #define NETDEV_PRECHANGEMTU     0x0017 /* notify before mtu change happened */
2335 #define NETDEV_CHANGEINFODATA   0x0018
2336 #define NETDEV_BONDING_INFO     0x0019
2337 #define NETDEV_PRECHANGEUPPER   0x001A
2338 #define NETDEV_CHANGELOWERSTATE 0x001B
2339 #define NETDEV_UDP_TUNNEL_PUSH_INFO     0x001C
2340 #define NETDEV_CHANGE_TX_QUEUE_LEN      0x001E
2341
2342 int register_netdevice_notifier(struct notifier_block *nb);
2343 int unregister_netdevice_notifier(struct notifier_block *nb);
2344
2345 struct netdev_notifier_info {
2346         struct net_device *dev;
2347 };
2348
2349 struct netdev_notifier_info_ext {
2350         struct netdev_notifier_info info; /* must be first */
2351         union {
2352                 u32 mtu;
2353         } ext;
2354 };
2355
2356 struct netdev_notifier_change_info {
2357         struct netdev_notifier_info info; /* must be first */
2358         unsigned int flags_changed;
2359 };
2360
2361 struct netdev_notifier_changeupper_info {
2362         struct netdev_notifier_info info; /* must be first */
2363         struct net_device *upper_dev; /* new upper dev */
2364         bool master; /* is upper dev master */
2365         bool linking; /* is the notification for link or unlink */
2366         void *upper_info; /* upper dev info */
2367 };
2368
2369 struct netdev_notifier_changelowerstate_info {
2370         struct netdev_notifier_info info; /* must be first */
2371         void *lower_state_info; /* is lower dev state */
2372 };
2373
2374 static inline void netdev_notifier_info_init(struct netdev_notifier_info *info,
2375                                              struct net_device *dev)
2376 {
2377         info->dev = dev;
2378 }
2379
2380 static inline struct net_device *
2381 netdev_notifier_info_to_dev(const struct netdev_notifier_info *info)
2382 {
2383         return info->dev;
2384 }
2385
2386 int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
2387
2388
2389 extern rwlock_t                         dev_base_lock;          /* Device list lock */
2390
2391 #define for_each_netdev(net, d)         \
2392                 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
2393 #define for_each_netdev_reverse(net, d) \
2394                 list_for_each_entry_reverse(d, &(net)->dev_base_head, dev_list)
2395 #define for_each_netdev_rcu(net, d)             \
2396                 list_for_each_entry_rcu(d, &(net)->dev_base_head, dev_list)
2397 #define for_each_netdev_safe(net, d, n) \
2398                 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
2399 #define for_each_netdev_continue(net, d)                \
2400                 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
2401 #define for_each_netdev_continue_rcu(net, d)            \
2402         list_for_each_entry_continue_rcu(d, &(net)->dev_base_head, dev_list)
2403 #define for_each_netdev_in_bond_rcu(bond, slave)        \
2404                 for_each_netdev_rcu(&init_net, slave)   \
2405                         if (netdev_master_upper_dev_get_rcu(slave) == (bond))
2406 #define net_device_entry(lh)    list_entry(lh, struct net_device, dev_list)
2407
2408 static inline struct net_device *next_net_device(struct net_device *dev)
2409 {
2410         struct list_head *lh;
2411         struct net *net;
2412
2413         net = dev_net(dev);
2414         lh = dev->dev_list.next;
2415         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2416 }
2417
2418 static inline struct net_device *next_net_device_rcu(struct net_device *dev)
2419 {
2420         struct list_head *lh;
2421         struct net *net;
2422
2423         net = dev_net(dev);
2424         lh = rcu_dereference(list_next_rcu(&dev->dev_list));
2425         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2426 }
2427
2428 static inline struct net_device *first_net_device(struct net *net)
2429 {
2430         return list_empty(&net->dev_base_head) ? NULL :
2431                 net_device_entry(net->dev_base_head.next);
2432 }
2433
2434 static inline struct net_device *first_net_device_rcu(struct net *net)
2435 {
2436         struct list_head *lh = rcu_dereference(list_next_rcu(&net->dev_base_head));
2437
2438         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2439 }
2440
2441 int netdev_boot_setup_check(struct net_device *dev);
2442 unsigned long netdev_boot_base(const char *prefix, int unit);
2443 struct net_device *dev_getbyhwaddr_rcu(struct net *net, unsigned short type,
2444                                        const char *hwaddr);
2445 struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
2446 struct net_device *__dev_getfirstbyhwtype(struct net *net, unsigned short type);
2447 void dev_add_pack(struct packet_type *pt);
2448 void dev_remove_pack(struct packet_type *pt);
2449 void __dev_remove_pack(struct packet_type *pt);
2450 void dev_add_offload(struct packet_offload *po);
2451 void dev_remove_offload(struct packet_offload *po);
2452
2453 int dev_get_iflink(const struct net_device *dev);
2454 int dev_fill_metadata_dst(struct net_device *dev, struct sk_buff *skb);
2455 struct net_device *__dev_get_by_flags(struct net *net, unsigned short flags,
2456                                       unsigned short mask);
2457 struct net_device *dev_get_by_name(struct net *net, const char *name);
2458 struct net_device *dev_get_by_name_rcu(struct net *net, const char *name);
2459 struct net_device *__dev_get_by_name(struct net *net, const char *name);
2460 int dev_alloc_name(struct net_device *dev, const char *name);
2461 int dev_open(struct net_device *dev);
2462 int dev_close(struct net_device *dev);
2463 int dev_close_many(struct list_head *head, bool unlink);
2464 void dev_disable_lro(struct net_device *dev);
2465 int dev_loopback_xmit(struct net *net, struct sock *sk, struct sk_buff *newskb);
2466 int dev_queue_xmit(struct sk_buff *skb);
2467 int dev_queue_xmit_accel(struct sk_buff *skb, void *accel_priv);
2468 int register_netdevice(struct net_device *dev);
2469 void unregister_netdevice_queue(struct net_device *dev, struct list_head *head);
2470 void unregister_netdevice_many(struct list_head *head);
2471 static inline void unregister_netdevice(struct net_device *dev)
2472 {
2473         unregister_netdevice_queue(dev, NULL);
2474 }
2475
2476 int netdev_refcnt_read(const struct net_device *dev);
2477 void free_netdev(struct net_device *dev);
2478 void netdev_freemem(struct net_device *dev);
2479 void synchronize_net(void);
2480 int init_dummy_netdev(struct net_device *dev);
2481
2482 DECLARE_PER_CPU(int, xmit_recursion);
2483 #define XMIT_RECURSION_LIMIT    8
2484
2485 static inline int dev_recursion_level(void)
2486 {
2487         return this_cpu_read(xmit_recursion);
2488 }
2489
2490 struct net_device *dev_get_by_index(struct net *net, int ifindex);
2491 struct net_device *__dev_get_by_index(struct net *net, int ifindex);
2492 struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex);
2493 int netdev_get_name(struct net *net, char *name, int ifindex);
2494 int dev_restart(struct net_device *dev);
2495 int skb_gro_receive(struct sk_buff **head, struct sk_buff *skb);
2496
2497 static inline unsigned int skb_gro_offset(const struct sk_buff *skb)
2498 {
2499         return NAPI_GRO_CB(skb)->data_offset;
2500 }
2501
2502 static inline unsigned int skb_gro_len(const struct sk_buff *skb)
2503 {
2504         return skb->len - NAPI_GRO_CB(skb)->data_offset;
2505 }
2506
2507 static inline void skb_gro_pull(struct sk_buff *skb, unsigned int len)
2508 {
2509         NAPI_GRO_CB(skb)->data_offset += len;
2510 }
2511
2512 static inline void *skb_gro_header_fast(struct sk_buff *skb,
2513                                         unsigned int offset)
2514 {
2515         return NAPI_GRO_CB(skb)->frag0 + offset;
2516 }
2517
2518 static inline int skb_gro_header_hard(struct sk_buff *skb, unsigned int hlen)
2519 {
2520         return NAPI_GRO_CB(skb)->frag0_len < hlen;
2521 }
2522
2523 static inline void skb_gro_frag0_invalidate(struct sk_buff *skb)
2524 {
2525         NAPI_GRO_CB(skb)->frag0 = NULL;
2526         NAPI_GRO_CB(skb)->frag0_len = 0;
2527 }
2528
2529 static inline void *skb_gro_header_slow(struct sk_buff *skb, unsigned int hlen,
2530                                         unsigned int offset)
2531 {
2532         if (!pskb_may_pull(skb, hlen))
2533                 return NULL;
2534
2535         skb_gro_frag0_invalidate(skb);
2536         return skb->data + offset;
2537 }
2538
2539 static inline void *skb_gro_network_header(struct sk_buff *skb)
2540 {
2541         return (NAPI_GRO_CB(skb)->frag0 ?: skb->data) +
2542                skb_network_offset(skb);
2543 }
2544
2545 static inline void skb_gro_postpull_rcsum(struct sk_buff *skb,
2546                                         const void *start, unsigned int len)
2547 {
2548         if (NAPI_GRO_CB(skb)->csum_valid)
2549                 NAPI_GRO_CB(skb)->csum = csum_sub(NAPI_GRO_CB(skb)->csum,
2550                                                   csum_partial(start, len, 0));
2551 }
2552
2553 /* GRO checksum functions. These are logical equivalents of the normal
2554  * checksum functions (in skbuff.h) except that they operate on the GRO
2555  * offsets and fields in sk_buff.
2556  */
2557
2558 __sum16 __skb_gro_checksum_complete(struct sk_buff *skb);
2559
2560 static inline bool skb_at_gro_remcsum_start(struct sk_buff *skb)
2561 {
2562         return (NAPI_GRO_CB(skb)->gro_remcsum_start == skb_gro_offset(skb));
2563 }
2564
2565 static inline bool __skb_gro_checksum_validate_needed(struct sk_buff *skb,
2566                                                       bool zero_okay,
2567                                                       __sum16 check)
2568 {
2569         return ((skb->ip_summed != CHECKSUM_PARTIAL ||
2570                 skb_checksum_start_offset(skb) <
2571                  skb_gro_offset(skb)) &&
2572                 !skb_at_gro_remcsum_start(skb) &&
2573                 NAPI_GRO_CB(skb)->csum_cnt == 0 &&
2574                 (!zero_okay || check));
2575 }
2576
2577 static inline __sum16 __skb_gro_checksum_validate_complete(struct sk_buff *skb,
2578                                                            __wsum psum)
2579 {
2580         if (NAPI_GRO_CB(skb)->csum_valid &&
2581             !csum_fold(csum_add(psum, NAPI_GRO_CB(skb)->csum)))
2582                 return 0;
2583
2584         NAPI_GRO_CB(skb)->csum = psum;
2585
2586         return __skb_gro_checksum_complete(skb);
2587 }
2588
2589 static inline void skb_gro_incr_csum_unnecessary(struct sk_buff *skb)
2590 {
2591         if (NAPI_GRO_CB(skb)->csum_cnt > 0) {
2592                 /* Consume a checksum from CHECKSUM_UNNECESSARY */
2593                 NAPI_GRO_CB(skb)->csum_cnt--;
2594         } else {
2595                 /* Update skb for CHECKSUM_UNNECESSARY and csum_level when we
2596                  * verified a new top level checksum or an encapsulated one
2597                  * during GRO. This saves work if we fallback to normal path.
2598                  */
2599                 __skb_incr_checksum_unnecessary(skb);
2600         }
2601 }
2602
2603 #define __skb_gro_checksum_validate(skb, proto, zero_okay, check,       \
2604                                     compute_pseudo)                     \
2605 ({                                                                      \
2606         __sum16 __ret = 0;                                              \
2607         if (__skb_gro_checksum_validate_needed(skb, zero_okay, check))  \
2608                 __ret = __skb_gro_checksum_validate_complete(skb,       \
2609                                 compute_pseudo(skb, proto));            \
2610         if (__ret)                                                      \
2611                 __skb_mark_checksum_bad(skb);                           \
2612         else                                                            \
2613                 skb_gro_incr_csum_unnecessary(skb);                     \
2614         __ret;                                                          \
2615 })
2616
2617 #define skb_gro_checksum_validate(skb, proto, compute_pseudo)           \
2618         __skb_gro_checksum_validate(skb, proto, false, 0, compute_pseudo)
2619
2620 #define skb_gro_checksum_validate_zero_check(skb, proto, check,         \
2621                                              compute_pseudo)            \
2622         __skb_gro_checksum_validate(skb, proto, true, check, compute_pseudo)
2623
2624 #define skb_gro_checksum_simple_validate(skb)                           \
2625         __skb_gro_checksum_validate(skb, 0, false, 0, null_compute_pseudo)
2626
2627 static inline bool __skb_gro_checksum_convert_check(struct sk_buff *skb)
2628 {
2629         return (NAPI_GRO_CB(skb)->csum_cnt == 0 &&
2630                 !NAPI_GRO_CB(skb)->csum_valid);
2631 }
2632
2633 static inline void __skb_gro_checksum_convert(struct sk_buff *skb,
2634                                               __sum16 check, __wsum pseudo)
2635 {
2636         NAPI_GRO_CB(skb)->csum = ~pseudo;
2637         NAPI_GRO_CB(skb)->csum_valid = 1;
2638 }
2639
2640 #define skb_gro_checksum_try_convert(skb, proto, check, compute_pseudo) \
2641 do {                                                                    \
2642         if (__skb_gro_checksum_convert_check(skb))                      \
2643                 __skb_gro_checksum_convert(skb, check,                  \
2644                                            compute_pseudo(skb, proto)); \
2645 } while (0)
2646
2647 struct gro_remcsum {
2648         int offset;
2649         __wsum delta;
2650 };
2651
2652 static inline void skb_gro_remcsum_init(struct gro_remcsum *grc)
2653 {
2654         grc->offset = 0;
2655         grc->delta = 0;
2656 }
2657
2658 static inline void *skb_gro_remcsum_process(struct sk_buff *skb, void *ptr,
2659                                             unsigned int off, size_t hdrlen,
2660                                             int start, int offset,
2661                                             struct gro_remcsum *grc,
2662                                             bool nopartial)
2663 {
2664         __wsum delta;
2665         size_t plen = hdrlen + max_t(size_t, offset + sizeof(u16), start);
2666
2667         BUG_ON(!NAPI_GRO_CB(skb)->csum_valid);
2668
2669         if (!nopartial) {
2670                 NAPI_GRO_CB(skb)->gro_remcsum_start = off + hdrlen + start;
2671                 return ptr;
2672         }
2673
2674         ptr = skb_gro_header_fast(skb, off);
2675         if (skb_gro_header_hard(skb, off + plen)) {
2676                 ptr = skb_gro_header_slow(skb, off + plen, off);
2677                 if (!ptr)
2678                         return NULL;
2679         }
2680
2681         delta = remcsum_adjust(ptr + hdrlen, NAPI_GRO_CB(skb)->csum,
2682                                start, offset);
2683
2684         /* Adjust skb->csum since we changed the packet */
2685         NAPI_GRO_CB(skb)->csum = csum_add(NAPI_GRO_CB(skb)->csum, delta);
2686
2687         grc->offset = off + hdrlen + offset;
2688         grc->delta = delta;
2689
2690         return ptr;
2691 }
2692
2693 static inline void skb_gro_remcsum_cleanup(struct sk_buff *skb,
2694                                            struct gro_remcsum *grc)
2695 {
2696         void *ptr;
2697         size_t plen = grc->offset + sizeof(u16);
2698
2699         if (!grc->delta)
2700                 return;
2701
2702         ptr = skb_gro_header_fast(skb, grc->offset);
2703         if (skb_gro_header_hard(skb, grc->offset + sizeof(u16))) {
2704                 ptr = skb_gro_header_slow(skb, plen, grc->offset);
2705                 if (!ptr)
2706                         return;
2707         }
2708
2709         remcsum_unadjust((__sum16 *)ptr, grc->delta);
2710 }
2711
2712 struct skb_csum_offl_spec {
2713         __u16           ipv4_okay:1,
2714                         ipv6_okay:1,
2715                         encap_okay:1,
2716                         ip_options_okay:1,
2717                         ext_hdrs_okay:1,
2718                         tcp_okay:1,
2719                         udp_okay:1,
2720                         sctp_okay:1,
2721                         vlan_okay:1,
2722                         no_encapped_ipv6:1,
2723                         no_not_encapped:1;
2724 };
2725
2726 bool __skb_csum_offload_chk(struct sk_buff *skb,
2727                             const struct skb_csum_offl_spec *spec,
2728                             bool *csum_encapped,
2729                             bool csum_help);
2730
2731 static inline bool skb_csum_offload_chk(struct sk_buff *skb,
2732                                         const struct skb_csum_offl_spec *spec,
2733                                         bool *csum_encapped,
2734                                         bool csum_help)
2735 {
2736         if (skb->ip_summed != CHECKSUM_PARTIAL)
2737                 return false;
2738
2739         return __skb_csum_offload_chk(skb, spec, csum_encapped, csum_help);
2740 }
2741
2742 static inline bool skb_csum_offload_chk_help(struct sk_buff *skb,
2743                                              const struct skb_csum_offl_spec *spec)
2744 {
2745         bool csum_encapped;
2746
2747         return skb_csum_offload_chk(skb, spec, &csum_encapped, true);
2748 }
2749
2750 static inline bool skb_csum_off_chk_help_cmn(struct sk_buff *skb)
2751 {
2752         static const struct skb_csum_offl_spec csum_offl_spec = {
2753                 .ipv4_okay = 1,
2754                 .ip_options_okay = 1,
2755                 .ipv6_okay = 1,
2756                 .vlan_okay = 1,
2757                 .tcp_okay = 1,
2758                 .udp_okay = 1,
2759         };
2760
2761         return skb_csum_offload_chk_help(skb, &csum_offl_spec);
2762 }
2763
2764 static inline bool skb_csum_off_chk_help_cmn_v4_only(struct sk_buff *skb)
2765 {
2766         static const struct skb_csum_offl_spec csum_offl_spec = {
2767                 .ipv4_okay = 1,
2768                 .ip_options_okay = 1,
2769                 .tcp_okay = 1,
2770                 .udp_okay = 1,
2771                 .vlan_okay = 1,
2772         };
2773
2774         return skb_csum_offload_chk_help(skb, &csum_offl_spec);
2775 }
2776
2777 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
2778                                   unsigned short type,
2779                                   const void *daddr, const void *saddr,
2780                                   unsigned int len)
2781 {
2782         if (!dev->header_ops || !dev->header_ops->create)
2783                 return 0;
2784
2785         return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
2786 }
2787
2788 static inline int dev_parse_header(const struct sk_buff *skb,
2789                                    unsigned char *haddr)
2790 {
2791         const struct net_device *dev = skb->dev;
2792
2793         if (!dev->header_ops || !dev->header_ops->parse)
2794                 return 0;
2795         return dev->header_ops->parse(skb, haddr);
2796 }
2797
2798 /* ll_header must have at least hard_header_len allocated */
2799 static inline bool dev_validate_header(const struct net_device *dev,
2800                                        char *ll_header, int len)
2801 {
2802         if (likely(len >= dev->hard_header_len))
2803                 return true;
2804         if (len < dev->min_header_len)
2805                 return false;
2806
2807         if (capable(CAP_SYS_RAWIO)) {
2808                 memset(ll_header + len, 0, dev->hard_header_len - len);
2809                 return true;
2810         }
2811
2812         if (dev->header_ops && dev->header_ops->validate)
2813                 return dev->header_ops->validate(ll_header, len);
2814
2815         return false;
2816 }
2817
2818 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
2819 int register_gifconf(unsigned int family, gifconf_func_t *gifconf);
2820 static inline int unregister_gifconf(unsigned int family)
2821 {
2822         return register_gifconf(family, NULL);
2823 }
2824
2825 #ifdef CONFIG_NET_FLOW_LIMIT
2826 #define FLOW_LIMIT_HISTORY      (1 << 7)  /* must be ^2 and !overflow buckets */
2827 struct sd_flow_limit {
2828         u64                     count;
2829         unsigned int            num_buckets;
2830         unsigned int            history_head;
2831         u16                     history[FLOW_LIMIT_HISTORY];
2832         u8                      buckets[];
2833 };
2834
2835 extern int netdev_flow_limit_table_len;
2836 #endif /* CONFIG_NET_FLOW_LIMIT */
2837
2838 /*
2839  * Incoming packets are placed on per-CPU queues
2840  */
2841 struct softnet_data {
2842         struct list_head        poll_list;
2843         struct sk_buff_head     process_queue;
2844
2845         /* stats */
2846         unsigned int            processed;
2847         unsigned int            time_squeeze;
2848         unsigned int            received_rps;
2849 #ifdef CONFIG_RPS
2850         struct softnet_data     *rps_ipi_list;
2851 #endif
2852 #ifdef CONFIG_NET_FLOW_LIMIT
2853         struct sd_flow_limit __rcu *flow_limit;
2854 #endif
2855         struct Qdisc            *output_queue;
2856         struct Qdisc            **output_queue_tailp;
2857         struct sk_buff          *completion_queue;
2858
2859 #ifdef CONFIG_RPS
2860         /* input_queue_head should be written by cpu owning this struct,
2861          * and only read by other cpus. Worth using a cache line.
2862          */
2863         unsigned int            input_queue_head ____cacheline_aligned_in_smp;
2864
2865         /* Elements below can be accessed between CPUs for RPS/RFS */
2866         struct call_single_data csd ____cacheline_aligned_in_smp;
2867         struct softnet_data     *rps_ipi_next;
2868         unsigned int            cpu;
2869         unsigned int            input_queue_tail;
2870 #endif
2871         unsigned int            dropped;
2872         struct sk_buff_head     input_pkt_queue;
2873         struct napi_struct      backlog;
2874
2875 };
2876
2877 static inline void input_queue_head_incr(struct softnet_data *sd)
2878 {
2879 #ifdef CONFIG_RPS
2880         sd->input_queue_head++;
2881 #endif
2882 }
2883
2884 static inline void input_queue_tail_incr_save(struct softnet_data *sd,
2885                                               unsigned int *qtail)
2886 {
2887 #ifdef CONFIG_RPS
2888         *qtail = ++sd->input_queue_tail;
2889 #endif
2890 }
2891
2892 DECLARE_PER_CPU_ALIGNED(struct softnet_data, softnet_data);
2893
2894 void __netif_schedule(struct Qdisc *q);
2895 void netif_schedule_queue(struct netdev_queue *txq);
2896
2897 static inline void netif_tx_schedule_all(struct net_device *dev)
2898 {
2899         unsigned int i;
2900
2901         for (i = 0; i < dev->num_tx_queues; i++)
2902                 netif_schedule_queue(netdev_get_tx_queue(dev, i));
2903 }
2904
2905 static __always_inline void netif_tx_start_queue(struct netdev_queue *dev_queue)
2906 {
2907         clear_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2908 }
2909
2910 /**
2911  *      netif_start_queue - allow transmit
2912  *      @dev: network device
2913  *
2914  *      Allow upper layers to call the device hard_start_xmit routine.
2915  */
2916 static inline void netif_start_queue(struct net_device *dev)
2917 {
2918         netif_tx_start_queue(netdev_get_tx_queue(dev, 0));
2919 }
2920
2921 static inline void netif_tx_start_all_queues(struct net_device *dev)
2922 {
2923         unsigned int i;
2924
2925         for (i = 0; i < dev->num_tx_queues; i++) {
2926                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2927                 netif_tx_start_queue(txq);
2928         }
2929 }
2930
2931 void netif_tx_wake_queue(struct netdev_queue *dev_queue);
2932
2933 /**
2934  *      netif_wake_queue - restart transmit
2935  *      @dev: network device
2936  *
2937  *      Allow upper layers to call the device hard_start_xmit routine.
2938  *      Used for flow control when transmit resources are available.
2939  */
2940 static inline void netif_wake_queue(struct net_device *dev)
2941 {
2942         netif_tx_wake_queue(netdev_get_tx_queue(dev, 0));
2943 }
2944
2945 static inline void netif_tx_wake_all_queues(struct net_device *dev)
2946 {
2947         unsigned int i;
2948
2949         for (i = 0; i < dev->num_tx_queues; i++) {
2950                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2951                 netif_tx_wake_queue(txq);
2952         }
2953 }
2954
2955 static __always_inline void netif_tx_stop_queue(struct netdev_queue *dev_queue)
2956 {
2957         set_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2958 }
2959
2960 /**
2961  *      netif_stop_queue - stop transmitted packets
2962  *      @dev: network device
2963  *
2964  *      Stop upper layers calling the device hard_start_xmit routine.
2965  *      Used for flow control when transmit resources are unavailable.
2966  */
2967 static inline void netif_stop_queue(struct net_device *dev)
2968 {
2969         netif_tx_stop_queue(netdev_get_tx_queue(dev, 0));
2970 }
2971
2972 void netif_tx_stop_all_queues(struct net_device *dev);
2973
2974 static inline bool netif_tx_queue_stopped(const struct netdev_queue *dev_queue)
2975 {
2976         return test_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2977 }
2978
2979 /**
2980  *      netif_queue_stopped - test if transmit queue is flowblocked
2981  *      @dev: network device
2982  *
2983  *      Test if transmit queue on device is currently unable to send.
2984  */
2985 static inline bool netif_queue_stopped(const struct net_device *dev)
2986 {
2987         return netif_tx_queue_stopped(netdev_get_tx_queue(dev, 0));
2988 }
2989
2990 static inline bool netif_xmit_stopped(const struct netdev_queue *dev_queue)
2991 {
2992         return dev_queue->state & QUEUE_STATE_ANY_XOFF;
2993 }
2994
2995 static inline bool
2996 netif_xmit_frozen_or_stopped(const struct netdev_queue *dev_queue)
2997 {
2998         return dev_queue->state & QUEUE_STATE_ANY_XOFF_OR_FROZEN;
2999 }
3000
3001 static inline bool
3002 netif_xmit_frozen_or_drv_stopped(const struct netdev_queue *dev_queue)
3003 {
3004         return dev_queue->state & QUEUE_STATE_DRV_XOFF_OR_FROZEN;
3005 }
3006
3007 /**
3008  *      netdev_txq_bql_enqueue_prefetchw - prefetch bql data for write
3009  *      @dev_queue: pointer to transmit queue
3010  *
3011  * BQL enabled drivers might use this helper in their ndo_start_xmit(),
3012  * to give appropriate hint to the CPU.
3013  */
3014 static inline void netdev_txq_bql_enqueue_prefetchw(struct netdev_queue *dev_queue)
3015 {
3016 #ifdef CONFIG_BQL
3017         prefetchw(&dev_queue->dql.num_queued);
3018 #endif
3019 }
3020
3021 /**
3022  *      netdev_txq_bql_complete_prefetchw - prefetch bql data for write
3023  *      @dev_queue: pointer to transmit queue
3024  *
3025  * BQL enabled drivers might use this helper in their TX completion path,
3026  * to give appropriate hint to the CPU.
3027  */
3028 static inline void netdev_txq_bql_complete_prefetchw(struct netdev_queue *dev_queue)
3029 {
3030 #ifdef CONFIG_BQL
3031         prefetchw(&dev_queue->dql.limit);
3032 #endif
3033 }
3034
3035 static inline void netdev_tx_sent_queue(struct netdev_queue *dev_queue,
3036                                         unsigned int bytes)
3037 {
3038 #ifdef CONFIG_BQL
3039         dql_queued(&dev_queue->dql, bytes);
3040
3041         if (likely(dql_avail(&dev_queue->dql) >= 0))
3042                 return;
3043
3044         set_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
3045
3046         /*
3047          * The XOFF flag must be set before checking the dql_avail below,
3048          * because in netdev_tx_completed_queue we update the dql_completed
3049          * before checking the XOFF flag.
3050          */
3051         smp_mb();
3052
3053         /* check again in case another CPU has just made room avail */
3054         if (unlikely(dql_avail(&dev_queue->dql) >= 0))
3055                 clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
3056 #endif
3057 }
3058
3059 /**
3060  *      netdev_sent_queue - report the number of bytes queued to hardware
3061  *      @dev: network device
3062  *      @bytes: number of bytes queued to the hardware device queue
3063  *
3064  *      Report the number of bytes queued for sending/completion to the network
3065  *      device hardware queue. @bytes should be a good approximation and should
3066  *      exactly match netdev_completed_queue() @bytes
3067  */
3068 static inline void netdev_sent_queue(struct net_device *dev, unsigned int bytes)
3069 {
3070         netdev_tx_sent_queue(netdev_get_tx_queue(dev, 0), bytes);
3071 }
3072
3073 static inline void netdev_tx_completed_queue(struct netdev_queue *dev_queue,
3074                                              unsigned int pkts, unsigned int bytes)
3075 {
3076 #ifdef CONFIG_BQL
3077         if (unlikely(!bytes))
3078                 return;
3079
3080         dql_completed(&dev_queue->dql, bytes);
3081
3082         /*
3083          * Without the memory barrier there is a small possiblity that
3084          * netdev_tx_sent_queue will miss the update and cause the queue to
3085          * be stopped forever
3086          */
3087         smp_mb();
3088
3089         if (dql_avail(&dev_queue->dql) < 0)
3090                 return;
3091
3092         if (test_and_clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state))
3093                 netif_schedule_queue(dev_queue);
3094 #endif
3095 }
3096
3097 /**
3098  *      netdev_completed_queue - report bytes and packets completed by device
3099  *      @dev: network device
3100  *      @pkts: actual number of packets sent over the medium
3101  *      @bytes: actual number of bytes sent over the medium
3102  *
3103  *      Report the number of bytes and packets transmitted by the network device
3104  *      hardware queue over the physical medium, @bytes must exactly match the
3105  *      @bytes amount passed to netdev_sent_queue()
3106  */
3107 static inline void netdev_completed_queue(struct net_device *dev,
3108                                           unsigned int pkts, unsigned int bytes)
3109 {
3110         netdev_tx_completed_queue(netdev_get_tx_queue(dev, 0), pkts, bytes);
3111 }
3112
3113 static inline void netdev_tx_reset_queue(struct netdev_queue *q)
3114 {
3115 #ifdef CONFIG_BQL
3116         clear_bit(__QUEUE_STATE_STACK_XOFF, &q->state);
3117         dql_reset(&q->dql);
3118 #endif
3119 }
3120
3121 /**
3122  *      netdev_reset_queue - reset the packets and bytes count of a network device
3123  *      @dev_queue: network device
3124  *
3125  *      Reset the bytes and packet count of a network device and clear the
3126  *      software flow control OFF bit for this network device
3127  */
3128 static inline void netdev_reset_queue(struct net_device *dev_queue)
3129 {
3130         netdev_tx_reset_queue(netdev_get_tx_queue(dev_queue, 0));
3131 }
3132
3133 /**
3134  *      netdev_cap_txqueue - check if selected tx queue exceeds device queues
3135  *      @dev: network device
3136  *      @queue_index: given tx queue index
3137  *
3138  *      Returns 0 if given tx queue index >= number of device tx queues,
3139  *      otherwise returns the originally passed tx queue index.
3140  */
3141 static inline u16 netdev_cap_txqueue(struct net_device *dev, u16 queue_index)
3142 {
3143         if (unlikely(queue_index >= dev->real_num_tx_queues)) {
3144                 net_warn_ratelimited("%s selects TX queue %d, but real number of TX queues is %d\n",
3145                                      dev->name, queue_index,
3146                                      dev->real_num_tx_queues);
3147                 return 0;
3148         }
3149
3150         return queue_index;
3151 }
3152
3153 /**
3154  *      netif_running - test if up
3155  *      @dev: network device
3156  *
3157  *      Test if the device has been brought up.
3158  */
3159 static inline bool netif_running(const struct net_device *dev)
3160 {
3161         return test_bit(__LINK_STATE_START, &dev->state);
3162 }
3163
3164 /*
3165  * Routines to manage the subqueues on a device.  We only need start,
3166  * stop, and a check if it's stopped.  All other device management is
3167  * done at the overall netdevice level.
3168  * Also test the device if we're multiqueue.
3169  */
3170
3171 /**
3172  *      netif_start_subqueue - allow sending packets on subqueue
3173  *      @dev: network device
3174  *      @queue_index: sub queue index
3175  *
3176  * Start individual transmit queue of a device with multiple transmit queues.
3177  */
3178 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
3179 {
3180         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3181
3182         netif_tx_start_queue(txq);
3183 }
3184
3185 /**
3186  *      netif_stop_subqueue - stop sending packets on subqueue
3187  *      @dev: network device
3188  *      @queue_index: sub queue index
3189  *
3190  * Stop individual transmit queue of a device with multiple transmit queues.
3191  */
3192 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
3193 {
3194         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3195         netif_tx_stop_queue(txq);
3196 }
3197
3198 /**
3199  *      netif_subqueue_stopped - test status of subqueue
3200  *      @dev: network device
3201  *      @queue_index: sub queue index
3202  *
3203  * Check individual transmit queue of a device with multiple transmit queues.
3204  */
3205 static inline bool __netif_subqueue_stopped(const struct net_device *dev,
3206                                             u16 queue_index)
3207 {
3208         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3209
3210         return netif_tx_queue_stopped(txq);
3211 }
3212
3213 static inline bool netif_subqueue_stopped(const struct net_device *dev,
3214                                           struct sk_buff *skb)
3215 {
3216         return __netif_subqueue_stopped(dev, skb_get_queue_mapping(skb));
3217 }
3218
3219 void netif_wake_subqueue(struct net_device *dev, u16 queue_index);
3220
3221 #ifdef CONFIG_XPS
3222 int netif_set_xps_queue(struct net_device *dev, const struct cpumask *mask,
3223                         u16 index);
3224 #else
3225 static inline int netif_set_xps_queue(struct net_device *dev,
3226                                       const struct cpumask *mask,
3227                                       u16 index)
3228 {
3229         return 0;
3230 }
3231 #endif
3232
3233 u16 __skb_tx_hash(const struct net_device *dev, struct sk_buff *skb,
3234                   unsigned int num_tx_queues);
3235
3236 /*
3237  * Returns a Tx hash for the given packet when dev->real_num_tx_queues is used
3238  * as a distribution range limit for the returned value.
3239  */
3240 static inline u16 skb_tx_hash(const struct net_device *dev,
3241                               struct sk_buff *skb)
3242 {
3243         return __skb_tx_hash(dev, skb, dev->real_num_tx_queues);
3244 }
3245
3246 /**
3247  *      netif_is_multiqueue - test if device has multiple transmit queues
3248  *      @dev: network device
3249  *
3250  * Check if device has multiple transmit queues
3251  */
3252 static inline bool netif_is_multiqueue(const struct net_device *dev)
3253 {
3254         return dev->num_tx_queues > 1;
3255 }
3256
3257 int netif_set_real_num_tx_queues(struct net_device *dev, unsigned int txq);
3258
3259 #ifdef CONFIG_SYSFS
3260 int netif_set_real_num_rx_queues(struct net_device *dev, unsigned int rxq);
3261 #else
3262 static inline int netif_set_real_num_rx_queues(struct net_device *dev,
3263                                                 unsigned int rxq)
3264 {
3265         return 0;
3266 }
3267 #endif
3268
3269 #ifdef CONFIG_SYSFS
3270 static inline unsigned int get_netdev_rx_queue_index(
3271                 struct netdev_rx_queue *queue)
3272 {
3273         struct net_device *dev = queue->dev;
3274         int index = queue - dev->_rx;
3275
3276         BUG_ON(index >= dev->num_rx_queues);
3277         return index;
3278 }
3279 #endif
3280
3281 #define DEFAULT_MAX_NUM_RSS_QUEUES      (8)
3282 int netif_get_num_default_rss_queues(void);
3283
3284 enum skb_free_reason {
3285         SKB_REASON_CONSUMED,
3286         SKB_REASON_DROPPED,
3287 };
3288
3289 void __dev_kfree_skb_irq(struct sk_buff *skb, enum skb_free_reason reason);
3290 void __dev_kfree_skb_any(struct sk_buff *skb, enum skb_free_reason reason);
3291
3292 /*
3293  * It is not allowed to call kfree_skb() or consume_skb() from hardware
3294  * interrupt context or with hardware interrupts being disabled.
3295  * (in_irq() || irqs_disabled())
3296  *
3297  * We provide four helpers that can be used in following contexts :
3298  *
3299  * dev_kfree_skb_irq(skb) when caller drops a packet from irq context,
3300  *  replacing kfree_skb(skb)
3301  *
3302  * dev_consume_skb_irq(skb) when caller consumes a packet from irq context.
3303  *  Typically used in place of consume_skb(skb) in TX completion path
3304  *
3305  * dev_kfree_skb_any(skb) when caller doesn't know its current irq context,
3306  *  replacing kfree_skb(skb)
3307  *
3308  * dev_consume_skb_any(skb) when caller doesn't know its current irq context,
3309  *  and consumed a packet. Used in place of consume_skb(skb)
3310  */
3311 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
3312 {
3313         __dev_kfree_skb_irq(skb, SKB_REASON_DROPPED);
3314 }
3315
3316 static inline void dev_consume_skb_irq(struct sk_buff *skb)
3317 {
3318         __dev_kfree_skb_irq(skb, SKB_REASON_CONSUMED);
3319 }
3320
3321 static inline void dev_kfree_skb_any(struct sk_buff *skb)
3322 {
3323         __dev_kfree_skb_any(skb, SKB_REASON_DROPPED);
3324 }
3325
3326 static inline void dev_consume_skb_any(struct sk_buff *skb)
3327 {
3328         __dev_kfree_skb_any(skb, SKB_REASON_CONSUMED);
3329 }
3330
3331 int netif_rx(struct sk_buff *skb);
3332 int netif_rx_ni(struct sk_buff *skb);
3333 int netif_receive_skb(struct sk_buff *skb);
3334 gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
3335 void napi_gro_flush(struct napi_struct *napi, bool flush_old);
3336 struct sk_buff *napi_get_frags(struct napi_struct *napi);
3337 gro_result_t napi_gro_frags(struct napi_struct *napi);
3338 struct packet_offload *gro_find_receive_by_type(__be16 type);
3339 struct packet_offload *gro_find_complete_by_type(__be16 type);
3340
3341 static inline void napi_free_frags(struct napi_struct *napi)
3342 {
3343         kfree_skb(napi->skb);
3344         napi->skb = NULL;
3345 }
3346
3347 bool netdev_is_rx_handler_busy(struct net_device *dev);
3348 int netdev_rx_handler_register(struct net_device *dev,
3349                                rx_handler_func_t *rx_handler,
3350                                void *rx_handler_data);
3351 void netdev_rx_handler_unregister(struct net_device *dev);
3352
3353 bool dev_valid_name(const char *name);
3354 int dev_ioctl(struct net *net, unsigned int cmd, void __user *);
3355 int dev_ethtool(struct net *net, struct ifreq *);
3356 unsigned int dev_get_flags(const struct net_device *);
3357 int __dev_change_flags(struct net_device *, unsigned int flags);
3358 int dev_change_flags(struct net_device *, unsigned int);
3359 void __dev_notify_flags(struct net_device *, unsigned int old_flags,
3360                         unsigned int gchanges);
3361 int dev_change_name(struct net_device *, const char *);
3362 int dev_set_alias(struct net_device *, const char *, size_t);
3363 int dev_change_net_namespace(struct net_device *, struct net *, const char *);
3364 int dev_set_mtu(struct net_device *, int);
3365 void dev_set_group(struct net_device *, int);
3366 int dev_set_mac_address(struct net_device *, struct sockaddr *);
3367 int dev_change_carrier(struct net_device *, bool new_carrier);
3368 int dev_get_phys_port_id(struct net_device *dev,
3369                          struct netdev_phys_item_id *ppid);
3370 int dev_get_phys_port_name(struct net_device *dev,
3371                            char *name, size_t len);
3372 int dev_change_proto_down(struct net_device *dev, bool proto_down);
3373 int dev_change_xdp_fd(struct net_device *dev, int fd);
3374 struct sk_buff *validate_xmit_skb_list(struct sk_buff *skb, struct net_device *dev);
3375 struct sk_buff *dev_hard_start_xmit(struct sk_buff *skb, struct net_device *dev,
3376                                     struct netdev_queue *txq, int *ret);
3377 int __dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
3378 int dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
3379 bool is_skb_forwardable(const struct net_device *dev,
3380                         const struct sk_buff *skb);
3381
3382 static __always_inline int ____dev_forward_skb(struct net_device *dev,
3383                                                struct sk_buff *skb)
3384 {
3385         if (skb_orphan_frags(skb, GFP_ATOMIC) ||
3386             unlikely(!is_skb_forwardable(dev, skb))) {
3387                 atomic_long_inc(&dev->rx_dropped);
3388                 kfree_skb(skb);
3389                 return NET_RX_DROP;
3390         }
3391
3392         skb_scrub_packet(skb, true);
3393         skb->priority = 0;
3394         return 0;
3395 }
3396
3397 void dev_queue_xmit_nit(struct sk_buff *skb, struct net_device *dev);
3398
3399 extern int              netdev_budget;
3400
3401 /* Called by rtnetlink.c:rtnl_unlock() */
3402 void netdev_run_todo(void);
3403
3404 /**
3405  *      dev_put - release reference to device
3406  *      @dev: network device
3407  *
3408  * Release reference to device to allow it to be freed.
3409  */
3410 static inline void dev_put(struct net_device *dev)
3411 {
3412         this_cpu_dec(*dev->pcpu_refcnt);
3413 }
3414
3415 /**
3416  *      dev_hold - get reference to device
3417  *      @dev: network device
3418  *
3419  * Hold reference to device to keep it from being freed.
3420  */
3421 static inline void dev_hold(struct net_device *dev)
3422 {
3423         this_cpu_inc(*dev->pcpu_refcnt);
3424 }
3425
3426 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
3427  * and _off may be called from IRQ context, but it is caller
3428  * who is responsible for serialization of these calls.
3429  *
3430  * The name carrier is inappropriate, these functions should really be
3431  * called netif_lowerlayer_*() because they represent the state of any
3432  * kind of lower layer not just hardware media.
3433  */
3434
3435 void linkwatch_init_dev(struct net_device *dev);
3436 void linkwatch_fire_event(struct net_device *dev);
3437 void linkwatch_forget_dev(struct net_device *dev);
3438
3439 /**
3440  *      netif_carrier_ok - test if carrier present
3441  *      @dev: network device
3442  *
3443  * Check if carrier is present on device
3444  */
3445 static inline bool netif_carrier_ok(const struct net_device *dev)
3446 {
3447         return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
3448 }
3449
3450 unsigned long dev_trans_start(struct net_device *dev);
3451
3452 void __netdev_watchdog_up(struct net_device *dev);
3453
3454 void netif_carrier_on(struct net_device *dev);
3455
3456 void netif_carrier_off(struct net_device *dev);
3457
3458 /**
3459  *      netif_dormant_on - mark device as dormant.
3460  *      @dev: network device
3461  *
3462  * Mark device as dormant (as per RFC2863).
3463  *
3464  * The dormant state indicates that the relevant interface is not
3465  * actually in a condition to pass packets (i.e., it is not 'up') but is
3466  * in a "pending" state, waiting for some external event.  For "on-
3467  * demand" interfaces, this new state identifies the situation where the
3468  * interface is waiting for events to place it in the up state.
3469  */
3470 static inline void netif_dormant_on(struct net_device *dev)
3471 {
3472         if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
3473                 linkwatch_fire_event(dev);
3474 }
3475
3476 /**
3477  *      netif_dormant_off - set device as not dormant.
3478  *      @dev: network device
3479  *
3480  * Device is not in dormant state.
3481  */
3482 static inline void netif_dormant_off(struct net_device *dev)
3483 {
3484         if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
3485                 linkwatch_fire_event(dev);
3486 }
3487
3488 /**
3489  *      netif_dormant - test if carrier present
3490  *      @dev: network device
3491  *
3492  * Check if carrier is present on device
3493  */
3494 static inline bool netif_dormant(const struct net_device *dev)
3495 {
3496         return test_bit(__LINK_STATE_DORMANT, &dev->state);
3497 }
3498
3499
3500 /**
3501  *      netif_oper_up - test if device is operational
3502  *      @dev: network device
3503  *
3504  * Check if carrier is operational
3505  */
3506 static inline bool netif_oper_up(const struct net_device *dev)
3507 {
3508         return (dev->operstate == IF_OPER_UP ||
3509                 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
3510 }
3511
3512 /**
3513  *      netif_device_present - is device available or removed
3514  *      @dev: network device
3515  *
3516  * Check if device has not been removed from system.
3517  */
3518 static inline bool netif_device_present(struct net_device *dev)
3519 {
3520         return test_bit(__LINK_STATE_PRESENT, &dev->state);
3521 }
3522
3523 void netif_device_detach(struct net_device *dev);
3524
3525 void netif_device_attach(struct net_device *dev);
3526
3527 /*
3528  * Network interface message level settings
3529  */
3530
3531 enum {
3532         NETIF_MSG_DRV           = 0x0001,
3533         NETIF_MSG_PROBE         = 0x0002,
3534         NETIF_MSG_LINK          = 0x0004,
3535         NETIF_MSG_TIMER         = 0x0008,
3536         NETIF_MSG_IFDOWN        = 0x0010,
3537         NETIF_MSG_IFUP          = 0x0020,
3538         NETIF_MSG_RX_ERR        = 0x0040,
3539         NETIF_MSG_TX_ERR        = 0x0080,
3540         NETIF_MSG_TX_QUEUED     = 0x0100,
3541         NETIF_MSG_INTR          = 0x0200,
3542         NETIF_MSG_TX_DONE       = 0x0400,
3543         NETIF_MSG_RX_STATUS     = 0x0800,
3544         NETIF_MSG_PKTDATA       = 0x1000,
3545         NETIF_MSG_HW            = 0x2000,
3546         NETIF_MSG_WOL           = 0x4000,
3547 };
3548
3549 #define netif_msg_drv(p)        ((p)->msg_enable & NETIF_MSG_DRV)
3550 #define netif_msg_probe(p)      ((p)->msg_enable & NETIF_MSG_PROBE)
3551 #define netif_msg_link(p)       ((p)->msg_enable & NETIF_MSG_LINK)
3552 #define netif_msg_timer(p)      ((p)->msg_enable & NETIF_MSG_TIMER)
3553 #define netif_msg_ifdown(p)     ((p)->msg_enable & NETIF_MSG_IFDOWN)
3554 #define netif_msg_ifup(p)       ((p)->msg_enable & NETIF_MSG_IFUP)
3555 #define netif_msg_rx_err(p)     ((p)->msg_enable & NETIF_MSG_RX_ERR)
3556 #define netif_msg_tx_err(p)     ((p)->msg_enable & NETIF_MSG_TX_ERR)
3557 #define netif_msg_tx_queued(p)  ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
3558 #define netif_msg_intr(p)       ((p)->msg_enable & NETIF_MSG_INTR)
3559 #define netif_msg_tx_done(p)    ((p)->msg_enable & NETIF_MSG_TX_DONE)
3560 #define netif_msg_rx_status(p)  ((p)->msg_enable & NETIF_MSG_RX_STATUS)
3561 #define netif_msg_pktdata(p)    ((p)->msg_enable & NETIF_MSG_PKTDATA)
3562 #define netif_msg_hw(p)         ((p)->msg_enable & NETIF_MSG_HW)
3563 #define netif_msg_wol(p)        ((p)->msg_enable & NETIF_MSG_WOL)
3564
3565 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
3566 {
3567         /* use default */
3568         if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
3569                 return default_msg_enable_bits;
3570         if (debug_value == 0)   /* no output */
3571                 return 0;
3572         /* set low N bits */
3573         return (1U << debug_value) - 1;
3574 }
3575
3576 static inline void __netif_tx_lock(struct netdev_queue *txq, int cpu)
3577 {
3578         spin_lock(&txq->_xmit_lock);
3579         txq->xmit_lock_owner = cpu;
3580 }
3581
3582 static inline void __netif_tx_lock_bh(struct netdev_queue *txq)
3583 {
3584         spin_lock_bh(&txq->_xmit_lock);
3585         txq->xmit_lock_owner = smp_processor_id();
3586 }
3587
3588 static inline bool __netif_tx_trylock(struct netdev_queue *txq)
3589 {
3590         bool ok = spin_trylock(&txq->_xmit_lock);
3591         if (likely(ok))
3592                 txq->xmit_lock_owner = smp_processor_id();
3593         return ok;
3594 }
3595
3596 static inline void __netif_tx_unlock(struct netdev_queue *txq)
3597 {
3598         txq->xmit_lock_owner = -1;
3599         spin_unlock(&txq->_xmit_lock);
3600 }
3601
3602 static inline void __netif_tx_unlock_bh(struct netdev_queue *txq)
3603 {
3604         txq->xmit_lock_owner = -1;
3605         spin_unlock_bh(&txq->_xmit_lock);
3606 }
3607
3608 static inline void txq_trans_update(struct netdev_queue *txq)
3609 {
3610         if (txq->xmit_lock_owner != -1)
3611                 txq->trans_start = jiffies;
3612 }
3613
3614 /* legacy drivers only, netdev_start_xmit() sets txq->trans_start */
3615 static inline void netif_trans_update(struct net_device *dev)
3616 {
3617         struct netdev_queue *txq = netdev_get_tx_queue(dev, 0);
3618
3619         if (txq->trans_start != jiffies)
3620                 txq->trans_start = jiffies;
3621 }
3622
3623 /**
3624  *      netif_tx_lock - grab network device transmit lock
3625  *      @dev: network device
3626  *
3627  * Get network device transmit lock
3628  */
3629 static inline void netif_tx_lock(struct net_device *dev)
3630 {
3631         unsigned int i;
3632         int cpu;
3633
3634         spin_lock(&dev->tx_global_lock);
3635         cpu = smp_processor_id();
3636         for (i = 0; i < dev->num_tx_queues; i++) {
3637                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3638
3639                 /* We are the only thread of execution doing a
3640                  * freeze, but we have to grab the _xmit_lock in
3641                  * order to synchronize with threads which are in
3642                  * the ->hard_start_xmit() handler and already
3643                  * checked the frozen bit.
3644                  */
3645                 __netif_tx_lock(txq, cpu);
3646                 set_bit(__QUEUE_STATE_FROZEN, &txq->state);
3647                 __netif_tx_unlock(txq);
3648         }
3649 }
3650
3651 static inline void netif_tx_lock_bh(struct net_device *dev)
3652 {
3653         local_bh_disable();
3654         netif_tx_lock(dev);
3655 }
3656
3657 static inline void netif_tx_unlock(struct net_device *dev)
3658 {
3659         unsigned int i;
3660
3661         for (i = 0; i < dev->num_tx_queues; i++) {
3662                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3663
3664                 /* No need to grab the _xmit_lock here.  If the
3665                  * queue is not stopped for another reason, we
3666                  * force a schedule.
3667                  */
3668                 clear_bit(__QUEUE_STATE_FROZEN, &txq->state);
3669                 netif_schedule_queue(txq);
3670         }
3671         spin_unlock(&dev->tx_global_lock);
3672 }
3673
3674 static inline void netif_tx_unlock_bh(struct net_device *dev)
3675 {
3676         netif_tx_unlock(dev);
3677         local_bh_enable();
3678 }
3679
3680 #define HARD_TX_LOCK(dev, txq, cpu) {                   \
3681         if ((dev->features & NETIF_F_LLTX) == 0) {      \
3682                 __netif_tx_lock(txq, cpu);              \
3683         }                                               \
3684 }
3685
3686 #define HARD_TX_TRYLOCK(dev, txq)                       \
3687         (((dev->features & NETIF_F_LLTX) == 0) ?        \
3688                 __netif_tx_trylock(txq) :               \
3689                 true )
3690
3691 #define HARD_TX_UNLOCK(dev, txq) {                      \
3692         if ((dev->features & NETIF_F_LLTX) == 0) {      \
3693                 __netif_tx_unlock(txq);                 \
3694         }                                               \
3695 }
3696
3697 static inline void netif_tx_disable(struct net_device *dev)
3698 {
3699         unsigned int i;
3700         int cpu;
3701
3702         local_bh_disable();
3703         cpu = smp_processor_id();
3704         spin_lock(&dev->tx_global_lock);
3705         for (i = 0; i < dev->num_tx_queues; i++) {
3706                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3707
3708                 __netif_tx_lock(txq, cpu);
3709                 netif_tx_stop_queue(txq);
3710                 __netif_tx_unlock(txq);
3711         }
3712         spin_unlock(&dev->tx_global_lock);
3713         local_bh_enable();
3714 }
3715
3716 static inline void netif_addr_lock(struct net_device *dev)
3717 {
3718         spin_lock(&dev->addr_list_lock);
3719 }
3720
3721 static inline void netif_addr_lock_nested(struct net_device *dev)
3722 {
3723         int subclass = SINGLE_DEPTH_NESTING;
3724
3725         if (dev->netdev_ops->ndo_get_lock_subclass)
3726                 subclass = dev->netdev_ops->ndo_get_lock_subclass(dev);
3727
3728         spin_lock_nested(&dev->addr_list_lock, subclass);
3729 }
3730
3731 static inline void netif_addr_lock_bh(struct net_device *dev)
3732 {
3733         spin_lock_bh(&dev->addr_list_lock);
3734 }
3735
3736 static inline void netif_addr_unlock(struct net_device *dev)
3737 {
3738         spin_unlock(&dev->addr_list_lock);
3739 }
3740
3741 static inline void netif_addr_unlock_bh(struct net_device *dev)
3742 {
3743         spin_unlock_bh(&dev->addr_list_lock);
3744 }
3745
3746 /*
3747  * dev_addrs walker. Should be used only for read access. Call with
3748  * rcu_read_lock held.
3749  */
3750 #define for_each_dev_addr(dev, ha) \
3751                 list_for_each_entry_rcu(ha, &dev->dev_addrs.list, list)
3752
3753 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
3754
3755 void ether_setup(struct net_device *dev);
3756
3757 /* Support for loadable net-drivers */
3758 struct net_device *alloc_netdev_mqs(int sizeof_priv, const char *name,
3759                                     unsigned char name_assign_type,
3760                                     void (*setup)(struct net_device *),
3761                                     unsigned int txqs, unsigned int rxqs);
3762 int dev_get_valid_name(struct net *net, struct net_device *dev,
3763                        const char *name);
3764
3765 #define alloc_netdev(sizeof_priv, name, name_assign_type, setup) \
3766         alloc_netdev_mqs(sizeof_priv, name, name_assign_type, setup, 1, 1)
3767
3768 #define alloc_netdev_mq(sizeof_priv, name, name_assign_type, setup, count) \
3769         alloc_netdev_mqs(sizeof_priv, name, name_assign_type, setup, count, \
3770                          count)
3771
3772 int register_netdev(struct net_device *dev);
3773 void unregister_netdev(struct net_device *dev);
3774
3775 /* General hardware address lists handling functions */
3776 int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
3777                    struct netdev_hw_addr_list *from_list, int addr_len);
3778 void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
3779                       struct netdev_hw_addr_list *from_list, int addr_len);
3780 int __hw_addr_sync_dev(struct netdev_hw_addr_list *list,
3781                        struct net_device *dev,
3782                        int (*sync)(struct net_device *, const unsigned char *),
3783                        int (*unsync)(struct net_device *,
3784                                      const unsigned char *));
3785 void __hw_addr_unsync_dev(struct netdev_hw_addr_list *list,
3786                           struct net_device *dev,
3787                           int (*unsync)(struct net_device *,
3788                                         const unsigned char *));
3789 void __hw_addr_init(struct netdev_hw_addr_list *list);
3790
3791 /* Functions used for device addresses handling */
3792 int dev_addr_add(struct net_device *dev, const unsigned char *addr,
3793                  unsigned char addr_type);
3794 int dev_addr_del(struct net_device *dev, const unsigned char *addr,
3795                  unsigned char addr_type);
3796 void dev_addr_flush(struct net_device *dev);
3797 int dev_addr_init(struct net_device *dev);
3798
3799 /* Functions used for unicast addresses handling */
3800 int dev_uc_add(struct net_device *dev, const unsigned char *addr);
3801 int dev_uc_add_excl(struct net_device *dev, const unsigned char *addr);
3802 int dev_uc_del(struct net_device *dev, const unsigned char *addr);
3803 int dev_uc_sync(struct net_device *to, struct net_device *from);
3804 int dev_uc_sync_multiple(struct net_device *to, struct net_device *from);
3805 void dev_uc_unsync(struct net_device *to, struct net_device *from);
3806 void dev_uc_flush(struct net_device *dev);
3807 void dev_uc_init(struct net_device *dev);
3808
3809 /**
3810  *  __dev_uc_sync - Synchonize device's unicast list
3811  *  @dev:  device to sync
3812  *  @sync: function to call if address should be added
3813  *  @unsync: function to call if address should be removed
3814  *
3815  *  Add newly added addresses to the interface, and release
3816  *  addresses that have been deleted.
3817  */
3818 static inline int __dev_uc_sync(struct net_device *dev,
3819                                 int (*sync)(struct net_device *,
3820                                             const unsigned char *),
3821                                 int (*unsync)(struct net_device *,
3822                                               const unsigned char *))
3823 {
3824         return __hw_addr_sync_dev(&dev->uc, dev, sync, unsync);
3825 }
3826
3827 /**
3828  *  __dev_uc_unsync - Remove synchronized addresses from device
3829  *  @dev:  device to sync
3830  *  @unsync: function to call if address should be removed
3831  *
3832  *  Remove all addresses that were added to the device by dev_uc_sync().
3833  */
3834 static inline void __dev_uc_unsync(struct net_device *dev,
3835                                    int (*unsync)(struct net_device *,
3836                                                  const unsigned char *))
3837 {
3838         __hw_addr_unsync_dev(&dev->uc, dev, unsync);
3839 }
3840
3841 /* Functions used for multicast addresses handling */
3842 int dev_mc_add(struct net_device *dev, const unsigned char *addr);
3843 int dev_mc_add_global(struct net_device *dev, const unsigned char *addr);
3844 int dev_mc_add_excl(struct net_device *dev, const unsigned char *addr);
3845 int dev_mc_del(struct net_device *dev, const unsigned char *addr);
3846 int dev_mc_del_global(struct net_device *dev, const unsigned char *addr);
3847 int dev_mc_sync(struct net_device *to, struct net_device *from);
3848 int dev_mc_sync_multiple(struct net_device *to, struct net_device *from);
3849 void dev_mc_unsync(struct net_device *to, struct net_device *from);
3850 void dev_mc_flush(struct net_device *dev);
3851 void dev_mc_init(struct net_device *dev);
3852
3853 /**
3854  *  __dev_mc_sync - Synchonize device's multicast list
3855  *  @dev:  device to sync
3856  *  @sync: function to call if address should be added
3857  *  @unsync: function to call if address should be removed
3858  *
3859  *  Add newly added addresses to the interface, and release
3860  *  addresses that have been deleted.
3861  */
3862 static inline int __dev_mc_sync(struct net_device *dev,
3863                                 int (*sync)(struct net_device *,
3864                                             const unsigned char *),
3865                                 int (*unsync)(struct net_device *,
3866                                               const unsigned char *))
3867 {
3868         return __hw_addr_sync_dev(&dev->mc, dev, sync, unsync);
3869 }
3870
3871 /**
3872  *  __dev_mc_unsync - Remove synchronized addresses from device
3873  *  @dev:  device to sync
3874  *  @unsync: function to call if address should be removed
3875  *
3876  *  Remove all addresses that were added to the device by dev_mc_sync().
3877  */
3878 static inline void __dev_mc_unsync(struct net_device *dev,
3879                                    int (*unsync)(struct net_device *,
3880                                                  const unsigned char *))
3881 {
3882         __hw_addr_unsync_dev(&dev->mc, dev, unsync);
3883 }
3884
3885 /* Functions used for secondary unicast and multicast support */
3886 void dev_set_rx_mode(struct net_device *dev);
3887 void __dev_set_rx_mode(struct net_device *dev);
3888 int dev_set_promiscuity(struct net_device *dev, int inc);
3889 int dev_set_allmulti(struct net_device *dev, int inc);
3890 void netdev_state_change(struct net_device *dev);
3891 void netdev_notify_peers(struct net_device *dev);
3892 void netdev_features_change(struct net_device *dev);
3893 /* Load a device via the kmod */
3894 void dev_load(struct net *net, const char *name);
3895 struct rtnl_link_stats64 *dev_get_stats(struct net_device *dev,
3896                                         struct rtnl_link_stats64 *storage);
3897 void netdev_stats_to_stats64(struct rtnl_link_stats64 *stats64,
3898                              const struct net_device_stats *netdev_stats);
3899
3900 extern int              netdev_max_backlog;
3901 extern int              netdev_tstamp_prequeue;
3902 extern int              weight_p;
3903
3904 bool netdev_has_upper_dev(struct net_device *dev, struct net_device *upper_dev);
3905 struct net_device *netdev_upper_get_next_dev_rcu(struct net_device *dev,
3906                                                      struct list_head **iter);
3907 struct net_device *netdev_all_upper_get_next_dev_rcu(struct net_device *dev,
3908                                                      struct list_head **iter);
3909
3910 /* iterate through upper list, must be called under RCU read lock */
3911 #define netdev_for_each_upper_dev_rcu(dev, updev, iter) \
3912         for (iter = &(dev)->adj_list.upper, \
3913              updev = netdev_upper_get_next_dev_rcu(dev, &(iter)); \
3914              updev; \
3915              updev = netdev_upper_get_next_dev_rcu(dev, &(iter)))
3916
3917 /* iterate through upper list, must be called under RCU read lock */
3918 #define netdev_for_each_all_upper_dev_rcu(dev, updev, iter) \
3919         for (iter = &(dev)->all_adj_list.upper, \
3920              updev = netdev_all_upper_get_next_dev_rcu(dev, &(iter)); \
3921              updev; \
3922              updev = netdev_all_upper_get_next_dev_rcu(dev, &(iter)))
3923
3924 bool netdev_has_any_upper_dev(struct net_device *dev);
3925
3926 void *netdev_lower_get_next_private(struct net_device *dev,
3927                                     struct list_head **iter);
3928 void *netdev_lower_get_next_private_rcu(struct net_device *dev,
3929                                         struct list_head **iter);
3930
3931 #define netdev_for_each_lower_private(dev, priv, iter) \
3932         for (iter = (dev)->adj_list.lower.next, \
3933              priv = netdev_lower_get_next_private(dev, &(iter)); \
3934              priv; \
3935              priv = netdev_lower_get_next_private(dev, &(iter)))
3936
3937 #define netdev_for_each_lower_private_rcu(dev, priv, iter) \
3938         for (iter = &(dev)->adj_list.lower, \
3939              priv = netdev_lower_get_next_private_rcu(dev, &(iter)); \
3940              priv; \
3941              priv = netdev_lower_get_next_private_rcu(dev, &(iter)))
3942
3943 void *netdev_lower_get_next(struct net_device *dev,
3944                                 struct list_head **iter);
3945
3946 #define netdev_for_each_lower_dev(dev, ldev, iter) \
3947         for (iter = (dev)->adj_list.lower.next, \
3948              ldev = netdev_lower_get_next(dev, &(iter)); \
3949              ldev; \
3950              ldev = netdev_lower_get_next(dev, &(iter)))
3951
3952 struct net_device *netdev_all_lower_get_next(struct net_device *dev,
3953                                              struct list_head **iter);
3954 struct net_device *netdev_all_lower_get_next_rcu(struct net_device *dev,
3955                                                  struct list_head **iter);
3956
3957 #define netdev_for_each_all_lower_dev(dev, ldev, iter) \
3958         for (iter = (dev)->all_adj_list.lower.next, \
3959              ldev = netdev_all_lower_get_next(dev, &(iter)); \
3960              ldev; \
3961              ldev = netdev_all_lower_get_next(dev, &(iter)))
3962
3963 #define netdev_for_each_all_lower_dev_rcu(dev, ldev, iter) \
3964         for (iter = &(dev)->all_adj_list.lower, \
3965              ldev = netdev_all_lower_get_next_rcu(dev, &(iter)); \
3966              ldev; \
3967              ldev = netdev_all_lower_get_next_rcu(dev, &(iter)))
3968
3969 void *netdev_adjacent_get_private(struct list_head *adj_list);
3970 void *netdev_lower_get_first_private_rcu(struct net_device *dev);
3971 struct net_device *netdev_master_upper_dev_get(struct net_device *dev);
3972 struct net_device *netdev_master_upper_dev_get_rcu(struct net_device *dev);
3973 int netdev_upper_dev_link(struct net_device *dev, struct net_device *upper_dev);
3974 int netdev_master_upper_dev_link(struct net_device *dev,
3975                                  struct net_device *upper_dev,
3976                                  void *upper_priv, void *upper_info);
3977 void netdev_upper_dev_unlink(struct net_device *dev,
3978                              struct net_device *upper_dev);
3979 void netdev_adjacent_rename_links(struct net_device *dev, char *oldname);
3980 void *netdev_lower_dev_get_private(struct net_device *dev,
3981                                    struct net_device *lower_dev);
3982 void netdev_lower_state_changed(struct net_device *lower_dev,
3983                                 void *lower_state_info);
3984 int netdev_default_l2upper_neigh_construct(struct net_device *dev,
3985                                            struct neighbour *n);
3986 void netdev_default_l2upper_neigh_destroy(struct net_device *dev,
3987                                           struct neighbour *n);
3988
3989 /* RSS keys are 40 or 52 bytes long */
3990 #define NETDEV_RSS_KEY_LEN 52
3991 extern u8 netdev_rss_key[NETDEV_RSS_KEY_LEN] __read_mostly;
3992 void netdev_rss_key_fill(void *buffer, size_t len);
3993
3994 int dev_get_nest_level(struct net_device *dev);
3995 int skb_checksum_help(struct sk_buff *skb);
3996 struct sk_buff *__skb_gso_segment(struct sk_buff *skb,
3997                                   netdev_features_t features, bool tx_path);
3998 struct sk_buff *skb_mac_gso_segment(struct sk_buff *skb,
3999                                     netdev_features_t features);
4000
4001 struct netdev_bonding_info {
4002         ifslave slave;
4003         ifbond  master;
4004 };
4005
4006 struct netdev_notifier_bonding_info {
4007         struct netdev_notifier_info info; /* must be first */
4008         struct netdev_bonding_info  bonding_info;
4009 };
4010
4011 void netdev_bonding_info_change(struct net_device *dev,
4012                                 struct netdev_bonding_info *bonding_info);
4013
4014 static inline
4015 struct sk_buff *skb_gso_segment(struct sk_buff *skb, netdev_features_t features)
4016 {
4017         return __skb_gso_segment(skb, features, true);
4018 }
4019 __be16 skb_network_protocol(struct sk_buff *skb, int *depth);
4020
4021 static inline bool can_checksum_protocol(netdev_features_t features,
4022                                          __be16 protocol)
4023 {
4024         if (protocol == htons(ETH_P_FCOE))
4025                 return !!(features & NETIF_F_FCOE_CRC);
4026
4027         /* Assume this is an IP checksum (not SCTP CRC) */
4028
4029         if (features & NETIF_F_HW_CSUM) {
4030                 /* Can checksum everything */
4031                 return true;
4032         }
4033
4034         switch (protocol) {
4035         case htons(ETH_P_IP):
4036                 return !!(features & NETIF_F_IP_CSUM);
4037         case htons(ETH_P_IPV6):
4038                 return !!(features & NETIF_F_IPV6_CSUM);
4039         default:
4040                 return false;
4041         }
4042 }
4043
4044 /* Map an ethertype into IP protocol if possible */
4045 static inline int eproto_to_ipproto(int eproto)
4046 {
4047         switch (eproto) {
4048         case htons(ETH_P_IP):
4049                 return IPPROTO_IP;
4050         case htons(ETH_P_IPV6):
4051                 return IPPROTO_IPV6;
4052         default:
4053                 return -1;
4054         }
4055 }
4056
4057 #ifdef CONFIG_BUG
4058 void netdev_rx_csum_fault(struct net_device *dev);
4059 #else
4060 static inline void netdev_rx_csum_fault(struct net_device *dev)
4061 {
4062 }
4063 #endif
4064 /* rx skb timestamps */
4065 void net_enable_timestamp(void);
4066 void net_disable_timestamp(void);
4067
4068 #ifdef CONFIG_PROC_FS
4069 int __init dev_proc_init(void);
4070 #else
4071 #define dev_proc_init() 0
4072 #endif
4073
4074 static inline netdev_tx_t __netdev_start_xmit(const struct net_device_ops *ops,
4075                                               struct sk_buff *skb, struct net_device *dev,
4076                                               bool more)
4077 {
4078         skb->xmit_more = more ? 1 : 0;
4079         return ops->ndo_start_xmit(skb, dev);
4080 }
4081
4082 static inline netdev_tx_t netdev_start_xmit(struct sk_buff *skb, struct net_device *dev,
4083                                             struct netdev_queue *txq, bool more)
4084 {
4085         const struct net_device_ops *ops = dev->netdev_ops;
4086         int rc;
4087
4088         rc = __netdev_start_xmit(ops, skb, dev, more);
4089         if (rc == NETDEV_TX_OK)
4090                 txq_trans_update(txq);
4091
4092         return rc;
4093 }
4094
4095 int netdev_class_create_file_ns(struct class_attribute *class_attr,
4096                                 const void *ns);
4097 void netdev_class_remove_file_ns(struct class_attribute *class_attr,
4098                                  const void *ns);
4099
4100 static inline int netdev_class_create_file(struct class_attribute *class_attr)
4101 {
4102         return netdev_class_create_file_ns(class_attr, NULL);
4103 }
4104
4105 static inline void netdev_class_remove_file(struct class_attribute *class_attr)
4106 {
4107         netdev_class_remove_file_ns(class_attr, NULL);
4108 }
4109
4110 extern struct kobj_ns_type_operations net_ns_type_operations;
4111
4112 const char *netdev_drivername(const struct net_device *dev);
4113
4114 void linkwatch_run_queue(void);
4115
4116 static inline netdev_features_t netdev_intersect_features(netdev_features_t f1,
4117                                                           netdev_features_t f2)
4118 {
4119         if ((f1 ^ f2) & NETIF_F_HW_CSUM) {
4120                 if (f1 & NETIF_F_HW_CSUM)
4121                         f1 |= (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM);
4122                 else
4123                         f2 |= (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM);
4124         }
4125
4126         return f1 & f2;
4127 }
4128
4129 static inline netdev_features_t netdev_get_wanted_features(
4130         struct net_device *dev)
4131 {
4132         return (dev->features & ~dev->hw_features) | dev->wanted_features;
4133 }
4134 netdev_features_t netdev_increment_features(netdev_features_t all,
4135         netdev_features_t one, netdev_features_t mask);
4136
4137 /* Allow TSO being used on stacked device :
4138  * Performing the GSO segmentation before last device
4139  * is a performance improvement.
4140  */
4141 static inline netdev_features_t netdev_add_tso_features(netdev_features_t features,
4142                                                         netdev_features_t mask)
4143 {
4144         return netdev_increment_features(features, NETIF_F_ALL_TSO, mask);
4145 }
4146
4147 int __netdev_update_features(struct net_device *dev);
4148 void netdev_update_features(struct net_device *dev);
4149 void netdev_change_features(struct net_device *dev);
4150
4151 void netif_stacked_transfer_operstate(const struct net_device *rootdev,
4152                                         struct net_device *dev);
4153
4154 netdev_features_t passthru_features_check(struct sk_buff *skb,
4155                                           struct net_device *dev,
4156                                           netdev_features_t features);
4157 netdev_features_t netif_skb_features(struct sk_buff *skb);
4158
4159 static inline bool net_gso_ok(netdev_features_t features, int gso_type)
4160 {
4161         netdev_features_t feature = (netdev_features_t)gso_type << NETIF_F_GSO_SHIFT;
4162
4163         /* check flags correspondence */
4164         BUILD_BUG_ON(SKB_GSO_TCPV4   != (NETIF_F_TSO >> NETIF_F_GSO_SHIFT));
4165         BUILD_BUG_ON(SKB_GSO_UDP     != (NETIF_F_UFO >> NETIF_F_GSO_SHIFT));
4166         BUILD_BUG_ON(SKB_GSO_DODGY   != (NETIF_F_GSO_ROBUST >> NETIF_F_GSO_SHIFT));
4167         BUILD_BUG_ON(SKB_GSO_TCP_ECN != (NETIF_F_TSO_ECN >> NETIF_F_GSO_SHIFT));
4168         BUILD_BUG_ON(SKB_GSO_TCP_FIXEDID != (NETIF_F_TSO_MANGLEID >> NETIF_F_GSO_SHIFT));
4169         BUILD_BUG_ON(SKB_GSO_TCPV6   != (NETIF_F_TSO6 >> NETIF_F_GSO_SHIFT));
4170         BUILD_BUG_ON(SKB_GSO_FCOE    != (NETIF_F_FSO >> NETIF_F_GSO_SHIFT));
4171         BUILD_BUG_ON(SKB_GSO_GRE     != (NETIF_F_GSO_GRE >> NETIF_F_GSO_SHIFT));
4172         BUILD_BUG_ON(SKB_GSO_GRE_CSUM != (NETIF_F_GSO_GRE_CSUM >> NETIF_F_GSO_SHIFT));
4173         BUILD_BUG_ON(SKB_GSO_IPXIP4  != (NETIF_F_GSO_IPXIP4 >> NETIF_F_GSO_SHIFT));
4174         BUILD_BUG_ON(SKB_GSO_IPXIP6  != (NETIF_F_GSO_IPXIP6 >> NETIF_F_GSO_SHIFT));
4175         BUILD_BUG_ON(SKB_GSO_UDP_TUNNEL != (NETIF_F_GSO_UDP_TUNNEL >> NETIF_F_GSO_SHIFT));
4176         BUILD_BUG_ON(SKB_GSO_UDP_TUNNEL_CSUM != (NETIF_F_GSO_UDP_TUNNEL_CSUM >> NETIF_F_GSO_SHIFT));
4177         BUILD_BUG_ON(SKB_GSO_PARTIAL != (NETIF_F_GSO_PARTIAL >> NETIF_F_GSO_SHIFT));
4178         BUILD_BUG_ON(SKB_GSO_TUNNEL_REMCSUM != (NETIF_F_GSO_TUNNEL_REMCSUM >> NETIF_F_GSO_SHIFT));
4179         BUILD_BUG_ON(SKB_GSO_SCTP    != (NETIF_F_GSO_SCTP >> NETIF_F_GSO_SHIFT));
4180
4181         return (features & feature) == feature;
4182 }
4183
4184 static inline bool skb_gso_ok(struct sk_buff *skb, netdev_features_t features)
4185 {
4186         return net_gso_ok(features, skb_shinfo(skb)->gso_type) &&
4187                (!skb_has_frag_list(skb) || (features & NETIF_F_FRAGLIST));
4188 }
4189
4190 static inline bool netif_needs_gso(struct sk_buff *skb,
4191                                    netdev_features_t features)
4192 {
4193         return skb_is_gso(skb) && (!skb_gso_ok(skb, features) ||
4194                 unlikely((skb->ip_summed != CHECKSUM_PARTIAL) &&
4195                          (skb->ip_summed != CHECKSUM_UNNECESSARY)));
4196 }
4197
4198 static inline void netif_set_gso_max_size(struct net_device *dev,
4199                                           unsigned int size)
4200 {
4201         dev->gso_max_size = size;
4202 }
4203
4204 static inline void skb_gso_error_unwind(struct sk_buff *skb, __be16 protocol,
4205                                         int pulled_hlen, u16 mac_offset,
4206                                         int mac_len)
4207 {
4208         skb->protocol = protocol;
4209         skb->encapsulation = 1;
4210         skb_push(skb, pulled_hlen);
4211         skb_reset_transport_header(skb);
4212         skb->mac_header = mac_offset;
4213         skb->network_header = skb->mac_header + mac_len;
4214         skb->mac_len = mac_len;
4215 }
4216
4217 static inline bool netif_is_macsec(const struct net_device *dev)
4218 {
4219         return dev->priv_flags & IFF_MACSEC;
4220 }
4221
4222 static inline bool netif_is_macvlan(const struct net_device *dev)
4223 {
4224         return dev->priv_flags & IFF_MACVLAN;
4225 }
4226
4227 static inline bool netif_is_macvlan_port(const struct net_device *dev)
4228 {
4229         return dev->priv_flags & IFF_MACVLAN_PORT;
4230 }
4231
4232 static inline bool netif_is_ipvlan(const struct net_device *dev)
4233 {
4234         return dev->priv_flags & IFF_IPVLAN_SLAVE;
4235 }
4236
4237 static inline bool netif_is_ipvlan_port(const struct net_device *dev)
4238 {
4239         return dev->priv_flags & IFF_IPVLAN_MASTER;
4240 }
4241
4242 static inline bool netif_is_bond_master(const struct net_device *dev)
4243 {
4244         return dev->flags & IFF_MASTER && dev->priv_flags & IFF_BONDING;
4245 }
4246
4247 static inline bool netif_is_bond_slave(const struct net_device *dev)
4248 {
4249         return dev->flags & IFF_SLAVE && dev->priv_flags & IFF_BONDING;
4250 }
4251
4252 static inline bool netif_supports_nofcs(struct net_device *dev)
4253 {
4254         return dev->priv_flags & IFF_SUPP_NOFCS;
4255 }
4256
4257 static inline bool netif_has_l3_rx_handler(const struct net_device *dev)
4258 {
4259         return dev->priv_flags & IFF_L3MDEV_RX_HANDLER;
4260 }
4261
4262 static inline bool netif_is_l3_master(const struct net_device *dev)
4263 {
4264         return dev->priv_flags & IFF_L3MDEV_MASTER;
4265 }
4266
4267 static inline bool netif_is_l3_slave(const struct net_device *dev)
4268 {
4269         return dev->priv_flags & IFF_L3MDEV_SLAVE;
4270 }
4271
4272 static inline bool netif_is_bridge_master(const struct net_device *dev)
4273 {
4274         return dev->priv_flags & IFF_EBRIDGE;
4275 }
4276
4277 static inline bool netif_is_bridge_port(const struct net_device *dev)
4278 {
4279         return dev->priv_flags & IFF_BRIDGE_PORT;
4280 }
4281
4282 static inline bool netif_is_ovs_master(const struct net_device *dev)
4283 {
4284         return dev->priv_flags & IFF_OPENVSWITCH;
4285 }
4286
4287 static inline bool netif_is_team_master(const struct net_device *dev)
4288 {
4289         return dev->priv_flags & IFF_TEAM;
4290 }
4291
4292 static inline bool netif_is_team_port(const struct net_device *dev)
4293 {
4294         return dev->priv_flags & IFF_TEAM_PORT;
4295 }
4296
4297 static inline bool netif_is_lag_master(const struct net_device *dev)
4298 {
4299         return netif_is_bond_master(dev) || netif_is_team_master(dev);
4300 }
4301
4302 static inline bool netif_is_lag_port(const struct net_device *dev)
4303 {
4304         return netif_is_bond_slave(dev) || netif_is_team_port(dev);
4305 }
4306
4307 static inline bool netif_is_rxfh_configured(const struct net_device *dev)
4308 {
4309         return dev->priv_flags & IFF_RXFH_CONFIGURED;
4310 }
4311
4312 /* This device needs to keep skb dst for qdisc enqueue or ndo_start_xmit() */
4313 static inline void netif_keep_dst(struct net_device *dev)
4314 {
4315         dev->priv_flags &= ~(IFF_XMIT_DST_RELEASE | IFF_XMIT_DST_RELEASE_PERM);
4316 }
4317
4318 /* return true if dev can't cope with mtu frames that need vlan tag insertion */
4319 static inline bool netif_reduces_vlan_mtu(struct net_device *dev)
4320 {
4321         /* TODO: reserve and use an additional IFF bit, if we get more users */
4322         return dev->priv_flags & IFF_MACSEC;
4323 }
4324
4325 extern struct pernet_operations __net_initdata loopback_net_ops;
4326
4327 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4328
4329 /* netdev_printk helpers, similar to dev_printk */
4330
4331 static inline const char *netdev_name(const struct net_device *dev)
4332 {
4333         if (!dev->name[0] || strchr(dev->name, '%'))
4334                 return "(unnamed net_device)";
4335         return dev->name;
4336 }
4337
4338 static inline const char *netdev_reg_state(const struct net_device *dev)
4339 {
4340         switch (dev->reg_state) {
4341         case NETREG_UNINITIALIZED: return " (uninitialized)";
4342         case NETREG_REGISTERED: return "";
4343         case NETREG_UNREGISTERING: return " (unregistering)";
4344         case NETREG_UNREGISTERED: return " (unregistered)";
4345         case NETREG_RELEASED: return " (released)";
4346         case NETREG_DUMMY: return " (dummy)";
4347         }
4348
4349         WARN_ONCE(1, "%s: unknown reg_state %d\n", dev->name, dev->reg_state);
4350         return " (unknown)";
4351 }
4352
4353 __printf(3, 4)
4354 void netdev_printk(const char *level, const struct net_device *dev,
4355                    const char *format, ...);
4356 __printf(2, 3)
4357 void netdev_emerg(const struct net_device *dev, const char *format, ...);
4358 __printf(2, 3)
4359 void netdev_alert(const struct net_device *dev, const char *format, ...);
4360 __printf(2, 3)
4361 void netdev_crit(const struct net_device *dev, const char *format, ...);
4362 __printf(2, 3)
4363 void netdev_err(const struct net_device *dev, const char *format, ...);
4364 __printf(2, 3)
4365 void netdev_warn(const struct net_device *dev, const char *format, ...);
4366 __printf(2, 3)
4367 void netdev_notice(const struct net_device *dev, const char *format, ...);
4368 __printf(2, 3)
4369 void netdev_info(const struct net_device *dev, const char *format, ...);
4370
4371 #define MODULE_ALIAS_NETDEV(device) \
4372         MODULE_ALIAS("netdev-" device)
4373
4374 #if defined(CONFIG_DYNAMIC_DEBUG)
4375 #define netdev_dbg(__dev, format, args...)                      \
4376 do {                                                            \
4377         dynamic_netdev_dbg(__dev, format, ##args);              \
4378 } while (0)
4379 #elif defined(DEBUG)
4380 #define netdev_dbg(__dev, format, args...)                      \
4381         netdev_printk(KERN_DEBUG, __dev, format, ##args)
4382 #else
4383 #define netdev_dbg(__dev, format, args...)                      \
4384 ({                                                              \
4385         if (0)                                                  \
4386                 netdev_printk(KERN_DEBUG, __dev, format, ##args); \
4387 })
4388 #endif
4389
4390 #if defined(VERBOSE_DEBUG)
4391 #define netdev_vdbg     netdev_dbg
4392 #else
4393
4394 #define netdev_vdbg(dev, format, args...)                       \
4395 ({                                                              \
4396         if (0)                                                  \
4397                 netdev_printk(KERN_DEBUG, dev, format, ##args); \
4398         0;                                                      \
4399 })
4400 #endif
4401
4402 /*
4403  * netdev_WARN() acts like dev_printk(), but with the key difference
4404  * of using a WARN/WARN_ON to get the message out, including the
4405  * file/line information and a backtrace.
4406  */
4407 #define netdev_WARN(dev, format, args...)                       \
4408         WARN(1, "netdevice: %s%s\n" format, netdev_name(dev),   \
4409              netdev_reg_state(dev), ##args)
4410
4411 /* netif printk helpers, similar to netdev_printk */
4412
4413 #define netif_printk(priv, type, level, dev, fmt, args...)      \
4414 do {                                                            \
4415         if (netif_msg_##type(priv))                             \
4416                 netdev_printk(level, (dev), fmt, ##args);       \
4417 } while (0)
4418
4419 #define netif_level(level, priv, type, dev, fmt, args...)       \
4420 do {                                                            \
4421         if (netif_msg_##type(priv))                             \
4422                 netdev_##level(dev, fmt, ##args);               \
4423 } while (0)
4424
4425 #define netif_emerg(priv, type, dev, fmt, args...)              \
4426         netif_level(emerg, priv, type, dev, fmt, ##args)
4427 #define netif_alert(priv, type, dev, fmt, args...)              \
4428         netif_level(alert, priv, type, dev, fmt, ##args)
4429 #define netif_crit(priv, type, dev, fmt, args...)               \
4430         netif_level(crit, priv, type, dev, fmt, ##args)
4431 #define netif_err(priv, type, dev, fmt, args...)                \
4432         netif_level(err, priv, type, dev, fmt, ##args)
4433 #define netif_warn(priv, type, dev, fmt, args...)               \
4434         netif_level(warn, priv, type, dev, fmt, ##args)
4435 #define netif_notice(priv, type, dev, fmt, args...)             \
4436         netif_level(notice, priv, type, dev, fmt, ##args)
4437 #define netif_info(priv, type, dev, fmt, args...)               \
4438         netif_level(info, priv, type, dev, fmt, ##args)
4439
4440 #if defined(CONFIG_DYNAMIC_DEBUG)
4441 #define netif_dbg(priv, type, netdev, format, args...)          \
4442 do {                                                            \
4443         if (netif_msg_##type(priv))                             \
4444                 dynamic_netdev_dbg(netdev, format, ##args);     \
4445 } while (0)
4446 #elif defined(DEBUG)
4447 #define netif_dbg(priv, type, dev, format, args...)             \
4448         netif_printk(priv, type, KERN_DEBUG, dev, format, ##args)
4449 #else
4450 #define netif_dbg(priv, type, dev, format, args...)                     \
4451 ({                                                                      \
4452         if (0)                                                          \
4453                 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
4454         0;                                                              \
4455 })
4456 #endif
4457
4458 #if defined(VERBOSE_DEBUG)
4459 #define netif_vdbg      netif_dbg
4460 #else
4461 #define netif_vdbg(priv, type, dev, format, args...)            \
4462 ({                                                              \
4463         if (0)                                                  \
4464                 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
4465         0;                                                      \
4466 })
4467 #endif
4468
4469 /*
4470  *      The list of packet types we will receive (as opposed to discard)
4471  *      and the routines to invoke.
4472  *
4473  *      Why 16. Because with 16 the only overlap we get on a hash of the
4474  *      low nibble of the protocol value is RARP/SNAP/X.25.
4475  *
4476  *      NOTE:  That is no longer true with the addition of VLAN tags.  Not
4477  *             sure which should go first, but I bet it won't make much
4478  *             difference if we are running VLANs.  The good news is that
4479  *             this protocol won't be in the list unless compiled in, so
4480  *             the average user (w/out VLANs) will not be adversely affected.
4481  *             --BLG
4482  *
4483  *              0800    IP
4484  *              8100    802.1Q VLAN
4485  *              0001    802.3
4486  *              0002    AX.25
4487  *              0004    802.2
4488  *              8035    RARP
4489  *              0005    SNAP
4490  *              0805    X.25
4491  *              0806    ARP
4492  *              8137    IPX
4493  *              0009    Localtalk
4494  *              86DD    IPv6
4495  */
4496 #define PTYPE_HASH_SIZE (16)
4497 #define PTYPE_HASH_MASK (PTYPE_HASH_SIZE - 1)
4498
4499 #endif  /* _LINUX_NETDEVICE_H */