include/linux/netdevice.h

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