include/linux/netdevice.h

   1 /*
   2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
   3  *              operating system.  INET is implemented using the  BSD Socket
   4  *              interface as the means of communication with the user level.
   5  *
   6  *              Definitions for the Interfaces handler.
   7  *
   8  * Version:     @(#)dev.h       1.0.10  08/12/93
   9  *
  10  * Authors:     Ross Biro
  11  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
  12  *              Corey Minyard <wf-rch!minyard@relay.EU.net>
  13  *              Donald J. Becker, <becker@cesdis.gsfc.nasa.gov>
  14  *              Alan Cox, <alan@lxorguk.ukuu.org.uk>
  15  *              Bjorn Ekwall. <bj0rn@blox.se>
  16  *              Pekka Riikonen <priikone@poseidon.pspt.fi>
  17  *
  18  *              This program is free software; you can redistribute it and/or
  19  *              modify it under the terms of the GNU General Public License
  20  *              as published by the Free Software Foundation; either version
  21  *              2 of the License, or (at your option) any later version.
  22  *
  23  *              Moved to /usr/include/linux for NET3
  24  */
  25 #ifndef _LINUX_NETDEVICE_H
  26 #define _LINUX_NETDEVICE_H
  27
  28 #include <linux/pm_qos.h>
  29 #include <linux/timer.h>
  30 #include <linux/bug.h>
  31 #include <linux/delay.h>
  32 #include <linux/atomic.h>
  33 #include <asm/cache.h>
  34 #include <asm/byteorder.h>
  35
  36 #include <linux/percpu.h>
  37 #include <linux/rculist.h>
  38 #include <linux/dmaengine.h>
  39 #include <linux/workqueue.h>
  40 #include <linux/dynamic_queue_limits.h>
  41
  42 #include <linux/ethtool.h>
  43 #include <net/net_namespace.h>
  44 #include <net/dsa.h>
  45 #ifdef CONFIG_DCB
  46 #include <net/dcbnl.h>
  47 #endif
  48 #include <net/netprio_cgroup.h>
  49
  50 #include <linux/netdev_features.h>
  51 #include <linux/neighbour.h>
  52 #include <uapi/linux/netdevice.h>
  53
  54 struct netpoll_info;
  55 struct device;
  56 struct phy_device;
  57 /* 802.11 specific */
  58 struct wireless_dev;
  59                                         /* source back-compat hooks */
  60 #define SET_ETHTOOL_OPS(netdev,ops) \
  61         ( (netdev)->ethtool_ops = (ops) )
  62
  63 void netdev_set_default_ethtool_ops(struct net_device *dev,
  64                                     const struct ethtool_ops *ops);
  65
  66 /* hardware address assignment types */
  67 #define NET_ADDR_PERM           0       /* address is permanent (default) */
  68 #define NET_ADDR_RANDOM         1       /* address is generated randomly */
  69 #define NET_ADDR_STOLEN         2       /* address is stolen from other device */
  70 #define NET_ADDR_SET            3       /* address is set using
  71                                          * dev_set_mac_address() */
  72
  73 /* Backlog congestion levels */
  74 #define NET_RX_SUCCESS          0       /* keep 'em coming, baby */
  75 #define NET_RX_DROP             1       /* packet dropped */
  76
  77 /*
  78  * Transmit return codes: transmit return codes originate from three different
  79  * namespaces:
  80  *
  81  * - qdisc return codes
  82  * - driver transmit return codes
  83  * - errno values
  84  *
  85  * Drivers are allowed to return any one of those in their hard_start_xmit()
  86  * function. Real network devices commonly used with qdiscs should only return
  87  * the driver transmit return codes though - when qdiscs are used, the actual
  88  * transmission happens asynchronously, so the value is not propagated to
  89  * higher layers. Virtual network devices transmit synchronously, in this case
  90  * the driver transmit return codes are consumed by dev_queue_xmit(), all
  91  * others are propagated to higher layers.
  92  */
  93
  94 /* qdisc ->enqueue() return codes. */
  95 #define NET_XMIT_SUCCESS        0x00
  96 #define NET_XMIT_DROP           0x01    /* skb dropped                  */
  97 #define NET_XMIT_CN             0x02    /* congestion notification      */
  98 #define NET_XMIT_POLICED        0x03    /* skb is shot by police        */
  99 #define NET_XMIT_MASK           0x0f    /* qdisc flags in net/sch_generic.h */
 100
 101 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
 102  * indicates that the device will soon be dropping packets, or already drops
 103  * some packets of the same priority; prompting us to send less aggressively. */
 104 #define net_xmit_eval(e)        ((e) == NET_XMIT_CN ? 0 : (e))
 105 #define net_xmit_errno(e)       ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
 106
 107 /* Driver transmit return codes */
 108 #define NETDEV_TX_MASK          0xf0
 109
 110 enum netdev_tx {
 111         __NETDEV_TX_MIN  = INT_MIN,     /* make sure enum is signed */
 112         NETDEV_TX_OK     = 0x00,        /* driver took care of packet */
 113         NETDEV_TX_BUSY   = 0x10,        /* driver tx path was busy*/
 114         NETDEV_TX_LOCKED = 0x20,        /* driver tx lock was already taken */
 115 };
 116 typedef enum netdev_tx netdev_tx_t;
 117
 118 /*
 119  * Current order: NETDEV_TX_MASK > NET_XMIT_MASK >= 0 is significant;
 120  * hard_start_xmit() return < NET_XMIT_MASK means skb was consumed.
 121  */
 122 static inline bool dev_xmit_complete(int rc)
 123 {
 124         /*
 125          * Positive cases with an skb consumed by a driver:
 126          * - successful transmission (rc == NETDEV_TX_OK)
 127          * - error while transmitting (rc < 0)
 128          * - error while queueing to a different device (rc & NET_XMIT_MASK)
 129          */
 130         if (likely(rc < NET_XMIT_MASK))
 131                 return true;
 132
 133         return false;
 134 }
 135
 136 /*
 137  *      Compute the worst case header length according to the protocols
 138  *      used.
 139  */
 140
 141 #if defined(CONFIG_WLAN) || IS_ENABLED(CONFIG_AX25)
 142 # if defined(CONFIG_MAC80211_MESH)
 143 #  define LL_MAX_HEADER 128
 144 # else
 145 #  define LL_MAX_HEADER 96
 146 # endif
 147 #else
 148 # define LL_MAX_HEADER 32
 149 #endif
 150
 151 #if !IS_ENABLED(CONFIG_NET_IPIP) && !IS_ENABLED(CONFIG_NET_IPGRE) && \
 152     !IS_ENABLED(CONFIG_IPV6_SIT) && !IS_ENABLED(CONFIG_IPV6_TUNNEL)
 153 #define MAX_HEADER LL_MAX_HEADER
 154 #else
 155 #define MAX_HEADER (LL_MAX_HEADER + 48)
 156 #endif
 157
 158 /*
 159  *      Old network device statistics. Fields are native words
 160  *      (unsigned long) so they can be read and written atomically.
 161  */
 162
 163 struct net_device_stats {
 164         unsigned long   rx_packets;
 165         unsigned long   tx_packets;
 166         unsigned long   rx_bytes;
 167         unsigned long   tx_bytes;
 168         unsigned long   rx_errors;
 169         unsigned long   tx_errors;
 170         unsigned long   rx_dropped;
 171         unsigned long   tx_dropped;
 172         unsigned long   multicast;
 173         unsigned long   collisions;
 174         unsigned long   rx_length_errors;
 175         unsigned long   rx_over_errors;
 176         unsigned long   rx_crc_errors;
 177         unsigned long   rx_frame_errors;
 178         unsigned long   rx_fifo_errors;
 179         unsigned long   rx_missed_errors;
 180         unsigned long   tx_aborted_errors;
 181         unsigned long   tx_carrier_errors;
 182         unsigned long   tx_fifo_errors;
 183         unsigned long   tx_heartbeat_errors;
 184         unsigned long   tx_window_errors;
 185         unsigned long   rx_compressed;
 186         unsigned long   tx_compressed;
 187 };
 188
 189
 190 #include <linux/cache.h>
 191 #include <linux/skbuff.h>
 192
 193 #ifdef CONFIG_RPS
 194 #include <linux/static_key.h>
 195 extern struct static_key rps_needed;
 196 #endif
 197
 198 struct neighbour;
 199 struct neigh_parms;
 200 struct sk_buff;
 201
 202 struct netdev_hw_addr {
 203         struct list_head        list;
 204         unsigned char           addr[MAX_ADDR_LEN];
 205         unsigned char           type;
 206 #define NETDEV_HW_ADDR_T_LAN            1
 207 #define NETDEV_HW_ADDR_T_SAN            2
 208 #define NETDEV_HW_ADDR_T_SLAVE          3
 209 #define NETDEV_HW_ADDR_T_UNICAST        4
 210 #define NETDEV_HW_ADDR_T_MULTICAST      5
 211         bool                    global_use;
 212         int                     sync_cnt;
 213         int                     refcount;
 214         int                     synced;
 215         struct rcu_head         rcu_head;
 216 };
 217
 218 struct netdev_hw_addr_list {
 219         struct list_head        list;
 220         int                     count;
 221 };
 222
 223 #define netdev_hw_addr_list_count(l) ((l)->count)
 224 #define netdev_hw_addr_list_empty(l) (netdev_hw_addr_list_count(l) == 0)
 225 #define netdev_hw_addr_list_for_each(ha, l) \
 226         list_for_each_entry(ha, &(l)->list, list)
 227
 228 #define netdev_uc_count(dev) netdev_hw_addr_list_count(&(dev)->uc)
 229 #define netdev_uc_empty(dev) netdev_hw_addr_list_empty(&(dev)->uc)
 230 #define netdev_for_each_uc_addr(ha, dev) \
 231         netdev_hw_addr_list_for_each(ha, &(dev)->uc)
 232
 233 #define netdev_mc_count(dev) netdev_hw_addr_list_count(&(dev)->mc)
 234 #define netdev_mc_empty(dev) netdev_hw_addr_list_empty(&(dev)->mc)
 235 #define netdev_for_each_mc_addr(ha, dev) \
 236         netdev_hw_addr_list_for_each(ha, &(dev)->mc)
 237
 238 struct hh_cache {
 239         u16             hh_len;
 240         u16             __pad;
 241         seqlock_t       hh_lock;
 242
 243         /* cached hardware header; allow for machine alignment needs.        */
 244 #define HH_DATA_MOD     16
 245 #define HH_DATA_OFF(__len) \
 246         (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
 247 #define HH_DATA_ALIGN(__len) \
 248         (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
 249         unsigned long   hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
 250 };
 251
 252 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
 253  * Alternative is:
 254  *   dev->hard_header_len ? (dev->hard_header_len +
 255  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
 256  *
 257  * We could use other alignment values, but we must maintain the
 258  * relationship HH alignment <= LL alignment.
 259  */
 260 #define LL_RESERVED_SPACE(dev) \
 261         ((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 262 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
 263         ((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 264
 265 struct header_ops {
 266         int     (*create) (struct sk_buff *skb, struct net_device *dev,
 267                            unsigned short type, const void *daddr,
 268                            const void *saddr, unsigned int len);
 269         int     (*parse)(const struct sk_buff *skb, unsigned char *haddr);
 270         int     (*rebuild)(struct sk_buff *skb);
 271         int     (*cache)(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
 272         void    (*cache_update)(struct hh_cache *hh,
 273                                 const struct net_device *dev,
 274                                 const unsigned char *haddr);
 275 };
 276
 277 /* These flag bits are private to the generic network queueing
 278  * layer, they may not be explicitly referenced by any other
 279  * code.
 280  */
 281
 282 enum netdev_state_t {
 283         __LINK_STATE_START,
 284         __LINK_STATE_PRESENT,
 285         __LINK_STATE_NOCARRIER,
 286         __LINK_STATE_LINKWATCH_PENDING,
 287         __LINK_STATE_DORMANT,
 288 };
 289
 290
 291 /*
 292  * This structure holds at boot time configured netdevice settings. They
 293  * are then used in the device probing.
 294  */
 295 struct netdev_boot_setup {
 296         char name[IFNAMSIZ];
 297         struct ifmap map;
 298 };
 299 #define NETDEV_BOOT_SETUP_MAX 8
 300
 301 int __init netdev_boot_setup(char *str);
 302
 303 /*
 304  * Structure for NAPI scheduling similar to tasklet but with weighting
 305  */
 306 struct napi_struct {
 307         /* The poll_list must only be managed by the entity which
 308          * changes the state of the NAPI_STATE_SCHED bit.  This means
 309          * whoever atomically sets that bit can add this napi_struct
 310          * to the per-cpu poll_list, and whoever clears that bit
 311          * can remove from the list right before clearing the bit.
 312          */
 313         struct list_head        poll_list;
 314
 315         unsigned long           state;
 316         int                     weight;
 317         unsigned int            gro_count;
 318         int                     (*poll)(struct napi_struct *, int);
 319 #ifdef CONFIG_NETPOLL
 320         spinlock_t              poll_lock;
 321         int                     poll_owner;
 322 #endif
 323         struct net_device       *dev;
 324         struct sk_buff          *gro_list;
 325         struct sk_buff          *skb;
 326         struct list_head        dev_list;
 327         struct hlist_node       napi_hash_node;
 328         unsigned int            napi_id;
 329 };
 330
 331 enum {
 332         NAPI_STATE_SCHED,       /* Poll is scheduled */
 333         NAPI_STATE_DISABLE,     /* Disable pending */
 334         NAPI_STATE_NPSVC,       /* Netpoll - don't dequeue from poll_list */
 335         NAPI_STATE_HASHED,      /* In NAPI hash */
 336 };
 337
 338 enum gro_result {
 339         GRO_MERGED,
 340         GRO_MERGED_FREE,
 341         GRO_HELD,
 342         GRO_NORMAL,
 343         GRO_DROP,
 344 };
 345 typedef enum gro_result gro_result_t;
 346
 347 /*
 348  * enum rx_handler_result - Possible return values for rx_handlers.
 349  * @RX_HANDLER_CONSUMED: skb was consumed by rx_handler, do not process it
 350  * further.
 351  * @RX_HANDLER_ANOTHER: Do another round in receive path. This is indicated in
 352  * case skb->dev was changed by rx_handler.
 353  * @RX_HANDLER_EXACT: Force exact delivery, no wildcard.
 354  * @RX_HANDLER_PASS: Do nothing, passe the skb as if no rx_handler was called.
 355  *
 356  * rx_handlers are functions called from inside __netif_receive_skb(), to do
 357  * special processing of the skb, prior to delivery to protocol handlers.
 358  *
 359  * Currently, a net_device can only have a single rx_handler registered. Trying
 360  * to register a second rx_handler will return -EBUSY.
 361  *
 362  * To register a rx_handler on a net_device, use netdev_rx_handler_register().
 363  * To unregister a rx_handler on a net_device, use
 364  * netdev_rx_handler_unregister().
 365  *
 366  * Upon return, rx_handler is expected to tell __netif_receive_skb() what to
 367  * do with the skb.
 368  *
 369  * If the rx_handler consumed to skb in some way, it should return
 370  * RX_HANDLER_CONSUMED. This is appropriate when the rx_handler arranged for
 371  * the skb to be delivered in some other ways.
 372  *
 373  * If the rx_handler changed skb->dev, to divert the skb to another
 374  * net_device, it should return RX_HANDLER_ANOTHER. The rx_handler for the
 375  * new device will be called if it exists.
 376  *
 377  * If the rx_handler consider the skb should be ignored, it should return
 378  * RX_HANDLER_EXACT. The skb will only be delivered to protocol handlers that
 379  * are registered on exact device (ptype->dev == skb->dev).
 380  *
 381  * If the rx_handler didn't changed skb->dev, but want the skb to be normally
 382  * delivered, it should return RX_HANDLER_PASS.
 383  *
 384  * A device without a registered rx_handler will behave as if rx_handler
 385  * returned RX_HANDLER_PASS.
 386  */
 387
 388 enum rx_handler_result {
 389         RX_HANDLER_CONSUMED,
 390         RX_HANDLER_ANOTHER,
 391         RX_HANDLER_EXACT,
 392         RX_HANDLER_PASS,
 393 };
 394 typedef enum rx_handler_result rx_handler_result_t;
 395 typedef rx_handler_result_t rx_handler_func_t(struct sk_buff **pskb);
 396
 397 void __napi_schedule(struct napi_struct *n);
 398
 399 static inline bool napi_disable_pending(struct napi_struct *n)
 400 {
 401         return test_bit(NAPI_STATE_DISABLE, &n->state);
 402 }
 403
 404 /**
 405  *      napi_schedule_prep - check if napi can be scheduled
 406  *      @n: napi context
 407  *
 408  * Test if NAPI routine is already running, and if not mark
 409  * it as running.  This is used as a condition variable
 410  * insure only one NAPI poll instance runs.  We also make
 411  * sure there is no pending NAPI disable.
 412  */
 413 static inline bool napi_schedule_prep(struct napi_struct *n)
 414 {
 415         return !napi_disable_pending(n) &&
 416                 !test_and_set_bit(NAPI_STATE_SCHED, &n->state);
 417 }
 418
 419 /**
 420  *      napi_schedule - schedule NAPI poll
 421  *      @n: napi context
 422  *
 423  * Schedule NAPI poll routine to be called if it is not already
 424  * running.
 425  */
 426 static inline void napi_schedule(struct napi_struct *n)
 427 {
 428         if (napi_schedule_prep(n))
 429                 __napi_schedule(n);
 430 }
 431
 432 /* Try to reschedule poll. Called by dev->poll() after napi_complete().  */
 433 static inline bool napi_reschedule(struct napi_struct *napi)
 434 {
 435         if (napi_schedule_prep(napi)) {
 436                 __napi_schedule(napi);
 437                 return true;
 438         }
 439         return false;
 440 }
 441
 442 /**
 443  *      napi_complete - NAPI processing complete
 444  *      @n: napi context
 445  *
 446  * Mark NAPI processing as complete.
 447  */
 448 void __napi_complete(struct napi_struct *n);
 449 void napi_complete(struct napi_struct *n);
 450
 451 /**
 452  *      napi_by_id - lookup a NAPI by napi_id
 453  *      @napi_id: hashed napi_id
 454  *
 455  * lookup @napi_id in napi_hash table
 456  * must be called under rcu_read_lock()
 457  */
 458 struct napi_struct *napi_by_id(unsigned int napi_id);
 459
 460 /**
 461  *      napi_hash_add - add a NAPI to global hashtable
 462  *      @napi: napi context
 463  *
 464  * generate a new napi_id and store a @napi under it in napi_hash
 465  */
 466 void napi_hash_add(struct napi_struct *napi);
 467
 468 /**
 469  *      napi_hash_del - remove a NAPI from global table
 470  *      @napi: napi context
 471  *
 472  * Warning: caller must observe rcu grace period
 473  * before freeing memory containing @napi
 474  */
 475 void napi_hash_del(struct napi_struct *napi);
 476
 477 /**
 478  *      napi_disable - prevent NAPI from scheduling
 479  *      @n: napi context
 480  *
 481  * Stop NAPI from being scheduled on this context.
 482  * Waits till any outstanding processing completes.
 483  */
 484 static inline void napi_disable(struct napi_struct *n)
 485 {
 486         might_sleep();
 487         set_bit(NAPI_STATE_DISABLE, &n->state);
 488         while (test_and_set_bit(NAPI_STATE_SCHED, &n->state))
 489                 msleep(1);
 490         clear_bit(NAPI_STATE_DISABLE, &n->state);
 491 }
 492
 493 /**
 494  *      napi_enable - enable NAPI scheduling
 495  *      @n: napi context
 496  *
 497  * Resume NAPI from being scheduled on this context.
 498  * Must be paired with napi_disable.
 499  */
 500 static inline void napi_enable(struct napi_struct *n)
 501 {
 502         BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
 503         smp_mb__before_clear_bit();
 504         clear_bit(NAPI_STATE_SCHED, &n->state);
 505 }
 506
 507 #ifdef CONFIG_SMP
 508 /**
 509  *      napi_synchronize - wait until NAPI is not running
 510  *      @n: napi context
 511  *
 512  * Wait until NAPI is done being scheduled on this context.
 513  * Waits till any outstanding processing completes but
 514  * does not disable future activations.
 515  */
 516 static inline void napi_synchronize(const struct napi_struct *n)
 517 {
 518         while (test_bit(NAPI_STATE_SCHED, &n->state))
 519                 msleep(1);
 520 }
 521 #else
 522 # define napi_synchronize(n)    barrier()
 523 #endif
 524
 525 enum netdev_queue_state_t {
 526         __QUEUE_STATE_DRV_XOFF,
 527         __QUEUE_STATE_STACK_XOFF,
 528         __QUEUE_STATE_FROZEN,
 529 #define QUEUE_STATE_ANY_XOFF ((1 << __QUEUE_STATE_DRV_XOFF)             | \
 530                               (1 << __QUEUE_STATE_STACK_XOFF))
 531 #define QUEUE_STATE_ANY_XOFF_OR_FROZEN (QUEUE_STATE_ANY_XOFF            | \
 532                                         (1 << __QUEUE_STATE_FROZEN))
 533 };
 534 /*
 535  * __QUEUE_STATE_DRV_XOFF is used by drivers to stop the transmit queue.  The
 536  * netif_tx_* functions below are used to manipulate this flag.  The
 537  * __QUEUE_STATE_STACK_XOFF flag is used by the stack to stop the transmit
 538  * queue independently.  The netif_xmit_*stopped functions below are called
 539  * to check if the queue has been stopped by the driver or stack (either
 540  * of the XOFF bits are set in the state).  Drivers should not need to call
 541  * netif_xmit*stopped functions, they should only be using netif_tx_*.
 542  */
 543
 544 struct netdev_queue {
 545 /*
 546  * read mostly part
 547  */
 548         struct net_device       *dev;
 549         struct Qdisc            *qdisc;
 550         struct Qdisc            *qdisc_sleeping;
 551 #ifdef CONFIG_SYSFS
 552         struct kobject          kobj;
 553 #endif
 554 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
 555         int                     numa_node;
 556 #endif
 557 /*
 558  * write mostly part
 559  */
 560         spinlock_t              _xmit_lock ____cacheline_aligned_in_smp;
 561         int                     xmit_lock_owner;
 562         /*
 563          * please use this field instead of dev->trans_start
 564          */
 565         unsigned long           trans_start;
 566
 567         /*
 568          * Number of TX timeouts for this queue
 569          * (/sys/class/net/DEV/Q/trans_timeout)
 570          */
 571         unsigned long           trans_timeout;
 572
 573         unsigned long           state;
 574
 575 #ifdef CONFIG_BQL
 576         struct dql              dql;
 577 #endif
 578 } ____cacheline_aligned_in_smp;
 579
 580 static inline int netdev_queue_numa_node_read(const struct netdev_queue *q)
 581 {
 582 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
 583         return q->numa_node;
 584 #else
 585         return NUMA_NO_NODE;
 586 #endif
 587 }
 588
 589 static inline void netdev_queue_numa_node_write(struct netdev_queue *q, int node)
 590 {
 591 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
 592         q->numa_node = node;
 593 #endif
 594 }
 595
 596 #ifdef CONFIG_RPS
 597 /*
 598  * This structure holds an RPS map which can be of variable length.  The
 599  * map is an array of CPUs.
 600  */
 601 struct rps_map {
 602         unsigned int len;
 603         struct rcu_head rcu;
 604         u16 cpus[0];
 605 };
 606 #define RPS_MAP_SIZE(_num) (sizeof(struct rps_map) + ((_num) * sizeof(u16)))
 607
 608 /*
 609  * The rps_dev_flow structure contains the mapping of a flow to a CPU, the
 610  * tail pointer for that CPU's input queue at the time of last enqueue, and
 611  * a hardware filter index.
 612  */
 613 struct rps_dev_flow {
 614         u16 cpu;
 615         u16 filter;
 616         unsigned int last_qtail;
 617 };
 618 #define RPS_NO_FILTER 0xffff
 619
 620 /*
 621  * The rps_dev_flow_table structure contains a table of flow mappings.
 622  */
 623 struct rps_dev_flow_table {
 624         unsigned int mask;
 625         struct rcu_head rcu;
 626         struct rps_dev_flow flows[0];
 627 };
 628 #define RPS_DEV_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_dev_flow_table) + \
 629     ((_num) * sizeof(struct rps_dev_flow)))
 630
 631 /*
 632  * The rps_sock_flow_table contains mappings of flows to the last CPU
 633  * on which they were processed by the application (set in recvmsg).
 634  */
 635 struct rps_sock_flow_table {
 636         unsigned int mask;
 637         u16 ents[0];
 638 };
 639 #define RPS_SOCK_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_sock_flow_table) + \
 640     ((_num) * sizeof(u16)))
 641
 642 #define RPS_NO_CPU 0xffff
 643
 644 static inline void rps_record_sock_flow(struct rps_sock_flow_table *table,
 645                                         u32 hash)
 646 {
 647         if (table && hash) {
 648                 unsigned int cpu, index = hash & table->mask;
 649
 650                 /* We only give a hint, preemption can change cpu under us */
 651                 cpu = raw_smp_processor_id();
 652
 653                 if (table->ents[index] != cpu)
 654                         table->ents[index] = cpu;
 655         }
 656 }
 657
 658 static inline void rps_reset_sock_flow(struct rps_sock_flow_table *table,
 659                                        u32 hash)
 660 {
 661         if (table && hash)
 662                 table->ents[hash & table->mask] = RPS_NO_CPU;
 663 }
 664
 665 extern struct rps_sock_flow_table __rcu *rps_sock_flow_table;
 666
 667 #ifdef CONFIG_RFS_ACCEL
 668 bool rps_may_expire_flow(struct net_device *dev, u16 rxq_index, u32 flow_id,
 669                          u16 filter_id);
 670 #endif
 671 #endif /* CONFIG_RPS */
 672
 673 /* This structure contains an instance of an RX queue. */
 674 struct netdev_rx_queue {
 675 #ifdef CONFIG_RPS
 676         struct rps_map __rcu            *rps_map;
 677         struct rps_dev_flow_table __rcu *rps_flow_table;
 678 #endif
 679         struct kobject                  kobj;
 680         struct net_device               *dev;
 681 } ____cacheline_aligned_in_smp;
 682
 683 /*
 684  * RX queue sysfs structures and functions.
 685  */
 686 struct rx_queue_attribute {
 687         struct attribute attr;
 688         ssize_t (*show)(struct netdev_rx_queue *queue,
 689             struct rx_queue_attribute *attr, char *buf);
 690         ssize_t (*store)(struct netdev_rx_queue *queue,
 691             struct rx_queue_attribute *attr, const char *buf, size_t len);
 692 };
 693
 694 #ifdef CONFIG_XPS
 695 /*
 696  * This structure holds an XPS map which can be of variable length.  The
 697  * map is an array of queues.
 698  */
 699 struct xps_map {
 700         unsigned int len;
 701         unsigned int alloc_len;
 702         struct rcu_head rcu;
 703         u16 queues[0];
 704 };
 705 #define XPS_MAP_SIZE(_num) (sizeof(struct xps_map) + ((_num) * sizeof(u16)))
 706 #define XPS_MIN_MAP_ALLOC ((L1_CACHE_BYTES - sizeof(struct xps_map))    \
 707     / sizeof(u16))
 708
 709 /*
 710  * This structure holds all XPS maps for device.  Maps are indexed by CPU.
 711  */
 712 struct xps_dev_maps {
 713         struct rcu_head rcu;
 714         struct xps_map __rcu *cpu_map[0];
 715 };
 716 #define XPS_DEV_MAPS_SIZE (sizeof(struct xps_dev_maps) +                \
 717     (nr_cpu_ids * sizeof(struct xps_map *)))
 718 #endif /* CONFIG_XPS */
 719
 720 #define TC_MAX_QUEUE    16
 721 #define TC_BITMASK      15
 722 /* HW offloaded queuing disciplines txq count and offset maps */
 723 struct netdev_tc_txq {
 724         u16 count;
 725         u16 offset;
 726 };
 727
 728 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
 729 /*
 730  * This structure is to hold information about the device
 731  * configured to run FCoE protocol stack.
 732  */
 733 struct netdev_fcoe_hbainfo {
 734         char    manufacturer[64];
 735         char    serial_number[64];
 736         char    hardware_version[64];
 737         char    driver_version[64];
 738         char    optionrom_version[64];
 739         char    firmware_version[64];
 740         char    model[256];
 741         char    model_description[256];
 742 };
 743 #endif
 744
 745 #define MAX_PHYS_PORT_ID_LEN 32
 746
 747 /* This structure holds a unique identifier to identify the
 748  * physical port used by a netdevice.
 749  */
 750 struct netdev_phys_port_id {
 751         unsigned char id[MAX_PHYS_PORT_ID_LEN];
 752         unsigned char id_len;
 753 };
 754
 755 typedef u16 (*select_queue_fallback_t)(struct net_device *dev,
 756                                        struct sk_buff *skb);
 757
 758 /*
 759  * This structure defines the management hooks for network devices.
 760  * The following hooks can be defined; unless noted otherwise, they are
 761  * optional and can be filled with a null pointer.
 762  *
 763  * int (*ndo_init)(struct net_device *dev);
 764  *     This function is called once when network device is registered.
 765  *     The network device can use this to any late stage initializaton
 766  *     or semantic validattion. It can fail with an error code which will
 767  *     be propogated back to register_netdev
 768  *
 769  * void (*ndo_uninit)(struct net_device *dev);
 770  *     This function is called when device is unregistered or when registration
 771  *     fails. It is not called if init fails.
 772  *
 773  * int (*ndo_open)(struct net_device *dev);
 774  *     This function is called when network device transistions to the up
 775  *     state.
 776  *
 777  * int (*ndo_stop)(struct net_device *dev);
 778  *     This function is called when network device transistions to the down
 779  *     state.
 780  *
 781  * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
 782  *                               struct net_device *dev);
 783  *      Called when a packet needs to be transmitted.
 784  *      Must return NETDEV_TX_OK , NETDEV_TX_BUSY.
 785  *        (can also return NETDEV_TX_LOCKED iff NETIF_F_LLTX)
 786  *      Required can not be NULL.
 787  *
 788  * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb,
 789  *                         void *accel_priv, select_queue_fallback_t fallback);
 790  *      Called to decide which queue to when device supports multiple
 791  *      transmit queues.
 792  *
 793  * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
 794  *      This function is called to allow device receiver to make
 795  *      changes to configuration when multicast or promiscious is enabled.
 796  *
 797  * void (*ndo_set_rx_mode)(struct net_device *dev);
 798  *      This function is called device changes address list filtering.
 799  *      If driver handles unicast address filtering, it should set
 800  *      IFF_UNICAST_FLT to its priv_flags.
 801  *
 802  * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
 803  *      This function  is called when the Media Access Control address
 804  *      needs to be changed. If this interface is not defined, the
 805  *      mac address can not be changed.
 806  *
 807  * int (*ndo_validate_addr)(struct net_device *dev);
 808  *      Test if Media Access Control address is valid for the device.
 809  *
 810  * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
 811  *      Called when a user request an ioctl which can't be handled by
 812  *      the generic interface code. If not defined ioctl's return
 813  *      not supported error code.
 814  *
 815  * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
 816  *      Used to set network devices bus interface parameters. This interface
 817  *      is retained for legacy reason, new devices should use the bus
 818  *      interface (PCI) for low level management.
 819  *
 820  * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
 821  *      Called when a user wants to change the Maximum Transfer Unit
 822  *      of a device. If not defined, any request to change MTU will
 823  *      will return an error.
 824  *
 825  * void (*ndo_tx_timeout)(struct net_device *dev);
 826  *      Callback uses when the transmitter has not made any progress
 827  *      for dev->watchdog ticks.
 828  *
 829  * struct rtnl_link_stats64* (*ndo_get_stats64)(struct net_device *dev,
 830  *                      struct rtnl_link_stats64 *storage);
 831  * struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
 832  *      Called when a user wants to get the network device usage
 833  *      statistics. Drivers must do one of the following:
 834  *      1. Define @ndo_get_stats64 to fill in a zero-initialised
 835  *         rtnl_link_stats64 structure passed by the caller.
 836  *      2. Define @ndo_get_stats to update a net_device_stats structure
 837  *         (which should normally be dev->stats) and return a pointer to
 838  *         it. The structure may be changed asynchronously only if each
 839  *         field is written atomically.
 840  *      3. Update dev->stats asynchronously and atomically, and define
 841  *         neither operation.
 842  *
 843  * int (*ndo_vlan_rx_add_vid)(struct net_device *dev, __be16 proto, u16t vid);
 844  *      If device support VLAN filtering this function is called when a
 845  *      VLAN id is registered.
 846  *
 847  * int (*ndo_vlan_rx_kill_vid)(struct net_device *dev, unsigned short vid);
 848  *      If device support VLAN filtering this function is called when a
 849  *      VLAN id is unregistered.
 850  *
 851  * void (*ndo_poll_controller)(struct net_device *dev);
 852  *
 853  *      SR-IOV management functions.
 854  * int (*ndo_set_vf_mac)(struct net_device *dev, int vf, u8* mac);
 855  * int (*ndo_set_vf_vlan)(struct net_device *dev, int vf, u16 vlan, u8 qos);
 856  * int (*ndo_set_vf_tx_rate)(struct net_device *dev, int vf, int rate);
 857  * int (*ndo_set_vf_spoofchk)(struct net_device *dev, int vf, bool setting);
 858  * int (*ndo_get_vf_config)(struct net_device *dev,
 859  *                          int vf, struct ifla_vf_info *ivf);
 860  * int (*ndo_set_vf_link_state)(struct net_device *dev, int vf, int link_state);
 861  * int (*ndo_set_vf_port)(struct net_device *dev, int vf,
 862  *                        struct nlattr *port[]);
 863  * int (*ndo_get_vf_port)(struct net_device *dev, int vf, struct sk_buff *skb);
 864  * int (*ndo_setup_tc)(struct net_device *dev, u8 tc)
 865  *      Called to setup 'tc' number of traffic classes in the net device. This
 866  *      is always called from the stack with the rtnl lock held and netif tx
 867  *      queues stopped. This allows the netdevice to perform queue management
 868  *      safely.
 869  *
 870  *      Fiber Channel over Ethernet (FCoE) offload functions.
 871  * int (*ndo_fcoe_enable)(struct net_device *dev);
 872  *      Called when the FCoE protocol stack wants to start using LLD for FCoE
 873  *      so the underlying device can perform whatever needed configuration or
 874  *      initialization to support acceleration of FCoE traffic.
 875  *
 876  * int (*ndo_fcoe_disable)(struct net_device *dev);
 877  *      Called when the FCoE protocol stack wants to stop using LLD for FCoE
 878  *      so the underlying device can perform whatever needed clean-ups to
 879  *      stop supporting acceleration of FCoE traffic.
 880  *
 881  * int (*ndo_fcoe_ddp_setup)(struct net_device *dev, u16 xid,
 882  *                           struct scatterlist *sgl, unsigned int sgc);
 883  *      Called when the FCoE Initiator wants to initialize an I/O that
 884  *      is a possible candidate for Direct Data Placement (DDP). The LLD can
 885  *      perform necessary setup and returns 1 to indicate the device is set up
 886  *      successfully to perform DDP on this I/O, otherwise this returns 0.
 887  *
 888  * int (*ndo_fcoe_ddp_done)(struct net_device *dev,  u16 xid);
 889  *      Called when the FCoE Initiator/Target is done with the DDPed I/O as
 890  *      indicated by the FC exchange id 'xid', so the underlying device can
 891  *      clean up and reuse resources for later DDP requests.
 892  *
 893  * int (*ndo_fcoe_ddp_target)(struct net_device *dev, u16 xid,
 894  *                            struct scatterlist *sgl, unsigned int sgc);
 895  *      Called when the FCoE Target wants to initialize an I/O that
 896  *      is a possible candidate for Direct Data Placement (DDP). The LLD can
 897  *      perform necessary setup and returns 1 to indicate the device is set up
 898  *      successfully to perform DDP on this I/O, otherwise this returns 0.
 899  *
 900  * int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
 901  *                             struct netdev_fcoe_hbainfo *hbainfo);
 902  *      Called when the FCoE Protocol stack wants information on the underlying
 903  *      device. This information is utilized by the FCoE protocol stack to
 904  *      register attributes with Fiber Channel management service as per the
 905  *      FC-GS Fabric Device Management Information(FDMI) specification.
 906  *
 907  * int (*ndo_fcoe_get_wwn)(struct net_device *dev, u64 *wwn, int type);
 908  *      Called when the underlying device wants to override default World Wide
 909  *      Name (WWN) generation mechanism in FCoE protocol stack to pass its own
 910  *      World Wide Port Name (WWPN) or World Wide Node Name (WWNN) to the FCoE
 911  *      protocol stack to use.
 912  *
 913  *      RFS acceleration.
 914  * int (*ndo_rx_flow_steer)(struct net_device *dev, const struct sk_buff *skb,
 915  *                          u16 rxq_index, u32 flow_id);
 916  *      Set hardware filter for RFS.  rxq_index is the target queue index;
 917  *      flow_id is a flow ID to be passed to rps_may_expire_flow() later.
 918  *      Return the filter ID on success, or a negative error code.
 919  *
 920  *      Slave management functions (for bridge, bonding, etc).
 921  * int (*ndo_add_slave)(struct net_device *dev, struct net_device *slave_dev);
 922  *      Called to make another netdev an underling.
 923  *
 924  * int (*ndo_del_slave)(struct net_device *dev, struct net_device *slave_dev);
 925  *      Called to release previously enslaved netdev.
 926  *
 927  *      Feature/offload setting functions.
 928  * netdev_features_t (*ndo_fix_features)(struct net_device *dev,
 929  *              netdev_features_t features);
 930  *      Adjusts the requested feature flags according to device-specific
 931  *      constraints, and returns the resulting flags. Must not modify
 932  *      the device state.
 933  *
 934  * int (*ndo_set_features)(struct net_device *dev, netdev_features_t features);
 935  *      Called to update device configuration to new features. Passed
 936  *      feature set might be less than what was returned by ndo_fix_features()).
 937  *      Must return >0 or -errno if it changed dev->features itself.
 938  *
 939  * int (*ndo_fdb_add)(struct ndmsg *ndm, struct nlattr *tb[],
 940  *                    struct net_device *dev,
 941  *                    const unsigned char *addr, u16 flags)
 942  *      Adds an FDB entry to dev for addr.
 943  * int (*ndo_fdb_del)(struct ndmsg *ndm, struct nlattr *tb[],
 944  *                    struct net_device *dev,
 945  *                    const unsigned char *addr)
 946  *      Deletes the FDB entry from dev coresponding to addr.
 947  * int (*ndo_fdb_dump)(struct sk_buff *skb, struct netlink_callback *cb,
 948  *                     struct net_device *dev, int idx)
 949  *      Used to add FDB entries to dump requests. Implementers should add
 950  *      entries to skb and update idx with the number of entries.
 951  *
 952  * int (*ndo_bridge_setlink)(struct net_device *dev, struct nlmsghdr *nlh)
 953  * int (*ndo_bridge_getlink)(struct sk_buff *skb, u32 pid, u32 seq,
 954  *                           struct net_device *dev, u32 filter_mask)
 955  *
 956  * int (*ndo_change_carrier)(struct net_device *dev, bool new_carrier);
 957  *      Called to change device carrier. Soft-devices (like dummy, team, etc)
 958  *      which do not represent real hardware may define this to allow their
 959  *      userspace components to manage their virtual carrier state. Devices
 960  *      that determine carrier state from physical hardware properties (eg
 961  *      network cables) or protocol-dependent mechanisms (eg
 962  *      USB_CDC_NOTIFY_NETWORK_CONNECTION) should NOT implement this function.
 963  *
 964  * int (*ndo_get_phys_port_id)(struct net_device *dev,
 965  *                             struct netdev_phys_port_id *ppid);
 966  *      Called to get ID of physical port of this device. If driver does
 967  *      not implement this, it is assumed that the hw is not able to have
 968  *      multiple net devices on single physical port.
 969  *
 970  * void (*ndo_add_vxlan_port)(struct  net_device *dev,
 971  *                            sa_family_t sa_family, __be16 port);
 972  *      Called by vxlan to notiy a driver about the UDP port and socket
 973  *      address family that vxlan is listnening to. It is called only when
 974  *      a new port starts listening. The operation is protected by the
 975  *      vxlan_net->sock_lock.
 976  *
 977  * void (*ndo_del_vxlan_port)(struct  net_device *dev,
 978  *                            sa_family_t sa_family, __be16 port);
 979  *      Called by vxlan to notify the driver about a UDP port and socket
 980  *      address family that vxlan is not listening to anymore. The operation
 981  *      is protected by the vxlan_net->sock_lock.
 982  *
 983  * void* (*ndo_dfwd_add_station)(struct net_device *pdev,
 984  *                               struct net_device *dev)
 985  *      Called by upper layer devices to accelerate switching or other
 986  *      station functionality into hardware. 'pdev is the lowerdev
 987  *      to use for the offload and 'dev' is the net device that will
 988  *      back the offload. Returns a pointer to the private structure
 989  *      the upper layer will maintain.
 990  * void (*ndo_dfwd_del_station)(struct net_device *pdev, void *priv)
 991  *      Called by upper layer device to delete the station created
 992  *      by 'ndo_dfwd_add_station'. 'pdev' is the net device backing
 993  *      the station and priv is the structure returned by the add
 994  *      operation.
 995  * netdev_tx_t (*ndo_dfwd_start_xmit)(struct sk_buff *skb,
 996  *                                    struct net_device *dev,
 997  *                                    void *priv);
 998  *      Callback to use for xmit over the accelerated station. This
 999  *      is used in place of ndo_start_xmit on accelerated net
1000  *      devices.
1001  */
1002 struct net_device_ops {
1003         int                     (*ndo_init)(struct net_device *dev);
1004         void                    (*ndo_uninit)(struct net_device *dev);
1005         int                     (*ndo_open)(struct net_device *dev);
1006         int                     (*ndo_stop)(struct net_device *dev);
1007         netdev_tx_t             (*ndo_start_xmit) (struct sk_buff *skb,
1008                                                    struct net_device *dev);
1009         u16                     (*ndo_select_queue)(struct net_device *dev,
1010                                                     struct sk_buff *skb,
1011                                                     void *accel_priv,
1012                                                     select_queue_fallback_t fallback);
1013         void                    (*ndo_change_rx_flags)(struct net_device *dev,
1014                                                        int flags);
1015         void                    (*ndo_set_rx_mode)(struct net_device *dev);
1016         int                     (*ndo_set_mac_address)(struct net_device *dev,
1017                                                        void *addr);
1018         int                     (*ndo_validate_addr)(struct net_device *dev);
1019         int                     (*ndo_do_ioctl)(struct net_device *dev,
1020                                                 struct ifreq *ifr, int cmd);
1021         int                     (*ndo_set_config)(struct net_device *dev,
1022                                                   struct ifmap *map);
1023         int                     (*ndo_change_mtu)(struct net_device *dev,
1024                                                   int new_mtu);
1025         int                     (*ndo_neigh_setup)(struct net_device *dev,
1026                                                    struct neigh_parms *);
1027         void                    (*ndo_tx_timeout) (struct net_device *dev);
1028
1029         struct rtnl_link_stats64* (*ndo_get_stats64)(struct net_device *dev,
1030                                                      struct rtnl_link_stats64 *storage);
1031         struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
1032
1033         int                     (*ndo_vlan_rx_add_vid)(struct net_device *dev,
1034                                                        __be16 proto, u16 vid);
1035         int                     (*ndo_vlan_rx_kill_vid)(struct net_device *dev,
1036                                                         __be16 proto, u16 vid);
1037 #ifdef CONFIG_NET_POLL_CONTROLLER
1038         void                    (*ndo_poll_controller)(struct net_device *dev);
1039         int                     (*ndo_netpoll_setup)(struct net_device *dev,
1040                                                      struct netpoll_info *info,
1041                                                      gfp_t gfp);
1042         void                    (*ndo_netpoll_cleanup)(struct net_device *dev);
1043 #endif
1044 #ifdef CONFIG_NET_RX_BUSY_POLL
1045         int                     (*ndo_busy_poll)(struct napi_struct *dev);
1046 #endif
1047         int                     (*ndo_set_vf_mac)(struct net_device *dev,
1048                                                   int queue, u8 *mac);
1049         int                     (*ndo_set_vf_vlan)(struct net_device *dev,
1050                                                    int queue, u16 vlan, u8 qos);
1051         int                     (*ndo_set_vf_tx_rate)(struct net_device *dev,
1052                                                       int vf, int rate);
1053         int                     (*ndo_set_vf_spoofchk)(struct net_device *dev,
1054                                                        int vf, bool setting);
1055         int                     (*ndo_get_vf_config)(struct net_device *dev,
1056                                                      int vf,
1057                                                      struct ifla_vf_info *ivf);
1058         int                     (*ndo_set_vf_link_state)(struct net_device *dev,
1059                                                          int vf, int link_state);
1060         int                     (*ndo_set_vf_port)(struct net_device *dev,
1061                                                    int vf,
1062                                                    struct nlattr *port[]);
1063         int                     (*ndo_get_vf_port)(struct net_device *dev,
1064                                                    int vf, struct sk_buff *skb);
1065         int                     (*ndo_setup_tc)(struct net_device *dev, u8 tc);
1066 #if IS_ENABLED(CONFIG_FCOE)
1067         int                     (*ndo_fcoe_enable)(struct net_device *dev);
1068         int                     (*ndo_fcoe_disable)(struct net_device *dev);
1069         int                     (*ndo_fcoe_ddp_setup)(struct net_device *dev,
1070                                                       u16 xid,
1071                                                       struct scatterlist *sgl,
1072                                                       unsigned int sgc);
1073         int                     (*ndo_fcoe_ddp_done)(struct net_device *dev,
1074                                                      u16 xid);
1075         int                     (*ndo_fcoe_ddp_target)(struct net_device *dev,
1076                                                        u16 xid,
1077                                                        struct scatterlist *sgl,
1078                                                        unsigned int sgc);
1079         int                     (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1080                                                         struct netdev_fcoe_hbainfo *hbainfo);
1081 #endif
1082
1083 #if IS_ENABLED(CONFIG_LIBFCOE)
1084 #define NETDEV_FCOE_WWNN 0
1085 #define NETDEV_FCOE_WWPN 1
1086         int                     (*ndo_fcoe_get_wwn)(struct net_device *dev,
1087                                                     u64 *wwn, int type);
1088 #endif
1089
1090 #ifdef CONFIG_RFS_ACCEL
1091         int                     (*ndo_rx_flow_steer)(struct net_device *dev,
1092                                                      const struct sk_buff *skb,
1093                                                      u16 rxq_index,
1094                                                      u32 flow_id);
1095 #endif
1096         int                     (*ndo_add_slave)(struct net_device *dev,
1097                                                  struct net_device *slave_dev);
1098         int                     (*ndo_del_slave)(struct net_device *dev,
1099                                                  struct net_device *slave_dev);
1100         netdev_features_t       (*ndo_fix_features)(struct net_device *dev,
1101                                                     netdev_features_t features);
1102         int                     (*ndo_set_features)(struct net_device *dev,
1103                                                     netdev_features_t features);
1104         int                     (*ndo_neigh_construct)(struct neighbour *n);
1105         void                    (*ndo_neigh_destroy)(struct neighbour *n);
1106
1107         int                     (*ndo_fdb_add)(struct ndmsg *ndm,
1108                                                struct nlattr *tb[],
1109                                                struct net_device *dev,
1110                                                const unsigned char *addr,
1111                                                u16 flags);
1112         int                     (*ndo_fdb_del)(struct ndmsg *ndm,
1113                                                struct nlattr *tb[],
1114                                                struct net_device *dev,
1115                                                const unsigned char *addr);
1116         int                     (*ndo_fdb_dump)(struct sk_buff *skb,
1117                                                 struct netlink_callback *cb,
1118                                                 struct net_device *dev,
1119                                                 int idx);
1120
1121         int                     (*ndo_bridge_setlink)(struct net_device *dev,
1122                                                       struct nlmsghdr *nlh);
1123         int                     (*ndo_bridge_getlink)(struct sk_buff *skb,
1124                                                       u32 pid, u32 seq,
1125                                                       struct net_device *dev,
1126                                                       u32 filter_mask);
1127         int                     (*ndo_bridge_dellink)(struct net_device *dev,
1128                                                       struct nlmsghdr *nlh);
1129         int                     (*ndo_change_carrier)(struct net_device *dev,
1130                                                       bool new_carrier);
1131         int                     (*ndo_get_phys_port_id)(struct net_device *dev,
1132                                                         struct netdev_phys_port_id *ppid);
1133         void                    (*ndo_add_vxlan_port)(struct  net_device *dev,
1134                                                       sa_family_t sa_family,
1135                                                       __be16 port);
1136         void                    (*ndo_del_vxlan_port)(struct  net_device *dev,
1137                                                       sa_family_t sa_family,
1138                                                       __be16 port);
1139
1140         void*                   (*ndo_dfwd_add_station)(struct net_device *pdev,
1141                                                         struct net_device *dev);
1142         void                    (*ndo_dfwd_del_station)(struct net_device *pdev,
1143                                                         void *priv);
1144
1145         netdev_tx_t             (*ndo_dfwd_start_xmit) (struct sk_buff *skb,
1146                                                         struct net_device *dev,
1147                                                         void *priv);
1148 };
1149
1150 /**
1151  * enum net_device_priv_flags - &struct net_device priv_flags
1152  *
1153  * These are the &struct net_device, they are only set internally
1154  * by drivers and used in the kernel. These flags are invisible to
1155  * userspace, this means that the order of these flags can change
1156  * during any kernel release.
1157  *
1158  * You should have a pretty good reason to be extending these flags.
1159  *
1160  * @IFF_802_1Q_VLAN: 802.1Q VLAN device
1161  * @IFF_EBRIDGE: Ethernet bridging device
1162  * @IFF_SLAVE_INACTIVE: bonding slave not the curr. active
1163  * @IFF_MASTER_8023AD: bonding master, 802.3ad
1164  * @IFF_MASTER_ALB: bonding master, balance-alb
1165  * @IFF_BONDING: bonding master or slave
1166  * @IFF_SLAVE_NEEDARP: need ARPs for validation
1167  * @IFF_ISATAP: ISATAP interface (RFC4214)
1168  * @IFF_MASTER_ARPMON: bonding master, ARP mon in use
1169  * @IFF_WAN_HDLC: WAN HDLC device
1170  * @IFF_XMIT_DST_RELEASE: dev_hard_start_xmit() is allowed to
1171  *      release skb->dst
1172  * @IFF_DONT_BRIDGE: disallow bridging this ether dev
1173  * @IFF_DISABLE_NETPOLL: disable netpoll at run-time
1174  * @IFF_MACVLAN_PORT: device used as macvlan port
1175  * @IFF_BRIDGE_PORT: device used as bridge port
1176  * @IFF_OVS_DATAPATH: device used as Open vSwitch datapath port
1177  * @IFF_TX_SKB_SHARING: The interface supports sharing skbs on transmit
1178  * @IFF_UNICAST_FLT: Supports unicast filtering
1179  * @IFF_TEAM_PORT: device used as team port
1180  * @IFF_SUPP_NOFCS: device supports sending custom FCS
1181  * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
1182  *      change when it's running
1183  * @IFF_MACVLAN: Macvlan device
1184  */
1185 enum netdev_priv_flags {
1186         IFF_802_1Q_VLAN                 = 1<<0,
1187         IFF_EBRIDGE                     = 1<<1,
1188         IFF_SLAVE_INACTIVE              = 1<<2,
1189         IFF_MASTER_8023AD               = 1<<3,
1190         IFF_MASTER_ALB                  = 1<<4,
1191         IFF_BONDING                     = 1<<5,
1192         IFF_SLAVE_NEEDARP               = 1<<6,
1193         IFF_ISATAP                      = 1<<7,
1194         IFF_MASTER_ARPMON               = 1<<8,
1195         IFF_WAN_HDLC                    = 1<<9,
1196         IFF_XMIT_DST_RELEASE            = 1<<10,
1197         IFF_DONT_BRIDGE                 = 1<<11,
1198         IFF_DISABLE_NETPOLL             = 1<<12,
1199         IFF_MACVLAN_PORT                = 1<<13,
1200         IFF_BRIDGE_PORT                 = 1<<14,
1201         IFF_OVS_DATAPATH                = 1<<15,
1202         IFF_TX_SKB_SHARING              = 1<<16,
1203         IFF_UNICAST_FLT                 = 1<<17,
1204         IFF_TEAM_PORT                   = 1<<18,
1205         IFF_SUPP_NOFCS                  = 1<<19,
1206         IFF_LIVE_ADDR_CHANGE            = 1<<20,
1207         IFF_MACVLAN                     = 1<<21,
1208 };
1209
1210 #define IFF_802_1Q_VLAN                 IFF_802_1Q_VLAN
1211 #define IFF_EBRIDGE                     IFF_EBRIDGE
1212 #define IFF_SLAVE_INACTIVE              IFF_SLAVE_INACTIVE
1213 #define IFF_MASTER_8023AD               IFF_MASTER_8023AD
1214 #define IFF_MASTER_ALB                  IFF_MASTER_ALB
1215 #define IFF_BONDING                     IFF_BONDING
1216 #define IFF_SLAVE_NEEDARP               IFF_SLAVE_NEEDARP
1217 #define IFF_ISATAP                      IFF_ISATAP
1218 #define IFF_MASTER_ARPMON               IFF_MASTER_ARPMON
1219 #define IFF_WAN_HDLC                    IFF_WAN_HDLC
1220 #define IFF_XMIT_DST_RELEASE            IFF_XMIT_DST_RELEASE
1221 #define IFF_DONT_BRIDGE                 IFF_DONT_BRIDGE
1222 #define IFF_DISABLE_NETPOLL             IFF_DISABLE_NETPOLL
1223 #define IFF_MACVLAN_PORT                IFF_MACVLAN_PORT
1224 #define IFF_BRIDGE_PORT                 IFF_BRIDGE_PORT
1225 #define IFF_OVS_DATAPATH                IFF_OVS_DATAPATH
1226 #define IFF_TX_SKB_SHARING              IFF_TX_SKB_SHARING
1227 #define IFF_UNICAST_FLT                 IFF_UNICAST_FLT
1228 #define IFF_TEAM_PORT                   IFF_TEAM_PORT
1229 #define IFF_SUPP_NOFCS                  IFF_SUPP_NOFCS
1230 #define IFF_LIVE_ADDR_CHANGE            IFF_LIVE_ADDR_CHANGE
1231 #define IFF_MACVLAN                     IFF_MACVLAN
1232
1233 /*
1234  *      The DEVICE structure.
1235  *      Actually, this whole structure is a big mistake.  It mixes I/O
1236  *      data with strictly "high-level" data, and it has to know about
1237  *      almost every data structure used in the INET module.
1238  *
1239  *      FIXME: cleanup struct net_device such that network protocol info
1240  *      moves out.
1241  */
1242
1243 struct net_device {
1244
1245         /*
1246          * This is the first field of the "visible" part of this structure
1247          * (i.e. as seen by users in the "Space.c" file).  It is the name
1248          * of the interface.
1249          */
1250         char                    name[IFNAMSIZ];
1251
1252         /* device name hash chain, please keep it close to name[] */
1253         struct hlist_node       name_hlist;
1254
1255         /* snmp alias */
1256         char                    *ifalias;
1257
1258         /*
1259          *      I/O specific fields
1260          *      FIXME: Merge these and struct ifmap into one
1261          */
1262         unsigned long           mem_end;        /* shared mem end       */
1263         unsigned long           mem_start;      /* shared mem start     */
1264         unsigned long           base_addr;      /* device I/O address   */
1265         int                     irq;            /* device IRQ number    */
1266
1267         /*
1268          *      Some hardware also needs these fields, but they are not
1269          *      part of the usual set specified in Space.c.
1270          */
1271
1272         unsigned long           state;
1273
1274         struct list_head        dev_list;
1275         struct list_head        napi_list;
1276         struct list_head        unreg_list;
1277         struct list_head        close_list;
1278
1279         /* directly linked devices, like slaves for bonding */
1280         struct {
1281                 struct list_head upper;
1282                 struct list_head lower;
1283         } adj_list;
1284
1285         /* all linked devices, *including* neighbours */
1286         struct {
1287                 struct list_head upper;
1288                 struct list_head lower;
1289         } all_adj_list;
1290
1291
1292         /* currently active device features */
1293         netdev_features_t       features;
1294         /* user-changeable features */
1295         netdev_features_t       hw_features;
1296         /* user-requested features */
1297         netdev_features_t       wanted_features;
1298         /* mask of features inheritable by VLAN devices */
1299         netdev_features_t       vlan_features;
1300         /* mask of features inherited by encapsulating devices
1301          * This field indicates what encapsulation offloads
1302          * the hardware is capable of doing, and drivers will
1303          * need to set them appropriately.
1304          */
1305         netdev_features_t       hw_enc_features;
1306         /* mask of fetures inheritable by MPLS */
1307         netdev_features_t       mpls_features;
1308
1309         /* Interface index. Unique device identifier    */
1310         int                     ifindex;
1311         int                     iflink;
1312
1313         struct net_device_stats stats;
1314
1315         /* dropped packets by core network, Do not use this in drivers */
1316         atomic_long_t           rx_dropped;
1317         atomic_long_t           tx_dropped;
1318
1319 #ifdef CONFIG_WIRELESS_EXT
1320         /* List of functions to handle Wireless Extensions (instead of ioctl).
1321          * See <net/iw_handler.h> for details. Jean II */
1322         const struct iw_handler_def *   wireless_handlers;
1323         /* Instance data managed by the core of Wireless Extensions. */
1324         struct iw_public_data * wireless_data;
1325 #endif
1326         /* Management operations */
1327         const struct net_device_ops *netdev_ops;
1328         const struct ethtool_ops *ethtool_ops;
1329         const struct forwarding_accel_ops *fwd_ops;
1330
1331         /* Hardware header description */
1332         const struct header_ops *header_ops;
1333
1334         unsigned int            flags;  /* interface flags (a la BSD)   */
1335         unsigned int            priv_flags; /* Like 'flags' but invisible to userspace.
1336                                              * See if.h for definitions. */
1337         unsigned short          gflags;
1338         unsigned short          padded; /* How much padding added by alloc_netdev() */
1339
1340         unsigned char           operstate; /* RFC2863 operstate */
1341         unsigned char           link_mode; /* mapping policy to operstate */
1342
1343         unsigned char           if_port;        /* Selectable AUI, TP,..*/
1344         unsigned char           dma;            /* DMA channel          */
1345
1346         unsigned int            mtu;    /* interface MTU value          */
1347         unsigned short          type;   /* interface hardware type      */
1348         unsigned short          hard_header_len;        /* hardware hdr length  */
1349
1350         /* extra head- and tailroom the hardware may need, but not in all cases
1351          * can this be guaranteed, especially tailroom. Some cases also use
1352          * LL_MAX_HEADER instead to allocate the skb.
1353          */
1354         unsigned short          needed_headroom;
1355         unsigned short          needed_tailroom;
1356
1357         /* Interface address info. */
1358         unsigned char           perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
1359         unsigned char           addr_assign_type; /* hw address assignment type */
1360         unsigned char           addr_len;       /* hardware address length      */
1361         unsigned short          neigh_priv_len;
1362         unsigned short          dev_id;         /* Used to differentiate devices
1363                                                  * that share the same link
1364                                                  * layer address
1365                                                  */
1366         unsigned short          dev_port;       /* Used to differentiate
1367                                                  * devices that share the same
1368                                                  * function
1369                                                  */
1370         spinlock_t              addr_list_lock;
1371         struct netdev_hw_addr_list      uc;     /* Unicast mac addresses */
1372         struct netdev_hw_addr_list      mc;     /* Multicast mac addresses */
1373         struct netdev_hw_addr_list      dev_addrs; /* list of device
1374                                                     * hw addresses
1375                                                     */
1376 #ifdef CONFIG_SYSFS
1377         struct kset             *queues_kset;
1378 #endif
1379
1380         bool                    uc_promisc;
1381         unsigned int            promiscuity;
1382         unsigned int            allmulti;
1383
1384
1385         /* Protocol specific pointers */
1386
1387 #if IS_ENABLED(CONFIG_VLAN_8021Q)
1388         struct vlan_info __rcu  *vlan_info;     /* VLAN info */
1389 #endif
1390 #if IS_ENABLED(CONFIG_NET_DSA)
1391         struct dsa_switch_tree  *dsa_ptr;       /* dsa specific data */
1392 #endif
1393 #if IS_ENABLED(CONFIG_TIPC)
1394         struct tipc_bearer __rcu *tipc_ptr;     /* TIPC specific data */
1395 #endif
1396         void                    *atalk_ptr;     /* AppleTalk link       */
1397         struct in_device __rcu  *ip_ptr;        /* IPv4 specific data   */
1398         struct dn_dev __rcu     *dn_ptr;        /* DECnet specific data */
1399         struct inet6_dev __rcu  *ip6_ptr;       /* IPv6 specific data */
1400         void                    *ax25_ptr;      /* AX.25 specific data */
1401         struct wireless_dev     *ieee80211_ptr; /* IEEE 802.11 specific data,
1402                                                    assign before registering */
1403
1404 /*
1405  * Cache lines mostly used on receive path (including eth_type_trans())
1406  */
1407         unsigned long           last_rx;        /* Time of last Rx */
1408
1409         /* Interface address info used in eth_type_trans() */
1410         unsigned char           *dev_addr;      /* hw address, (before bcast
1411                                                    because most packets are
1412                                                    unicast) */
1413
1414
1415 #ifdef CONFIG_SYSFS
1416         struct netdev_rx_queue  *_rx;
1417
1418         /* Number of RX queues allocated at register_netdev() time */
1419         unsigned int            num_rx_queues;
1420
1421         /* Number of RX queues currently active in device */
1422         unsigned int            real_num_rx_queues;
1423
1424 #endif
1425
1426         rx_handler_func_t __rcu *rx_handler;
1427         void __rcu              *rx_handler_data;
1428
1429         struct netdev_queue __rcu *ingress_queue;
1430         unsigned char           broadcast[MAX_ADDR_LEN];        /* hw bcast add */
1431
1432
1433 /*
1434  * Cache lines mostly used on transmit path
1435  */
1436         struct netdev_queue     *_tx ____cacheline_aligned_in_smp;
1437
1438         /* Number of TX queues allocated at alloc_netdev_mq() time  */
1439         unsigned int            num_tx_queues;
1440
1441         /* Number of TX queues currently active in device  */
1442         unsigned int            real_num_tx_queues;
1443
1444         /* root qdisc from userspace point of view */
1445         struct Qdisc            *qdisc;
1446
1447         unsigned long           tx_queue_len;   /* Max frames per queue allowed */
1448         spinlock_t              tx_global_lock;
1449
1450 #ifdef CONFIG_XPS
1451         struct xps_dev_maps __rcu *xps_maps;
1452 #endif
1453 #ifdef CONFIG_RFS_ACCEL
1454         /* CPU reverse-mapping for RX completion interrupts, indexed
1455          * by RX queue number.  Assigned by driver.  This must only be
1456          * set if the ndo_rx_flow_steer operation is defined. */
1457         struct cpu_rmap         *rx_cpu_rmap;
1458 #endif
1459
1460         /* These may be needed for future network-power-down code. */
1461
1462         /*
1463          * trans_start here is expensive for high speed devices on SMP,
1464          * please use netdev_queue->trans_start instead.
1465          */
1466         unsigned long           trans_start;    /* Time (in jiffies) of last Tx */
1467
1468         int                     watchdog_timeo; /* used by dev_watchdog() */
1469         struct timer_list       watchdog_timer;
1470
1471         /* Number of references to this device */
1472         int __percpu            *pcpu_refcnt;
1473
1474         /* delayed register/unregister */
1475         struct list_head        todo_list;
1476         /* device index hash chain */
1477         struct hlist_node       index_hlist;
1478
1479         struct list_head        link_watch_list;
1480
1481         /* register/unregister state machine */
1482         enum { NETREG_UNINITIALIZED=0,
1483                NETREG_REGISTERED,       /* completed register_netdevice */
1484                NETREG_UNREGISTERING,    /* called unregister_netdevice */
1485                NETREG_UNREGISTERED,     /* completed unregister todo */
1486                NETREG_RELEASED,         /* called free_netdev */
1487                NETREG_DUMMY,            /* dummy device for NAPI poll */
1488         } reg_state:8;
1489
1490         bool dismantle; /* device is going do be freed */
1491
1492         enum {
1493                 RTNL_LINK_INITIALIZED,
1494                 RTNL_LINK_INITIALIZING,
1495         } rtnl_link_state:16;
1496
1497         /* Called from unregister, can be used to call free_netdev */
1498         void (*destructor)(struct net_device *dev);
1499
1500 #ifdef CONFIG_NETPOLL
1501         struct netpoll_info __rcu       *npinfo;
1502 #endif
1503
1504 #ifdef CONFIG_NET_NS
1505         /* Network namespace this network device is inside */
1506         struct net              *nd_net;
1507 #endif
1508
1509         /* mid-layer private */
1510         union {
1511                 void                            *ml_priv;
1512                 struct pcpu_lstats __percpu     *lstats; /* loopback stats */
1513                 struct pcpu_sw_netstats __percpu        *tstats;
1514                 struct pcpu_dstats __percpu     *dstats; /* dummy stats */
1515                 struct pcpu_vstats __percpu     *vstats; /* veth stats */
1516         };
1517         /* GARP */
1518         struct garp_port __rcu  *garp_port;
1519         /* MRP */
1520         struct mrp_port __rcu   *mrp_port;
1521
1522         /* class/net/name entry */
1523         struct device           dev;
1524         /* space for optional device, statistics, and wireless sysfs groups */
1525         const struct attribute_group *sysfs_groups[4];
1526         /* space for optional per-rx queue attributes */
1527         const struct attribute_group *sysfs_rx_queue_group;
1528
1529         /* rtnetlink link ops */
1530         const struct rtnl_link_ops *rtnl_link_ops;
1531
1532         /* for setting kernel sock attribute on TCP connection setup */
1533 #define GSO_MAX_SIZE            65536
1534         unsigned int            gso_max_size;
1535 #define GSO_MAX_SEGS            65535
1536         u16                     gso_max_segs;
1537
1538 #ifdef CONFIG_DCB
1539         /* Data Center Bridging netlink ops */
1540         const struct dcbnl_rtnl_ops *dcbnl_ops;
1541 #endif
1542         u8 num_tc;
1543         struct netdev_tc_txq tc_to_txq[TC_MAX_QUEUE];
1544         u8 prio_tc_map[TC_BITMASK + 1];
1545
1546 #if IS_ENABLED(CONFIG_FCOE)
1547         /* max exchange id for FCoE LRO by ddp */
1548         unsigned int            fcoe_ddp_xid;
1549 #endif
1550 #if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
1551         struct netprio_map __rcu *priomap;
1552 #endif
1553         /* phy device may attach itself for hardware timestamping */
1554         struct phy_device *phydev;
1555
1556         struct lock_class_key *qdisc_tx_busylock;
1557
1558         /* group the device belongs to */
1559         int group;
1560
1561         struct pm_qos_request   pm_qos_req;
1562 };
1563 #define to_net_dev(d) container_of(d, struct net_device, dev)
1564
1565 #define NETDEV_ALIGN            32
1566
1567 static inline
1568 int netdev_get_prio_tc_map(const struct net_device *dev, u32 prio)
1569 {
1570         return dev->prio_tc_map[prio & TC_BITMASK];
1571 }
1572
1573 static inline
1574 int netdev_set_prio_tc_map(struct net_device *dev, u8 prio, u8 tc)
1575 {
1576         if (tc >= dev->num_tc)
1577                 return -EINVAL;
1578
1579         dev->prio_tc_map[prio & TC_BITMASK] = tc & TC_BITMASK;
1580         return 0;
1581 }
1582
1583 static inline
1584 void netdev_reset_tc(struct net_device *dev)
1585 {
1586         dev->num_tc = 0;
1587         memset(dev->tc_to_txq, 0, sizeof(dev->tc_to_txq));
1588         memset(dev->prio_tc_map, 0, sizeof(dev->prio_tc_map));
1589 }
1590
1591 static inline
1592 int netdev_set_tc_queue(struct net_device *dev, u8 tc, u16 count, u16 offset)
1593 {
1594         if (tc >= dev->num_tc)
1595                 return -EINVAL;
1596
1597         dev->tc_to_txq[tc].count = count;
1598         dev->tc_to_txq[tc].offset = offset;
1599         return 0;
1600 }
1601
1602 static inline
1603 int netdev_set_num_tc(struct net_device *dev, u8 num_tc)
1604 {
1605         if (num_tc > TC_MAX_QUEUE)
1606                 return -EINVAL;
1607
1608         dev->num_tc = num_tc;
1609         return 0;
1610 }
1611
1612 static inline
1613 int netdev_get_num_tc(struct net_device *dev)
1614 {
1615         return dev->num_tc;
1616 }
1617
1618 static inline
1619 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
1620                                          unsigned int index)
1621 {
1622         return &dev->_tx[index];
1623 }
1624
1625 static inline void netdev_for_each_tx_queue(struct net_device *dev,
1626                                             void (*f)(struct net_device *,
1627                                                       struct netdev_queue *,
1628                                                       void *),
1629                                             void *arg)
1630 {
1631         unsigned int i;
1632
1633         for (i = 0; i < dev->num_tx_queues; i++)
1634                 f(dev, &dev->_tx[i], arg);
1635 }
1636
1637 struct netdev_queue *netdev_pick_tx(struct net_device *dev,
1638                                     struct sk_buff *skb,
1639                                     void *accel_priv);
1640
1641 /*
1642  * Net namespace inlines
1643  */
1644 static inline
1645 struct net *dev_net(const struct net_device *dev)
1646 {
1647         return read_pnet(&dev->nd_net);
1648 }
1649
1650 static inline
1651 void dev_net_set(struct net_device *dev, struct net *net)
1652 {
1653 #ifdef CONFIG_NET_NS
1654         release_net(dev->nd_net);
1655         dev->nd_net = hold_net(net);
1656 #endif
1657 }
1658
1659 static inline bool netdev_uses_dsa_tags(struct net_device *dev)
1660 {
1661 #ifdef CONFIG_NET_DSA_TAG_DSA
1662         if (dev->dsa_ptr != NULL)
1663                 return dsa_uses_dsa_tags(dev->dsa_ptr);
1664 #endif
1665
1666         return 0;
1667 }
1668
1669 static inline bool netdev_uses_trailer_tags(struct net_device *dev)
1670 {
1671 #ifdef CONFIG_NET_DSA_TAG_TRAILER
1672         if (dev->dsa_ptr != NULL)
1673                 return dsa_uses_trailer_tags(dev->dsa_ptr);
1674 #endif
1675
1676         return 0;
1677 }
1678
1679 /**
1680  *      netdev_priv - access network device private data
1681  *      @dev: network device
1682  *
1683  * Get network device private data
1684  */
1685 static inline void *netdev_priv(const struct net_device *dev)
1686 {
1687         return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
1688 }
1689
1690 /* Set the sysfs physical device reference for the network logical device
1691  * if set prior to registration will cause a symlink during initialization.
1692  */
1693 #define SET_NETDEV_DEV(net, pdev)       ((net)->dev.parent = (pdev))
1694
1695 /* Set the sysfs device type for the network logical device to allow
1696  * fine-grained identification of different network device types. For
1697  * example Ethernet, Wirelss LAN, Bluetooth, WiMAX etc.
1698  */
1699 #define SET_NETDEV_DEVTYPE(net, devtype)        ((net)->dev.type = (devtype))
1700
1701 /* Default NAPI poll() weight
1702  * Device drivers are strongly advised to not use bigger value
1703  */
1704 #define NAPI_POLL_WEIGHT 64
1705
1706 /**
1707  *      netif_napi_add - initialize a napi context
1708  *      @dev:  network device
1709  *      @napi: napi context
1710  *      @poll: polling function
1711  *      @weight: default weight
1712  *
1713  * netif_napi_add() must be used to initialize a napi context prior to calling
1714  * *any* of the other napi related functions.
1715  */
1716 void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
1717                     int (*poll)(struct napi_struct *, int), int weight);
1718
1719 /**
1720  *  netif_napi_del - remove a napi context
1721  *  @napi: napi context
1722  *
1723  *  netif_napi_del() removes a napi context from the network device napi list
1724  */
1725 void netif_napi_del(struct napi_struct *napi);
1726
1727 struct napi_gro_cb {
1728         /* Virtual address of skb_shinfo(skb)->frags[0].page + offset. */
1729         void *frag0;
1730
1731         /* Length of frag0. */
1732         unsigned int frag0_len;
1733
1734         /* This indicates where we are processing relative to skb->data. */
1735         int data_offset;
1736
1737         /* This is non-zero if the packet cannot be merged with the new skb. */
1738         u16     flush;
1739
1740         /* Save the IP ID here and check when we get to the transport layer */
1741         u16     flush_id;
1742
1743         /* Number of segments aggregated. */
1744         u16     count;
1745
1746         /* This is non-zero if the packet may be of the same flow. */
1747         u8      same_flow;
1748
1749         /* Free the skb? */
1750         u8      free;
1751 #define NAPI_GRO_FREE             1
1752 #define NAPI_GRO_FREE_STOLEN_HEAD 2
1753
1754         /* jiffies when first packet was created/queued */
1755         unsigned long age;
1756
1757         /* Used in ipv6_gro_receive() */
1758         u16     proto;
1759
1760         /* Used in udp_gro_receive */
1761         u16     udp_mark;
1762
1763         /* used to support CHECKSUM_COMPLETE for tunneling protocols */
1764         __wsum  csum;
1765
1766         /* used in skb_gro_receive() slow path */
1767         struct sk_buff *last;
1768 };
1769
1770 #define NAPI_GRO_CB(skb) ((struct napi_gro_cb *)(skb)->cb)
1771
1772 struct packet_type {
1773         __be16                  type;   /* This is really htons(ether_type). */
1774         struct net_device       *dev;   /* NULL is wildcarded here           */
1775         int                     (*func) (struct sk_buff *,
1776                                          struct net_device *,
1777                                          struct packet_type *,
1778                                          struct net_device *);
1779         bool                    (*id_match)(struct packet_type *ptype,
1780                                             struct sock *sk);
1781         void                    *af_packet_priv;
1782         struct list_head        list;
1783 };
1784
1785 struct offload_callbacks {
1786         struct sk_buff          *(*gso_segment)(struct sk_buff *skb,
1787                                                 netdev_features_t features);
1788         int                     (*gso_send_check)(struct sk_buff *skb);
1789         struct sk_buff          **(*gro_receive)(struct sk_buff **head,
1790                                                struct sk_buff *skb);
1791         int                     (*gro_complete)(struct sk_buff *skb, int nhoff);
1792 };
1793
1794 struct packet_offload {
1795         __be16                   type;  /* This is really htons(ether_type). */
1796         struct offload_callbacks callbacks;
1797         struct list_head         list;
1798 };
1799
1800 struct udp_offload {
1801         __be16                   port;
1802         struct offload_callbacks callbacks;
1803 };
1804
1805 /* often modified stats are per cpu, other are shared (netdev->stats) */
1806 struct pcpu_sw_netstats {
1807         u64     rx_packets;
1808         u64     rx_bytes;
1809         u64     tx_packets;
1810         u64     tx_bytes;
1811         struct u64_stats_sync   syncp;
1812 };
1813
1814 #define netdev_alloc_pcpu_stats(type)                           \
1815 ({                                                              \
1816         typeof(type) __percpu *pcpu_stats = alloc_percpu(type); \
1817         if (pcpu_stats) {                                       \
1818                 int i;                                          \
1819                 for_each_possible_cpu(i) {                      \
1820                         typeof(type) *stat;                     \
1821                         stat = per_cpu_ptr(pcpu_stats, i);      \
1822                         u64_stats_init(&stat->syncp);           \
1823                 }                                               \
1824         }                                                       \
1825         pcpu_stats;                                             \
1826 })
1827
1828 #include <linux/notifier.h>
1829
1830 /* netdevice notifier chain. Please remember to update the rtnetlink
1831  * notification exclusion list in rtnetlink_event() when adding new
1832  * types.
1833  */
1834 #define NETDEV_UP       0x0001  /* For now you can't veto a device up/down */
1835 #define NETDEV_DOWN     0x0002
1836 #define NETDEV_REBOOT   0x0003  /* Tell a protocol stack a network interface
1837                                    detected a hardware crash and restarted
1838                                    - we can use this eg to kick tcp sessions
1839                                    once done */
1840 #define NETDEV_CHANGE   0x0004  /* Notify device state change */
1841 #define NETDEV_REGISTER 0x0005
1842 #define NETDEV_UNREGISTER       0x0006
1843 #define NETDEV_CHANGEMTU        0x0007 /* notify after mtu change happened */
1844 #define NETDEV_CHANGEADDR       0x0008
1845 #define NETDEV_GOING_DOWN       0x0009
1846 #define NETDEV_CHANGENAME       0x000A
1847 #define NETDEV_FEAT_CHANGE      0x000B
1848 #define NETDEV_BONDING_FAILOVER 0x000C
1849 #define NETDEV_PRE_UP           0x000D
1850 #define NETDEV_PRE_TYPE_CHANGE  0x000E
1851 #define NETDEV_POST_TYPE_CHANGE 0x000F
1852 #define NETDEV_POST_INIT        0x0010
1853 #define NETDEV_UNREGISTER_FINAL 0x0011
1854 #define NETDEV_RELEASE          0x0012
1855 #define NETDEV_NOTIFY_PEERS     0x0013
1856 #define NETDEV_JOIN             0x0014
1857 #define NETDEV_CHANGEUPPER      0x0015
1858 #define NETDEV_RESEND_IGMP      0x0016
1859 #define NETDEV_PRECHANGEMTU     0x0017 /* notify before mtu change happened */
1860
1861 int register_netdevice_notifier(struct notifier_block *nb);
1862 int unregister_netdevice_notifier(struct notifier_block *nb);
1863
1864 struct netdev_notifier_info {
1865         struct net_device *dev;
1866 };
1867
1868 struct netdev_notifier_change_info {
1869         struct netdev_notifier_info info; /* must be first */
1870         unsigned int flags_changed;
1871 };
1872
1873 static inline void netdev_notifier_info_init(struct netdev_notifier_info *info,
1874                                              struct net_device *dev)
1875 {
1876         info->dev = dev;
1877 }
1878
1879 static inline struct net_device *
1880 netdev_notifier_info_to_dev(const struct netdev_notifier_info *info)
1881 {
1882         return info->dev;
1883 }
1884
1885 int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
1886
1887
1888 extern rwlock_t                         dev_base_lock;          /* Device list lock */
1889
1890 #define for_each_netdev(net, d)         \
1891                 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
1892 #define for_each_netdev_reverse(net, d) \
1893                 list_for_each_entry_reverse(d, &(net)->dev_base_head, dev_list)
1894 #define for_each_netdev_rcu(net, d)             \
1895                 list_for_each_entry_rcu(d, &(net)->dev_base_head, dev_list)
1896 #define for_each_netdev_safe(net, d, n) \
1897                 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
1898 #define for_each_netdev_continue(net, d)                \
1899                 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
1900 #define for_each_netdev_continue_rcu(net, d)            \
1901         list_for_each_entry_continue_rcu(d, &(net)->dev_base_head, dev_list)
1902 #define for_each_netdev_in_bond_rcu(bond, slave)        \
1903                 for_each_netdev_rcu(&init_net, slave)   \
1904                         if (netdev_master_upper_dev_get_rcu(slave) == bond)
1905 #define net_device_entry(lh)    list_entry(lh, struct net_device, dev_list)
1906
1907 static inline struct net_device *next_net_device(struct net_device *dev)
1908 {
1909         struct list_head *lh;
1910         struct net *net;
1911
1912         net = dev_net(dev);
1913         lh = dev->dev_list.next;
1914         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
1915 }
1916
1917 static inline struct net_device *next_net_device_rcu(struct net_device *dev)
1918 {
1919         struct list_head *lh;
1920         struct net *net;
1921
1922         net = dev_net(dev);
1923         lh = rcu_dereference(list_next_rcu(&dev->dev_list));
1924         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
1925 }
1926
1927 static inline struct net_device *first_net_device(struct net *net)
1928 {
1929         return list_empty(&net->dev_base_head) ? NULL :
1930                 net_device_entry(net->dev_base_head.next);
1931 }
1932
1933 static inline struct net_device *first_net_device_rcu(struct net *net)
1934 {
1935         struct list_head *lh = rcu_dereference(list_next_rcu(&net->dev_base_head));
1936
1937         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
1938 }
1939
1940 int netdev_boot_setup_check(struct net_device *dev);
1941 unsigned long netdev_boot_base(const char *prefix, int unit);
1942 struct net_device *dev_getbyhwaddr_rcu(struct net *net, unsigned short type,
1943                                        const char *hwaddr);
1944 struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
1945 struct net_device *__dev_getfirstbyhwtype(struct net *net, unsigned short type);
1946 void dev_add_pack(struct packet_type *pt);
1947 void dev_remove_pack(struct packet_type *pt);
1948 void __dev_remove_pack(struct packet_type *pt);
1949 void dev_add_offload(struct packet_offload *po);
1950 void dev_remove_offload(struct packet_offload *po);
1951
1952 struct net_device *dev_get_by_flags_rcu(struct net *net, unsigned short flags,
1953                                         unsigned short mask);
1954 struct net_device *dev_get_by_name(struct net *net, const char *name);
1955 struct net_device *dev_get_by_name_rcu(struct net *net, const char *name);
1956 struct net_device *__dev_get_by_name(struct net *net, const char *name);
1957 int dev_alloc_name(struct net_device *dev, const char *name);
1958 int dev_open(struct net_device *dev);
1959 int dev_close(struct net_device *dev);
1960 void dev_disable_lro(struct net_device *dev);
1961 int dev_loopback_xmit(struct sk_buff *newskb);
1962 int dev_queue_xmit(struct sk_buff *skb);
1963 int dev_queue_xmit_accel(struct sk_buff *skb, void *accel_priv);
1964 int register_netdevice(struct net_device *dev);
1965 void unregister_netdevice_queue(struct net_device *dev, struct list_head *head);
1966 void unregister_netdevice_many(struct list_head *head);
1967 static inline void unregister_netdevice(struct net_device *dev)
1968 {
1969         unregister_netdevice_queue(dev, NULL);
1970 }
1971
1972 int netdev_refcnt_read(const struct net_device *dev);
1973 void free_netdev(struct net_device *dev);
1974 void netdev_freemem(struct net_device *dev);
1975 void synchronize_net(void);
1976 int init_dummy_netdev(struct net_device *dev);
1977
1978 struct net_device *dev_get_by_index(struct net *net, int ifindex);
1979 struct net_device *__dev_get_by_index(struct net *net, int ifindex);
1980 struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex);
1981 int netdev_get_name(struct net *net, char *name, int ifindex);
1982 int dev_restart(struct net_device *dev);
1983 int skb_gro_receive(struct sk_buff **head, struct sk_buff *skb);
1984
1985 static inline unsigned int skb_gro_offset(const struct sk_buff *skb)
1986 {
1987         return NAPI_GRO_CB(skb)->data_offset;
1988 }
1989
1990 static inline unsigned int skb_gro_len(const struct sk_buff *skb)
1991 {
1992         return skb->len - NAPI_GRO_CB(skb)->data_offset;
1993 }
1994
1995 static inline void skb_gro_pull(struct sk_buff *skb, unsigned int len)
1996 {
1997         NAPI_GRO_CB(skb)->data_offset += len;
1998 }
1999
2000 static inline void *skb_gro_header_fast(struct sk_buff *skb,
2001                                         unsigned int offset)
2002 {
2003         return NAPI_GRO_CB(skb)->frag0 + offset;
2004 }
2005
2006 static inline int skb_gro_header_hard(struct sk_buff *skb, unsigned int hlen)
2007 {
2008         return NAPI_GRO_CB(skb)->frag0_len < hlen;
2009 }
2010
2011 static inline void *skb_gro_header_slow(struct sk_buff *skb, unsigned int hlen,
2012                                         unsigned int offset)
2013 {
2014         if (!pskb_may_pull(skb, hlen))
2015                 return NULL;
2016
2017         NAPI_GRO_CB(skb)->frag0 = NULL;
2018         NAPI_GRO_CB(skb)->frag0_len = 0;
2019         return skb->data + offset;
2020 }
2021
2022 static inline void *skb_gro_mac_header(struct sk_buff *skb)
2023 {
2024         return NAPI_GRO_CB(skb)->frag0 ?: skb_mac_header(skb);
2025 }
2026
2027 static inline void *skb_gro_network_header(struct sk_buff *skb)
2028 {
2029         return (NAPI_GRO_CB(skb)->frag0 ?: skb->data) +
2030                skb_network_offset(skb);
2031 }
2032
2033 static inline void skb_gro_postpull_rcsum(struct sk_buff *skb,
2034                                         const void *start, unsigned int len)
2035 {
2036         if (skb->ip_summed == CHECKSUM_COMPLETE)
2037                 NAPI_GRO_CB(skb)->csum = csum_sub(NAPI_GRO_CB(skb)->csum,
2038                                                   csum_partial(start, len, 0));
2039 }
2040
2041 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
2042                                   unsigned short type,
2043                                   const void *daddr, const void *saddr,
2044                                   unsigned int len)
2045 {
2046         if (!dev->header_ops || !dev->header_ops->create)
2047                 return 0;
2048
2049         return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
2050 }
2051
2052 static inline int dev_parse_header(const struct sk_buff *skb,
2053                                    unsigned char *haddr)
2054 {
2055         const struct net_device *dev = skb->dev;
2056
2057         if (!dev->header_ops || !dev->header_ops->parse)
2058                 return 0;
2059         return dev->header_ops->parse(skb, haddr);
2060 }
2061
2062 static inline int dev_rebuild_header(struct sk_buff *skb)
2063 {
2064         const struct net_device *dev = skb->dev;
2065
2066         if (!dev->header_ops || !dev->header_ops->rebuild)
2067                 return 0;
2068         return dev->header_ops->rebuild(skb);
2069 }
2070
2071 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
2072 int register_gifconf(unsigned int family, gifconf_func_t *gifconf);
2073 static inline int unregister_gifconf(unsigned int family)
2074 {
2075         return register_gifconf(family, NULL);
2076 }
2077
2078 #ifdef CONFIG_NET_FLOW_LIMIT
2079 #define FLOW_LIMIT_HISTORY      (1 << 7)  /* must be ^2 and !overflow buckets */
2080 struct sd_flow_limit {
2081         u64                     count;
2082         unsigned int            num_buckets;
2083         unsigned int            history_head;
2084         u16                     history[FLOW_LIMIT_HISTORY];
2085         u8                      buckets[];
2086 };
2087
2088 extern int netdev_flow_limit_table_len;
2089 #endif /* CONFIG_NET_FLOW_LIMIT */
2090
2091 /*
2092  * Incoming packets are placed on per-cpu queues
2093  */
2094 struct softnet_data {
2095         struct Qdisc            *output_queue;
2096         struct Qdisc            **output_queue_tailp;
2097         struct list_head        poll_list;
2098         struct sk_buff          *completion_queue;
2099         struct sk_buff_head     process_queue;
2100
2101         /* stats */
2102         unsigned int            processed;
2103         unsigned int            time_squeeze;
2104         unsigned int            cpu_collision;
2105         unsigned int            received_rps;
2106
2107 #ifdef CONFIG_RPS
2108         struct softnet_data     *rps_ipi_list;
2109
2110         /* Elements below can be accessed between CPUs for RPS */
2111         struct call_single_data csd ____cacheline_aligned_in_smp;
2112         struct softnet_data     *rps_ipi_next;
2113         unsigned int            cpu;
2114         unsigned int            input_queue_head;
2115         unsigned int            input_queue_tail;
2116 #endif
2117         unsigned int            dropped;
2118         struct sk_buff_head     input_pkt_queue;
2119         struct napi_struct      backlog;
2120
2121 #ifdef CONFIG_NET_FLOW_LIMIT
2122         struct sd_flow_limit __rcu *flow_limit;
2123 #endif
2124 };
2125
2126 static inline void input_queue_head_incr(struct softnet_data *sd)
2127 {
2128 #ifdef CONFIG_RPS
2129         sd->input_queue_head++;
2130 #endif
2131 }
2132
2133 static inline void input_queue_tail_incr_save(struct softnet_data *sd,
2134                                               unsigned int *qtail)
2135 {
2136 #ifdef CONFIG_RPS
2137         *qtail = ++sd->input_queue_tail;
2138 #endif
2139 }
2140
2141 DECLARE_PER_CPU_ALIGNED(struct softnet_data, softnet_data);
2142
2143 void __netif_schedule(struct Qdisc *q);
2144
2145 static inline void netif_schedule_queue(struct netdev_queue *txq)
2146 {
2147         if (!(txq->state & QUEUE_STATE_ANY_XOFF))
2148                 __netif_schedule(txq->qdisc);
2149 }
2150
2151 static inline void netif_tx_schedule_all(struct net_device *dev)
2152 {
2153         unsigned int i;
2154
2155         for (i = 0; i < dev->num_tx_queues; i++)
2156                 netif_schedule_queue(netdev_get_tx_queue(dev, i));
2157 }
2158
2159 static inline void netif_tx_start_queue(struct netdev_queue *dev_queue)
2160 {
2161         clear_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2162 }
2163
2164 /**
2165  *      netif_start_queue - allow transmit
2166  *      @dev: network device
2167  *
2168  *      Allow upper layers to call the device hard_start_xmit routine.
2169  */
2170 static inline void netif_start_queue(struct net_device *dev)
2171 {
2172         netif_tx_start_queue(netdev_get_tx_queue(dev, 0));
2173 }
2174
2175 static inline void netif_tx_start_all_queues(struct net_device *dev)
2176 {
2177         unsigned int i;
2178
2179         for (i = 0; i < dev->num_tx_queues; i++) {
2180                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2181                 netif_tx_start_queue(txq);
2182         }
2183 }
2184
2185 static inline void netif_tx_wake_queue(struct netdev_queue *dev_queue)
2186 {
2187         if (test_and_clear_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state))
2188                 __netif_schedule(dev_queue->qdisc);
2189 }
2190
2191 /**
2192  *      netif_wake_queue - restart transmit
2193  *      @dev: network device
2194  *
2195  *      Allow upper layers to call the device hard_start_xmit routine.
2196  *      Used for flow control when transmit resources are available.
2197  */
2198 static inline void netif_wake_queue(struct net_device *dev)
2199 {
2200         netif_tx_wake_queue(netdev_get_tx_queue(dev, 0));
2201 }
2202
2203 static inline void netif_tx_wake_all_queues(struct net_device *dev)
2204 {
2205         unsigned int i;
2206
2207         for (i = 0; i < dev->num_tx_queues; i++) {
2208                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2209                 netif_tx_wake_queue(txq);
2210         }
2211 }
2212
2213 static inline void netif_tx_stop_queue(struct netdev_queue *dev_queue)
2214 {
2215         if (WARN_ON(!dev_queue)) {
2216                 pr_info("netif_stop_queue() cannot be called before register_netdev()\n");
2217                 return;
2218         }
2219         set_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2220 }
2221
2222 /**
2223  *      netif_stop_queue - stop transmitted packets
2224  *      @dev: network device
2225  *
2226  *      Stop upper layers calling the device hard_start_xmit routine.
2227  *      Used for flow control when transmit resources are unavailable.
2228  */
2229 static inline void netif_stop_queue(struct net_device *dev)
2230 {
2231         netif_tx_stop_queue(netdev_get_tx_queue(dev, 0));
2232 }
2233
2234 static inline void netif_tx_stop_all_queues(struct net_device *dev)
2235 {
2236         unsigned int i;
2237
2238         for (i = 0; i < dev->num_tx_queues; i++) {
2239                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2240                 netif_tx_stop_queue(txq);
2241         }
2242 }
2243
2244 static inline bool netif_tx_queue_stopped(const struct netdev_queue *dev_queue)
2245 {
2246         return test_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2247 }
2248
2249 /**
2250  *      netif_queue_stopped - test if transmit queue is flowblocked
2251  *      @dev: network device
2252  *
2253  *      Test if transmit queue on device is currently unable to send.
2254  */
2255 static inline bool netif_queue_stopped(const struct net_device *dev)
2256 {
2257         return netif_tx_queue_stopped(netdev_get_tx_queue(dev, 0));
2258 }
2259
2260 static inline bool netif_xmit_stopped(const struct netdev_queue *dev_queue)
2261 {
2262         return dev_queue->state & QUEUE_STATE_ANY_XOFF;
2263 }
2264
2265 static inline bool netif_xmit_frozen_or_stopped(const struct netdev_queue *dev_queue)
2266 {
2267         return dev_queue->state & QUEUE_STATE_ANY_XOFF_OR_FROZEN;
2268 }
2269
2270 static inline void netdev_tx_sent_queue(struct netdev_queue *dev_queue,
2271                                         unsigned int bytes)
2272 {
2273 #ifdef CONFIG_BQL
2274         dql_queued(&dev_queue->dql, bytes);
2275
2276         if (likely(dql_avail(&dev_queue->dql) >= 0))
2277                 return;
2278
2279         set_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
2280
2281         /*
2282          * The XOFF flag must be set before checking the dql_avail below,
2283          * because in netdev_tx_completed_queue we update the dql_completed
2284          * before checking the XOFF flag.
2285          */
2286         smp_mb();
2287
2288         /* check again in case another CPU has just made room avail */
2289         if (unlikely(dql_avail(&dev_queue->dql) >= 0))
2290                 clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
2291 #endif
2292 }
2293
2294 /**
2295  *      netdev_sent_queue - report the number of bytes queued to hardware
2296  *      @dev: network device
2297  *      @bytes: number of bytes queued to the hardware device queue
2298  *
2299  *      Report the number of bytes queued for sending/completion to the network
2300  *      device hardware queue. @bytes should be a good approximation and should
2301  *      exactly match netdev_completed_queue() @bytes
2302  */
2303 static inline void netdev_sent_queue(struct net_device *dev, unsigned int bytes)
2304 {
2305         netdev_tx_sent_queue(netdev_get_tx_queue(dev, 0), bytes);
2306 }
2307
2308 static inline void netdev_tx_completed_queue(struct netdev_queue *dev_queue,
2309                                              unsigned int pkts, unsigned int bytes)
2310 {
2311 #ifdef CONFIG_BQL
2312         if (unlikely(!bytes))
2313                 return;
2314
2315         dql_completed(&dev_queue->dql, bytes);
2316
2317         /*
2318          * Without the memory barrier there is a small possiblity that
2319          * netdev_tx_sent_queue will miss the update and cause the queue to
2320          * be stopped forever
2321          */
2322         smp_mb();
2323
2324         if (dql_avail(&dev_queue->dql) < 0)
2325                 return;
2326
2327         if (test_and_clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state))
2328                 netif_schedule_queue(dev_queue);
2329 #endif
2330 }
2331
2332 /**
2333  *      netdev_completed_queue - report bytes and packets completed by device
2334  *      @dev: network device
2335  *      @pkts: actual number of packets sent over the medium
2336  *      @bytes: actual number of bytes sent over the medium
2337  *
2338  *      Report the number of bytes and packets transmitted by the network device
2339  *      hardware queue over the physical medium, @bytes must exactly match the
2340  *      @bytes amount passed to netdev_sent_queue()
2341  */
2342 static inline void netdev_completed_queue(struct net_device *dev,
2343                                           unsigned int pkts, unsigned int bytes)
2344 {
2345         netdev_tx_completed_queue(netdev_get_tx_queue(dev, 0), pkts, bytes);
2346 }
2347
2348 static inline void netdev_tx_reset_queue(struct netdev_queue *q)
2349 {
2350 #ifdef CONFIG_BQL
2351         clear_bit(__QUEUE_STATE_STACK_XOFF, &q->state);
2352         dql_reset(&q->dql);
2353 #endif
2354 }
2355
2356 /**
2357  *      netdev_reset_queue - reset the packets and bytes count of a network device
2358  *      @dev_queue: network device
2359  *
2360  *      Reset the bytes and packet count of a network device and clear the
2361  *      software flow control OFF bit for this network device
2362  */
2363 static inline void netdev_reset_queue(struct net_device *dev_queue)
2364 {
2365         netdev_tx_reset_queue(netdev_get_tx_queue(dev_queue, 0));
2366 }
2367
2368 /**
2369  *      netdev_cap_txqueue - check if selected tx queue exceeds device queues
2370  *      @dev: network device
2371  *      @queue_index: given tx queue index
2372  *
2373  *      Returns 0 if given tx queue index >= number of device tx queues,
2374  *      otherwise returns the originally passed tx queue index.
2375  */
2376 static inline u16 netdev_cap_txqueue(struct net_device *dev, u16 queue_index)
2377 {
2378         if (unlikely(queue_index >= dev->real_num_tx_queues)) {
2379                 net_warn_ratelimited("%s selects TX queue %d, but real number of TX queues is %d\n",
2380                                      dev->name, queue_index,
2381                                      dev->real_num_tx_queues);
2382                 return 0;
2383         }
2384
2385         return queue_index;
2386 }
2387
2388 /**
2389  *      netif_running - test if up
2390  *      @dev: network device
2391  *
2392  *      Test if the device has been brought up.
2393  */
2394 static inline bool netif_running(const struct net_device *dev)
2395 {
2396         return test_bit(__LINK_STATE_START, &dev->state);
2397 }
2398
2399 /*
2400  * Routines to manage the subqueues on a device.  We only need start
2401  * stop, and a check if it's stopped.  All other device management is
2402  * done at the overall netdevice level.
2403  * Also test the device if we're multiqueue.
2404  */
2405
2406 /**
2407  *      netif_start_subqueue - allow sending packets on subqueue
2408  *      @dev: network device
2409  *      @queue_index: sub queue index
2410  *
2411  * Start individual transmit queue of a device with multiple transmit queues.
2412  */
2413 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
2414 {
2415         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2416
2417         netif_tx_start_queue(txq);
2418 }
2419
2420 /**
2421  *      netif_stop_subqueue - stop sending packets on subqueue
2422  *      @dev: network device
2423  *      @queue_index: sub queue index
2424  *
2425  * Stop individual transmit queue of a device with multiple transmit queues.
2426  */
2427 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
2428 {
2429         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2430         netif_tx_stop_queue(txq);
2431 }
2432
2433 /**
2434  *      netif_subqueue_stopped - test status of subqueue
2435  *      @dev: network device
2436  *      @queue_index: sub queue index
2437  *
2438  * Check individual transmit queue of a device with multiple transmit queues.
2439  */
2440 static inline bool __netif_subqueue_stopped(const struct net_device *dev,
2441                                             u16 queue_index)
2442 {
2443         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2444
2445         return netif_tx_queue_stopped(txq);
2446 }
2447
2448 static inline bool netif_subqueue_stopped(const struct net_device *dev,
2449                                           struct sk_buff *skb)
2450 {
2451         return __netif_subqueue_stopped(dev, skb_get_queue_mapping(skb));
2452 }
2453
2454 /**
2455  *      netif_wake_subqueue - allow sending packets on subqueue
2456  *      @dev: network device
2457  *      @queue_index: sub queue index
2458  *
2459  * Resume individual transmit queue of a device with multiple transmit queues.
2460  */
2461 static inline void netif_wake_subqueue(struct net_device *dev, u16 queue_index)
2462 {
2463         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2464         if (test_and_clear_bit(__QUEUE_STATE_DRV_XOFF, &txq->state))
2465                 __netif_schedule(txq->qdisc);
2466 }
2467
2468 #ifdef CONFIG_XPS
2469 int netif_set_xps_queue(struct net_device *dev, const struct cpumask *mask,
2470                         u16 index);
2471 #else
2472 static inline int netif_set_xps_queue(struct net_device *dev,
2473                                       const struct cpumask *mask,
2474                                       u16 index)
2475 {
2476         return 0;
2477 }
2478 #endif
2479
2480 /*
2481  * Returns a Tx hash for the given packet when dev->real_num_tx_queues is used
2482  * as a distribution range limit for the returned value.
2483  */
2484 static inline u16 skb_tx_hash(const struct net_device *dev,
2485                               const struct sk_buff *skb)
2486 {
2487         return __skb_tx_hash(dev, skb, dev->real_num_tx_queues);
2488 }
2489
2490 /**
2491  *      netif_is_multiqueue - test if device has multiple transmit queues
2492  *      @dev: network device
2493  *
2494  * Check if device has multiple transmit queues
2495  */
2496 static inline bool netif_is_multiqueue(const struct net_device *dev)
2497 {
2498         return dev->num_tx_queues > 1;
2499 }
2500
2501 int netif_set_real_num_tx_queues(struct net_device *dev, unsigned int txq);
2502
2503 #ifdef CONFIG_SYSFS
2504 int netif_set_real_num_rx_queues(struct net_device *dev, unsigned int rxq);
2505 #else
2506 static inline int netif_set_real_num_rx_queues(struct net_device *dev,
2507                                                 unsigned int rxq)
2508 {
2509         return 0;
2510 }
2511 #endif
2512
2513 static inline int netif_copy_real_num_queues(struct net_device *to_dev,
2514                                              const struct net_device *from_dev)
2515 {
2516         int err;
2517
2518         err = netif_set_real_num_tx_queues(to_dev,
2519                                            from_dev->real_num_tx_queues);
2520         if (err)
2521                 return err;
2522 #ifdef CONFIG_SYSFS
2523         return netif_set_real_num_rx_queues(to_dev,
2524                                             from_dev->real_num_rx_queues);
2525 #else
2526         return 0;
2527 #endif
2528 }
2529
2530 #ifdef CONFIG_SYSFS
2531 static inline unsigned int get_netdev_rx_queue_index(
2532                 struct netdev_rx_queue *queue)
2533 {
2534         struct net_device *dev = queue->dev;
2535         int index = queue - dev->_rx;
2536
2537         BUG_ON(index >= dev->num_rx_queues);
2538         return index;
2539 }
2540 #endif
2541
2542 #define DEFAULT_MAX_NUM_RSS_QUEUES      (8)
2543 int netif_get_num_default_rss_queues(void);
2544
2545 enum skb_free_reason {
2546         SKB_REASON_CONSUMED,
2547         SKB_REASON_DROPPED,
2548 };
2549
2550 void __dev_kfree_skb_irq(struct sk_buff *skb, enum skb_free_reason reason);
2551 void __dev_kfree_skb_any(struct sk_buff *skb, enum skb_free_reason reason);
2552
2553 /*
2554  * It is not allowed to call kfree_skb() or consume_skb() from hardware
2555  * interrupt context or with hardware interrupts being disabled.
2556  * (in_irq() || irqs_disabled())
2557  *
2558  * We provide four helpers that can be used in following contexts :
2559  *
2560  * dev_kfree_skb_irq(skb) when caller drops a packet from irq context,
2561  *  replacing kfree_skb(skb)
2562  *
2563  * dev_consume_skb_irq(skb) when caller consumes a packet from irq context.
2564  *  Typically used in place of consume_skb(skb) in TX completion path
2565  *
2566  * dev_kfree_skb_any(skb) when caller doesn't know its current irq context,
2567  *  replacing kfree_skb(skb)
2568  *
2569  * dev_consume_skb_any(skb) when caller doesn't know its current irq context,
2570  *  and consumed a packet. Used in place of consume_skb(skb)
2571  */
2572 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
2573 {
2574         __dev_kfree_skb_irq(skb, SKB_REASON_DROPPED);
2575 }
2576
2577 static inline void dev_consume_skb_irq(struct sk_buff *skb)
2578 {
2579         __dev_kfree_skb_irq(skb, SKB_REASON_CONSUMED);
2580 }
2581
2582 static inline void dev_kfree_skb_any(struct sk_buff *skb)
2583 {
2584         __dev_kfree_skb_any(skb, SKB_REASON_DROPPED);
2585 }
2586
2587 static inline void dev_consume_skb_any(struct sk_buff *skb)
2588 {
2589         __dev_kfree_skb_any(skb, SKB_REASON_CONSUMED);
2590 }
2591
2592 int netif_rx(struct sk_buff *skb);
2593 int netif_rx_ni(struct sk_buff *skb);
2594 int netif_receive_skb(struct sk_buff *skb);
2595 gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
2596 void napi_gro_flush(struct napi_struct *napi, bool flush_old);
2597 struct sk_buff *napi_get_frags(struct napi_struct *napi);
2598 gro_result_t napi_gro_frags(struct napi_struct *napi);
2599 struct packet_offload *gro_find_receive_by_type(__be16 type);
2600 struct packet_offload *gro_find_complete_by_type(__be16 type);
2601
2602 static inline void napi_free_frags(struct napi_struct *napi)
2603 {
2604         kfree_skb(napi->skb);
2605         napi->skb = NULL;
2606 }
2607
2608 int netdev_rx_handler_register(struct net_device *dev,
2609                                rx_handler_func_t *rx_handler,
2610                                void *rx_handler_data);
2611 void netdev_rx_handler_unregister(struct net_device *dev);
2612
2613 bool dev_valid_name(const char *name);
2614 int dev_ioctl(struct net *net, unsigned int cmd, void __user *);
2615 int dev_ethtool(struct net *net, struct ifreq *);
2616 unsigned int dev_get_flags(const struct net_device *);
2617 int __dev_change_flags(struct net_device *, unsigned int flags);
2618 int dev_change_flags(struct net_device *, unsigned int);
2619 void __dev_notify_flags(struct net_device *, unsigned int old_flags,
2620                         unsigned int gchanges);
2621 int dev_change_name(struct net_device *, const char *);
2622 int dev_set_alias(struct net_device *, const char *, size_t);
2623 int dev_change_net_namespace(struct net_device *, struct net *, const char *);
2624 int dev_set_mtu(struct net_device *, int);
2625 void dev_set_group(struct net_device *, int);
2626 int dev_set_mac_address(struct net_device *, struct sockaddr *);
2627 int dev_change_carrier(struct net_device *, bool new_carrier);
2628 int dev_get_phys_port_id(struct net_device *dev,
2629                          struct netdev_phys_port_id *ppid);
2630 int dev_hard_start_xmit(struct sk_buff *skb, struct net_device *dev,
2631                         struct netdev_queue *txq);
2632 int dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
2633
2634 extern int              netdev_budget;
2635
2636 /* Called by rtnetlink.c:rtnl_unlock() */
2637 void netdev_run_todo(void);
2638
2639 /**
2640  *      dev_put - release reference to device
2641  *      @dev: network device
2642  *
2643  * Release reference to device to allow it to be freed.
2644  */
2645 static inline void dev_put(struct net_device *dev)
2646 {
2647         this_cpu_dec(*dev->pcpu_refcnt);
2648 }
2649
2650 /**
2651  *      dev_hold - get reference to device
2652  *      @dev: network device
2653  *
2654  * Hold reference to device to keep it from being freed.
2655  */
2656 static inline void dev_hold(struct net_device *dev)
2657 {
2658         this_cpu_inc(*dev->pcpu_refcnt);
2659 }
2660
2661 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
2662  * and _off may be called from IRQ context, but it is caller
2663  * who is responsible for serialization of these calls.
2664  *
2665  * The name carrier is inappropriate, these functions should really be
2666  * called netif_lowerlayer_*() because they represent the state of any
2667  * kind of lower layer not just hardware media.
2668  */
2669
2670 void linkwatch_init_dev(struct net_device *dev);
2671 void linkwatch_fire_event(struct net_device *dev);
2672 void linkwatch_forget_dev(struct net_device *dev);
2673
2674 /**
2675  *      netif_carrier_ok - test if carrier present
2676  *      @dev: network device
2677  *
2678  * Check if carrier is present on device
2679  */
2680 static inline bool netif_carrier_ok(const struct net_device *dev)
2681 {
2682         return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
2683 }
2684
2685 unsigned long dev_trans_start(struct net_device *dev);
2686
2687 void __netdev_watchdog_up(struct net_device *dev);
2688
2689 void netif_carrier_on(struct net_device *dev);
2690
2691 void netif_carrier_off(struct net_device *dev);
2692
2693 /**
2694  *      netif_dormant_on - mark device as dormant.
2695  *      @dev: network device
2696  *
2697  * Mark device as dormant (as per RFC2863).
2698  *
2699  * The dormant state indicates that the relevant interface is not
2700  * actually in a condition to pass packets (i.e., it is not 'up') but is
2701  * in a "pending" state, waiting for some external event.  For "on-
2702  * demand" interfaces, this new state identifies the situation where the
2703  * interface is waiting for events to place it in the up state.
2704  *
2705  */
2706 static inline void netif_dormant_on(struct net_device *dev)
2707 {
2708         if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
2709                 linkwatch_fire_event(dev);
2710 }
2711
2712 /**
2713  *      netif_dormant_off - set device as not dormant.
2714  *      @dev: network device
2715  *
2716  * Device is not in dormant state.
2717  */
2718 static inline void netif_dormant_off(struct net_device *dev)
2719 {
2720         if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
2721                 linkwatch_fire_event(dev);
2722 }
2723
2724 /**
2725  *      netif_dormant - test if carrier present
2726  *      @dev: network device
2727  *
2728  * Check if carrier is present on device
2729  */
2730 static inline bool netif_dormant(const struct net_device *dev)
2731 {
2732         return test_bit(__LINK_STATE_DORMANT, &dev->state);
2733 }
2734
2735
2736 /**
2737  *      netif_oper_up - test if device is operational
2738  *      @dev: network device
2739  *
2740  * Check if carrier is operational
2741  */
2742 static inline bool netif_oper_up(const struct net_device *dev)
2743 {
2744         return (dev->operstate == IF_OPER_UP ||
2745                 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
2746 }
2747
2748 /**
2749  *      netif_device_present - is device available or removed
2750  *      @dev: network device
2751  *
2752  * Check if device has not been removed from system.
2753  */
2754 static inline bool netif_device_present(struct net_device *dev)
2755 {
2756         return test_bit(__LINK_STATE_PRESENT, &dev->state);
2757 }
2758
2759 void netif_device_detach(struct net_device *dev);
2760
2761 void netif_device_attach(struct net_device *dev);
2762
2763 /*
2764  * Network interface message level settings
2765  */
2766
2767 enum {
2768         NETIF_MSG_DRV           = 0x0001,
2769         NETIF_MSG_PROBE         = 0x0002,
2770         NETIF_MSG_LINK          = 0x0004,
2771         NETIF_MSG_TIMER         = 0x0008,
2772         NETIF_MSG_IFDOWN        = 0x0010,
2773         NETIF_MSG_IFUP          = 0x0020,
2774         NETIF_MSG_RX_ERR        = 0x0040,
2775         NETIF_MSG_TX_ERR        = 0x0080,
2776         NETIF_MSG_TX_QUEUED     = 0x0100,
2777         NETIF_MSG_INTR          = 0x0200,
2778         NETIF_MSG_TX_DONE       = 0x0400,
2779         NETIF_MSG_RX_STATUS     = 0x0800,
2780         NETIF_MSG_PKTDATA       = 0x1000,
2781         NETIF_MSG_HW            = 0x2000,
2782         NETIF_MSG_WOL           = 0x4000,
2783 };
2784
2785 #define netif_msg_drv(p)        ((p)->msg_enable & NETIF_MSG_DRV)
2786 #define netif_msg_probe(p)      ((p)->msg_enable & NETIF_MSG_PROBE)
2787 #define netif_msg_link(p)       ((p)->msg_enable & NETIF_MSG_LINK)
2788 #define netif_msg_timer(p)      ((p)->msg_enable & NETIF_MSG_TIMER)
2789 #define netif_msg_ifdown(p)     ((p)->msg_enable & NETIF_MSG_IFDOWN)
2790 #define netif_msg_ifup(p)       ((p)->msg_enable & NETIF_MSG_IFUP)
2791 #define netif_msg_rx_err(p)     ((p)->msg_enable & NETIF_MSG_RX_ERR)
2792 #define netif_msg_tx_err(p)     ((p)->msg_enable & NETIF_MSG_TX_ERR)
2793 #define netif_msg_tx_queued(p)  ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
2794 #define netif_msg_intr(p)       ((p)->msg_enable & NETIF_MSG_INTR)
2795 #define netif_msg_tx_done(p)    ((p)->msg_enable & NETIF_MSG_TX_DONE)
2796 #define netif_msg_rx_status(p)  ((p)->msg_enable & NETIF_MSG_RX_STATUS)
2797 #define netif_msg_pktdata(p)    ((p)->msg_enable & NETIF_MSG_PKTDATA)
2798 #define netif_msg_hw(p)         ((p)->msg_enable & NETIF_MSG_HW)
2799 #define netif_msg_wol(p)        ((p)->msg_enable & NETIF_MSG_WOL)
2800
2801 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
2802 {
2803         /* use default */
2804         if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
2805                 return default_msg_enable_bits;
2806         if (debug_value == 0)   /* no output */
2807                 return 0;
2808         /* set low N bits */
2809         return (1 << debug_value) - 1;
2810 }
2811
2812 static inline void __netif_tx_lock(struct netdev_queue *txq, int cpu)
2813 {
2814         spin_lock(&txq->_xmit_lock);
2815         txq->xmit_lock_owner = cpu;
2816 }
2817
2818 static inline void __netif_tx_lock_bh(struct netdev_queue *txq)
2819 {
2820         spin_lock_bh(&txq->_xmit_lock);
2821         txq->xmit_lock_owner = smp_processor_id();
2822 }
2823
2824 static inline bool __netif_tx_trylock(struct netdev_queue *txq)
2825 {
2826         bool ok = spin_trylock(&txq->_xmit_lock);
2827         if (likely(ok))
2828                 txq->xmit_lock_owner = smp_processor_id();
2829         return ok;
2830 }
2831
2832 static inline void __netif_tx_unlock(struct netdev_queue *txq)
2833 {
2834         txq->xmit_lock_owner = -1;
2835         spin_unlock(&txq->_xmit_lock);
2836 }
2837
2838 static inline void __netif_tx_unlock_bh(struct netdev_queue *txq)
2839 {
2840         txq->xmit_lock_owner = -1;
2841         spin_unlock_bh(&txq->_xmit_lock);
2842 }
2843
2844 static inline void txq_trans_update(struct netdev_queue *txq)
2845 {
2846         if (txq->xmit_lock_owner != -1)
2847                 txq->trans_start = jiffies;
2848 }
2849
2850 /**
2851  *      netif_tx_lock - grab network device transmit lock
2852  *      @dev: network device
2853  *
2854  * Get network device transmit lock
2855  */
2856 static inline void netif_tx_lock(struct net_device *dev)
2857 {
2858         unsigned int i;
2859         int cpu;
2860
2861         spin_lock(&dev->tx_global_lock);
2862         cpu = smp_processor_id();
2863         for (i = 0; i < dev->num_tx_queues; i++) {
2864                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2865
2866                 /* We are the only thread of execution doing a
2867                  * freeze, but we have to grab the _xmit_lock in
2868                  * order to synchronize with threads which are in
2869                  * the ->hard_start_xmit() handler and already
2870                  * checked the frozen bit.
2871                  */
2872                 __netif_tx_lock(txq, cpu);
2873                 set_bit(__QUEUE_STATE_FROZEN, &txq->state);
2874                 __netif_tx_unlock(txq);
2875         }
2876 }
2877
2878 static inline void netif_tx_lock_bh(struct net_device *dev)
2879 {
2880         local_bh_disable();
2881         netif_tx_lock(dev);
2882 }
2883
2884 static inline void netif_tx_unlock(struct net_device *dev)
2885 {
2886         unsigned int i;
2887
2888         for (i = 0; i < dev->num_tx_queues; i++) {
2889                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2890
2891                 /* No need to grab the _xmit_lock here.  If the
2892                  * queue is not stopped for another reason, we
2893                  * force a schedule.
2894                  */
2895                 clear_bit(__QUEUE_STATE_FROZEN, &txq->state);
2896                 netif_schedule_queue(txq);
2897         }
2898         spin_unlock(&dev->tx_global_lock);
2899 }
2900
2901 static inline void netif_tx_unlock_bh(struct net_device *dev)
2902 {
2903         netif_tx_unlock(dev);
2904         local_bh_enable();
2905 }
2906
2907 #define HARD_TX_LOCK(dev, txq, cpu) {                   \
2908         if ((dev->features & NETIF_F_LLTX) == 0) {      \
2909                 __netif_tx_lock(txq, cpu);              \
2910         }                                               \
2911 }
2912
2913 #define HARD_TX_UNLOCK(dev, txq) {                      \
2914         if ((dev->features & NETIF_F_LLTX) == 0) {      \
2915                 __netif_tx_unlock(txq);                 \
2916         }                                               \
2917 }
2918
2919 static inline void netif_tx_disable(struct net_device *dev)
2920 {
2921         unsigned int i;
2922         int cpu;
2923
2924         local_bh_disable();
2925         cpu = smp_processor_id();
2926         for (i = 0; i < dev->num_tx_queues; i++) {
2927                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2928
2929                 __netif_tx_lock(txq, cpu);
2930                 netif_tx_stop_queue(txq);
2931                 __netif_tx_unlock(txq);
2932         }
2933         local_bh_enable();
2934 }
2935
2936 static inline void netif_addr_lock(struct net_device *dev)
2937 {
2938         spin_lock(&dev->addr_list_lock);
2939 }
2940
2941 static inline void netif_addr_lock_nested(struct net_device *dev)
2942 {
2943         spin_lock_nested(&dev->addr_list_lock, SINGLE_DEPTH_NESTING);
2944 }
2945
2946 static inline void netif_addr_lock_bh(struct net_device *dev)
2947 {
2948         spin_lock_bh(&dev->addr_list_lock);
2949 }
2950
2951 static inline void netif_addr_unlock(struct net_device *dev)
2952 {
2953         spin_unlock(&dev->addr_list_lock);
2954 }
2955
2956 static inline void netif_addr_unlock_bh(struct net_device *dev)
2957 {
2958         spin_unlock_bh(&dev->addr_list_lock);
2959 }
2960
2961 /*
2962  * dev_addrs walker. Should be used only for read access. Call with
2963  * rcu_read_lock held.
2964  */
2965 #define for_each_dev_addr(dev, ha) \
2966                 list_for_each_entry_rcu(ha, &dev->dev_addrs.list, list)
2967
2968 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
2969
2970 void ether_setup(struct net_device *dev);
2971
2972 /* Support for loadable net-drivers */
2973 struct net_device *alloc_netdev_mqs(int sizeof_priv, const char *name,
2974                                     void (*setup)(struct net_device *),
2975                                     unsigned int txqs, unsigned int rxqs);
2976 #define alloc_netdev(sizeof_priv, name, setup) \
2977         alloc_netdev_mqs(sizeof_priv, name, setup, 1, 1)
2978
2979 #define alloc_netdev_mq(sizeof_priv, name, setup, count) \
2980         alloc_netdev_mqs(sizeof_priv, name, setup, count, count)
2981
2982 int register_netdev(struct net_device *dev);
2983 void unregister_netdev(struct net_device *dev);
2984
2985 /* General hardware address lists handling functions */
2986 int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
2987                    struct netdev_hw_addr_list *from_list, int addr_len);
2988 void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
2989                       struct netdev_hw_addr_list *from_list, int addr_len);
2990 void __hw_addr_init(struct netdev_hw_addr_list *list);
2991
2992 /* Functions used for device addresses handling */
2993 int dev_addr_add(struct net_device *dev, const unsigned char *addr,
2994                  unsigned char addr_type);
2995 int dev_addr_del(struct net_device *dev, const unsigned char *addr,
2996                  unsigned char addr_type);
2997 void dev_addr_flush(struct net_device *dev);
2998 int dev_addr_init(struct net_device *dev);
2999
3000 /* Functions used for unicast addresses handling */
3001 int dev_uc_add(struct net_device *dev, const unsigned char *addr);
3002 int dev_uc_add_excl(struct net_device *dev, const unsigned char *addr);
3003 int dev_uc_del(struct net_device *dev, const unsigned char *addr);
3004 int dev_uc_sync(struct net_device *to, struct net_device *from);
3005 int dev_uc_sync_multiple(struct net_device *to, struct net_device *from);
3006 void dev_uc_unsync(struct net_device *to, struct net_device *from);
3007 void dev_uc_flush(struct net_device *dev);
3008 void dev_uc_init(struct net_device *dev);
3009
3010 /* Functions used for multicast addresses handling */
3011 int dev_mc_add(struct net_device *dev, const unsigned char *addr);
3012 int dev_mc_add_global(struct net_device *dev, const unsigned char *addr);
3013 int dev_mc_add_excl(struct net_device *dev, const unsigned char *addr);
3014 int dev_mc_del(struct net_device *dev, const unsigned char *addr);
3015 int dev_mc_del_global(struct net_device *dev, const unsigned char *addr);
3016 int dev_mc_sync(struct net_device *to, struct net_device *from);
3017 int dev_mc_sync_multiple(struct net_device *to, struct net_device *from);
3018 void dev_mc_unsync(struct net_device *to, struct net_device *from);
3019 void dev_mc_flush(struct net_device *dev);
3020 void dev_mc_init(struct net_device *dev);
3021
3022 /* Functions used for secondary unicast and multicast support */
3023 void dev_set_rx_mode(struct net_device *dev);
3024 void __dev_set_rx_mode(struct net_device *dev);
3025 int dev_set_promiscuity(struct net_device *dev, int inc);
3026 int dev_set_allmulti(struct net_device *dev, int inc);
3027 void netdev_state_change(struct net_device *dev);
3028 void netdev_notify_peers(struct net_device *dev);
3029 void netdev_features_change(struct net_device *dev);
3030 /* Load a device via the kmod */
3031 void dev_load(struct net *net, const char *name);
3032 struct rtnl_link_stats64 *dev_get_stats(struct net_device *dev,
3033                                         struct rtnl_link_stats64 *storage);
3034 void netdev_stats_to_stats64(struct rtnl_link_stats64 *stats64,
3035                              const struct net_device_stats *netdev_stats);
3036
3037 extern int              netdev_max_backlog;
3038 extern int              netdev_tstamp_prequeue;
3039 extern int              weight_p;
3040 extern int              bpf_jit_enable;
3041
3042 bool netdev_has_upper_dev(struct net_device *dev, struct net_device *upper_dev);
3043 struct net_device *netdev_all_upper_get_next_dev_rcu(struct net_device *dev,
3044                                                      struct list_head **iter);
3045
3046 /* iterate through upper list, must be called under RCU read lock */
3047 #define netdev_for_each_all_upper_dev_rcu(dev, updev, iter) \
3048         for (iter = &(dev)->all_adj_list.upper, \
3049              updev = netdev_all_upper_get_next_dev_rcu(dev, &(iter)); \
3050              updev; \
3051              updev = netdev_all_upper_get_next_dev_rcu(dev, &(iter)))
3052
3053 void *netdev_lower_get_next_private(struct net_device *dev,
3054                                     struct list_head **iter);
3055 void *netdev_lower_get_next_private_rcu(struct net_device *dev,
3056                                         struct list_head **iter);
3057
3058 #define netdev_for_each_lower_private(dev, priv, iter) \
3059         for (iter = (dev)->adj_list.lower.next, \
3060              priv = netdev_lower_get_next_private(dev, &(iter)); \
3061              priv; \
3062              priv = netdev_lower_get_next_private(dev, &(iter)))
3063
3064 #define netdev_for_each_lower_private_rcu(dev, priv, iter) \
3065         for (iter = &(dev)->adj_list.lower, \
3066              priv = netdev_lower_get_next_private_rcu(dev, &(iter)); \
3067              priv; \
3068              priv = netdev_lower_get_next_private_rcu(dev, &(iter)))
3069
3070 void *netdev_adjacent_get_private(struct list_head *adj_list);
3071 void *netdev_lower_get_first_private_rcu(struct net_device *dev);
3072 struct net_device *netdev_master_upper_dev_get(struct net_device *dev);
3073 struct net_device *netdev_master_upper_dev_get_rcu(struct net_device *dev);
3074 int netdev_upper_dev_link(struct net_device *dev, struct net_device *upper_dev);
3075 int netdev_master_upper_dev_link(struct net_device *dev,
3076                                  struct net_device *upper_dev);
3077 int netdev_master_upper_dev_link_private(struct net_device *dev,
3078                                          struct net_device *upper_dev,
3079                                          void *private);
3080 void netdev_upper_dev_unlink(struct net_device *dev,
3081                              struct net_device *upper_dev);
3082 void netdev_adjacent_rename_links(struct net_device *dev, char *oldname);
3083 void *netdev_lower_dev_get_private(struct net_device *dev,
3084                                    struct net_device *lower_dev);
3085 int skb_checksum_help(struct sk_buff *skb);
3086 struct sk_buff *__skb_gso_segment(struct sk_buff *skb,
3087                                   netdev_features_t features, bool tx_path);
3088 struct sk_buff *skb_mac_gso_segment(struct sk_buff *skb,
3089                                     netdev_features_t features);
3090
3091 static inline
3092 struct sk_buff *skb_gso_segment(struct sk_buff *skb, netdev_features_t features)
3093 {
3094         return __skb_gso_segment(skb, features, true);
3095 }
3096 __be16 skb_network_protocol(struct sk_buff *skb);
3097
3098 static inline bool can_checksum_protocol(netdev_features_t features,
3099                                          __be16 protocol)
3100 {
3101         return ((features & NETIF_F_GEN_CSUM) ||
3102                 ((features & NETIF_F_V4_CSUM) &&
3103                  protocol == htons(ETH_P_IP)) ||
3104                 ((features & NETIF_F_V6_CSUM) &&
3105                  protocol == htons(ETH_P_IPV6)) ||
3106                 ((features & NETIF_F_FCOE_CRC) &&
3107                  protocol == htons(ETH_P_FCOE)));
3108 }
3109
3110 #ifdef CONFIG_BUG
3111 void netdev_rx_csum_fault(struct net_device *dev);
3112 #else
3113 static inline void netdev_rx_csum_fault(struct net_device *dev)
3114 {
3115 }
3116 #endif
3117 /* rx skb timestamps */
3118 void net_enable_timestamp(void);
3119 void net_disable_timestamp(void);
3120
3121 #ifdef CONFIG_PROC_FS
3122 int __init dev_proc_init(void);
3123 #else
3124 #define dev_proc_init() 0
3125 #endif
3126
3127 int netdev_class_create_file_ns(struct class_attribute *class_attr,
3128                                 const void *ns);
3129 void netdev_class_remove_file_ns(struct class_attribute *class_attr,
3130                                  const void *ns);
3131
3132 static inline int netdev_class_create_file(struct class_attribute *class_attr)
3133 {
3134         return netdev_class_create_file_ns(class_attr, NULL);
3135 }
3136
3137 static inline void netdev_class_remove_file(struct class_attribute *class_attr)
3138 {
3139         netdev_class_remove_file_ns(class_attr, NULL);
3140 }
3141
3142 extern struct kobj_ns_type_operations net_ns_type_operations;
3143
3144 const char *netdev_drivername(const struct net_device *dev);
3145
3146 void linkwatch_run_queue(void);
3147
3148 static inline netdev_features_t netdev_get_wanted_features(
3149         struct net_device *dev)
3150 {
3151         return (dev->features & ~dev->hw_features) | dev->wanted_features;
3152 }
3153 netdev_features_t netdev_increment_features(netdev_features_t all,
3154         netdev_features_t one, netdev_features_t mask);
3155
3156 /* Allow TSO being used on stacked device :
3157  * Performing the GSO segmentation before last device
3158  * is a performance improvement.
3159  */
3160 static inline netdev_features_t netdev_add_tso_features(netdev_features_t features,
3161                                                         netdev_features_t mask)
3162 {
3163         return netdev_increment_features(features, NETIF_F_ALL_TSO, mask);
3164 }
3165
3166 int __netdev_update_features(struct net_device *dev);
3167 void netdev_update_features(struct net_device *dev);
3168 void netdev_change_features(struct net_device *dev);
3169
3170 void netif_stacked_transfer_operstate(const struct net_device *rootdev,
3171                                         struct net_device *dev);
3172
3173 netdev_features_t netif_skb_dev_features(struct sk_buff *skb,
3174                                          const struct net_device *dev);
3175 static inline netdev_features_t netif_skb_features(struct sk_buff *skb)
3176 {
3177         return netif_skb_dev_features(skb, skb->dev);
3178 }
3179
3180 static inline bool net_gso_ok(netdev_features_t features, int gso_type)
3181 {
3182         netdev_features_t feature = gso_type << NETIF_F_GSO_SHIFT;
3183
3184         /* check flags correspondence */
3185         BUILD_BUG_ON(SKB_GSO_TCPV4   != (NETIF_F_TSO >> NETIF_F_GSO_SHIFT));
3186         BUILD_BUG_ON(SKB_GSO_UDP     != (NETIF_F_UFO >> NETIF_F_GSO_SHIFT));
3187         BUILD_BUG_ON(SKB_GSO_DODGY   != (NETIF_F_GSO_ROBUST >> NETIF_F_GSO_SHIFT));
3188         BUILD_BUG_ON(SKB_GSO_TCP_ECN != (NETIF_F_TSO_ECN >> NETIF_F_GSO_SHIFT));
3189         BUILD_BUG_ON(SKB_GSO_TCPV6   != (NETIF_F_TSO6 >> NETIF_F_GSO_SHIFT));
3190         BUILD_BUG_ON(SKB_GSO_FCOE    != (NETIF_F_FSO >> NETIF_F_GSO_SHIFT));
3191
3192         return (features & feature) == feature;
3193 }
3194
3195 static inline bool skb_gso_ok(struct sk_buff *skb, netdev_features_t features)
3196 {
3197         return net_gso_ok(features, skb_shinfo(skb)->gso_type) &&
3198                (!skb_has_frag_list(skb) || (features & NETIF_F_FRAGLIST));
3199 }
3200
3201 static inline bool netif_needs_gso(struct sk_buff *skb,
3202                                    netdev_features_t features)
3203 {
3204         return skb_is_gso(skb) && (!skb_gso_ok(skb, features) ||
3205                 unlikely((skb->ip_summed != CHECKSUM_PARTIAL) &&
3206                          (skb->ip_summed != CHECKSUM_UNNECESSARY)));
3207 }
3208
3209 static inline void netif_set_gso_max_size(struct net_device *dev,
3210                                           unsigned int size)
3211 {
3212         dev->gso_max_size = size;
3213 }
3214
3215 static inline void skb_gso_error_unwind(struct sk_buff *skb, __be16 protocol,
3216                                         int pulled_hlen, u16 mac_offset,
3217                                         int mac_len)
3218 {
3219         skb->protocol = protocol;
3220         skb->encapsulation = 1;
3221         skb_push(skb, pulled_hlen);
3222         skb_reset_transport_header(skb);
3223         skb->mac_header = mac_offset;
3224         skb->network_header = skb->mac_header + mac_len;
3225         skb->mac_len = mac_len;
3226 }
3227
3228 static inline bool netif_is_macvlan(struct net_device *dev)
3229 {
3230         return dev->priv_flags & IFF_MACVLAN;
3231 }
3232
3233 static inline bool netif_is_bond_master(struct net_device *dev)
3234 {
3235         return dev->flags & IFF_MASTER && dev->priv_flags & IFF_BONDING;
3236 }
3237
3238 static inline bool netif_is_bond_slave(struct net_device *dev)
3239 {
3240         return dev->flags & IFF_SLAVE && dev->priv_flags & IFF_BONDING;
3241 }
3242
3243 static inline bool netif_supports_nofcs(struct net_device *dev)
3244 {
3245         return dev->priv_flags & IFF_SUPP_NOFCS;
3246 }
3247
3248 extern struct pernet_operations __net_initdata loopback_net_ops;
3249
3250 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3251
3252 /* netdev_printk helpers, similar to dev_printk */
3253
3254 static inline const char *netdev_name(const struct net_device *dev)
3255 {
3256         if (dev->reg_state != NETREG_REGISTERED)
3257                 return "(unregistered net_device)";
3258         return dev->name;
3259 }
3260
3261 __printf(3, 4)
3262 int netdev_printk(const char *level, const struct net_device *dev,
3263                   const char *format, ...);
3264 __printf(2, 3)
3265 int netdev_emerg(const struct net_device *dev, const char *format, ...);
3266 __printf(2, 3)
3267 int netdev_alert(const struct net_device *dev, const char *format, ...);
3268 __printf(2, 3)
3269 int netdev_crit(const struct net_device *dev, const char *format, ...);
3270 __printf(2, 3)
3271 int netdev_err(const struct net_device *dev, const char *format, ...);
3272 __printf(2, 3)
3273 int netdev_warn(const struct net_device *dev, const char *format, ...);
3274 __printf(2, 3)
3275 int netdev_notice(const struct net_device *dev, const char *format, ...);
3276 __printf(2, 3)
3277 int netdev_info(const struct net_device *dev, const char *format, ...);
3278
3279 #define MODULE_ALIAS_NETDEV(device) \
3280         MODULE_ALIAS("netdev-" device)
3281
3282 #if defined(CONFIG_DYNAMIC_DEBUG)
3283 #define netdev_dbg(__dev, format, args...)                      \
3284 do {                                                            \
3285         dynamic_netdev_dbg(__dev, format, ##args);              \
3286 } while (0)
3287 #elif defined(DEBUG)
3288 #define netdev_dbg(__dev, format, args...)                      \
3289         netdev_printk(KERN_DEBUG, __dev, format, ##args)
3290 #else
3291 #define netdev_dbg(__dev, format, args...)                      \
3292 ({                                                              \
3293         if (0)                                                  \
3294                 netdev_printk(KERN_DEBUG, __dev, format, ##args); \
3295         0;                                                      \
3296 })
3297 #endif
3298
3299 #if defined(VERBOSE_DEBUG)
3300 #define netdev_vdbg     netdev_dbg
3301 #else
3302
3303 #define netdev_vdbg(dev, format, args...)                       \
3304 ({                                                              \
3305         if (0)                                                  \
3306                 netdev_printk(KERN_DEBUG, dev, format, ##args); \
3307         0;                                                      \
3308 })
3309 #endif
3310
3311 /*
3312  * netdev_WARN() acts like dev_printk(), but with the key difference
3313  * of using a WARN/WARN_ON to get the message out, including the
3314  * file/line information and a backtrace.
3315  */
3316 #define netdev_WARN(dev, format, args...)                       \
3317         WARN(1, "netdevice: %s\n" format, netdev_name(dev), ##args)
3318
3319 /* netif printk helpers, similar to netdev_printk */
3320
3321 #define netif_printk(priv, type, level, dev, fmt, args...)      \
3322 do {                                                            \
3323         if (netif_msg_##type(priv))                             \
3324                 netdev_printk(level, (dev), fmt, ##args);       \
3325 } while (0)
3326
3327 #define netif_level(level, priv, type, dev, fmt, args...)       \
3328 do {                                                            \
3329         if (netif_msg_##type(priv))                             \
3330                 netdev_##level(dev, fmt, ##args);               \
3331 } while (0)
3332
3333 #define netif_emerg(priv, type, dev, fmt, args...)              \
3334         netif_level(emerg, priv, type, dev, fmt, ##args)
3335 #define netif_alert(priv, type, dev, fmt, args...)              \
3336         netif_level(alert, priv, type, dev, fmt, ##args)
3337 #define netif_crit(priv, type, dev, fmt, args...)               \
3338         netif_level(crit, priv, type, dev, fmt, ##args)
3339 #define netif_err(priv, type, dev, fmt, args...)                \
3340         netif_level(err, priv, type, dev, fmt, ##args)
3341 #define netif_warn(priv, type, dev, fmt, args...)               \
3342         netif_level(warn, priv, type, dev, fmt, ##args)
3343 #define netif_notice(priv, type, dev, fmt, args...)             \
3344         netif_level(notice, priv, type, dev, fmt, ##args)
3345 #define netif_info(priv, type, dev, fmt, args...)               \
3346         netif_level(info, priv, type, dev, fmt, ##args)
3347
3348 #if defined(CONFIG_DYNAMIC_DEBUG)
3349 #define netif_dbg(priv, type, netdev, format, args...)          \
3350 do {                                                            \
3351         if (netif_msg_##type(priv))                             \
3352                 dynamic_netdev_dbg(netdev, format, ##args);     \
3353 } while (0)
3354 #elif defined(DEBUG)
3355 #define netif_dbg(priv, type, dev, format, args...)             \
3356         netif_printk(priv, type, KERN_DEBUG, dev, format, ##args)
3357 #else
3358 #define netif_dbg(priv, type, dev, format, args...)                     \
3359 ({                                                                      \
3360         if (0)                                                          \
3361                 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
3362         0;                                                              \
3363 })
3364 #endif
3365
3366 #if defined(VERBOSE_DEBUG)
3367 #define netif_vdbg      netif_dbg
3368 #else
3369 #define netif_vdbg(priv, type, dev, format, args...)            \
3370 ({                                                              \
3371         if (0)                                                  \
3372                 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
3373         0;                                                      \
3374 })
3375 #endif
3376
3377 /*
3378  *      The list of packet types we will receive (as opposed to discard)
3379  *      and the routines to invoke.
3380  *
3381  *      Why 16. Because with 16 the only overlap we get on a hash of the
3382  *      low nibble of the protocol value is RARP/SNAP/X.25.
3383  *
3384  *      NOTE:  That is no longer true with the addition of VLAN tags.  Not
3385  *             sure which should go first, but I bet it won't make much
3386  *             difference if we are running VLANs.  The good news is that
3387  *             this protocol won't be in the list unless compiled in, so
3388  *             the average user (w/out VLANs) will not be adversely affected.
3389  *             --BLG
3390  *
3391  *              0800    IP
3392  *              8100    802.1Q VLAN
3393  *              0001    802.3
3394  *              0002    AX.25
3395  *              0004    802.2
3396  *              8035    RARP
3397  *              0005    SNAP
3398  *              0805    X.25
3399  *              0806    ARP
3400  *              8137    IPX
3401  *              0009    Localtalk
3402  *              86DD    IPv6
3403  */
3404 #define PTYPE_HASH_SIZE (16)
3405 #define PTYPE_HASH_MASK (PTYPE_HASH_SIZE - 1)
3406
3407 #endif  /* _LINUX_NETDEVICE_H */