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