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