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/if.h>
  29 #include <linux/if_ether.h>
  30 #include <linux/if_packet.h>
  31 #include <linux/if_link.h>
  32
  33 #ifdef __KERNEL__
  34 #include <linux/timer.h>
  35 #include <linux/delay.h>
  36 #include <linux/mm.h>
  37 #include <asm/atomic.h>
  38 #include <asm/cache.h>
  39 #include <asm/byteorder.h>
  40
  41 #include <linux/device.h>
  42 #include <linux/percpu.h>
  43 #include <linux/rculist.h>
  44 #include <linux/dmaengine.h>
  45 #include <linux/workqueue.h>
  46
  47 #include <linux/ethtool.h>
  48 #include <net/net_namespace.h>
  49 #include <net/dsa.h>
  50 #ifdef CONFIG_DCB
  51 #include <net/dcbnl.h>
  52 #endif
  53
  54 struct vlan_group;
  55 struct netpoll_info;
  56 /* 802.11 specific */
  57 struct wireless_dev;
  58                                         /* source back-compat hooks */
  59 #define SET_ETHTOOL_OPS(netdev,ops) \
  60         ( (netdev)->ethtool_ops = (ops) )
  61
  62 #define HAVE_ALLOC_NETDEV               /* feature macro: alloc_xxxdev
  63                                            functions are available. */
  64 #define HAVE_FREE_NETDEV                /* free_netdev() */
  65 #define HAVE_NETDEV_PRIV                /* netdev_priv() */
  66
  67 /* Backlog congestion levels */
  68 #define NET_RX_SUCCESS          0       /* keep 'em coming, baby */
  69 #define NET_RX_DROP             1       /* packet dropped */
  70
  71 /*
  72  * Transmit return codes: transmit return codes originate from three different
  73  * namespaces:
  74  *
  75  * - qdisc return codes
  76  * - driver transmit return codes
  77  * - errno values
  78  *
  79  * Drivers are allowed to return any one of those in their hard_start_xmit()
  80  * function. Real network devices commonly used with qdiscs should only return
  81  * the driver transmit return codes though - when qdiscs are used, the actual
  82  * transmission happens asynchronously, so the value is not propagated to
  83  * higher layers. Virtual network devices transmit synchronously, in this case
  84  * the driver transmit return codes are consumed by dev_queue_xmit(), all
  85  * others are propagated to higher layers.
  86  */
  87
  88 /* qdisc ->enqueue() return codes. */
  89 #define NET_XMIT_SUCCESS        0x00
  90 #define NET_XMIT_DROP           0x01    /* skb dropped                  */
  91 #define NET_XMIT_CN             0x02    /* congestion notification      */
  92 #define NET_XMIT_POLICED        0x03    /* skb is shot by police        */
  93 #define NET_XMIT_MASK           0x0f    /* qdisc flags in net/sch_generic.h */
  94
  95 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
  96  * indicates that the device will soon be dropping packets, or already drops
  97  * some packets of the same priority; prompting us to send less aggressively. */
  98 #define net_xmit_eval(e)        ((e) == NET_XMIT_CN ? 0 : (e))
  99 #define net_xmit_errno(e)       ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
 100
 101 /* Driver transmit return codes */
 102 #define NETDEV_TX_MASK          0xf0
 103
 104 enum netdev_tx {
 105         __NETDEV_TX_MIN  = INT_MIN,     /* make sure enum is signed */
 106         NETDEV_TX_OK     = 0x00,        /* driver took care of packet */
 107         NETDEV_TX_BUSY   = 0x10,        /* driver tx path was busy*/
 108         NETDEV_TX_LOCKED = 0x20,        /* driver tx lock was already taken */
 109 };
 110 typedef enum netdev_tx netdev_tx_t;
 111
 112 /*
 113  * Current order: NETDEV_TX_MASK > NET_XMIT_MASK >= 0 is significant;
 114  * hard_start_xmit() return < NET_XMIT_MASK means skb was consumed.
 115  */
 116 static inline bool dev_xmit_complete(int rc)
 117 {
 118         /*
 119          * Positive cases with an skb consumed by a driver:
 120          * - successful transmission (rc == NETDEV_TX_OK)
 121          * - error while transmitting (rc < 0)
 122          * - error while queueing to a different device (rc & NET_XMIT_MASK)
 123          */
 124         if (likely(rc < NET_XMIT_MASK))
 125                 return true;
 126
 127         return false;
 128 }
 129
 130 #endif
 131
 132 #define MAX_ADDR_LEN    32              /* Largest hardware address length */
 133
 134 #ifdef  __KERNEL__
 135 /*
 136  *      Compute the worst case header length according to the protocols
 137  *      used.
 138  */
 139
 140 #if defined(CONFIG_WLAN) || defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
 141 # if defined(CONFIG_MAC80211_MESH)
 142 #  define LL_MAX_HEADER 128
 143 # else
 144 #  define LL_MAX_HEADER 96
 145 # endif
 146 #elif defined(CONFIG_TR) || defined(CONFIG_TR_MODULE)
 147 # define LL_MAX_HEADER 48
 148 #else
 149 # define LL_MAX_HEADER 32
 150 #endif
 151
 152 #if !defined(CONFIG_NET_IPIP) && !defined(CONFIG_NET_IPIP_MODULE) && \
 153     !defined(CONFIG_NET_IPGRE) &&  !defined(CONFIG_NET_IPGRE_MODULE) && \
 154     !defined(CONFIG_IPV6_SIT) && !defined(CONFIG_IPV6_SIT_MODULE) && \
 155     !defined(CONFIG_IPV6_TUNNEL) && !defined(CONFIG_IPV6_TUNNEL_MODULE)
 156 #define MAX_HEADER LL_MAX_HEADER
 157 #else
 158 #define MAX_HEADER (LL_MAX_HEADER + 48)
 159 #endif
 160
 161 #endif  /*  __KERNEL__  */
 162
 163 /*
 164  *      Network device statistics. Akin to the 2.0 ether stats but
 165  *      with byte counters.
 166  */
 167
 168 struct net_device_stats {
 169         unsigned long   rx_packets;             /* total packets received       */
 170         unsigned long   tx_packets;             /* total packets transmitted    */
 171         unsigned long   rx_bytes;               /* total bytes received         */
 172         unsigned long   tx_bytes;               /* total bytes transmitted      */
 173         unsigned long   rx_errors;              /* bad packets received         */
 174         unsigned long   tx_errors;              /* packet transmit problems     */
 175         unsigned long   rx_dropped;             /* no space in linux buffers    */
 176         unsigned long   tx_dropped;             /* no space available in linux  */
 177         unsigned long   multicast;              /* multicast packets received   */
 178         unsigned long   collisions;
 179
 180         /* detailed rx_errors: */
 181         unsigned long   rx_length_errors;
 182         unsigned long   rx_over_errors;         /* receiver ring buff overflow  */
 183         unsigned long   rx_crc_errors;          /* recved pkt with crc error    */
 184         unsigned long   rx_frame_errors;        /* recv'd frame alignment error */
 185         unsigned long   rx_fifo_errors;         /* recv'r fifo overrun          */
 186         unsigned long   rx_missed_errors;       /* receiver missed packet       */
 187
 188         /* detailed tx_errors */
 189         unsigned long   tx_aborted_errors;
 190         unsigned long   tx_carrier_errors;
 191         unsigned long   tx_fifo_errors;
 192         unsigned long   tx_heartbeat_errors;
 193         unsigned long   tx_window_errors;
 194
 195         /* for cslip etc */
 196         unsigned long   rx_compressed;
 197         unsigned long   tx_compressed;
 198 };
 199
 200
 201 /* Media selection options. */
 202 enum {
 203         IF_PORT_UNKNOWN = 0,
 204         IF_PORT_10BASE2,
 205         IF_PORT_10BASET,
 206         IF_PORT_AUI,
 207         IF_PORT_100BASET,
 208         IF_PORT_100BASETX,
 209         IF_PORT_100BASEFX
 210 };
 211
 212 #ifdef __KERNEL__
 213
 214 #include <linux/cache.h>
 215 #include <linux/skbuff.h>
 216
 217 struct neighbour;
 218 struct neigh_parms;
 219 struct sk_buff;
 220
 221 struct netdev_hw_addr {
 222         struct list_head        list;
 223         unsigned char           addr[MAX_ADDR_LEN];
 224         unsigned char           type;
 225 #define NETDEV_HW_ADDR_T_LAN            1
 226 #define NETDEV_HW_ADDR_T_SAN            2
 227 #define NETDEV_HW_ADDR_T_SLAVE          3
 228 #define NETDEV_HW_ADDR_T_UNICAST        4
 229 #define NETDEV_HW_ADDR_T_MULTICAST      5
 230         int                     refcount;
 231         bool                    synced;
 232         bool                    global_use;
 233         struct rcu_head         rcu_head;
 234 };
 235
 236 struct netdev_hw_addr_list {
 237         struct list_head        list;
 238         int                     count;
 239 };
 240
 241 #define netdev_hw_addr_list_count(l) ((l)->count)
 242 #define netdev_hw_addr_list_empty(l) (netdev_hw_addr_list_count(l) == 0)
 243 #define netdev_hw_addr_list_for_each(ha, l) \
 244         list_for_each_entry(ha, &(l)->list, list)
 245
 246 #define netdev_uc_count(dev) netdev_hw_addr_list_count(&(dev)->uc)
 247 #define netdev_uc_empty(dev) netdev_hw_addr_list_empty(&(dev)->uc)
 248 #define netdev_for_each_uc_addr(ha, dev) \
 249         netdev_hw_addr_list_for_each(ha, &(dev)->uc)
 250
 251 #define netdev_mc_count(dev) netdev_hw_addr_list_count(&(dev)->mc)
 252 #define netdev_mc_empty(dev) netdev_hw_addr_list_empty(&(dev)->mc)
 253 #define netdev_for_each_mc_addr(ha, dev) \
 254         netdev_hw_addr_list_for_each(ha, &(dev)->mc)
 255
 256 struct hh_cache {
 257         struct hh_cache *hh_next;       /* Next entry                        */
 258         atomic_t        hh_refcnt;      /* number of users                   */
 259 /*
 260  * We want hh_output, hh_len, hh_lock and hh_data be a in a separate
 261  * cache line on SMP.
 262  * They are mostly read, but hh_refcnt may be changed quite frequently,
 263  * incurring cache line ping pongs.
 264  */
 265         __be16          hh_type ____cacheline_aligned_in_smp;
 266                                         /* protocol identifier, f.e ETH_P_IP
 267                                          *  NOTE:  For VLANs, this will be the
 268                                          *  encapuslated type. --BLG
 269                                          */
 270         u16             hh_len;         /* length of header */
 271         int             (*hh_output)(struct sk_buff *skb);
 272         seqlock_t       hh_lock;
 273
 274         /* cached hardware header; allow for machine alignment needs.        */
 275 #define HH_DATA_MOD     16
 276 #define HH_DATA_OFF(__len) \
 277         (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
 278 #define HH_DATA_ALIGN(__len) \
 279         (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
 280         unsigned long   hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
 281 };
 282
 283 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
 284  * Alternative is:
 285  *   dev->hard_header_len ? (dev->hard_header_len +
 286  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
 287  *
 288  * We could use other alignment values, but we must maintain the
 289  * relationship HH alignment <= LL alignment.
 290  *
 291  * LL_ALLOCATED_SPACE also takes into account the tailroom the device
 292  * may need.
 293  */
 294 #define LL_RESERVED_SPACE(dev) \
 295         ((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 296 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
 297         ((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 298 #define LL_ALLOCATED_SPACE(dev) \
 299         ((((dev)->hard_header_len+(dev)->needed_headroom+(dev)->needed_tailroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
 300
 301 struct header_ops {
 302         int     (*create) (struct sk_buff *skb, struct net_device *dev,
 303                            unsigned short type, const void *daddr,
 304                            const void *saddr, unsigned len);
 305         int     (*parse)(const struct sk_buff *skb, unsigned char *haddr);
 306         int     (*rebuild)(struct sk_buff *skb);
 307 #define HAVE_HEADER_CACHE
 308         int     (*cache)(const struct neighbour *neigh, struct hh_cache *hh);
 309         void    (*cache_update)(struct hh_cache *hh,
 310                                 const struct net_device *dev,
 311                                 const unsigned char *haddr);
 312 };
 313
 314 /* These flag bits are private to the generic network queueing
 315  * layer, they may not be explicitly referenced by any other
 316  * code.
 317  */
 318
 319 enum netdev_state_t {
 320         __LINK_STATE_START,
 321         __LINK_STATE_PRESENT,
 322         __LINK_STATE_NOCARRIER,
 323         __LINK_STATE_LINKWATCH_PENDING,
 324         __LINK_STATE_DORMANT,
 325 };
 326
 327
 328 /*
 329  * This structure holds at boot time configured netdevice settings. They
 330  * are then used in the device probing.
 331  */
 332 struct netdev_boot_setup {
 333         char name[IFNAMSIZ];
 334         struct ifmap map;
 335 };
 336 #define NETDEV_BOOT_SETUP_MAX 8
 337
 338 extern int __init netdev_boot_setup(char *str);
 339
 340 /*
 341  * Structure for NAPI scheduling similar to tasklet but with weighting
 342  */
 343 struct napi_struct {
 344         /* The poll_list must only be managed by the entity which
 345          * changes the state of the NAPI_STATE_SCHED bit.  This means
 346          * whoever atomically sets that bit can add this napi_struct
 347          * to the per-cpu poll_list, and whoever clears that bit
 348          * can remove from the list right before clearing the bit.
 349          */
 350         struct list_head        poll_list;
 351
 352         unsigned long           state;
 353         int                     weight;
 354         int                     (*poll)(struct napi_struct *, int);
 355 #ifdef CONFIG_NETPOLL
 356         spinlock_t              poll_lock;
 357         int                     poll_owner;
 358 #endif
 359
 360         unsigned int            gro_count;
 361
 362         struct net_device       *dev;
 363         struct list_head        dev_list;
 364         struct sk_buff          *gro_list;
 365         struct sk_buff          *skb;
 366 };
 367
 368 enum {
 369         NAPI_STATE_SCHED,       /* Poll is scheduled */
 370         NAPI_STATE_DISABLE,     /* Disable pending */
 371         NAPI_STATE_NPSVC,       /* Netpoll - don't dequeue from poll_list */
 372 };
 373
 374 enum gro_result {
 375         GRO_MERGED,
 376         GRO_MERGED_FREE,
 377         GRO_HELD,
 378         GRO_NORMAL,
 379         GRO_DROP,
 380 };
 381 typedef enum gro_result gro_result_t;
 382
 383 extern void __napi_schedule(struct napi_struct *n);
 384
 385 static inline int napi_disable_pending(struct napi_struct *n)
 386 {
 387         return test_bit(NAPI_STATE_DISABLE, &n->state);
 388 }
 389
 390 /**
 391  *      napi_schedule_prep - check if napi can be scheduled
 392  *      @n: napi context
 393  *
 394  * Test if NAPI routine is already running, and if not mark
 395  * it as running.  This is used as a condition variable
 396  * insure only one NAPI poll instance runs.  We also make
 397  * sure there is no pending NAPI disable.
 398  */
 399 static inline int napi_schedule_prep(struct napi_struct *n)
 400 {
 401         return !napi_disable_pending(n) &&
 402                 !test_and_set_bit(NAPI_STATE_SCHED, &n->state);
 403 }
 404
 405 /**
 406  *      napi_schedule - schedule NAPI poll
 407  *      @n: napi context
 408  *
 409  * Schedule NAPI poll routine to be called if it is not already
 410  * running.
 411  */
 412 static inline void napi_schedule(struct napi_struct *n)
 413 {
 414         if (napi_schedule_prep(n))
 415                 __napi_schedule(n);
 416 }
 417
 418 /* Try to reschedule poll. Called by dev->poll() after napi_complete().  */
 419 static inline int napi_reschedule(struct napi_struct *napi)
 420 {
 421         if (napi_schedule_prep(napi)) {
 422                 __napi_schedule(napi);
 423                 return 1;
 424         }
 425         return 0;
 426 }
 427
 428 /**
 429  *      napi_complete - NAPI processing complete
 430  *      @n: napi context
 431  *
 432  * Mark NAPI processing as complete.
 433  */
 434 extern void __napi_complete(struct napi_struct *n);
 435 extern void napi_complete(struct napi_struct *n);
 436
 437 /**
 438  *      napi_disable - prevent NAPI from scheduling
 439  *      @n: napi context
 440  *
 441  * Stop NAPI from being scheduled on this context.
 442  * Waits till any outstanding processing completes.
 443  */
 444 static inline void napi_disable(struct napi_struct *n)
 445 {
 446         set_bit(NAPI_STATE_DISABLE, &n->state);
 447         while (test_and_set_bit(NAPI_STATE_SCHED, &n->state))
 448                 msleep(1);
 449         clear_bit(NAPI_STATE_DISABLE, &n->state);
 450 }
 451
 452 /**
 453  *      napi_enable - enable NAPI scheduling
 454  *      @n: napi context
 455  *
 456  * Resume NAPI from being scheduled on this context.
 457  * Must be paired with napi_disable.
 458  */
 459 static inline void napi_enable(struct napi_struct *n)
 460 {
 461         BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
 462         smp_mb__before_clear_bit();
 463         clear_bit(NAPI_STATE_SCHED, &n->state);
 464 }
 465
 466 #ifdef CONFIG_SMP
 467 /**
 468  *      napi_synchronize - wait until NAPI is not running
 469  *      @n: napi context
 470  *
 471  * Wait until NAPI is done being scheduled on this context.
 472  * Waits till any outstanding processing completes but
 473  * does not disable future activations.
 474  */
 475 static inline void napi_synchronize(const struct napi_struct *n)
 476 {
 477         while (test_bit(NAPI_STATE_SCHED, &n->state))
 478                 msleep(1);
 479 }
 480 #else
 481 # define napi_synchronize(n)    barrier()
 482 #endif
 483
 484 enum netdev_queue_state_t {
 485         __QUEUE_STATE_XOFF,
 486         __QUEUE_STATE_FROZEN,
 487 };
 488
 489 struct netdev_queue {
 490 /*
 491  * read mostly part
 492  */
 493         struct net_device       *dev;
 494         struct Qdisc            *qdisc;
 495         unsigned long           state;
 496         struct Qdisc            *qdisc_sleeping;
 497 /*
 498  * write mostly part
 499  */
 500         spinlock_t              _xmit_lock ____cacheline_aligned_in_smp;
 501         int                     xmit_lock_owner;
 502         /*
 503          * please use this field instead of dev->trans_start
 504          */
 505         unsigned long           trans_start;
 506         unsigned long           tx_bytes;
 507         unsigned long           tx_packets;
 508         unsigned long           tx_dropped;
 509 } ____cacheline_aligned_in_smp;
 510
 511 #ifdef CONFIG_RPS
 512 /*
 513  * This structure holds an RPS map which can be of variable length.  The
 514  * map is an array of CPUs.
 515  */
 516 struct rps_map {
 517         unsigned int len;
 518         struct rcu_head rcu;
 519         u16 cpus[0];
 520 };
 521 #define RPS_MAP_SIZE(_num) (sizeof(struct rps_map) + (_num * sizeof(u16)))
 522
 523 /*
 524  * The rps_dev_flow structure contains the mapping of a flow to a CPU and the
 525  * tail pointer for that CPU's input queue at the time of last enqueue.
 526  */
 527 struct rps_dev_flow {
 528         u16 cpu;
 529         u16 fill;
 530         unsigned int last_qtail;
 531 };
 532
 533 /*
 534  * The rps_dev_flow_table structure contains a table of flow mappings.
 535  */
 536 struct rps_dev_flow_table {
 537         unsigned int mask;
 538         struct rcu_head rcu;
 539         struct work_struct free_work;
 540         struct rps_dev_flow flows[0];
 541 };
 542 #define RPS_DEV_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_dev_flow_table) + \
 543     (_num * sizeof(struct rps_dev_flow)))
 544
 545 /*
 546  * The rps_sock_flow_table contains mappings of flows to the last CPU
 547  * on which they were processed by the application (set in recvmsg).
 548  */
 549 struct rps_sock_flow_table {
 550         unsigned int mask;
 551         u16 ents[0];
 552 };
 553 #define RPS_SOCK_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_sock_flow_table) + \
 554     (_num * sizeof(u16)))
 555
 556 #define RPS_NO_CPU 0xffff
 557
 558 static inline void rps_record_sock_flow(struct rps_sock_flow_table *table,
 559                                         u32 hash)
 560 {
 561         if (table && hash) {
 562                 unsigned int cpu, index = hash & table->mask;
 563
 564                 /* We only give a hint, preemption can change cpu under us */
 565                 cpu = raw_smp_processor_id();
 566
 567                 if (table->ents[index] != cpu)
 568                         table->ents[index] = cpu;
 569         }
 570 }
 571
 572 static inline void rps_reset_sock_flow(struct rps_sock_flow_table *table,
 573                                        u32 hash)
 574 {
 575         if (table && hash)
 576                 table->ents[hash & table->mask] = RPS_NO_CPU;
 577 }
 578
 579 extern struct rps_sock_flow_table *rps_sock_flow_table;
 580
 581 /* This structure contains an instance of an RX queue. */
 582 struct netdev_rx_queue {
 583         struct rps_map *rps_map;
 584         struct rps_dev_flow_table *rps_flow_table;
 585         struct kobject kobj;
 586         struct netdev_rx_queue *first;
 587         atomic_t count;
 588 } ____cacheline_aligned_in_smp;
 589 #endif /* CONFIG_RPS */
 590
 591 /*
 592  * This structure defines the management hooks for network devices.
 593  * The following hooks can be defined; unless noted otherwise, they are
 594  * optional and can be filled with a null pointer.
 595  *
 596  * int (*ndo_init)(struct net_device *dev);
 597  *     This function is called once when network device is registered.
 598  *     The network device can use this to any late stage initializaton
 599  *     or semantic validattion. It can fail with an error code which will
 600  *     be propogated back to register_netdev
 601  *
 602  * void (*ndo_uninit)(struct net_device *dev);
 603  *     This function is called when device is unregistered or when registration
 604  *     fails. It is not called if init fails.
 605  *
 606  * int (*ndo_open)(struct net_device *dev);
 607  *     This function is called when network device transistions to the up
 608  *     state.
 609  *
 610  * int (*ndo_stop)(struct net_device *dev);
 611  *     This function is called when network device transistions to the down
 612  *     state.
 613  *
 614  * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
 615  *                               struct net_device *dev);
 616  *      Called when a packet needs to be transmitted.
 617  *      Must return NETDEV_TX_OK , NETDEV_TX_BUSY.
 618  *        (can also return NETDEV_TX_LOCKED iff NETIF_F_LLTX)
 619  *      Required can not be NULL.
 620  *
 621  * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb);
 622  *      Called to decide which queue to when device supports multiple
 623  *      transmit queues.
 624  *
 625  * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
 626  *      This function is called to allow device receiver to make
 627  *      changes to configuration when multicast or promiscious is enabled.
 628  *
 629  * void (*ndo_set_rx_mode)(struct net_device *dev);
 630  *      This function is called device changes address list filtering.
 631  *
 632  * void (*ndo_set_multicast_list)(struct net_device *dev);
 633  *      This function is called when the multicast address list changes.
 634  *
 635  * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
 636  *      This function  is called when the Media Access Control address
 637  *      needs to be changed. If this interface is not defined, the
 638  *      mac address can not be changed.
 639  *
 640  * int (*ndo_validate_addr)(struct net_device *dev);
 641  *      Test if Media Access Control address is valid for the device.
 642  *
 643  * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
 644  *      Called when a user request an ioctl which can't be handled by
 645  *      the generic interface code. If not defined ioctl's return
 646  *      not supported error code.
 647  *
 648  * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
 649  *      Used to set network devices bus interface parameters. This interface
 650  *      is retained for legacy reason, new devices should use the bus
 651  *      interface (PCI) for low level management.
 652  *
 653  * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
 654  *      Called when a user wants to change the Maximum Transfer Unit
 655  *      of a device. If not defined, any request to change MTU will
 656  *      will return an error.
 657  *
 658  * void (*ndo_tx_timeout)(struct net_device *dev);
 659  *      Callback uses when the transmitter has not made any progress
 660  *      for dev->watchdog ticks.
 661  *
 662  * struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
 663  *      Called when a user wants to get the network device usage
 664  *      statistics. If not defined, the counters in dev->stats will
 665  *      be used.
 666  *
 667  * void (*ndo_vlan_rx_register)(struct net_device *dev, struct vlan_group *grp);
 668  *      If device support VLAN receive accleration
 669  *      (ie. dev->features & NETIF_F_HW_VLAN_RX), then this function is called
 670  *      when vlan groups for the device changes.  Note: grp is NULL
 671  *      if no vlan's groups are being used.
 672  *
 673  * void (*ndo_vlan_rx_add_vid)(struct net_device *dev, unsigned short vid);
 674  *      If device support VLAN filtering (dev->features & NETIF_F_HW_VLAN_FILTER)
 675  *      this function is called when a VLAN id is registered.
 676  *
 677  * void (*ndo_vlan_rx_kill_vid)(struct net_device *dev, unsigned short vid);
 678  *      If device support VLAN filtering (dev->features & NETIF_F_HW_VLAN_FILTER)
 679  *      this function is called when a VLAN id is unregistered.
 680  *
 681  * void (*ndo_poll_controller)(struct net_device *dev);
 682  *
 683  *      SR-IOV management functions.
 684  * int (*ndo_set_vf_mac)(struct net_device *dev, int vf, u8* mac);
 685  * int (*ndo_set_vf_vlan)(struct net_device *dev, int vf, u16 vlan, u8 qos);
 686  * int (*ndo_set_vf_tx_rate)(struct net_device *dev, int vf, int rate);
 687  * int (*ndo_get_vf_config)(struct net_device *dev,
 688  *                          int vf, struct ifla_vf_info *ivf);
 689  */
 690 #define HAVE_NET_DEVICE_OPS
 691 struct net_device_ops {
 692         int                     (*ndo_init)(struct net_device *dev);
 693         void                    (*ndo_uninit)(struct net_device *dev);
 694         int                     (*ndo_open)(struct net_device *dev);
 695         int                     (*ndo_stop)(struct net_device *dev);
 696         netdev_tx_t             (*ndo_start_xmit) (struct sk_buff *skb,
 697                                                    struct net_device *dev);
 698         u16                     (*ndo_select_queue)(struct net_device *dev,
 699                                                     struct sk_buff *skb);
 700         void                    (*ndo_change_rx_flags)(struct net_device *dev,
 701                                                        int flags);
 702         void                    (*ndo_set_rx_mode)(struct net_device *dev);
 703         void                    (*ndo_set_multicast_list)(struct net_device *dev);
 704         int                     (*ndo_set_mac_address)(struct net_device *dev,
 705                                                        void *addr);
 706         int                     (*ndo_validate_addr)(struct net_device *dev);
 707         int                     (*ndo_do_ioctl)(struct net_device *dev,
 708                                                 struct ifreq *ifr, int cmd);
 709         int                     (*ndo_set_config)(struct net_device *dev,
 710                                                   struct ifmap *map);
 711         int                     (*ndo_change_mtu)(struct net_device *dev,
 712                                                   int new_mtu);
 713         int                     (*ndo_neigh_setup)(struct net_device *dev,
 714                                                    struct neigh_parms *);
 715         void                    (*ndo_tx_timeout) (struct net_device *dev);
 716
 717         struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
 718
 719         void                    (*ndo_vlan_rx_register)(struct net_device *dev,
 720                                                         struct vlan_group *grp);
 721         void                    (*ndo_vlan_rx_add_vid)(struct net_device *dev,
 722                                                        unsigned short vid);
 723         void                    (*ndo_vlan_rx_kill_vid)(struct net_device *dev,
 724                                                         unsigned short vid);
 725 #ifdef CONFIG_NET_POLL_CONTROLLER
 726         void                    (*ndo_poll_controller)(struct net_device *dev);
 727         void                    (*ndo_netpoll_cleanup)(struct net_device *dev);
 728 #endif
 729         int                     (*ndo_set_vf_mac)(struct net_device *dev,
 730                                                   int queue, u8 *mac);
 731         int                     (*ndo_set_vf_vlan)(struct net_device *dev,
 732                                                    int queue, u16 vlan, u8 qos);
 733         int                     (*ndo_set_vf_tx_rate)(struct net_device *dev,
 734                                                       int vf, int rate);
 735         int                     (*ndo_get_vf_config)(struct net_device *dev,
 736                                                      int vf,
 737                                                      struct ifla_vf_info *ivf);
 738 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
 739         int                     (*ndo_fcoe_enable)(struct net_device *dev);
 740         int                     (*ndo_fcoe_disable)(struct net_device *dev);
 741         int                     (*ndo_fcoe_ddp_setup)(struct net_device *dev,
 742                                                       u16 xid,
 743                                                       struct scatterlist *sgl,
 744                                                       unsigned int sgc);
 745         int                     (*ndo_fcoe_ddp_done)(struct net_device *dev,
 746                                                      u16 xid);
 747 #define NETDEV_FCOE_WWNN 0
 748 #define NETDEV_FCOE_WWPN 1
 749         int                     (*ndo_fcoe_get_wwn)(struct net_device *dev,
 750                                                     u64 *wwn, int type);
 751 #endif
 752 };
 753
 754 /*
 755  *      The DEVICE structure.
 756  *      Actually, this whole structure is a big mistake.  It mixes I/O
 757  *      data with strictly "high-level" data, and it has to know about
 758  *      almost every data structure used in the INET module.
 759  *
 760  *      FIXME: cleanup struct net_device such that network protocol info
 761  *      moves out.
 762  */
 763
 764 struct net_device {
 765
 766         /*
 767          * This is the first field of the "visible" part of this structure
 768          * (i.e. as seen by users in the "Space.c" file).  It is the name
 769          * the interface.
 770          */
 771         char                    name[IFNAMSIZ];
 772         /* device name hash chain */
 773         struct hlist_node       name_hlist;
 774         /* snmp alias */
 775         char                    *ifalias;
 776
 777         /*
 778          *      I/O specific fields
 779          *      FIXME: Merge these and struct ifmap into one
 780          */
 781         unsigned long           mem_end;        /* shared mem end       */
 782         unsigned long           mem_start;      /* shared mem start     */
 783         unsigned long           base_addr;      /* device I/O address   */
 784         unsigned int            irq;            /* device IRQ number    */
 785
 786         /*
 787          *      Some hardware also needs these fields, but they are not
 788          *      part of the usual set specified in Space.c.
 789          */
 790
 791         unsigned char           if_port;        /* Selectable AUI, TP,..*/
 792         unsigned char           dma;            /* DMA channel          */
 793
 794         unsigned long           state;
 795
 796         struct list_head        dev_list;
 797         struct list_head        napi_list;
 798         struct list_head        unreg_list;
 799
 800         /* Net device features */
 801         unsigned long           features;
 802 #define NETIF_F_SG              1       /* Scatter/gather IO. */
 803 #define NETIF_F_IP_CSUM         2       /* Can checksum TCP/UDP over IPv4. */
 804 #define NETIF_F_NO_CSUM         4       /* Does not require checksum. F.e. loopack. */
 805 #define NETIF_F_HW_CSUM         8       /* Can checksum all the packets. */
 806 #define NETIF_F_IPV6_CSUM       16      /* Can checksum TCP/UDP over IPV6 */
 807 #define NETIF_F_HIGHDMA         32      /* Can DMA to high memory. */
 808 #define NETIF_F_FRAGLIST        64      /* Scatter/gather IO. */
 809 #define NETIF_F_HW_VLAN_TX      128     /* Transmit VLAN hw acceleration */
 810 #define NETIF_F_HW_VLAN_RX      256     /* Receive VLAN hw acceleration */
 811 #define NETIF_F_HW_VLAN_FILTER  512     /* Receive filtering on VLAN */
 812 #define NETIF_F_VLAN_CHALLENGED 1024    /* Device cannot handle VLAN packets */
 813 #define NETIF_F_GSO             2048    /* Enable software GSO. */
 814 #define NETIF_F_LLTX            4096    /* LockLess TX - deprecated. Please */
 815                                         /* do not use LLTX in new drivers */
 816 #define NETIF_F_NETNS_LOCAL     8192    /* Does not change network namespaces */
 817 #define NETIF_F_GRO             16384   /* Generic receive offload */
 818 #define NETIF_F_LRO             32768   /* large receive offload */
 819
 820 /* the GSO_MASK reserves bits 16 through 23 */
 821 #define NETIF_F_FCOE_CRC        (1 << 24) /* FCoE CRC32 */
 822 #define NETIF_F_SCTP_CSUM       (1 << 25) /* SCTP checksum offload */
 823 #define NETIF_F_FCOE_MTU        (1 << 26) /* Supports max FCoE MTU, 2158 bytes*/
 824 #define NETIF_F_NTUPLE          (1 << 27) /* N-tuple filters supported */
 825 #define NETIF_F_RXHASH          (1 << 28) /* Receive hashing offload */
 826
 827         /* Segmentation offload features */
 828 #define NETIF_F_GSO_SHIFT       16
 829 #define NETIF_F_GSO_MASK        0x00ff0000
 830 #define NETIF_F_TSO             (SKB_GSO_TCPV4 << NETIF_F_GSO_SHIFT)
 831 #define NETIF_F_UFO             (SKB_GSO_UDP << NETIF_F_GSO_SHIFT)
 832 #define NETIF_F_GSO_ROBUST      (SKB_GSO_DODGY << NETIF_F_GSO_SHIFT)
 833 #define NETIF_F_TSO_ECN         (SKB_GSO_TCP_ECN << NETIF_F_GSO_SHIFT)
 834 #define NETIF_F_TSO6            (SKB_GSO_TCPV6 << NETIF_F_GSO_SHIFT)
 835 #define NETIF_F_FSO             (SKB_GSO_FCOE << NETIF_F_GSO_SHIFT)
 836
 837         /* List of features with software fallbacks. */
 838 #define NETIF_F_GSO_SOFTWARE    (NETIF_F_TSO | NETIF_F_TSO_ECN | NETIF_F_TSO6)
 839
 840
 841 #define NETIF_F_GEN_CSUM        (NETIF_F_NO_CSUM | NETIF_F_HW_CSUM)
 842 #define NETIF_F_V4_CSUM         (NETIF_F_GEN_CSUM | NETIF_F_IP_CSUM)
 843 #define NETIF_F_V6_CSUM         (NETIF_F_GEN_CSUM | NETIF_F_IPV6_CSUM)
 844 #define NETIF_F_ALL_CSUM        (NETIF_F_V4_CSUM | NETIF_F_V6_CSUM)
 845
 846         /*
 847          * If one device supports one of these features, then enable them
 848          * for all in netdev_increment_features.
 849          */
 850 #define NETIF_F_ONE_FOR_ALL     (NETIF_F_GSO_SOFTWARE | NETIF_F_GSO_ROBUST | \
 851                                  NETIF_F_SG | NETIF_F_HIGHDMA |         \
 852                                  NETIF_F_FRAGLIST)
 853
 854         /* Interface index. Unique device identifier    */
 855         int                     ifindex;
 856         int                     iflink;
 857
 858         struct net_device_stats stats;
 859
 860 #ifdef CONFIG_WIRELESS_EXT
 861         /* List of functions to handle Wireless Extensions (instead of ioctl).
 862          * See <net/iw_handler.h> for details. Jean II */
 863         const struct iw_handler_def *   wireless_handlers;
 864         /* Instance data managed by the core of Wireless Extensions. */
 865         struct iw_public_data * wireless_data;
 866 #endif
 867         /* Management operations */
 868         const struct net_device_ops *netdev_ops;
 869         const struct ethtool_ops *ethtool_ops;
 870
 871         /* Hardware header description */
 872         const struct header_ops *header_ops;
 873
 874         unsigned int            flags;  /* interface flags (a la BSD)   */
 875         unsigned short          gflags;
 876         unsigned short          priv_flags; /* Like 'flags' but invisible to userspace. */
 877         unsigned short          padded; /* How much padding added by alloc_netdev() */
 878
 879         unsigned char           operstate; /* RFC2863 operstate */
 880         unsigned char           link_mode; /* mapping policy to operstate */
 881
 882         unsigned int            mtu;    /* interface MTU value          */
 883         unsigned short          type;   /* interface hardware type      */
 884         unsigned short          hard_header_len;        /* hardware hdr length  */
 885
 886         /* extra head- and tailroom the hardware may need, but not in all cases
 887          * can this be guaranteed, especially tailroom. Some cases also use
 888          * LL_MAX_HEADER instead to allocate the skb.
 889          */
 890         unsigned short          needed_headroom;
 891         unsigned short          needed_tailroom;
 892
 893         struct net_device       *master; /* Pointer to master device of a group,
 894                                           * which this device is member of.
 895                                           */
 896
 897         /* Interface address info. */
 898         unsigned char           perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
 899         unsigned char           addr_len;       /* hardware address length      */
 900         unsigned short          dev_id;         /* for shared network cards */
 901
 902         spinlock_t              addr_list_lock;
 903         struct netdev_hw_addr_list      uc;     /* Unicast mac addresses */
 904         struct netdev_hw_addr_list      mc;     /* Multicast mac addresses */
 905         int                     uc_promisc;
 906         unsigned int            promiscuity;
 907         unsigned int            allmulti;
 908
 909
 910         /* Protocol specific pointers */
 911
 912 #ifdef CONFIG_NET_DSA
 913         void                    *dsa_ptr;       /* dsa specific data */
 914 #endif
 915         void                    *atalk_ptr;     /* AppleTalk link       */
 916         void                    *ip_ptr;        /* IPv4 specific data   */
 917         void                    *dn_ptr;        /* DECnet specific data */
 918         void                    *ip6_ptr;       /* IPv6 specific data */
 919         void                    *ec_ptr;        /* Econet specific data */
 920         void                    *ax25_ptr;      /* AX.25 specific data */
 921         struct wireless_dev     *ieee80211_ptr; /* IEEE 802.11 specific data,
 922                                                    assign before registering */
 923
 924 /*
 925  * Cache line mostly used on receive path (including eth_type_trans())
 926  */
 927         unsigned long           last_rx;        /* Time of last Rx      */
 928         /* Interface address info used in eth_type_trans() */
 929         unsigned char           *dev_addr;      /* hw address, (before bcast
 930                                                    because most packets are
 931                                                    unicast) */
 932
 933         struct netdev_hw_addr_list      dev_addrs; /* list of device
 934                                                       hw addresses */
 935
 936         unsigned char           broadcast[MAX_ADDR_LEN];        /* hw bcast add */
 937
 938 #ifdef CONFIG_RPS
 939         struct kset             *queues_kset;
 940
 941         struct netdev_rx_queue  *_rx;
 942
 943         /* Number of RX queues allocated at alloc_netdev_mq() time  */
 944         unsigned int            num_rx_queues;
 945 #endif
 946
 947         struct netdev_queue     rx_queue;
 948
 949         struct netdev_queue     *_tx ____cacheline_aligned_in_smp;
 950
 951         /* Number of TX queues allocated at alloc_netdev_mq() time  */
 952         unsigned int            num_tx_queues;
 953
 954         /* Number of TX queues currently active in device  */
 955         unsigned int            real_num_tx_queues;
 956
 957         /* root qdisc from userspace point of view */
 958         struct Qdisc            *qdisc;
 959
 960         unsigned long           tx_queue_len;   /* Max frames per queue allowed */
 961         spinlock_t              tx_global_lock;
 962 /*
 963  * One part is mostly used on xmit path (device)
 964  */
 965         /* These may be needed for future network-power-down code. */
 966
 967         /*
 968          * trans_start here is expensive for high speed devices on SMP,
 969          * please use netdev_queue->trans_start instead.
 970          */
 971         unsigned long           trans_start;    /* Time (in jiffies) of last Tx */
 972
 973         int                     watchdog_timeo; /* used by dev_watchdog() */
 974         struct timer_list       watchdog_timer;
 975
 976         /* Number of references to this device */
 977         atomic_t                refcnt ____cacheline_aligned_in_smp;
 978
 979         /* delayed register/unregister */
 980         struct list_head        todo_list;
 981         /* device index hash chain */
 982         struct hlist_node       index_hlist;
 983
 984         struct list_head        link_watch_list;
 985
 986         /* register/unregister state machine */
 987         enum { NETREG_UNINITIALIZED=0,
 988                NETREG_REGISTERED,       /* completed register_netdevice */
 989                NETREG_UNREGISTERING,    /* called unregister_netdevice */
 990                NETREG_UNREGISTERED,     /* completed unregister todo */
 991                NETREG_RELEASED,         /* called free_netdev */
 992                NETREG_DUMMY,            /* dummy device for NAPI poll */
 993         } reg_state:16;
 994
 995         enum {
 996                 RTNL_LINK_INITIALIZED,
 997                 RTNL_LINK_INITIALIZING,
 998         } rtnl_link_state:16;
 999
1000         /* Called from unregister, can be used to call free_netdev */
1001         void (*destructor)(struct net_device *dev);
1002
1003 #ifdef CONFIG_NETPOLL
1004         struct netpoll_info     *npinfo;
1005 #endif
1006
1007 #ifdef CONFIG_NET_NS
1008         /* Network namespace this network device is inside */
1009         struct net              *nd_net;
1010 #endif
1011
1012         /* mid-layer private */
1013         void                    *ml_priv;
1014
1015         /* bridge stuff */
1016         struct net_bridge_port  *br_port;
1017         /* macvlan */
1018         struct macvlan_port     *macvlan_port;
1019         /* GARP */
1020         struct garp_port        *garp_port;
1021
1022         /* class/net/name entry */
1023         struct device           dev;
1024         /* space for optional device, statistics, and wireless sysfs groups */
1025         const struct attribute_group *sysfs_groups[4];
1026
1027         /* rtnetlink link ops */
1028         const struct rtnl_link_ops *rtnl_link_ops;
1029
1030         /* VLAN feature mask */
1031         unsigned long vlan_features;
1032
1033         /* for setting kernel sock attribute on TCP connection setup */
1034 #define GSO_MAX_SIZE            65536
1035         unsigned int            gso_max_size;
1036
1037 #ifdef CONFIG_DCB
1038         /* Data Center Bridging netlink ops */
1039         const struct dcbnl_rtnl_ops *dcbnl_ops;
1040 #endif
1041
1042 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
1043         /* max exchange id for FCoE LRO by ddp */
1044         unsigned int            fcoe_ddp_xid;
1045 #endif
1046         /* n-tuple filter list attached to this device */
1047         struct ethtool_rx_ntuple_list ethtool_ntuple_list;
1048 };
1049 #define to_net_dev(d) container_of(d, struct net_device, dev)
1050
1051 #define NETDEV_ALIGN            32
1052
1053 static inline
1054 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
1055                                          unsigned int index)
1056 {
1057         return &dev->_tx[index];
1058 }
1059
1060 static inline void netdev_for_each_tx_queue(struct net_device *dev,
1061                                             void (*f)(struct net_device *,
1062                                                       struct netdev_queue *,
1063                                                       void *),
1064                                             void *arg)
1065 {
1066         unsigned int i;
1067
1068         for (i = 0; i < dev->num_tx_queues; i++)
1069                 f(dev, &dev->_tx[i], arg);
1070 }
1071
1072 /*
1073  * Net namespace inlines
1074  */
1075 static inline
1076 struct net *dev_net(const struct net_device *dev)
1077 {
1078 #ifdef CONFIG_NET_NS
1079         return dev->nd_net;
1080 #else
1081         return &init_net;
1082 #endif
1083 }
1084
1085 static inline
1086 void dev_net_set(struct net_device *dev, struct net *net)
1087 {
1088 #ifdef CONFIG_NET_NS
1089         release_net(dev->nd_net);
1090         dev->nd_net = hold_net(net);
1091 #endif
1092 }
1093
1094 static inline bool netdev_uses_dsa_tags(struct net_device *dev)
1095 {
1096 #ifdef CONFIG_NET_DSA_TAG_DSA
1097         if (dev->dsa_ptr != NULL)
1098                 return dsa_uses_dsa_tags(dev->dsa_ptr);
1099 #endif
1100
1101         return 0;
1102 }
1103
1104 #ifndef CONFIG_NET_NS
1105 static inline void skb_set_dev(struct sk_buff *skb, struct net_device *dev)
1106 {
1107         skb->dev = dev;
1108 }
1109 #else /* CONFIG_NET_NS */
1110 void skb_set_dev(struct sk_buff *skb, struct net_device *dev);
1111 #endif
1112
1113 static inline bool netdev_uses_trailer_tags(struct net_device *dev)
1114 {
1115 #ifdef CONFIG_NET_DSA_TAG_TRAILER
1116         if (dev->dsa_ptr != NULL)
1117                 return dsa_uses_trailer_tags(dev->dsa_ptr);
1118 #endif
1119
1120         return 0;
1121 }
1122
1123 /**
1124  *      netdev_priv - access network device private data
1125  *      @dev: network device
1126  *
1127  * Get network device private data
1128  */
1129 static inline void *netdev_priv(const struct net_device *dev)
1130 {
1131         return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
1132 }
1133
1134 /* Set the sysfs physical device reference for the network logical device
1135  * if set prior to registration will cause a symlink during initialization.
1136  */
1137 #define SET_NETDEV_DEV(net, pdev)       ((net)->dev.parent = (pdev))
1138
1139 /* Set the sysfs device type for the network logical device to allow
1140  * fin grained indentification of different network device types. For
1141  * example Ethernet, Wirelss LAN, Bluetooth, WiMAX etc.
1142  */
1143 #define SET_NETDEV_DEVTYPE(net, devtype)        ((net)->dev.type = (devtype))
1144
1145 /**
1146  *      netif_napi_add - initialize a napi context
1147  *      @dev:  network device
1148  *      @napi: napi context
1149  *      @poll: polling function
1150  *      @weight: default weight
1151  *
1152  * netif_napi_add() must be used to initialize a napi context prior to calling
1153  * *any* of the other napi related functions.
1154  */
1155 void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
1156                     int (*poll)(struct napi_struct *, int), int weight);
1157
1158 /**
1159  *  netif_napi_del - remove a napi context
1160  *  @napi: napi context
1161  *
1162  *  netif_napi_del() removes a napi context from the network device napi list
1163  */
1164 void netif_napi_del(struct napi_struct *napi);
1165
1166 struct napi_gro_cb {
1167         /* Virtual address of skb_shinfo(skb)->frags[0].page + offset. */
1168         void *frag0;
1169
1170         /* Length of frag0. */
1171         unsigned int frag0_len;
1172
1173         /* This indicates where we are processing relative to skb->data. */
1174         int data_offset;
1175
1176         /* This is non-zero if the packet may be of the same flow. */
1177         int same_flow;
1178
1179         /* This is non-zero if the packet cannot be merged with the new skb. */
1180         int flush;
1181
1182         /* Number of segments aggregated. */
1183         int count;
1184
1185         /* Free the skb? */
1186         int free;
1187 };
1188
1189 #define NAPI_GRO_CB(skb) ((struct napi_gro_cb *)(skb)->cb)
1190
1191 struct packet_type {
1192         __be16                  type;   /* This is really htons(ether_type). */
1193         struct net_device       *dev;   /* NULL is wildcarded here           */
1194         int                     (*func) (struct sk_buff *,
1195                                          struct net_device *,
1196                                          struct packet_type *,
1197                                          struct net_device *);
1198         struct sk_buff          *(*gso_segment)(struct sk_buff *skb,
1199                                                 int features);
1200         int                     (*gso_send_check)(struct sk_buff *skb);
1201         struct sk_buff          **(*gro_receive)(struct sk_buff **head,
1202                                                struct sk_buff *skb);
1203         int                     (*gro_complete)(struct sk_buff *skb);
1204         void                    *af_packet_priv;
1205         struct list_head        list;
1206 };
1207
1208 #include <linux/interrupt.h>
1209 #include <linux/notifier.h>
1210
1211 extern rwlock_t                         dev_base_lock;          /* Device list lock */
1212
1213
1214 #define for_each_netdev(net, d)         \
1215                 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
1216 #define for_each_netdev_reverse(net, d) \
1217                 list_for_each_entry_reverse(d, &(net)->dev_base_head, dev_list)
1218 #define for_each_netdev_rcu(net, d)             \
1219                 list_for_each_entry_rcu(d, &(net)->dev_base_head, dev_list)
1220 #define for_each_netdev_safe(net, d, n) \
1221                 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
1222 #define for_each_netdev_continue(net, d)                \
1223                 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
1224 #define for_each_netdev_continue_rcu(net, d)            \
1225         list_for_each_entry_continue_rcu(d, &(net)->dev_base_head, dev_list)
1226 #define net_device_entry(lh)    list_entry(lh, struct net_device, dev_list)
1227
1228 static inline struct net_device *next_net_device(struct net_device *dev)
1229 {
1230         struct list_head *lh;
1231         struct net *net;
1232
1233         net = dev_net(dev);
1234         lh = dev->dev_list.next;
1235         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
1236 }
1237
1238 static inline struct net_device *next_net_device_rcu(struct net_device *dev)
1239 {
1240         struct list_head *lh;
1241         struct net *net;
1242
1243         net = dev_net(dev);
1244         lh = rcu_dereference(dev->dev_list.next);
1245         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
1246 }
1247
1248 static inline struct net_device *first_net_device(struct net *net)
1249 {
1250         return list_empty(&net->dev_base_head) ? NULL :
1251                 net_device_entry(net->dev_base_head.next);
1252 }
1253
1254 extern int                      netdev_boot_setup_check(struct net_device *dev);
1255 extern unsigned long            netdev_boot_base(const char *prefix, int unit);
1256 extern struct net_device    *dev_getbyhwaddr(struct net *net, unsigned short type, char *hwaddr);
1257 extern struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
1258 extern struct net_device *__dev_getfirstbyhwtype(struct net *net, unsigned short type);
1259 extern void             dev_add_pack(struct packet_type *pt);
1260 extern void             dev_remove_pack(struct packet_type *pt);
1261 extern void             __dev_remove_pack(struct packet_type *pt);
1262
1263 extern struct net_device        *dev_get_by_flags(struct net *net, unsigned short flags,
1264                                                   unsigned short mask);
1265 extern struct net_device        *dev_get_by_name(struct net *net, const char *name);
1266 extern struct net_device        *dev_get_by_name_rcu(struct net *net, const char *name);
1267 extern struct net_device        *__dev_get_by_name(struct net *net, const char *name);
1268 extern int              dev_alloc_name(struct net_device *dev, const char *name);
1269 extern int              dev_open(struct net_device *dev);
1270 extern int              dev_close(struct net_device *dev);
1271 extern void             dev_disable_lro(struct net_device *dev);
1272 extern int              dev_queue_xmit(struct sk_buff *skb);
1273 extern int              register_netdevice(struct net_device *dev);
1274 extern void             unregister_netdevice_queue(struct net_device *dev,
1275                                                    struct list_head *head);
1276 extern void             unregister_netdevice_many(struct list_head *head);
1277 static inline void unregister_netdevice(struct net_device *dev)
1278 {
1279         unregister_netdevice_queue(dev, NULL);
1280 }
1281
1282 extern void             free_netdev(struct net_device *dev);
1283 extern void             synchronize_net(void);
1284 extern int              register_netdevice_notifier(struct notifier_block *nb);
1285 extern int              unregister_netdevice_notifier(struct notifier_block *nb);
1286 extern int              init_dummy_netdev(struct net_device *dev);
1287 extern void             netdev_resync_ops(struct net_device *dev);
1288
1289 extern int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
1290 extern struct net_device        *dev_get_by_index(struct net *net, int ifindex);
1291 extern struct net_device        *__dev_get_by_index(struct net *net, int ifindex);
1292 extern struct net_device        *dev_get_by_index_rcu(struct net *net, int ifindex);
1293 extern int              dev_restart(struct net_device *dev);
1294 #ifdef CONFIG_NETPOLL_TRAP
1295 extern int              netpoll_trap(void);
1296 #endif
1297 extern int             skb_gro_receive(struct sk_buff **head,
1298                                        struct sk_buff *skb);
1299 extern void            skb_gro_reset_offset(struct sk_buff *skb);
1300
1301 static inline unsigned int skb_gro_offset(const struct sk_buff *skb)
1302 {
1303         return NAPI_GRO_CB(skb)->data_offset;
1304 }
1305
1306 static inline unsigned int skb_gro_len(const struct sk_buff *skb)
1307 {
1308         return skb->len - NAPI_GRO_CB(skb)->data_offset;
1309 }
1310
1311 static inline void skb_gro_pull(struct sk_buff *skb, unsigned int len)
1312 {
1313         NAPI_GRO_CB(skb)->data_offset += len;
1314 }
1315
1316 static inline void *skb_gro_header_fast(struct sk_buff *skb,
1317                                         unsigned int offset)
1318 {
1319         return NAPI_GRO_CB(skb)->frag0 + offset;
1320 }
1321
1322 static inline int skb_gro_header_hard(struct sk_buff *skb, unsigned int hlen)
1323 {
1324         return NAPI_GRO_CB(skb)->frag0_len < hlen;
1325 }
1326
1327 static inline void *skb_gro_header_slow(struct sk_buff *skb, unsigned int hlen,
1328                                         unsigned int offset)
1329 {
1330         NAPI_GRO_CB(skb)->frag0 = NULL;
1331         NAPI_GRO_CB(skb)->frag0_len = 0;
1332         return pskb_may_pull(skb, hlen) ? skb->data + offset : NULL;
1333 }
1334
1335 static inline void *skb_gro_mac_header(struct sk_buff *skb)
1336 {
1337         return NAPI_GRO_CB(skb)->frag0 ?: skb_mac_header(skb);
1338 }
1339
1340 static inline void *skb_gro_network_header(struct sk_buff *skb)
1341 {
1342         return (NAPI_GRO_CB(skb)->frag0 ?: skb->data) +
1343                skb_network_offset(skb);
1344 }
1345
1346 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
1347                                   unsigned short type,
1348                                   const void *daddr, const void *saddr,
1349                                   unsigned len)
1350 {
1351         if (!dev->header_ops || !dev->header_ops->create)
1352                 return 0;
1353
1354         return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
1355 }
1356
1357 static inline int dev_parse_header(const struct sk_buff *skb,
1358                                    unsigned char *haddr)
1359 {
1360         const struct net_device *dev = skb->dev;
1361
1362         if (!dev->header_ops || !dev->header_ops->parse)
1363                 return 0;
1364         return dev->header_ops->parse(skb, haddr);
1365 }
1366
1367 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
1368 extern int              register_gifconf(unsigned int family, gifconf_func_t * gifconf);
1369 static inline int unregister_gifconf(unsigned int family)
1370 {
1371         return register_gifconf(family, NULL);
1372 }
1373
1374 /*
1375  * Incoming packets are placed on per-cpu queues
1376  */
1377 struct softnet_data {
1378         struct Qdisc            *output_queue;
1379         struct Qdisc            **output_queue_tailp;
1380         struct list_head        poll_list;
1381         struct sk_buff          *completion_queue;
1382         struct sk_buff_head     process_queue;
1383
1384         /* stats */
1385         unsigned int            processed;
1386         unsigned int            time_squeeze;
1387         unsigned int            cpu_collision;
1388         unsigned int            received_rps;
1389
1390 #ifdef CONFIG_RPS
1391         struct softnet_data     *rps_ipi_list;
1392
1393         /* Elements below can be accessed between CPUs for RPS */
1394         struct call_single_data csd ____cacheline_aligned_in_smp;
1395         struct softnet_data     *rps_ipi_next;
1396         unsigned int            cpu;
1397         unsigned int            input_queue_head;
1398 #endif
1399         unsigned                dropped;
1400         struct sk_buff_head     input_pkt_queue;
1401         struct napi_struct      backlog;
1402 };
1403
1404 static inline void input_queue_head_add(struct softnet_data *sd,
1405                                         unsigned int len)
1406 {
1407 #ifdef CONFIG_RPS
1408         sd->input_queue_head += len;
1409 #endif
1410 }
1411
1412 DECLARE_PER_CPU_ALIGNED(struct softnet_data, softnet_data);
1413
1414 #define HAVE_NETIF_QUEUE
1415
1416 extern void __netif_schedule(struct Qdisc *q);
1417
1418 static inline void netif_schedule_queue(struct netdev_queue *txq)
1419 {
1420         if (!test_bit(__QUEUE_STATE_XOFF, &txq->state))
1421                 __netif_schedule(txq->qdisc);
1422 }
1423
1424 static inline void netif_tx_schedule_all(struct net_device *dev)
1425 {
1426         unsigned int i;
1427
1428         for (i = 0; i < dev->num_tx_queues; i++)
1429                 netif_schedule_queue(netdev_get_tx_queue(dev, i));
1430 }
1431
1432 static inline void netif_tx_start_queue(struct netdev_queue *dev_queue)
1433 {
1434         clear_bit(__QUEUE_STATE_XOFF, &dev_queue->state);
1435 }
1436
1437 /**
1438  *      netif_start_queue - allow transmit
1439  *      @dev: network device
1440  *
1441  *      Allow upper layers to call the device hard_start_xmit routine.
1442  */
1443 static inline void netif_start_queue(struct net_device *dev)
1444 {
1445         netif_tx_start_queue(netdev_get_tx_queue(dev, 0));
1446 }
1447
1448 static inline void netif_tx_start_all_queues(struct net_device *dev)
1449 {
1450         unsigned int i;
1451
1452         for (i = 0; i < dev->num_tx_queues; i++) {
1453                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
1454                 netif_tx_start_queue(txq);
1455         }
1456 }
1457
1458 static inline void netif_tx_wake_queue(struct netdev_queue *dev_queue)
1459 {
1460 #ifdef CONFIG_NETPOLL_TRAP
1461         if (netpoll_trap()) {
1462                 netif_tx_start_queue(dev_queue);
1463                 return;
1464         }
1465 #endif
1466         if (test_and_clear_bit(__QUEUE_STATE_XOFF, &dev_queue->state))
1467                 __netif_schedule(dev_queue->qdisc);
1468 }
1469
1470 /**
1471  *      netif_wake_queue - restart transmit
1472  *      @dev: network device
1473  *
1474  *      Allow upper layers to call the device hard_start_xmit routine.
1475  *      Used for flow control when transmit resources are available.
1476  */
1477 static inline void netif_wake_queue(struct net_device *dev)
1478 {
1479         netif_tx_wake_queue(netdev_get_tx_queue(dev, 0));
1480 }
1481
1482 static inline void netif_tx_wake_all_queues(struct net_device *dev)
1483 {
1484         unsigned int i;
1485
1486         for (i = 0; i < dev->num_tx_queues; i++) {
1487                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
1488                 netif_tx_wake_queue(txq);
1489         }
1490 }
1491
1492 static inline void netif_tx_stop_queue(struct netdev_queue *dev_queue)
1493 {
1494         set_bit(__QUEUE_STATE_XOFF, &dev_queue->state);
1495 }
1496
1497 /**
1498  *      netif_stop_queue - stop transmitted packets
1499  *      @dev: network device
1500  *
1501  *      Stop upper layers calling the device hard_start_xmit routine.
1502  *      Used for flow control when transmit resources are unavailable.
1503  */
1504 static inline void netif_stop_queue(struct net_device *dev)
1505 {
1506         netif_tx_stop_queue(netdev_get_tx_queue(dev, 0));
1507 }
1508
1509 static inline void netif_tx_stop_all_queues(struct net_device *dev)
1510 {
1511         unsigned int i;
1512
1513         for (i = 0; i < dev->num_tx_queues; i++) {
1514                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
1515                 netif_tx_stop_queue(txq);
1516         }
1517 }
1518
1519 static inline int netif_tx_queue_stopped(const struct netdev_queue *dev_queue)
1520 {
1521         return test_bit(__QUEUE_STATE_XOFF, &dev_queue->state);
1522 }
1523
1524 /**
1525  *      netif_queue_stopped - test if transmit queue is flowblocked
1526  *      @dev: network device
1527  *
1528  *      Test if transmit queue on device is currently unable to send.
1529  */
1530 static inline int netif_queue_stopped(const struct net_device *dev)
1531 {
1532         return netif_tx_queue_stopped(netdev_get_tx_queue(dev, 0));
1533 }
1534
1535 static inline int netif_tx_queue_frozen(const struct netdev_queue *dev_queue)
1536 {
1537         return test_bit(__QUEUE_STATE_FROZEN, &dev_queue->state);
1538 }
1539
1540 /**
1541  *      netif_running - test if up
1542  *      @dev: network device
1543  *
1544  *      Test if the device has been brought up.
1545  */
1546 static inline int netif_running(const struct net_device *dev)
1547 {
1548         return test_bit(__LINK_STATE_START, &dev->state);
1549 }
1550
1551 /*
1552  * Routines to manage the subqueues on a device.  We only need start
1553  * stop, and a check if it's stopped.  All other device management is
1554  * done at the overall netdevice level.
1555  * Also test the device if we're multiqueue.
1556  */
1557
1558 /**
1559  *      netif_start_subqueue - allow sending packets on subqueue
1560  *      @dev: network device
1561  *      @queue_index: sub queue index
1562  *
1563  * Start individual transmit queue of a device with multiple transmit queues.
1564  */
1565 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
1566 {
1567         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
1568
1569         netif_tx_start_queue(txq);
1570 }
1571
1572 /**
1573  *      netif_stop_subqueue - stop sending packets on subqueue
1574  *      @dev: network device
1575  *      @queue_index: sub queue index
1576  *
1577  * Stop individual transmit queue of a device with multiple transmit queues.
1578  */
1579 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
1580 {
1581         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
1582 #ifdef CONFIG_NETPOLL_TRAP
1583         if (netpoll_trap())
1584                 return;
1585 #endif
1586         netif_tx_stop_queue(txq);
1587 }
1588
1589 /**
1590  *      netif_subqueue_stopped - test status of subqueue
1591  *      @dev: network device
1592  *      @queue_index: sub queue index
1593  *
1594  * Check individual transmit queue of a device with multiple transmit queues.
1595  */
1596 static inline int __netif_subqueue_stopped(const struct net_device *dev,
1597                                          u16 queue_index)
1598 {
1599         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
1600
1601         return netif_tx_queue_stopped(txq);
1602 }
1603
1604 static inline int netif_subqueue_stopped(const struct net_device *dev,
1605                                          struct sk_buff *skb)
1606 {
1607         return __netif_subqueue_stopped(dev, skb_get_queue_mapping(skb));
1608 }
1609
1610 /**
1611  *      netif_wake_subqueue - allow sending packets on subqueue
1612  *      @dev: network device
1613  *      @queue_index: sub queue index
1614  *
1615  * Resume individual transmit queue of a device with multiple transmit queues.
1616  */
1617 static inline void netif_wake_subqueue(struct net_device *dev, u16 queue_index)
1618 {
1619         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
1620 #ifdef CONFIG_NETPOLL_TRAP
1621         if (netpoll_trap())
1622                 return;
1623 #endif
1624         if (test_and_clear_bit(__QUEUE_STATE_XOFF, &txq->state))
1625                 __netif_schedule(txq->qdisc);
1626 }
1627
1628 /**
1629  *      netif_is_multiqueue - test if device has multiple transmit queues
1630  *      @dev: network device
1631  *
1632  * Check if device has multiple transmit queues
1633  */
1634 static inline int netif_is_multiqueue(const struct net_device *dev)
1635 {
1636         return (dev->num_tx_queues > 1);
1637 }
1638
1639 /* Use this variant when it is known for sure that it
1640  * is executing from hardware interrupt context or with hardware interrupts
1641  * disabled.
1642  */
1643 extern void dev_kfree_skb_irq(struct sk_buff *skb);
1644
1645 /* Use this variant in places where it could be invoked
1646  * from either hardware interrupt or other context, with hardware interrupts
1647  * either disabled or enabled.
1648  */
1649 extern void dev_kfree_skb_any(struct sk_buff *skb);
1650
1651 #define HAVE_NETIF_RX 1
1652 extern int              netif_rx(struct sk_buff *skb);
1653 extern int              netif_rx_ni(struct sk_buff *skb);
1654 #define HAVE_NETIF_RECEIVE_SKB 1
1655 extern int              netif_receive_skb(struct sk_buff *skb);
1656 extern gro_result_t     dev_gro_receive(struct napi_struct *napi,
1657                                         struct sk_buff *skb);
1658 extern gro_result_t     napi_skb_finish(gro_result_t ret, struct sk_buff *skb);
1659 extern gro_result_t     napi_gro_receive(struct napi_struct *napi,
1660                                          struct sk_buff *skb);
1661 extern void             napi_reuse_skb(struct napi_struct *napi,
1662                                        struct sk_buff *skb);
1663 extern struct sk_buff * napi_get_frags(struct napi_struct *napi);
1664 extern gro_result_t     napi_frags_finish(struct napi_struct *napi,
1665                                           struct sk_buff *skb,
1666                                           gro_result_t ret);
1667 extern struct sk_buff * napi_frags_skb(struct napi_struct *napi);
1668 extern gro_result_t     napi_gro_frags(struct napi_struct *napi);
1669
1670 static inline void napi_free_frags(struct napi_struct *napi)
1671 {
1672         kfree_skb(napi->skb);
1673         napi->skb = NULL;
1674 }
1675
1676 extern void             netif_nit_deliver(struct sk_buff *skb);
1677 extern int              dev_valid_name(const char *name);
1678 extern int              dev_ioctl(struct net *net, unsigned int cmd, void __user *);
1679 extern int              dev_ethtool(struct net *net, struct ifreq *);
1680 extern unsigned         dev_get_flags(const struct net_device *);
1681 extern int              __dev_change_flags(struct net_device *, unsigned int flags);
1682 extern int              dev_change_flags(struct net_device *, unsigned);
1683 extern void             __dev_notify_flags(struct net_device *, unsigned int old_flags);
1684 extern int              dev_change_name(struct net_device *, const char *);
1685 extern int              dev_set_alias(struct net_device *, const char *, size_t);
1686 extern int              dev_change_net_namespace(struct net_device *,
1687                                                  struct net *, const char *);
1688 extern int              dev_set_mtu(struct net_device *, int);
1689 extern int              dev_set_mac_address(struct net_device *,
1690                                             struct sockaddr *);
1691 extern int              dev_hard_start_xmit(struct sk_buff *skb,
1692                                             struct net_device *dev,
1693                                             struct netdev_queue *txq);
1694 extern int              dev_forward_skb(struct net_device *dev,
1695                                         struct sk_buff *skb);
1696
1697 extern int              netdev_budget;
1698
1699 /* Called by rtnetlink.c:rtnl_unlock() */
1700 extern void netdev_run_todo(void);
1701
1702 /**
1703  *      dev_put - release reference to device
1704  *      @dev: network device
1705  *
1706  * Release reference to device to allow it to be freed.
1707  */
1708 static inline void dev_put(struct net_device *dev)
1709 {
1710         atomic_dec(&dev->refcnt);
1711 }
1712
1713 /**
1714  *      dev_hold - get reference to device
1715  *      @dev: network device
1716  *
1717  * Hold reference to device to keep it from being freed.
1718  */
1719 static inline void dev_hold(struct net_device *dev)
1720 {
1721         atomic_inc(&dev->refcnt);
1722 }
1723
1724 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
1725  * and _off may be called from IRQ context, but it is caller
1726  * who is responsible for serialization of these calls.
1727  *
1728  * The name carrier is inappropriate, these functions should really be
1729  * called netif_lowerlayer_*() because they represent the state of any
1730  * kind of lower layer not just hardware media.
1731  */
1732
1733 extern void linkwatch_fire_event(struct net_device *dev);
1734 extern void linkwatch_forget_dev(struct net_device *dev);
1735
1736 /**
1737  *      netif_carrier_ok - test if carrier present
1738  *      @dev: network device
1739  *
1740  * Check if carrier is present on device
1741  */
1742 static inline int netif_carrier_ok(const struct net_device *dev)
1743 {
1744         return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
1745 }
1746
1747 extern unsigned long dev_trans_start(struct net_device *dev);
1748
1749 extern void __netdev_watchdog_up(struct net_device *dev);
1750
1751 extern void netif_carrier_on(struct net_device *dev);
1752
1753 extern void netif_carrier_off(struct net_device *dev);
1754
1755 /**
1756  *      netif_dormant_on - mark device as dormant.
1757  *      @dev: network device
1758  *
1759  * Mark device as dormant (as per RFC2863).
1760  *
1761  * The dormant state indicates that the relevant interface is not
1762  * actually in a condition to pass packets (i.e., it is not 'up') but is
1763  * in a "pending" state, waiting for some external event.  For "on-
1764  * demand" interfaces, this new state identifies the situation where the
1765  * interface is waiting for events to place it in the up state.
1766  *
1767  */
1768 static inline void netif_dormant_on(struct net_device *dev)
1769 {
1770         if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
1771                 linkwatch_fire_event(dev);
1772 }
1773
1774 /**
1775  *      netif_dormant_off - set device as not dormant.
1776  *      @dev: network device
1777  *
1778  * Device is not in dormant state.
1779  */
1780 static inline void netif_dormant_off(struct net_device *dev)
1781 {
1782         if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
1783                 linkwatch_fire_event(dev);
1784 }
1785
1786 /**
1787  *      netif_dormant - test if carrier present
1788  *      @dev: network device
1789  *
1790  * Check if carrier is present on device
1791  */
1792 static inline int netif_dormant(const struct net_device *dev)
1793 {
1794         return test_bit(__LINK_STATE_DORMANT, &dev->state);
1795 }
1796
1797
1798 /**
1799  *      netif_oper_up - test if device is operational
1800  *      @dev: network device
1801  *
1802  * Check if carrier is operational
1803  */
1804 static inline int netif_oper_up(const struct net_device *dev)
1805 {
1806         return (dev->operstate == IF_OPER_UP ||
1807                 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
1808 }
1809
1810 /**
1811  *      netif_device_present - is device available or removed
1812  *      @dev: network device
1813  *
1814  * Check if device has not been removed from system.
1815  */
1816 static inline int netif_device_present(struct net_device *dev)
1817 {
1818         return test_bit(__LINK_STATE_PRESENT, &dev->state);
1819 }
1820
1821 extern void netif_device_detach(struct net_device *dev);
1822
1823 extern void netif_device_attach(struct net_device *dev);
1824
1825 /*
1826  * Network interface message level settings
1827  */
1828 #define HAVE_NETIF_MSG 1
1829
1830 enum {
1831         NETIF_MSG_DRV           = 0x0001,
1832         NETIF_MSG_PROBE         = 0x0002,
1833         NETIF_MSG_LINK          = 0x0004,
1834         NETIF_MSG_TIMER         = 0x0008,
1835         NETIF_MSG_IFDOWN        = 0x0010,
1836         NETIF_MSG_IFUP          = 0x0020,
1837         NETIF_MSG_RX_ERR        = 0x0040,
1838         NETIF_MSG_TX_ERR        = 0x0080,
1839         NETIF_MSG_TX_QUEUED     = 0x0100,
1840         NETIF_MSG_INTR          = 0x0200,
1841         NETIF_MSG_TX_DONE       = 0x0400,
1842         NETIF_MSG_RX_STATUS     = 0x0800,
1843         NETIF_MSG_PKTDATA       = 0x1000,
1844         NETIF_MSG_HW            = 0x2000,
1845         NETIF_MSG_WOL           = 0x4000,
1846 };
1847
1848 #define netif_msg_drv(p)        ((p)->msg_enable & NETIF_MSG_DRV)
1849 #define netif_msg_probe(p)      ((p)->msg_enable & NETIF_MSG_PROBE)
1850 #define netif_msg_link(p)       ((p)->msg_enable & NETIF_MSG_LINK)
1851 #define netif_msg_timer(p)      ((p)->msg_enable & NETIF_MSG_TIMER)
1852 #define netif_msg_ifdown(p)     ((p)->msg_enable & NETIF_MSG_IFDOWN)
1853 #define netif_msg_ifup(p)       ((p)->msg_enable & NETIF_MSG_IFUP)
1854 #define netif_msg_rx_err(p)     ((p)->msg_enable & NETIF_MSG_RX_ERR)
1855 #define netif_msg_tx_err(p)     ((p)->msg_enable & NETIF_MSG_TX_ERR)
1856 #define netif_msg_tx_queued(p)  ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
1857 #define netif_msg_intr(p)       ((p)->msg_enable & NETIF_MSG_INTR)
1858 #define netif_msg_tx_done(p)    ((p)->msg_enable & NETIF_MSG_TX_DONE)
1859 #define netif_msg_rx_status(p)  ((p)->msg_enable & NETIF_MSG_RX_STATUS)
1860 #define netif_msg_pktdata(p)    ((p)->msg_enable & NETIF_MSG_PKTDATA)
1861 #define netif_msg_hw(p)         ((p)->msg_enable & NETIF_MSG_HW)
1862 #define netif_msg_wol(p)        ((p)->msg_enable & NETIF_MSG_WOL)
1863
1864 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
1865 {
1866         /* use default */
1867         if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
1868                 return default_msg_enable_bits;
1869         if (debug_value == 0)   /* no output */
1870                 return 0;
1871         /* set low N bits */
1872         return (1 << debug_value) - 1;
1873 }
1874
1875 static inline void __netif_tx_lock(struct netdev_queue *txq, int cpu)
1876 {
1877         spin_lock(&txq->_xmit_lock);
1878         txq->xmit_lock_owner = cpu;
1879 }
1880
1881 static inline void __netif_tx_lock_bh(struct netdev_queue *txq)
1882 {
1883         spin_lock_bh(&txq->_xmit_lock);
1884         txq->xmit_lock_owner = smp_processor_id();
1885 }
1886
1887 static inline int __netif_tx_trylock(struct netdev_queue *txq)
1888 {
1889         int ok = spin_trylock(&txq->_xmit_lock);
1890         if (likely(ok))
1891                 txq->xmit_lock_owner = smp_processor_id();
1892         return ok;
1893 }
1894
1895 static inline void __netif_tx_unlock(struct netdev_queue *txq)
1896 {
1897         txq->xmit_lock_owner = -1;
1898         spin_unlock(&txq->_xmit_lock);
1899 }
1900
1901 static inline void __netif_tx_unlock_bh(struct netdev_queue *txq)
1902 {
1903         txq->xmit_lock_owner = -1;
1904         spin_unlock_bh(&txq->_xmit_lock);
1905 }
1906
1907 static inline void txq_trans_update(struct netdev_queue *txq)
1908 {
1909         if (txq->xmit_lock_owner != -1)
1910                 txq->trans_start = jiffies;
1911 }
1912
1913 /**
1914  *      netif_tx_lock - grab network device transmit lock
1915  *      @dev: network device
1916  *
1917  * Get network device transmit lock
1918  */
1919 static inline void netif_tx_lock(struct net_device *dev)
1920 {
1921         unsigned int i;
1922         int cpu;
1923
1924         spin_lock(&dev->tx_global_lock);
1925         cpu = smp_processor_id();
1926         for (i = 0; i < dev->num_tx_queues; i++) {
1927                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
1928
1929                 /* We are the only thread of execution doing a
1930                  * freeze, but we have to grab the _xmit_lock in
1931                  * order to synchronize with threads which are in
1932                  * the ->hard_start_xmit() handler and already
1933                  * checked the frozen bit.
1934                  */
1935                 __netif_tx_lock(txq, cpu);
1936                 set_bit(__QUEUE_STATE_FROZEN, &txq->state);
1937                 __netif_tx_unlock(txq);
1938         }
1939 }
1940
1941 static inline void netif_tx_lock_bh(struct net_device *dev)
1942 {
1943         local_bh_disable();
1944         netif_tx_lock(dev);
1945 }
1946
1947 static inline void netif_tx_unlock(struct net_device *dev)
1948 {
1949         unsigned int i;
1950
1951         for (i = 0; i < dev->num_tx_queues; i++) {
1952                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
1953
1954                 /* No need to grab the _xmit_lock here.  If the
1955                  * queue is not stopped for another reason, we
1956                  * force a schedule.
1957                  */
1958                 clear_bit(__QUEUE_STATE_FROZEN, &txq->state);
1959                 netif_schedule_queue(txq);
1960         }
1961         spin_unlock(&dev->tx_global_lock);
1962 }
1963
1964 static inline void netif_tx_unlock_bh(struct net_device *dev)
1965 {
1966         netif_tx_unlock(dev);
1967         local_bh_enable();
1968 }
1969
1970 #define HARD_TX_LOCK(dev, txq, cpu) {                   \
1971         if ((dev->features & NETIF_F_LLTX) == 0) {      \
1972                 __netif_tx_lock(txq, cpu);              \
1973         }                                               \
1974 }
1975
1976 #define HARD_TX_UNLOCK(dev, txq) {                      \
1977         if ((dev->features & NETIF_F_LLTX) == 0) {      \
1978                 __netif_tx_unlock(txq);                 \
1979         }                                               \
1980 }
1981
1982 static inline void netif_tx_disable(struct net_device *dev)
1983 {
1984         unsigned int i;
1985         int cpu;
1986
1987         local_bh_disable();
1988         cpu = smp_processor_id();
1989         for (i = 0; i < dev->num_tx_queues; i++) {
1990                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
1991
1992                 __netif_tx_lock(txq, cpu);
1993                 netif_tx_stop_queue(txq);
1994                 __netif_tx_unlock(txq);
1995         }
1996         local_bh_enable();
1997 }
1998
1999 static inline void netif_addr_lock(struct net_device *dev)
2000 {
2001         spin_lock(&dev->addr_list_lock);
2002 }
2003
2004 static inline void netif_addr_lock_bh(struct net_device *dev)
2005 {
2006         spin_lock_bh(&dev->addr_list_lock);
2007 }
2008
2009 static inline void netif_addr_unlock(struct net_device *dev)
2010 {
2011         spin_unlock(&dev->addr_list_lock);
2012 }
2013
2014 static inline void netif_addr_unlock_bh(struct net_device *dev)
2015 {
2016         spin_unlock_bh(&dev->addr_list_lock);
2017 }
2018
2019 /*
2020  * dev_addrs walker. Should be used only for read access. Call with
2021  * rcu_read_lock held.
2022  */
2023 #define for_each_dev_addr(dev, ha) \
2024                 list_for_each_entry_rcu(ha, &dev->dev_addrs.list, list)
2025
2026 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
2027
2028 extern void             ether_setup(struct net_device *dev);
2029
2030 /* Support for loadable net-drivers */
2031 extern struct net_device *alloc_netdev_mq(int sizeof_priv, const char *name,
2032                                        void (*setup)(struct net_device *),
2033                                        unsigned int queue_count);
2034 #define alloc_netdev(sizeof_priv, name, setup) \
2035         alloc_netdev_mq(sizeof_priv, name, setup, 1)
2036 extern int              register_netdev(struct net_device *dev);
2037 extern void             unregister_netdev(struct net_device *dev);
2038
2039 /* General hardware address lists handling functions */
2040 extern int __hw_addr_add_multiple(struct netdev_hw_addr_list *to_list,
2041                                   struct netdev_hw_addr_list *from_list,
2042                                   int addr_len, unsigned char addr_type);
2043 extern void __hw_addr_del_multiple(struct netdev_hw_addr_list *to_list,
2044                                    struct netdev_hw_addr_list *from_list,
2045                                    int addr_len, unsigned char addr_type);
2046 extern int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
2047                           struct netdev_hw_addr_list *from_list,
2048                           int addr_len);
2049 extern void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
2050                              struct netdev_hw_addr_list *from_list,
2051                              int addr_len);
2052 extern void __hw_addr_flush(struct netdev_hw_addr_list *list);
2053 extern void __hw_addr_init(struct netdev_hw_addr_list *list);
2054
2055 /* Functions used for device addresses handling */
2056 extern int dev_addr_add(struct net_device *dev, unsigned char *addr,
2057                         unsigned char addr_type);
2058 extern int dev_addr_del(struct net_device *dev, unsigned char *addr,
2059                         unsigned char addr_type);
2060 extern int dev_addr_add_multiple(struct net_device *to_dev,
2061                                  struct net_device *from_dev,
2062                                  unsigned char addr_type);
2063 extern int dev_addr_del_multiple(struct net_device *to_dev,
2064                                  struct net_device *from_dev,
2065                                  unsigned char addr_type);
2066 extern void dev_addr_flush(struct net_device *dev);
2067 extern int dev_addr_init(struct net_device *dev);
2068
2069 /* Functions used for unicast addresses handling */
2070 extern int dev_uc_add(struct net_device *dev, unsigned char *addr);
2071 extern int dev_uc_del(struct net_device *dev, unsigned char *addr);
2072 extern int dev_uc_sync(struct net_device *to, struct net_device *from);
2073 extern void dev_uc_unsync(struct net_device *to, struct net_device *from);
2074 extern void dev_uc_flush(struct net_device *dev);
2075 extern void dev_uc_init(struct net_device *dev);
2076
2077 /* Functions used for multicast addresses handling */
2078 extern int dev_mc_add(struct net_device *dev, unsigned char *addr);
2079 extern int dev_mc_add_global(struct net_device *dev, unsigned char *addr);
2080 extern int dev_mc_del(struct net_device *dev, unsigned char *addr);
2081 extern int dev_mc_del_global(struct net_device *dev, unsigned char *addr);
2082 extern int dev_mc_sync(struct net_device *to, struct net_device *from);
2083 extern void dev_mc_unsync(struct net_device *to, struct net_device *from);
2084 extern void dev_mc_flush(struct net_device *dev);
2085 extern void dev_mc_init(struct net_device *dev);
2086
2087 /* Functions used for secondary unicast and multicast support */
2088 extern void             dev_set_rx_mode(struct net_device *dev);
2089 extern void             __dev_set_rx_mode(struct net_device *dev);
2090 extern int              dev_set_promiscuity(struct net_device *dev, int inc);
2091 extern int              dev_set_allmulti(struct net_device *dev, int inc);
2092 extern void             netdev_state_change(struct net_device *dev);
2093 extern int              netdev_bonding_change(struct net_device *dev,
2094                                               unsigned long event);
2095 extern void             netdev_features_change(struct net_device *dev);
2096 /* Load a device via the kmod */
2097 extern void             dev_load(struct net *net, const char *name);
2098 extern void             dev_mcast_init(void);
2099 extern const struct net_device_stats *dev_get_stats(struct net_device *dev);
2100 extern void             dev_txq_stats_fold(const struct net_device *dev, struct net_device_stats *stats);
2101
2102 extern int              netdev_max_backlog;
2103 extern int              netdev_tstamp_prequeue;
2104 extern int              weight_p;
2105 extern int              netdev_set_master(struct net_device *dev, struct net_device *master);
2106 extern int skb_checksum_help(struct sk_buff *skb);
2107 extern struct sk_buff *skb_gso_segment(struct sk_buff *skb, int features);
2108 #ifdef CONFIG_BUG
2109 extern void netdev_rx_csum_fault(struct net_device *dev);
2110 #else
2111 static inline void netdev_rx_csum_fault(struct net_device *dev)
2112 {
2113 }
2114 #endif
2115 /* rx skb timestamps */
2116 extern void             net_enable_timestamp(void);
2117 extern void             net_disable_timestamp(void);
2118
2119 #ifdef CONFIG_PROC_FS
2120 extern void *dev_seq_start(struct seq_file *seq, loff_t *pos);
2121 extern void *dev_seq_next(struct seq_file *seq, void *v, loff_t *pos);
2122 extern void dev_seq_stop(struct seq_file *seq, void *v);
2123 #endif
2124
2125 extern int netdev_class_create_file(struct class_attribute *class_attr);
2126 extern void netdev_class_remove_file(struct class_attribute *class_attr);
2127
2128 extern char *netdev_drivername(const struct net_device *dev, char *buffer, int len);
2129
2130 extern void linkwatch_run_queue(void);
2131
2132 unsigned long netdev_increment_features(unsigned long all, unsigned long one,
2133                                         unsigned long mask);
2134 unsigned long netdev_fix_features(unsigned long features, const char *name);
2135
2136 void netif_stacked_transfer_operstate(const struct net_device *rootdev,
2137                                         struct net_device *dev);
2138
2139 static inline int net_gso_ok(int features, int gso_type)
2140 {
2141         int feature = gso_type << NETIF_F_GSO_SHIFT;
2142         return (features & feature) == feature;
2143 }
2144
2145 static inline int skb_gso_ok(struct sk_buff *skb, int features)
2146 {
2147         return net_gso_ok(features, skb_shinfo(skb)->gso_type) &&
2148                (!skb_has_frags(skb) || (features & NETIF_F_FRAGLIST));
2149 }
2150
2151 static inline int netif_needs_gso(struct net_device *dev, struct sk_buff *skb)
2152 {
2153         return skb_is_gso(skb) &&
2154                (!skb_gso_ok(skb, dev->features) ||
2155                 unlikely(skb->ip_summed != CHECKSUM_PARTIAL));
2156 }
2157
2158 static inline void netif_set_gso_max_size(struct net_device *dev,
2159                                           unsigned int size)
2160 {
2161         dev->gso_max_size = size;
2162 }
2163
2164 extern int __skb_bond_should_drop(struct sk_buff *skb,
2165                                   struct net_device *master);
2166
2167 static inline int skb_bond_should_drop(struct sk_buff *skb,
2168                                        struct net_device *master)
2169 {
2170         if (master)
2171                 return __skb_bond_should_drop(skb, master);
2172         return 0;
2173 }
2174
2175 extern struct pernet_operations __net_initdata loopback_net_ops;
2176
2177 static inline int dev_ethtool_get_settings(struct net_device *dev,
2178                                            struct ethtool_cmd *cmd)
2179 {
2180         if (!dev->ethtool_ops || !dev->ethtool_ops->get_settings)
2181                 return -EOPNOTSUPP;
2182         return dev->ethtool_ops->get_settings(dev, cmd);
2183 }
2184
2185 static inline u32 dev_ethtool_get_rx_csum(struct net_device *dev)
2186 {
2187         if (!dev->ethtool_ops || !dev->ethtool_ops->get_rx_csum)
2188                 return 0;
2189         return dev->ethtool_ops->get_rx_csum(dev);
2190 }
2191
2192 static inline u32 dev_ethtool_get_flags(struct net_device *dev)
2193 {
2194         if (!dev->ethtool_ops || !dev->ethtool_ops->get_flags)
2195                 return 0;
2196         return dev->ethtool_ops->get_flags(dev);
2197 }
2198
2199 /* Logging, debugging and troubleshooting/diagnostic helpers. */
2200
2201 /* netdev_printk helpers, similar to dev_printk */
2202
2203 static inline const char *netdev_name(const struct net_device *dev)
2204 {
2205         if (dev->reg_state != NETREG_REGISTERED)
2206                 return "(unregistered net_device)";
2207         return dev->name;
2208 }
2209
2210 #define netdev_printk(level, netdev, format, args...)           \
2211         dev_printk(level, (netdev)->dev.parent,                 \
2212                    "%s: " format,                               \
2213                    netdev_name(netdev), ##args)
2214
2215 #define netdev_emerg(dev, format, args...)                      \
2216         netdev_printk(KERN_EMERG, dev, format, ##args)
2217 #define netdev_alert(dev, format, args...)                      \
2218         netdev_printk(KERN_ALERT, dev, format, ##args)
2219 #define netdev_crit(dev, format, args...)                       \
2220         netdev_printk(KERN_CRIT, dev, format, ##args)
2221 #define netdev_err(dev, format, args...)                        \
2222         netdev_printk(KERN_ERR, dev, format, ##args)
2223 #define netdev_warn(dev, format, args...)                       \
2224         netdev_printk(KERN_WARNING, dev, format, ##args)
2225 #define netdev_notice(dev, format, args...)                     \
2226         netdev_printk(KERN_NOTICE, dev, format, ##args)
2227 #define netdev_info(dev, format, args...)                       \
2228         netdev_printk(KERN_INFO, dev, format, ##args)
2229
2230 #if defined(DEBUG)
2231 #define netdev_dbg(__dev, format, args...)                      \
2232         netdev_printk(KERN_DEBUG, __dev, format, ##args)
2233 #elif defined(CONFIG_DYNAMIC_DEBUG)
2234 #define netdev_dbg(__dev, format, args...)                      \
2235 do {                                                            \
2236         dynamic_dev_dbg((__dev)->dev.parent, "%s: " format,     \
2237                         netdev_name(__dev), ##args);            \
2238 } while (0)
2239 #else
2240 #define netdev_dbg(__dev, format, args...)                      \
2241 ({                                                              \
2242         if (0)                                                  \
2243                 netdev_printk(KERN_DEBUG, __dev, format, ##args); \
2244         0;                                                      \
2245 })
2246 #endif
2247
2248 #if defined(VERBOSE_DEBUG)
2249 #define netdev_vdbg     netdev_dbg
2250 #else
2251
2252 #define netdev_vdbg(dev, format, args...)                       \
2253 ({                                                              \
2254         if (0)                                                  \
2255                 netdev_printk(KERN_DEBUG, dev, format, ##args); \
2256         0;                                                      \
2257 })
2258 #endif
2259
2260 /*
2261  * netdev_WARN() acts like dev_printk(), but with the key difference
2262  * of using a WARN/WARN_ON to get the message out, including the
2263  * file/line information and a backtrace.
2264  */
2265 #define netdev_WARN(dev, format, args...)                       \
2266         WARN(1, "netdevice: %s\n" format, netdev_name(dev), ##args);
2267
2268 /* netif printk helpers, similar to netdev_printk */
2269
2270 #define netif_printk(priv, type, level, dev, fmt, args...)      \
2271 do {                                                            \
2272         if (netif_msg_##type(priv))                             \
2273                 netdev_printk(level, (dev), fmt, ##args);       \
2274 } while (0)
2275
2276 #define netif_emerg(priv, type, dev, fmt, args...)              \
2277         netif_printk(priv, type, KERN_EMERG, dev, fmt, ##args)
2278 #define netif_alert(priv, type, dev, fmt, args...)              \
2279         netif_printk(priv, type, KERN_ALERT, dev, fmt, ##args)
2280 #define netif_crit(priv, type, dev, fmt, args...)               \
2281         netif_printk(priv, type, KERN_CRIT, dev, fmt, ##args)
2282 #define netif_err(priv, type, dev, fmt, args...)                \
2283         netif_printk(priv, type, KERN_ERR, dev, fmt, ##args)
2284 #define netif_warn(priv, type, dev, fmt, args...)               \
2285         netif_printk(priv, type, KERN_WARNING, dev, fmt, ##args)
2286 #define netif_notice(priv, type, dev, fmt, args...)             \
2287         netif_printk(priv, type, KERN_NOTICE, dev, fmt, ##args)
2288 #define netif_info(priv, type, dev, fmt, args...)               \
2289         netif_printk(priv, type, KERN_INFO, (dev), fmt, ##args)
2290
2291 #if defined(DEBUG)
2292 #define netif_dbg(priv, type, dev, format, args...)             \
2293         netif_printk(priv, type, KERN_DEBUG, dev, format, ##args)
2294 #elif defined(CONFIG_DYNAMIC_DEBUG)
2295 #define netif_dbg(priv, type, netdev, format, args...)          \
2296 do {                                                            \
2297         if (netif_msg_##type(priv))                             \
2298                 dynamic_dev_dbg((netdev)->dev.parent,           \
2299                                 "%s: " format,                  \
2300                                 netdev_name(netdev), ##args);   \
2301 } while (0)
2302 #else
2303 #define netif_dbg(priv, type, dev, format, args...)                     \
2304 ({                                                                      \
2305         if (0)                                                          \
2306                 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
2307         0;                                                              \
2308 })
2309 #endif
2310
2311 #if defined(VERBOSE_DEBUG)
2312 #define netif_vdbg      netdev_dbg
2313 #else
2314 #define netif_vdbg(priv, type, dev, format, args...)            \
2315 ({                                                              \
2316         if (0)                                                  \
2317                 netif_printk(KERN_DEBUG, dev, format, ##args);  \
2318         0;                                                      \
2319 })
2320 #endif
2321
2322 #endif /* __KERNEL__ */
2323
2324 #endif  /* _LINUX_NETDEVICE_H */