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