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