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