net: separate SIOCGIFCONF handling from dev_ioctl()
[muen/linux.git] / include / linux / netdevice.h
1 /*
2  * INET         An implementation of the TCP/IP protocol suite for the LINUX
3  *              operating system.  INET is implemented using the  BSD Socket
4  *              interface as the means of communication with the user level.
5  *
6  *              Definitions for the Interfaces handler.
7  *
8  * Version:     @(#)dev.h       1.0.10  08/12/93
9  *
10  * Authors:     Ross Biro
11  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12  *              Corey Minyard <wf-rch!minyard@relay.EU.net>
13  *              Donald J. Becker, <becker@cesdis.gsfc.nasa.gov>
14  *              Alan Cox, <alan@lxorguk.ukuu.org.uk>
15  *              Bjorn Ekwall. <bj0rn@blox.se>
16  *              Pekka Riikonen <priikone@poseidon.pspt.fi>
17  *
18  *              This program is free software; you can redistribute it and/or
19  *              modify it under the terms of the GNU General Public License
20  *              as published by the Free Software Foundation; either version
21  *              2 of the License, or (at your option) any later version.
22  *
23  *              Moved to /usr/include/linux for NET3
24  */
25 #ifndef _LINUX_NETDEVICE_H
26 #define _LINUX_NETDEVICE_H
27
28 #include <linux/timer.h>
29 #include <linux/bug.h>
30 #include <linux/delay.h>
31 #include <linux/atomic.h>
32 #include <linux/prefetch.h>
33 #include <asm/cache.h>
34 #include <asm/byteorder.h>
35
36 #include <linux/percpu.h>
37 #include <linux/rculist.h>
38 #include <linux/workqueue.h>
39 #include <linux/dynamic_queue_limits.h>
40
41 #include <linux/ethtool.h>
42 #include <net/net_namespace.h>
43 #ifdef CONFIG_DCB
44 #include <net/dcbnl.h>
45 #endif
46 #include <net/netprio_cgroup.h>
47 #include <net/xdp.h>
48
49 #include <linux/netdev_features.h>
50 #include <linux/neighbour.h>
51 #include <uapi/linux/netdevice.h>
52 #include <uapi/linux/if_bonding.h>
53 #include <uapi/linux/pkt_cls.h>
54 #include <linux/hashtable.h>
55
56 struct netpoll_info;
57 struct device;
58 struct phy_device;
59 struct dsa_port;
60
61 /* 802.11 specific */
62 struct wireless_dev;
63 /* 802.15.4 specific */
64 struct wpan_dev;
65 struct mpls_dev;
66 /* UDP Tunnel offloads */
67 struct udp_tunnel_info;
68 struct bpf_prog;
69 struct xdp_buff;
70
71 void netdev_set_default_ethtool_ops(struct net_device *dev,
72                                     const struct ethtool_ops *ops);
73
74 /* Backlog congestion levels */
75 #define NET_RX_SUCCESS          0       /* keep 'em coming, baby */
76 #define NET_RX_DROP             1       /* packet dropped */
77
78 /*
79  * Transmit return codes: transmit return codes originate from three different
80  * namespaces:
81  *
82  * - qdisc return codes
83  * - driver transmit return codes
84  * - errno values
85  *
86  * Drivers are allowed to return any one of those in their hard_start_xmit()
87  * function. Real network devices commonly used with qdiscs should only return
88  * the driver transmit return codes though - when qdiscs are used, the actual
89  * transmission happens asynchronously, so the value is not propagated to
90  * higher layers. Virtual network devices transmit synchronously; in this case
91  * the driver transmit return codes are consumed by dev_queue_xmit(), and all
92  * others are propagated to higher layers.
93  */
94
95 /* qdisc ->enqueue() return codes. */
96 #define NET_XMIT_SUCCESS        0x00
97 #define NET_XMIT_DROP           0x01    /* skb dropped                  */
98 #define NET_XMIT_CN             0x02    /* congestion notification      */
99 #define NET_XMIT_MASK           0x0f    /* qdisc flags in net/sch_generic.h */
100
101 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
102  * indicates that the device will soon be dropping packets, or already drops
103  * some packets of the same priority; prompting us to send less aggressively. */
104 #define net_xmit_eval(e)        ((e) == NET_XMIT_CN ? 0 : (e))
105 #define net_xmit_errno(e)       ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
106
107 /* Driver transmit return codes */
108 #define NETDEV_TX_MASK          0xf0
109
110 enum netdev_tx {
111         __NETDEV_TX_MIN  = INT_MIN,     /* make sure enum is signed */
112         NETDEV_TX_OK     = 0x00,        /* driver took care of packet */
113         NETDEV_TX_BUSY   = 0x10,        /* driver tx path was busy*/
114 };
115 typedef enum netdev_tx netdev_tx_t;
116
117 /*
118  * Current order: NETDEV_TX_MASK > NET_XMIT_MASK >= 0 is significant;
119  * hard_start_xmit() return < NET_XMIT_MASK means skb was consumed.
120  */
121 static inline bool dev_xmit_complete(int rc)
122 {
123         /*
124          * Positive cases with an skb consumed by a driver:
125          * - successful transmission (rc == NETDEV_TX_OK)
126          * - error while transmitting (rc < 0)
127          * - error while queueing to a different device (rc & NET_XMIT_MASK)
128          */
129         if (likely(rc < NET_XMIT_MASK))
130                 return true;
131
132         return false;
133 }
134
135 /*
136  *      Compute the worst-case header length according to the protocols
137  *      used.
138  */
139
140 #if defined(CONFIG_HYPERV_NET)
141 # define LL_MAX_HEADER 128
142 #elif defined(CONFIG_WLAN) || IS_ENABLED(CONFIG_AX25)
143 # if defined(CONFIG_MAC80211_MESH)
144 #  define LL_MAX_HEADER 128
145 # else
146 #  define LL_MAX_HEADER 96
147 # endif
148 #else
149 # define LL_MAX_HEADER 32
150 #endif
151
152 #if !IS_ENABLED(CONFIG_NET_IPIP) && !IS_ENABLED(CONFIG_NET_IPGRE) && \
153     !IS_ENABLED(CONFIG_IPV6_SIT) && !IS_ENABLED(CONFIG_IPV6_TUNNEL)
154 #define MAX_HEADER LL_MAX_HEADER
155 #else
156 #define MAX_HEADER (LL_MAX_HEADER + 48)
157 #endif
158
159 /*
160  *      Old network device statistics. Fields are native words
161  *      (unsigned long) so they can be read and written atomically.
162  */
163
164 struct net_device_stats {
165         unsigned long   rx_packets;
166         unsigned long   tx_packets;
167         unsigned long   rx_bytes;
168         unsigned long   tx_bytes;
169         unsigned long   rx_errors;
170         unsigned long   tx_errors;
171         unsigned long   rx_dropped;
172         unsigned long   tx_dropped;
173         unsigned long   multicast;
174         unsigned long   collisions;
175         unsigned long   rx_length_errors;
176         unsigned long   rx_over_errors;
177         unsigned long   rx_crc_errors;
178         unsigned long   rx_frame_errors;
179         unsigned long   rx_fifo_errors;
180         unsigned long   rx_missed_errors;
181         unsigned long   tx_aborted_errors;
182         unsigned long   tx_carrier_errors;
183         unsigned long   tx_fifo_errors;
184         unsigned long   tx_heartbeat_errors;
185         unsigned long   tx_window_errors;
186         unsigned long   rx_compressed;
187         unsigned long   tx_compressed;
188 };
189
190
191 #include <linux/cache.h>
192 #include <linux/skbuff.h>
193
194 #ifdef CONFIG_RPS
195 #include <linux/static_key.h>
196 extern struct static_key rps_needed;
197 extern struct static_key rfs_needed;
198 #endif
199
200 struct neighbour;
201 struct neigh_parms;
202 struct sk_buff;
203
204 struct netdev_hw_addr {
205         struct list_head        list;
206         unsigned char           addr[MAX_ADDR_LEN];
207         unsigned char           type;
208 #define NETDEV_HW_ADDR_T_LAN            1
209 #define NETDEV_HW_ADDR_T_SAN            2
210 #define NETDEV_HW_ADDR_T_SLAVE          3
211 #define NETDEV_HW_ADDR_T_UNICAST        4
212 #define NETDEV_HW_ADDR_T_MULTICAST      5
213         bool                    global_use;
214         int                     sync_cnt;
215         int                     refcount;
216         int                     synced;
217         struct rcu_head         rcu_head;
218 };
219
220 struct netdev_hw_addr_list {
221         struct list_head        list;
222         int                     count;
223 };
224
225 #define netdev_hw_addr_list_count(l) ((l)->count)
226 #define netdev_hw_addr_list_empty(l) (netdev_hw_addr_list_count(l) == 0)
227 #define netdev_hw_addr_list_for_each(ha, l) \
228         list_for_each_entry(ha, &(l)->list, list)
229
230 #define netdev_uc_count(dev) netdev_hw_addr_list_count(&(dev)->uc)
231 #define netdev_uc_empty(dev) netdev_hw_addr_list_empty(&(dev)->uc)
232 #define netdev_for_each_uc_addr(ha, dev) \
233         netdev_hw_addr_list_for_each(ha, &(dev)->uc)
234
235 #define netdev_mc_count(dev) netdev_hw_addr_list_count(&(dev)->mc)
236 #define netdev_mc_empty(dev) netdev_hw_addr_list_empty(&(dev)->mc)
237 #define netdev_for_each_mc_addr(ha, dev) \
238         netdev_hw_addr_list_for_each(ha, &(dev)->mc)
239
240 struct hh_cache {
241         unsigned int    hh_len;
242         seqlock_t       hh_lock;
243
244         /* cached hardware header; allow for machine alignment needs.        */
245 #define HH_DATA_MOD     16
246 #define HH_DATA_OFF(__len) \
247         (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
248 #define HH_DATA_ALIGN(__len) \
249         (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
250         unsigned long   hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
251 };
252
253 /* Reserve HH_DATA_MOD byte-aligned hard_header_len, but at least that much.
254  * Alternative is:
255  *   dev->hard_header_len ? (dev->hard_header_len +
256  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
257  *
258  * We could use other alignment values, but we must maintain the
259  * relationship HH alignment <= LL alignment.
260  */
261 #define LL_RESERVED_SPACE(dev) \
262         ((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
263 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
264         ((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
265
266 struct header_ops {
267         int     (*create) (struct sk_buff *skb, struct net_device *dev,
268                            unsigned short type, const void *daddr,
269                            const void *saddr, unsigned int len);
270         int     (*parse)(const struct sk_buff *skb, unsigned char *haddr);
271         int     (*cache)(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
272         void    (*cache_update)(struct hh_cache *hh,
273                                 const struct net_device *dev,
274                                 const unsigned char *haddr);
275         bool    (*validate)(const char *ll_header, unsigned int len);
276 };
277
278 /* These flag bits are private to the generic network queueing
279  * layer; they may not be explicitly referenced by any other
280  * code.
281  */
282
283 enum netdev_state_t {
284         __LINK_STATE_START,
285         __LINK_STATE_PRESENT,
286         __LINK_STATE_NOCARRIER,
287         __LINK_STATE_LINKWATCH_PENDING,
288         __LINK_STATE_DORMANT,
289 };
290
291
292 /*
293  * This structure holds boot-time configured netdevice settings. They
294  * are then used in the device probing.
295  */
296 struct netdev_boot_setup {
297         char name[IFNAMSIZ];
298         struct ifmap map;
299 };
300 #define NETDEV_BOOT_SETUP_MAX 8
301
302 int __init netdev_boot_setup(char *str);
303
304 /*
305  * Structure for NAPI scheduling similar to tasklet but with weighting
306  */
307 struct napi_struct {
308         /* The poll_list must only be managed by the entity which
309          * changes the state of the NAPI_STATE_SCHED bit.  This means
310          * whoever atomically sets that bit can add this napi_struct
311          * to the per-CPU poll_list, and whoever clears that bit
312          * can remove from the list right before clearing the bit.
313          */
314         struct list_head        poll_list;
315
316         unsigned long           state;
317         int                     weight;
318         unsigned int            gro_count;
319         int                     (*poll)(struct napi_struct *, int);
320 #ifdef CONFIG_NETPOLL
321         int                     poll_owner;
322 #endif
323         struct net_device       *dev;
324         struct sk_buff          *gro_list;
325         struct sk_buff          *skb;
326         struct hrtimer          timer;
327         struct list_head        dev_list;
328         struct hlist_node       napi_hash_node;
329         unsigned int            napi_id;
330 };
331
332 enum {
333         NAPI_STATE_SCHED,       /* Poll is scheduled */
334         NAPI_STATE_MISSED,      /* reschedule a napi */
335         NAPI_STATE_DISABLE,     /* Disable pending */
336         NAPI_STATE_NPSVC,       /* Netpoll - don't dequeue from poll_list */
337         NAPI_STATE_HASHED,      /* In NAPI hash (busy polling possible) */
338         NAPI_STATE_NO_BUSY_POLL,/* Do not add in napi_hash, no busy polling */
339         NAPI_STATE_IN_BUSY_POLL,/* sk_busy_loop() owns this NAPI */
340 };
341
342 enum {
343         NAPIF_STATE_SCHED        = BIT(NAPI_STATE_SCHED),
344         NAPIF_STATE_MISSED       = BIT(NAPI_STATE_MISSED),
345         NAPIF_STATE_DISABLE      = BIT(NAPI_STATE_DISABLE),
346         NAPIF_STATE_NPSVC        = BIT(NAPI_STATE_NPSVC),
347         NAPIF_STATE_HASHED       = BIT(NAPI_STATE_HASHED),
348         NAPIF_STATE_NO_BUSY_POLL = BIT(NAPI_STATE_NO_BUSY_POLL),
349         NAPIF_STATE_IN_BUSY_POLL = BIT(NAPI_STATE_IN_BUSY_POLL),
350 };
351
352 enum gro_result {
353         GRO_MERGED,
354         GRO_MERGED_FREE,
355         GRO_HELD,
356         GRO_NORMAL,
357         GRO_DROP,
358         GRO_CONSUMED,
359 };
360 typedef enum gro_result gro_result_t;
361
362 /*
363  * enum rx_handler_result - Possible return values for rx_handlers.
364  * @RX_HANDLER_CONSUMED: skb was consumed by rx_handler, do not process it
365  * further.
366  * @RX_HANDLER_ANOTHER: Do another round in receive path. This is indicated in
367  * case skb->dev was changed by rx_handler.
368  * @RX_HANDLER_EXACT: Force exact delivery, no wildcard.
369  * @RX_HANDLER_PASS: Do nothing, pass the skb as if no rx_handler was called.
370  *
371  * rx_handlers are functions called from inside __netif_receive_skb(), to do
372  * special processing of the skb, prior to delivery to protocol handlers.
373  *
374  * Currently, a net_device can only have a single rx_handler registered. Trying
375  * to register a second rx_handler will return -EBUSY.
376  *
377  * To register a rx_handler on a net_device, use netdev_rx_handler_register().
378  * To unregister a rx_handler on a net_device, use
379  * netdev_rx_handler_unregister().
380  *
381  * Upon return, rx_handler is expected to tell __netif_receive_skb() what to
382  * do with the skb.
383  *
384  * If the rx_handler consumed the skb in some way, it should return
385  * RX_HANDLER_CONSUMED. This is appropriate when the rx_handler arranged for
386  * the skb to be delivered in some other way.
387  *
388  * If the rx_handler changed skb->dev, to divert the skb to another
389  * net_device, it should return RX_HANDLER_ANOTHER. The rx_handler for the
390  * new device will be called if it exists.
391  *
392  * If the rx_handler decides the skb should be ignored, it should return
393  * RX_HANDLER_EXACT. The skb will only be delivered to protocol handlers that
394  * are registered on exact device (ptype->dev == skb->dev).
395  *
396  * If the rx_handler didn't change skb->dev, but wants the skb to be normally
397  * delivered, it should return RX_HANDLER_PASS.
398  *
399  * A device without a registered rx_handler will behave as if rx_handler
400  * returned RX_HANDLER_PASS.
401  */
402
403 enum rx_handler_result {
404         RX_HANDLER_CONSUMED,
405         RX_HANDLER_ANOTHER,
406         RX_HANDLER_EXACT,
407         RX_HANDLER_PASS,
408 };
409 typedef enum rx_handler_result rx_handler_result_t;
410 typedef rx_handler_result_t rx_handler_func_t(struct sk_buff **pskb);
411
412 void __napi_schedule(struct napi_struct *n);
413 void __napi_schedule_irqoff(struct napi_struct *n);
414
415 static inline bool napi_disable_pending(struct napi_struct *n)
416 {
417         return test_bit(NAPI_STATE_DISABLE, &n->state);
418 }
419
420 bool napi_schedule_prep(struct napi_struct *n);
421
422 /**
423  *      napi_schedule - schedule NAPI poll
424  *      @n: NAPI context
425  *
426  * Schedule NAPI poll routine to be called if it is not already
427  * running.
428  */
429 static inline void napi_schedule(struct napi_struct *n)
430 {
431         if (napi_schedule_prep(n))
432                 __napi_schedule(n);
433 }
434
435 /**
436  *      napi_schedule_irqoff - schedule NAPI poll
437  *      @n: NAPI context
438  *
439  * Variant of napi_schedule(), assuming hard irqs are masked.
440  */
441 static inline void napi_schedule_irqoff(struct napi_struct *n)
442 {
443         if (napi_schedule_prep(n))
444                 __napi_schedule_irqoff(n);
445 }
446
447 /* Try to reschedule poll. Called by dev->poll() after napi_complete().  */
448 static inline bool napi_reschedule(struct napi_struct *napi)
449 {
450         if (napi_schedule_prep(napi)) {
451                 __napi_schedule(napi);
452                 return true;
453         }
454         return false;
455 }
456
457 bool napi_complete_done(struct napi_struct *n, int work_done);
458 /**
459  *      napi_complete - NAPI processing complete
460  *      @n: NAPI context
461  *
462  * Mark NAPI processing as complete.
463  * Consider using napi_complete_done() instead.
464  * Return false if device should avoid rearming interrupts.
465  */
466 static inline bool napi_complete(struct napi_struct *n)
467 {
468         return napi_complete_done(n, 0);
469 }
470
471 /**
472  *      napi_hash_del - remove a NAPI from global table
473  *      @napi: NAPI context
474  *
475  * Warning: caller must observe RCU grace period
476  * before freeing memory containing @napi, if
477  * this function returns true.
478  * Note: core networking stack automatically calls it
479  * from netif_napi_del().
480  * Drivers might want to call this helper to combine all
481  * the needed RCU grace periods into a single one.
482  */
483 bool napi_hash_del(struct napi_struct *napi);
484
485 /**
486  *      napi_disable - prevent NAPI from scheduling
487  *      @n: NAPI context
488  *
489  * Stop NAPI from being scheduled on this context.
490  * Waits till any outstanding processing completes.
491  */
492 void napi_disable(struct napi_struct *n);
493
494 /**
495  *      napi_enable - enable NAPI scheduling
496  *      @n: NAPI context
497  *
498  * Resume NAPI from being scheduled on this context.
499  * Must be paired with napi_disable.
500  */
501 static inline void napi_enable(struct napi_struct *n)
502 {
503         BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
504         smp_mb__before_atomic();
505         clear_bit(NAPI_STATE_SCHED, &n->state);
506         clear_bit(NAPI_STATE_NPSVC, &n->state);
507 }
508
509 /**
510  *      napi_synchronize - wait until NAPI is not running
511  *      @n: NAPI context
512  *
513  * Wait until NAPI is done being scheduled on this context.
514  * Waits till any outstanding processing completes but
515  * does not disable future activations.
516  */
517 static inline void napi_synchronize(const struct napi_struct *n)
518 {
519         if (IS_ENABLED(CONFIG_SMP))
520                 while (test_bit(NAPI_STATE_SCHED, &n->state))
521                         msleep(1);
522         else
523                 barrier();
524 }
525
526 enum netdev_queue_state_t {
527         __QUEUE_STATE_DRV_XOFF,
528         __QUEUE_STATE_STACK_XOFF,
529         __QUEUE_STATE_FROZEN,
530 };
531
532 #define QUEUE_STATE_DRV_XOFF    (1 << __QUEUE_STATE_DRV_XOFF)
533 #define QUEUE_STATE_STACK_XOFF  (1 << __QUEUE_STATE_STACK_XOFF)
534 #define QUEUE_STATE_FROZEN      (1 << __QUEUE_STATE_FROZEN)
535
536 #define QUEUE_STATE_ANY_XOFF    (QUEUE_STATE_DRV_XOFF | QUEUE_STATE_STACK_XOFF)
537 #define QUEUE_STATE_ANY_XOFF_OR_FROZEN (QUEUE_STATE_ANY_XOFF | \
538                                         QUEUE_STATE_FROZEN)
539 #define QUEUE_STATE_DRV_XOFF_OR_FROZEN (QUEUE_STATE_DRV_XOFF | \
540                                         QUEUE_STATE_FROZEN)
541
542 /*
543  * __QUEUE_STATE_DRV_XOFF is used by drivers to stop the transmit queue.  The
544  * netif_tx_* functions below are used to manipulate this flag.  The
545  * __QUEUE_STATE_STACK_XOFF flag is used by the stack to stop the transmit
546  * queue independently.  The netif_xmit_*stopped functions below are called
547  * to check if the queue has been stopped by the driver or stack (either
548  * of the XOFF bits are set in the state).  Drivers should not need to call
549  * netif_xmit*stopped functions, they should only be using netif_tx_*.
550  */
551
552 struct netdev_queue {
553 /*
554  * read-mostly part
555  */
556         struct net_device       *dev;
557         struct Qdisc __rcu      *qdisc;
558         struct Qdisc            *qdisc_sleeping;
559 #ifdef CONFIG_SYSFS
560         struct kobject          kobj;
561 #endif
562 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
563         int                     numa_node;
564 #endif
565         unsigned long           tx_maxrate;
566         /*
567          * Number of TX timeouts for this queue
568          * (/sys/class/net/DEV/Q/trans_timeout)
569          */
570         unsigned long           trans_timeout;
571 /*
572  * write-mostly part
573  */
574         spinlock_t              _xmit_lock ____cacheline_aligned_in_smp;
575         int                     xmit_lock_owner;
576         /*
577          * Time (in jiffies) of last Tx
578          */
579         unsigned long           trans_start;
580
581         unsigned long           state;
582
583 #ifdef CONFIG_BQL
584         struct dql              dql;
585 #endif
586 } ____cacheline_aligned_in_smp;
587
588 static inline int netdev_queue_numa_node_read(const struct netdev_queue *q)
589 {
590 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
591         return q->numa_node;
592 #else
593         return NUMA_NO_NODE;
594 #endif
595 }
596
597 static inline void netdev_queue_numa_node_write(struct netdev_queue *q, int node)
598 {
599 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
600         q->numa_node = node;
601 #endif
602 }
603
604 #ifdef CONFIG_RPS
605 /*
606  * This structure holds an RPS map which can be of variable length.  The
607  * map is an array of CPUs.
608  */
609 struct rps_map {
610         unsigned int len;
611         struct rcu_head rcu;
612         u16 cpus[0];
613 };
614 #define RPS_MAP_SIZE(_num) (sizeof(struct rps_map) + ((_num) * sizeof(u16)))
615
616 /*
617  * The rps_dev_flow structure contains the mapping of a flow to a CPU, the
618  * tail pointer for that CPU's input queue at the time of last enqueue, and
619  * a hardware filter index.
620  */
621 struct rps_dev_flow {
622         u16 cpu;
623         u16 filter;
624         unsigned int last_qtail;
625 };
626 #define RPS_NO_FILTER 0xffff
627
628 /*
629  * The rps_dev_flow_table structure contains a table of flow mappings.
630  */
631 struct rps_dev_flow_table {
632         unsigned int mask;
633         struct rcu_head rcu;
634         struct rps_dev_flow flows[0];
635 };
636 #define RPS_DEV_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_dev_flow_table) + \
637     ((_num) * sizeof(struct rps_dev_flow)))
638
639 /*
640  * The rps_sock_flow_table contains mappings of flows to the last CPU
641  * on which they were processed by the application (set in recvmsg).
642  * Each entry is a 32bit value. Upper part is the high-order bits
643  * of flow hash, lower part is CPU number.
644  * rps_cpu_mask is used to partition the space, depending on number of
645  * possible CPUs : rps_cpu_mask = roundup_pow_of_two(nr_cpu_ids) - 1
646  * For example, if 64 CPUs are possible, rps_cpu_mask = 0x3f,
647  * meaning we use 32-6=26 bits for the hash.
648  */
649 struct rps_sock_flow_table {
650         u32     mask;
651
652         u32     ents[0] ____cacheline_aligned_in_smp;
653 };
654 #define RPS_SOCK_FLOW_TABLE_SIZE(_num) (offsetof(struct rps_sock_flow_table, ents[_num]))
655
656 #define RPS_NO_CPU 0xffff
657
658 extern u32 rps_cpu_mask;
659 extern struct rps_sock_flow_table __rcu *rps_sock_flow_table;
660
661 static inline void rps_record_sock_flow(struct rps_sock_flow_table *table,
662                                         u32 hash)
663 {
664         if (table && hash) {
665                 unsigned int index = hash & table->mask;
666                 u32 val = hash & ~rps_cpu_mask;
667
668                 /* We only give a hint, preemption can change CPU under us */
669                 val |= raw_smp_processor_id();
670
671                 if (table->ents[index] != val)
672                         table->ents[index] = val;
673         }
674 }
675
676 #ifdef CONFIG_RFS_ACCEL
677 bool rps_may_expire_flow(struct net_device *dev, u16 rxq_index, u32 flow_id,
678                          u16 filter_id);
679 #endif
680 #endif /* CONFIG_RPS */
681
682 /* This structure contains an instance of an RX queue. */
683 struct netdev_rx_queue {
684 #ifdef CONFIG_RPS
685         struct rps_map __rcu            *rps_map;
686         struct rps_dev_flow_table __rcu *rps_flow_table;
687 #endif
688         struct kobject                  kobj;
689         struct net_device               *dev;
690         struct xdp_rxq_info             xdp_rxq;
691 } ____cacheline_aligned_in_smp;
692
693 /*
694  * RX queue sysfs structures and functions.
695  */
696 struct rx_queue_attribute {
697         struct attribute attr;
698         ssize_t (*show)(struct netdev_rx_queue *queue, char *buf);
699         ssize_t (*store)(struct netdev_rx_queue *queue,
700                          const char *buf, size_t len);
701 };
702
703 #ifdef CONFIG_XPS
704 /*
705  * This structure holds an XPS map which can be of variable length.  The
706  * map is an array of queues.
707  */
708 struct xps_map {
709         unsigned int len;
710         unsigned int alloc_len;
711         struct rcu_head rcu;
712         u16 queues[0];
713 };
714 #define XPS_MAP_SIZE(_num) (sizeof(struct xps_map) + ((_num) * sizeof(u16)))
715 #define XPS_MIN_MAP_ALLOC ((L1_CACHE_ALIGN(offsetof(struct xps_map, queues[1])) \
716        - sizeof(struct xps_map)) / sizeof(u16))
717
718 /*
719  * This structure holds all XPS maps for device.  Maps are indexed by CPU.
720  */
721 struct xps_dev_maps {
722         struct rcu_head rcu;
723         struct xps_map __rcu *cpu_map[0];
724 };
725 #define XPS_DEV_MAPS_SIZE(_tcs) (sizeof(struct xps_dev_maps) +          \
726         (nr_cpu_ids * (_tcs) * sizeof(struct xps_map *)))
727 #endif /* CONFIG_XPS */
728
729 #define TC_MAX_QUEUE    16
730 #define TC_BITMASK      15
731 /* HW offloaded queuing disciplines txq count and offset maps */
732 struct netdev_tc_txq {
733         u16 count;
734         u16 offset;
735 };
736
737 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
738 /*
739  * This structure is to hold information about the device
740  * configured to run FCoE protocol stack.
741  */
742 struct netdev_fcoe_hbainfo {
743         char    manufacturer[64];
744         char    serial_number[64];
745         char    hardware_version[64];
746         char    driver_version[64];
747         char    optionrom_version[64];
748         char    firmware_version[64];
749         char    model[256];
750         char    model_description[256];
751 };
752 #endif
753
754 #define MAX_PHYS_ITEM_ID_LEN 32
755
756 /* This structure holds a unique identifier to identify some
757  * physical item (port for example) used by a netdevice.
758  */
759 struct netdev_phys_item_id {
760         unsigned char id[MAX_PHYS_ITEM_ID_LEN];
761         unsigned char id_len;
762 };
763
764 static inline bool netdev_phys_item_id_same(struct netdev_phys_item_id *a,
765                                             struct netdev_phys_item_id *b)
766 {
767         return a->id_len == b->id_len &&
768                memcmp(a->id, b->id, a->id_len) == 0;
769 }
770
771 typedef u16 (*select_queue_fallback_t)(struct net_device *dev,
772                                        struct sk_buff *skb);
773
774 enum tc_setup_type {
775         TC_SETUP_QDISC_MQPRIO,
776         TC_SETUP_CLSU32,
777         TC_SETUP_CLSFLOWER,
778         TC_SETUP_CLSMATCHALL,
779         TC_SETUP_CLSBPF,
780         TC_SETUP_BLOCK,
781         TC_SETUP_QDISC_CBS,
782         TC_SETUP_QDISC_RED,
783         TC_SETUP_QDISC_PRIO,
784 };
785
786 /* These structures hold the attributes of bpf state that are being passed
787  * to the netdevice through the bpf op.
788  */
789 enum bpf_netdev_command {
790         /* Set or clear a bpf program used in the earliest stages of packet
791          * rx. The prog will have been loaded as BPF_PROG_TYPE_XDP. The callee
792          * is responsible for calling bpf_prog_put on any old progs that are
793          * stored. In case of error, the callee need not release the new prog
794          * reference, but on success it takes ownership and must bpf_prog_put
795          * when it is no longer used.
796          */
797         XDP_SETUP_PROG,
798         XDP_SETUP_PROG_HW,
799         /* Check if a bpf program is set on the device.  The callee should
800          * set @prog_attached to one of XDP_ATTACHED_* values, note that "true"
801          * is equivalent to XDP_ATTACHED_DRV.
802          */
803         XDP_QUERY_PROG,
804         /* BPF program for offload callbacks, invoked at program load time. */
805         BPF_OFFLOAD_VERIFIER_PREP,
806         BPF_OFFLOAD_TRANSLATE,
807         BPF_OFFLOAD_DESTROY,
808         BPF_OFFLOAD_MAP_ALLOC,
809         BPF_OFFLOAD_MAP_FREE,
810 };
811
812 struct bpf_prog_offload_ops;
813 struct netlink_ext_ack;
814
815 struct netdev_bpf {
816         enum bpf_netdev_command command;
817         union {
818                 /* XDP_SETUP_PROG */
819                 struct {
820                         u32 flags;
821                         struct bpf_prog *prog;
822                         struct netlink_ext_ack *extack;
823                 };
824                 /* XDP_QUERY_PROG */
825                 struct {
826                         u8 prog_attached;
827                         u32 prog_id;
828                         /* flags with which program was installed */
829                         u32 prog_flags;
830                 };
831                 /* BPF_OFFLOAD_VERIFIER_PREP */
832                 struct {
833                         struct bpf_prog *prog;
834                         const struct bpf_prog_offload_ops *ops; /* callee set */
835                 } verifier;
836                 /* BPF_OFFLOAD_TRANSLATE, BPF_OFFLOAD_DESTROY */
837                 struct {
838                         struct bpf_prog *prog;
839                 } offload;
840                 /* BPF_OFFLOAD_MAP_ALLOC, BPF_OFFLOAD_MAP_FREE */
841                 struct {
842                         struct bpf_offloaded_map *offmap;
843                 };
844         };
845 };
846
847 #ifdef CONFIG_XFRM_OFFLOAD
848 struct xfrmdev_ops {
849         int     (*xdo_dev_state_add) (struct xfrm_state *x);
850         void    (*xdo_dev_state_delete) (struct xfrm_state *x);
851         void    (*xdo_dev_state_free) (struct xfrm_state *x);
852         bool    (*xdo_dev_offload_ok) (struct sk_buff *skb,
853                                        struct xfrm_state *x);
854 };
855 #endif
856
857 struct dev_ifalias {
858         struct rcu_head rcuhead;
859         char ifalias[];
860 };
861
862 /*
863  * This structure defines the management hooks for network devices.
864  * The following hooks can be defined; unless noted otherwise, they are
865  * optional and can be filled with a null pointer.
866  *
867  * int (*ndo_init)(struct net_device *dev);
868  *     This function is called once when a network device is registered.
869  *     The network device can use this for any late stage initialization
870  *     or semantic validation. It can fail with an error code which will
871  *     be propagated back to register_netdev.
872  *
873  * void (*ndo_uninit)(struct net_device *dev);
874  *     This function is called when device is unregistered or when registration
875  *     fails. It is not called if init fails.
876  *
877  * int (*ndo_open)(struct net_device *dev);
878  *     This function is called when a network device transitions to the up
879  *     state.
880  *
881  * int (*ndo_stop)(struct net_device *dev);
882  *     This function is called when a network device transitions to the down
883  *     state.
884  *
885  * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
886  *                               struct net_device *dev);
887  *      Called when a packet needs to be transmitted.
888  *      Returns NETDEV_TX_OK.  Can return NETDEV_TX_BUSY, but you should stop
889  *      the queue before that can happen; it's for obsolete devices and weird
890  *      corner cases, but the stack really does a non-trivial amount
891  *      of useless work if you return NETDEV_TX_BUSY.
892  *      Required; cannot be NULL.
893  *
894  * netdev_features_t (*ndo_features_check)(struct sk_buff *skb,
895  *                                         struct net_device *dev
896  *                                         netdev_features_t features);
897  *      Called by core transmit path to determine if device is capable of
898  *      performing offload operations on a given packet. This is to give
899  *      the device an opportunity to implement any restrictions that cannot
900  *      be otherwise expressed by feature flags. The check is called with
901  *      the set of features that the stack has calculated and it returns
902  *      those the driver believes to be appropriate.
903  *
904  * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb,
905  *                         void *accel_priv, select_queue_fallback_t fallback);
906  *      Called to decide which queue to use when device supports multiple
907  *      transmit queues.
908  *
909  * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
910  *      This function is called to allow device receiver to make
911  *      changes to configuration when multicast or promiscuous is enabled.
912  *
913  * void (*ndo_set_rx_mode)(struct net_device *dev);
914  *      This function is called device changes address list filtering.
915  *      If driver handles unicast address filtering, it should set
916  *      IFF_UNICAST_FLT in its priv_flags.
917  *
918  * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
919  *      This function  is called when the Media Access Control address
920  *      needs to be changed. If this interface is not defined, the
921  *      MAC address can not be changed.
922  *
923  * int (*ndo_validate_addr)(struct net_device *dev);
924  *      Test if Media Access Control address is valid for the device.
925  *
926  * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
927  *      Called when a user requests an ioctl which can't be handled by
928  *      the generic interface code. If not defined ioctls return
929  *      not supported error code.
930  *
931  * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
932  *      Used to set network devices bus interface parameters. This interface
933  *      is retained for legacy reasons; new devices should use the bus
934  *      interface (PCI) for low level management.
935  *
936  * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
937  *      Called when a user wants to change the Maximum Transfer Unit
938  *      of a device.
939  *
940  * void (*ndo_tx_timeout)(struct net_device *dev);
941  *      Callback used when the transmitter has not made any progress
942  *      for dev->watchdog ticks.
943  *
944  * void (*ndo_get_stats64)(struct net_device *dev,
945  *                         struct rtnl_link_stats64 *storage);
946  * struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
947  *      Called when a user wants to get the network device usage
948  *      statistics. Drivers must do one of the following:
949  *      1. Define @ndo_get_stats64 to fill in a zero-initialised
950  *         rtnl_link_stats64 structure passed by the caller.
951  *      2. Define @ndo_get_stats to update a net_device_stats structure
952  *         (which should normally be dev->stats) and return a pointer to
953  *         it. The structure may be changed asynchronously only if each
954  *         field is written atomically.
955  *      3. Update dev->stats asynchronously and atomically, and define
956  *         neither operation.
957  *
958  * bool (*ndo_has_offload_stats)(const struct net_device *dev, int attr_id)
959  *      Return true if this device supports offload stats of this attr_id.
960  *
961  * int (*ndo_get_offload_stats)(int attr_id, const struct net_device *dev,
962  *      void *attr_data)
963  *      Get statistics for offload operations by attr_id. Write it into the
964  *      attr_data pointer.
965  *
966  * int (*ndo_vlan_rx_add_vid)(struct net_device *dev, __be16 proto, u16 vid);
967  *      If device supports VLAN filtering this function is called when a
968  *      VLAN id is registered.
969  *
970  * int (*ndo_vlan_rx_kill_vid)(struct net_device *dev, __be16 proto, u16 vid);
971  *      If device supports VLAN filtering this function is called when a
972  *      VLAN id is unregistered.
973  *
974  * void (*ndo_poll_controller)(struct net_device *dev);
975  *
976  *      SR-IOV management functions.
977  * int (*ndo_set_vf_mac)(struct net_device *dev, int vf, u8* mac);
978  * int (*ndo_set_vf_vlan)(struct net_device *dev, int vf, u16 vlan,
979  *                        u8 qos, __be16 proto);
980  * int (*ndo_set_vf_rate)(struct net_device *dev, int vf, int min_tx_rate,
981  *                        int max_tx_rate);
982  * int (*ndo_set_vf_spoofchk)(struct net_device *dev, int vf, bool setting);
983  * int (*ndo_set_vf_trust)(struct net_device *dev, int vf, bool setting);
984  * int (*ndo_get_vf_config)(struct net_device *dev,
985  *                          int vf, struct ifla_vf_info *ivf);
986  * int (*ndo_set_vf_link_state)(struct net_device *dev, int vf, int link_state);
987  * int (*ndo_set_vf_port)(struct net_device *dev, int vf,
988  *                        struct nlattr *port[]);
989  *
990  *      Enable or disable the VF ability to query its RSS Redirection Table and
991  *      Hash Key. This is needed since on some devices VF share this information
992  *      with PF and querying it may introduce a theoretical security risk.
993  * int (*ndo_set_vf_rss_query_en)(struct net_device *dev, int vf, bool setting);
994  * int (*ndo_get_vf_port)(struct net_device *dev, int vf, struct sk_buff *skb);
995  * int (*ndo_setup_tc)(struct net_device *dev, enum tc_setup_type type,
996  *                     void *type_data);
997  *      Called to setup any 'tc' scheduler, classifier or action on @dev.
998  *      This is always called from the stack with the rtnl lock held and netif
999  *      tx queues stopped. This allows the netdevice to perform queue
1000  *      management safely.
1001  *
1002  *      Fiber Channel over Ethernet (FCoE) offload functions.
1003  * int (*ndo_fcoe_enable)(struct net_device *dev);
1004  *      Called when the FCoE protocol stack wants to start using LLD for FCoE
1005  *      so the underlying device can perform whatever needed configuration or
1006  *      initialization to support acceleration of FCoE traffic.
1007  *
1008  * int (*ndo_fcoe_disable)(struct net_device *dev);
1009  *      Called when the FCoE protocol stack wants to stop using LLD for FCoE
1010  *      so the underlying device can perform whatever needed clean-ups to
1011  *      stop supporting acceleration of FCoE traffic.
1012  *
1013  * int (*ndo_fcoe_ddp_setup)(struct net_device *dev, u16 xid,
1014  *                           struct scatterlist *sgl, unsigned int sgc);
1015  *      Called when the FCoE Initiator wants to initialize an I/O that
1016  *      is a possible candidate for Direct Data Placement (DDP). The LLD can
1017  *      perform necessary setup and returns 1 to indicate the device is set up
1018  *      successfully to perform DDP on this I/O, otherwise this returns 0.
1019  *
1020  * int (*ndo_fcoe_ddp_done)(struct net_device *dev,  u16 xid);
1021  *      Called when the FCoE Initiator/Target is done with the DDPed I/O as
1022  *      indicated by the FC exchange id 'xid', so the underlying device can
1023  *      clean up and reuse resources for later DDP requests.
1024  *
1025  * int (*ndo_fcoe_ddp_target)(struct net_device *dev, u16 xid,
1026  *                            struct scatterlist *sgl, unsigned int sgc);
1027  *      Called when the FCoE Target wants to initialize an I/O that
1028  *      is a possible candidate for Direct Data Placement (DDP). The LLD can
1029  *      perform necessary setup and returns 1 to indicate the device is set up
1030  *      successfully to perform DDP on this I/O, otherwise this returns 0.
1031  *
1032  * int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1033  *                             struct netdev_fcoe_hbainfo *hbainfo);
1034  *      Called when the FCoE Protocol stack wants information on the underlying
1035  *      device. This information is utilized by the FCoE protocol stack to
1036  *      register attributes with Fiber Channel management service as per the
1037  *      FC-GS Fabric Device Management Information(FDMI) specification.
1038  *
1039  * int (*ndo_fcoe_get_wwn)(struct net_device *dev, u64 *wwn, int type);
1040  *      Called when the underlying device wants to override default World Wide
1041  *      Name (WWN) generation mechanism in FCoE protocol stack to pass its own
1042  *      World Wide Port Name (WWPN) or World Wide Node Name (WWNN) to the FCoE
1043  *      protocol stack to use.
1044  *
1045  *      RFS acceleration.
1046  * int (*ndo_rx_flow_steer)(struct net_device *dev, const struct sk_buff *skb,
1047  *                          u16 rxq_index, u32 flow_id);
1048  *      Set hardware filter for RFS.  rxq_index is the target queue index;
1049  *      flow_id is a flow ID to be passed to rps_may_expire_flow() later.
1050  *      Return the filter ID on success, or a negative error code.
1051  *
1052  *      Slave management functions (for bridge, bonding, etc).
1053  * int (*ndo_add_slave)(struct net_device *dev, struct net_device *slave_dev);
1054  *      Called to make another netdev an underling.
1055  *
1056  * int (*ndo_del_slave)(struct net_device *dev, struct net_device *slave_dev);
1057  *      Called to release previously enslaved netdev.
1058  *
1059  *      Feature/offload setting functions.
1060  * netdev_features_t (*ndo_fix_features)(struct net_device *dev,
1061  *              netdev_features_t features);
1062  *      Adjusts the requested feature flags according to device-specific
1063  *      constraints, and returns the resulting flags. Must not modify
1064  *      the device state.
1065  *
1066  * int (*ndo_set_features)(struct net_device *dev, netdev_features_t features);
1067  *      Called to update device configuration to new features. Passed
1068  *      feature set might be less than what was returned by ndo_fix_features()).
1069  *      Must return >0 or -errno if it changed dev->features itself.
1070  *
1071  * int (*ndo_fdb_add)(struct ndmsg *ndm, struct nlattr *tb[],
1072  *                    struct net_device *dev,
1073  *                    const unsigned char *addr, u16 vid, u16 flags)
1074  *      Adds an FDB entry to dev for addr.
1075  * int (*ndo_fdb_del)(struct ndmsg *ndm, struct nlattr *tb[],
1076  *                    struct net_device *dev,
1077  *                    const unsigned char *addr, u16 vid)
1078  *      Deletes the FDB entry from dev coresponding to addr.
1079  * int (*ndo_fdb_dump)(struct sk_buff *skb, struct netlink_callback *cb,
1080  *                     struct net_device *dev, struct net_device *filter_dev,
1081  *                     int *idx)
1082  *      Used to add FDB entries to dump requests. Implementers should add
1083  *      entries to skb and update idx with the number of entries.
1084  *
1085  * int (*ndo_bridge_setlink)(struct net_device *dev, struct nlmsghdr *nlh,
1086  *                           u16 flags)
1087  * int (*ndo_bridge_getlink)(struct sk_buff *skb, u32 pid, u32 seq,
1088  *                           struct net_device *dev, u32 filter_mask,
1089  *                           int nlflags)
1090  * int (*ndo_bridge_dellink)(struct net_device *dev, struct nlmsghdr *nlh,
1091  *                           u16 flags);
1092  *
1093  * int (*ndo_change_carrier)(struct net_device *dev, bool new_carrier);
1094  *      Called to change device carrier. Soft-devices (like dummy, team, etc)
1095  *      which do not represent real hardware may define this to allow their
1096  *      userspace components to manage their virtual carrier state. Devices
1097  *      that determine carrier state from physical hardware properties (eg
1098  *      network cables) or protocol-dependent mechanisms (eg
1099  *      USB_CDC_NOTIFY_NETWORK_CONNECTION) should NOT implement this function.
1100  *
1101  * int (*ndo_get_phys_port_id)(struct net_device *dev,
1102  *                             struct netdev_phys_item_id *ppid);
1103  *      Called to get ID of physical port of this device. If driver does
1104  *      not implement this, it is assumed that the hw is not able to have
1105  *      multiple net devices on single physical port.
1106  *
1107  * void (*ndo_udp_tunnel_add)(struct net_device *dev,
1108  *                            struct udp_tunnel_info *ti);
1109  *      Called by UDP tunnel to notify a driver about the UDP port and socket
1110  *      address family that a UDP tunnel is listnening to. It is called only
1111  *      when a new port starts listening. The operation is protected by the
1112  *      RTNL.
1113  *
1114  * void (*ndo_udp_tunnel_del)(struct net_device *dev,
1115  *                            struct udp_tunnel_info *ti);
1116  *      Called by UDP tunnel to notify the driver about a UDP port and socket
1117  *      address family that the UDP tunnel is not listening to anymore. The
1118  *      operation is protected by the RTNL.
1119  *
1120  * void* (*ndo_dfwd_add_station)(struct net_device *pdev,
1121  *                               struct net_device *dev)
1122  *      Called by upper layer devices to accelerate switching or other
1123  *      station functionality into hardware. 'pdev is the lowerdev
1124  *      to use for the offload and 'dev' is the net device that will
1125  *      back the offload. Returns a pointer to the private structure
1126  *      the upper layer will maintain.
1127  * void (*ndo_dfwd_del_station)(struct net_device *pdev, void *priv)
1128  *      Called by upper layer device to delete the station created
1129  *      by 'ndo_dfwd_add_station'. 'pdev' is the net device backing
1130  *      the station and priv is the structure returned by the add
1131  *      operation.
1132  * int (*ndo_set_tx_maxrate)(struct net_device *dev,
1133  *                           int queue_index, u32 maxrate);
1134  *      Called when a user wants to set a max-rate limitation of specific
1135  *      TX queue.
1136  * int (*ndo_get_iflink)(const struct net_device *dev);
1137  *      Called to get the iflink value of this device.
1138  * void (*ndo_change_proto_down)(struct net_device *dev,
1139  *                               bool proto_down);
1140  *      This function is used to pass protocol port error state information
1141  *      to the switch driver. The switch driver can react to the proto_down
1142  *      by doing a phys down on the associated switch port.
1143  * int (*ndo_fill_metadata_dst)(struct net_device *dev, struct sk_buff *skb);
1144  *      This function is used to get egress tunnel information for given skb.
1145  *      This is useful for retrieving outer tunnel header parameters while
1146  *      sampling packet.
1147  * void (*ndo_set_rx_headroom)(struct net_device *dev, int needed_headroom);
1148  *      This function is used to specify the headroom that the skb must
1149  *      consider when allocation skb during packet reception. Setting
1150  *      appropriate rx headroom value allows avoiding skb head copy on
1151  *      forward. Setting a negative value resets the rx headroom to the
1152  *      default value.
1153  * int (*ndo_bpf)(struct net_device *dev, struct netdev_bpf *bpf);
1154  *      This function is used to set or query state related to XDP on the
1155  *      netdevice and manage BPF offload. See definition of
1156  *      enum bpf_netdev_command for details.
1157  * int (*ndo_xdp_xmit)(struct net_device *dev, struct xdp_buff *xdp);
1158  *      This function is used to submit a XDP packet for transmit on a
1159  *      netdevice.
1160  * void (*ndo_xdp_flush)(struct net_device *dev);
1161  *      This function is used to inform the driver to flush a particular
1162  *      xdp tx queue. Must be called on same CPU as xdp_xmit.
1163  */
1164 struct net_device_ops {
1165         int                     (*ndo_init)(struct net_device *dev);
1166         void                    (*ndo_uninit)(struct net_device *dev);
1167         int                     (*ndo_open)(struct net_device *dev);
1168         int                     (*ndo_stop)(struct net_device *dev);
1169         netdev_tx_t             (*ndo_start_xmit)(struct sk_buff *skb,
1170                                                   struct net_device *dev);
1171         netdev_features_t       (*ndo_features_check)(struct sk_buff *skb,
1172                                                       struct net_device *dev,
1173                                                       netdev_features_t features);
1174         u16                     (*ndo_select_queue)(struct net_device *dev,
1175                                                     struct sk_buff *skb,
1176                                                     void *accel_priv,
1177                                                     select_queue_fallback_t fallback);
1178         void                    (*ndo_change_rx_flags)(struct net_device *dev,
1179                                                        int flags);
1180         void                    (*ndo_set_rx_mode)(struct net_device *dev);
1181         int                     (*ndo_set_mac_address)(struct net_device *dev,
1182                                                        void *addr);
1183         int                     (*ndo_validate_addr)(struct net_device *dev);
1184         int                     (*ndo_do_ioctl)(struct net_device *dev,
1185                                                 struct ifreq *ifr, int cmd);
1186         int                     (*ndo_set_config)(struct net_device *dev,
1187                                                   struct ifmap *map);
1188         int                     (*ndo_change_mtu)(struct net_device *dev,
1189                                                   int new_mtu);
1190         int                     (*ndo_neigh_setup)(struct net_device *dev,
1191                                                    struct neigh_parms *);
1192         void                    (*ndo_tx_timeout) (struct net_device *dev);
1193
1194         void                    (*ndo_get_stats64)(struct net_device *dev,
1195                                                    struct rtnl_link_stats64 *storage);
1196         bool                    (*ndo_has_offload_stats)(const struct net_device *dev, int attr_id);
1197         int                     (*ndo_get_offload_stats)(int attr_id,
1198                                                          const struct net_device *dev,
1199                                                          void *attr_data);
1200         struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
1201
1202         int                     (*ndo_vlan_rx_add_vid)(struct net_device *dev,
1203                                                        __be16 proto, u16 vid);
1204         int                     (*ndo_vlan_rx_kill_vid)(struct net_device *dev,
1205                                                         __be16 proto, u16 vid);
1206 #ifdef CONFIG_NET_POLL_CONTROLLER
1207         void                    (*ndo_poll_controller)(struct net_device *dev);
1208         int                     (*ndo_netpoll_setup)(struct net_device *dev,
1209                                                      struct netpoll_info *info);
1210         void                    (*ndo_netpoll_cleanup)(struct net_device *dev);
1211 #endif
1212         int                     (*ndo_set_vf_mac)(struct net_device *dev,
1213                                                   int queue, u8 *mac);
1214         int                     (*ndo_set_vf_vlan)(struct net_device *dev,
1215                                                    int queue, u16 vlan,
1216                                                    u8 qos, __be16 proto);
1217         int                     (*ndo_set_vf_rate)(struct net_device *dev,
1218                                                    int vf, int min_tx_rate,
1219                                                    int max_tx_rate);
1220         int                     (*ndo_set_vf_spoofchk)(struct net_device *dev,
1221                                                        int vf, bool setting);
1222         int                     (*ndo_set_vf_trust)(struct net_device *dev,
1223                                                     int vf, bool setting);
1224         int                     (*ndo_get_vf_config)(struct net_device *dev,
1225                                                      int vf,
1226                                                      struct ifla_vf_info *ivf);
1227         int                     (*ndo_set_vf_link_state)(struct net_device *dev,
1228                                                          int vf, int link_state);
1229         int                     (*ndo_get_vf_stats)(struct net_device *dev,
1230                                                     int vf,
1231                                                     struct ifla_vf_stats
1232                                                     *vf_stats);
1233         int                     (*ndo_set_vf_port)(struct net_device *dev,
1234                                                    int vf,
1235                                                    struct nlattr *port[]);
1236         int                     (*ndo_get_vf_port)(struct net_device *dev,
1237                                                    int vf, struct sk_buff *skb);
1238         int                     (*ndo_set_vf_guid)(struct net_device *dev,
1239                                                    int vf, u64 guid,
1240                                                    int guid_type);
1241         int                     (*ndo_set_vf_rss_query_en)(
1242                                                    struct net_device *dev,
1243                                                    int vf, bool setting);
1244         int                     (*ndo_setup_tc)(struct net_device *dev,
1245                                                 enum tc_setup_type type,
1246                                                 void *type_data);
1247 #if IS_ENABLED(CONFIG_FCOE)
1248         int                     (*ndo_fcoe_enable)(struct net_device *dev);
1249         int                     (*ndo_fcoe_disable)(struct net_device *dev);
1250         int                     (*ndo_fcoe_ddp_setup)(struct net_device *dev,
1251                                                       u16 xid,
1252                                                       struct scatterlist *sgl,
1253                                                       unsigned int sgc);
1254         int                     (*ndo_fcoe_ddp_done)(struct net_device *dev,
1255                                                      u16 xid);
1256         int                     (*ndo_fcoe_ddp_target)(struct net_device *dev,
1257                                                        u16 xid,
1258                                                        struct scatterlist *sgl,
1259                                                        unsigned int sgc);
1260         int                     (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1261                                                         struct netdev_fcoe_hbainfo *hbainfo);
1262 #endif
1263
1264 #if IS_ENABLED(CONFIG_LIBFCOE)
1265 #define NETDEV_FCOE_WWNN 0
1266 #define NETDEV_FCOE_WWPN 1
1267         int                     (*ndo_fcoe_get_wwn)(struct net_device *dev,
1268                                                     u64 *wwn, int type);
1269 #endif
1270
1271 #ifdef CONFIG_RFS_ACCEL
1272         int                     (*ndo_rx_flow_steer)(struct net_device *dev,
1273                                                      const struct sk_buff *skb,
1274                                                      u16 rxq_index,
1275                                                      u32 flow_id);
1276 #endif
1277         int                     (*ndo_add_slave)(struct net_device *dev,
1278                                                  struct net_device *slave_dev,
1279                                                  struct netlink_ext_ack *extack);
1280         int                     (*ndo_del_slave)(struct net_device *dev,
1281                                                  struct net_device *slave_dev);
1282         netdev_features_t       (*ndo_fix_features)(struct net_device *dev,
1283                                                     netdev_features_t features);
1284         int                     (*ndo_set_features)(struct net_device *dev,
1285                                                     netdev_features_t features);
1286         int                     (*ndo_neigh_construct)(struct net_device *dev,
1287                                                        struct neighbour *n);
1288         void                    (*ndo_neigh_destroy)(struct net_device *dev,
1289                                                      struct neighbour *n);
1290
1291         int                     (*ndo_fdb_add)(struct ndmsg *ndm,
1292                                                struct nlattr *tb[],
1293                                                struct net_device *dev,
1294                                                const unsigned char *addr,
1295                                                u16 vid,
1296                                                u16 flags);
1297         int                     (*ndo_fdb_del)(struct ndmsg *ndm,
1298                                                struct nlattr *tb[],
1299                                                struct net_device *dev,
1300                                                const unsigned char *addr,
1301                                                u16 vid);
1302         int                     (*ndo_fdb_dump)(struct sk_buff *skb,
1303                                                 struct netlink_callback *cb,
1304                                                 struct net_device *dev,
1305                                                 struct net_device *filter_dev,
1306                                                 int *idx);
1307
1308         int                     (*ndo_bridge_setlink)(struct net_device *dev,
1309                                                       struct nlmsghdr *nlh,
1310                                                       u16 flags);
1311         int                     (*ndo_bridge_getlink)(struct sk_buff *skb,
1312                                                       u32 pid, u32 seq,
1313                                                       struct net_device *dev,
1314                                                       u32 filter_mask,
1315                                                       int nlflags);
1316         int                     (*ndo_bridge_dellink)(struct net_device *dev,
1317                                                       struct nlmsghdr *nlh,
1318                                                       u16 flags);
1319         int                     (*ndo_change_carrier)(struct net_device *dev,
1320                                                       bool new_carrier);
1321         int                     (*ndo_get_phys_port_id)(struct net_device *dev,
1322                                                         struct netdev_phys_item_id *ppid);
1323         int                     (*ndo_get_phys_port_name)(struct net_device *dev,
1324                                                           char *name, size_t len);
1325         void                    (*ndo_udp_tunnel_add)(struct net_device *dev,
1326                                                       struct udp_tunnel_info *ti);
1327         void                    (*ndo_udp_tunnel_del)(struct net_device *dev,
1328                                                       struct udp_tunnel_info *ti);
1329         void*                   (*ndo_dfwd_add_station)(struct net_device *pdev,
1330                                                         struct net_device *dev);
1331         void                    (*ndo_dfwd_del_station)(struct net_device *pdev,
1332                                                         void *priv);
1333
1334         int                     (*ndo_get_lock_subclass)(struct net_device *dev);
1335         int                     (*ndo_set_tx_maxrate)(struct net_device *dev,
1336                                                       int queue_index,
1337                                                       u32 maxrate);
1338         int                     (*ndo_get_iflink)(const struct net_device *dev);
1339         int                     (*ndo_change_proto_down)(struct net_device *dev,
1340                                                          bool proto_down);
1341         int                     (*ndo_fill_metadata_dst)(struct net_device *dev,
1342                                                        struct sk_buff *skb);
1343         void                    (*ndo_set_rx_headroom)(struct net_device *dev,
1344                                                        int needed_headroom);
1345         int                     (*ndo_bpf)(struct net_device *dev,
1346                                            struct netdev_bpf *bpf);
1347         int                     (*ndo_xdp_xmit)(struct net_device *dev,
1348                                                 struct xdp_buff *xdp);
1349         void                    (*ndo_xdp_flush)(struct net_device *dev);
1350 };
1351
1352 /**
1353  * enum net_device_priv_flags - &struct net_device priv_flags
1354  *
1355  * These are the &struct net_device, they are only set internally
1356  * by drivers and used in the kernel. These flags are invisible to
1357  * userspace; this means that the order of these flags can change
1358  * during any kernel release.
1359  *
1360  * You should have a pretty good reason to be extending these flags.
1361  *
1362  * @IFF_802_1Q_VLAN: 802.1Q VLAN device
1363  * @IFF_EBRIDGE: Ethernet bridging device
1364  * @IFF_BONDING: bonding master or slave
1365  * @IFF_ISATAP: ISATAP interface (RFC4214)
1366  * @IFF_WAN_HDLC: WAN HDLC device
1367  * @IFF_XMIT_DST_RELEASE: dev_hard_start_xmit() is allowed to
1368  *      release skb->dst
1369  * @IFF_DONT_BRIDGE: disallow bridging this ether dev
1370  * @IFF_DISABLE_NETPOLL: disable netpoll at run-time
1371  * @IFF_MACVLAN_PORT: device used as macvlan port
1372  * @IFF_BRIDGE_PORT: device used as bridge port
1373  * @IFF_OVS_DATAPATH: device used as Open vSwitch datapath port
1374  * @IFF_TX_SKB_SHARING: The interface supports sharing skbs on transmit
1375  * @IFF_UNICAST_FLT: Supports unicast filtering
1376  * @IFF_TEAM_PORT: device used as team port
1377  * @IFF_SUPP_NOFCS: device supports sending custom FCS
1378  * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
1379  *      change when it's running
1380  * @IFF_MACVLAN: Macvlan device
1381  * @IFF_XMIT_DST_RELEASE_PERM: IFF_XMIT_DST_RELEASE not taking into account
1382  *      underlying stacked devices
1383  * @IFF_IPVLAN_MASTER: IPvlan master device
1384  * @IFF_IPVLAN_SLAVE: IPvlan slave device
1385  * @IFF_L3MDEV_MASTER: device is an L3 master device
1386  * @IFF_NO_QUEUE: device can run without qdisc attached
1387  * @IFF_OPENVSWITCH: device is a Open vSwitch master
1388  * @IFF_L3MDEV_SLAVE: device is enslaved to an L3 master device
1389  * @IFF_TEAM: device is a team device
1390  * @IFF_RXFH_CONFIGURED: device has had Rx Flow indirection table configured
1391  * @IFF_PHONY_HEADROOM: the headroom value is controlled by an external
1392  *      entity (i.e. the master device for bridged veth)
1393  * @IFF_MACSEC: device is a MACsec device
1394  */
1395 enum netdev_priv_flags {
1396         IFF_802_1Q_VLAN                 = 1<<0,
1397         IFF_EBRIDGE                     = 1<<1,
1398         IFF_BONDING                     = 1<<2,
1399         IFF_ISATAP                      = 1<<3,
1400         IFF_WAN_HDLC                    = 1<<4,
1401         IFF_XMIT_DST_RELEASE            = 1<<5,
1402         IFF_DONT_BRIDGE                 = 1<<6,
1403         IFF_DISABLE_NETPOLL             = 1<<7,
1404         IFF_MACVLAN_PORT                = 1<<8,
1405         IFF_BRIDGE_PORT                 = 1<<9,
1406         IFF_OVS_DATAPATH                = 1<<10,
1407         IFF_TX_SKB_SHARING              = 1<<11,
1408         IFF_UNICAST_FLT                 = 1<<12,
1409         IFF_TEAM_PORT                   = 1<<13,
1410         IFF_SUPP_NOFCS                  = 1<<14,
1411         IFF_LIVE_ADDR_CHANGE            = 1<<15,
1412         IFF_MACVLAN                     = 1<<16,
1413         IFF_XMIT_DST_RELEASE_PERM       = 1<<17,
1414         IFF_IPVLAN_MASTER               = 1<<18,
1415         IFF_IPVLAN_SLAVE                = 1<<19,
1416         IFF_L3MDEV_MASTER               = 1<<20,
1417         IFF_NO_QUEUE                    = 1<<21,
1418         IFF_OPENVSWITCH                 = 1<<22,
1419         IFF_L3MDEV_SLAVE                = 1<<23,
1420         IFF_TEAM                        = 1<<24,
1421         IFF_RXFH_CONFIGURED             = 1<<25,
1422         IFF_PHONY_HEADROOM              = 1<<26,
1423         IFF_MACSEC                      = 1<<27,
1424 };
1425
1426 #define IFF_802_1Q_VLAN                 IFF_802_1Q_VLAN
1427 #define IFF_EBRIDGE                     IFF_EBRIDGE
1428 #define IFF_BONDING                     IFF_BONDING
1429 #define IFF_ISATAP                      IFF_ISATAP
1430 #define IFF_WAN_HDLC                    IFF_WAN_HDLC
1431 #define IFF_XMIT_DST_RELEASE            IFF_XMIT_DST_RELEASE
1432 #define IFF_DONT_BRIDGE                 IFF_DONT_BRIDGE
1433 #define IFF_DISABLE_NETPOLL             IFF_DISABLE_NETPOLL
1434 #define IFF_MACVLAN_PORT                IFF_MACVLAN_PORT
1435 #define IFF_BRIDGE_PORT                 IFF_BRIDGE_PORT
1436 #define IFF_OVS_DATAPATH                IFF_OVS_DATAPATH
1437 #define IFF_TX_SKB_SHARING              IFF_TX_SKB_SHARING
1438 #define IFF_UNICAST_FLT                 IFF_UNICAST_FLT
1439 #define IFF_TEAM_PORT                   IFF_TEAM_PORT
1440 #define IFF_SUPP_NOFCS                  IFF_SUPP_NOFCS
1441 #define IFF_LIVE_ADDR_CHANGE            IFF_LIVE_ADDR_CHANGE
1442 #define IFF_MACVLAN                     IFF_MACVLAN
1443 #define IFF_XMIT_DST_RELEASE_PERM       IFF_XMIT_DST_RELEASE_PERM
1444 #define IFF_IPVLAN_MASTER               IFF_IPVLAN_MASTER
1445 #define IFF_IPVLAN_SLAVE                IFF_IPVLAN_SLAVE
1446 #define IFF_L3MDEV_MASTER               IFF_L3MDEV_MASTER
1447 #define IFF_NO_QUEUE                    IFF_NO_QUEUE
1448 #define IFF_OPENVSWITCH                 IFF_OPENVSWITCH
1449 #define IFF_L3MDEV_SLAVE                IFF_L3MDEV_SLAVE
1450 #define IFF_TEAM                        IFF_TEAM
1451 #define IFF_RXFH_CONFIGURED             IFF_RXFH_CONFIGURED
1452 #define IFF_MACSEC                      IFF_MACSEC
1453
1454 /**
1455  *      struct net_device - The DEVICE structure.
1456  *
1457  *      Actually, this whole structure is a big mistake.  It mixes I/O
1458  *      data with strictly "high-level" data, and it has to know about
1459  *      almost every data structure used in the INET module.
1460  *
1461  *      @name:  This is the first field of the "visible" part of this structure
1462  *              (i.e. as seen by users in the "Space.c" file).  It is the name
1463  *              of the interface.
1464  *
1465  *      @name_hlist:    Device name hash chain, please keep it close to name[]
1466  *      @ifalias:       SNMP alias
1467  *      @mem_end:       Shared memory end
1468  *      @mem_start:     Shared memory start
1469  *      @base_addr:     Device I/O address
1470  *      @irq:           Device IRQ number
1471  *
1472  *      @state:         Generic network queuing layer state, see netdev_state_t
1473  *      @dev_list:      The global list of network devices
1474  *      @napi_list:     List entry used for polling NAPI devices
1475  *      @unreg_list:    List entry  when we are unregistering the
1476  *                      device; see the function unregister_netdev
1477  *      @close_list:    List entry used when we are closing the device
1478  *      @ptype_all:     Device-specific packet handlers for all protocols
1479  *      @ptype_specific: Device-specific, protocol-specific packet handlers
1480  *
1481  *      @adj_list:      Directly linked devices, like slaves for bonding
1482  *      @features:      Currently active device features
1483  *      @hw_features:   User-changeable features
1484  *
1485  *      @wanted_features:       User-requested features
1486  *      @vlan_features:         Mask of features inheritable by VLAN devices
1487  *
1488  *      @hw_enc_features:       Mask of features inherited by encapsulating devices
1489  *                              This field indicates what encapsulation
1490  *                              offloads the hardware is capable of doing,
1491  *                              and drivers will need to set them appropriately.
1492  *
1493  *      @mpls_features: Mask of features inheritable by MPLS
1494  *
1495  *      @ifindex:       interface index
1496  *      @group:         The group the device belongs to
1497  *
1498  *      @stats:         Statistics struct, which was left as a legacy, use
1499  *                      rtnl_link_stats64 instead
1500  *
1501  *      @rx_dropped:    Dropped packets by core network,
1502  *                      do not use this in drivers
1503  *      @tx_dropped:    Dropped packets by core network,
1504  *                      do not use this in drivers
1505  *      @rx_nohandler:  nohandler dropped packets by core network on
1506  *                      inactive devices, do not use this in drivers
1507  *      @carrier_up_count:      Number of times the carrier has been up
1508  *      @carrier_down_count:    Number of times the carrier has been down
1509  *
1510  *      @wireless_handlers:     List of functions to handle Wireless Extensions,
1511  *                              instead of ioctl,
1512  *                              see <net/iw_handler.h> for details.
1513  *      @wireless_data: Instance data managed by the core of wireless extensions
1514  *
1515  *      @netdev_ops:    Includes several pointers to callbacks,
1516  *                      if one wants to override the ndo_*() functions
1517  *      @ethtool_ops:   Management operations
1518  *      @ndisc_ops:     Includes callbacks for different IPv6 neighbour
1519  *                      discovery handling. Necessary for e.g. 6LoWPAN.
1520  *      @header_ops:    Includes callbacks for creating,parsing,caching,etc
1521  *                      of Layer 2 headers.
1522  *
1523  *      @flags:         Interface flags (a la BSD)
1524  *      @priv_flags:    Like 'flags' but invisible to userspace,
1525  *                      see if.h for the definitions
1526  *      @gflags:        Global flags ( kept as legacy )
1527  *      @padded:        How much padding added by alloc_netdev()
1528  *      @operstate:     RFC2863 operstate
1529  *      @link_mode:     Mapping policy to operstate
1530  *      @if_port:       Selectable AUI, TP, ...
1531  *      @dma:           DMA channel
1532  *      @mtu:           Interface MTU value
1533  *      @min_mtu:       Interface Minimum MTU value
1534  *      @max_mtu:       Interface Maximum MTU value
1535  *      @type:          Interface hardware type
1536  *      @hard_header_len: Maximum hardware header length.
1537  *      @min_header_len:  Minimum hardware header length
1538  *
1539  *      @needed_headroom: Extra headroom the hardware may need, but not in all
1540  *                        cases can this be guaranteed
1541  *      @needed_tailroom: Extra tailroom the hardware may need, but not in all
1542  *                        cases can this be guaranteed. Some cases also use
1543  *                        LL_MAX_HEADER instead to allocate the skb
1544  *
1545  *      interface address info:
1546  *
1547  *      @perm_addr:             Permanent hw address
1548  *      @addr_assign_type:      Hw address assignment type
1549  *      @addr_len:              Hardware address length
1550  *      @neigh_priv_len:        Used in neigh_alloc()
1551  *      @dev_id:                Used to differentiate devices that share
1552  *                              the same link layer address
1553  *      @dev_port:              Used to differentiate devices that share
1554  *                              the same function
1555  *      @addr_list_lock:        XXX: need comments on this one
1556  *      @uc_promisc:            Counter that indicates promiscuous mode
1557  *                              has been enabled due to the need to listen to
1558  *                              additional unicast addresses in a device that
1559  *                              does not implement ndo_set_rx_mode()
1560  *      @uc:                    unicast mac addresses
1561  *      @mc:                    multicast mac addresses
1562  *      @dev_addrs:             list of device hw addresses
1563  *      @queues_kset:           Group of all Kobjects in the Tx and RX queues
1564  *      @promiscuity:           Number of times the NIC is told to work in
1565  *                              promiscuous mode; if it becomes 0 the NIC will
1566  *                              exit promiscuous mode
1567  *      @allmulti:              Counter, enables or disables allmulticast mode
1568  *
1569  *      @vlan_info:     VLAN info
1570  *      @dsa_ptr:       dsa specific data
1571  *      @tipc_ptr:      TIPC specific data
1572  *      @atalk_ptr:     AppleTalk link
1573  *      @ip_ptr:        IPv4 specific data
1574  *      @dn_ptr:        DECnet specific data
1575  *      @ip6_ptr:       IPv6 specific data
1576  *      @ax25_ptr:      AX.25 specific data
1577  *      @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
1578  *
1579  *      @dev_addr:      Hw address (before bcast,
1580  *                      because most packets are unicast)
1581  *
1582  *      @_rx:                   Array of RX queues
1583  *      @num_rx_queues:         Number of RX queues
1584  *                              allocated at register_netdev() time
1585  *      @real_num_rx_queues:    Number of RX queues currently active in device
1586  *
1587  *      @rx_handler:            handler for received packets
1588  *      @rx_handler_data:       XXX: need comments on this one
1589  *      @miniq_ingress:         ingress/clsact qdisc specific data for
1590  *                              ingress processing
1591  *      @ingress_queue:         XXX: need comments on this one
1592  *      @broadcast:             hw bcast address
1593  *
1594  *      @rx_cpu_rmap:   CPU reverse-mapping for RX completion interrupts,
1595  *                      indexed by RX queue number. Assigned by driver.
1596  *                      This must only be set if the ndo_rx_flow_steer
1597  *                      operation is defined
1598  *      @index_hlist:           Device index hash chain
1599  *
1600  *      @_tx:                   Array of TX queues
1601  *      @num_tx_queues:         Number of TX queues allocated at alloc_netdev_mq() time
1602  *      @real_num_tx_queues:    Number of TX queues currently active in device
1603  *      @qdisc:                 Root qdisc from userspace point of view
1604  *      @tx_queue_len:          Max frames per queue allowed
1605  *      @tx_global_lock:        XXX: need comments on this one
1606  *
1607  *      @xps_maps:      XXX: need comments on this one
1608  *      @miniq_egress:          clsact qdisc specific data for
1609  *                              egress processing
1610  *      @watchdog_timeo:        Represents the timeout that is used by
1611  *                              the watchdog (see dev_watchdog())
1612  *      @watchdog_timer:        List of timers
1613  *
1614  *      @pcpu_refcnt:           Number of references to this device
1615  *      @todo_list:             Delayed register/unregister
1616  *      @link_watch_list:       XXX: need comments on this one
1617  *
1618  *      @reg_state:             Register/unregister state machine
1619  *      @dismantle:             Device is going to be freed
1620  *      @rtnl_link_state:       This enum represents the phases of creating
1621  *                              a new link
1622  *
1623  *      @needs_free_netdev:     Should unregister perform free_netdev?
1624  *      @priv_destructor:       Called from unregister
1625  *      @npinfo:                XXX: need comments on this one
1626  *      @nd_net:                Network namespace this network device is inside
1627  *
1628  *      @ml_priv:       Mid-layer private
1629  *      @lstats:        Loopback statistics
1630  *      @tstats:        Tunnel statistics
1631  *      @dstats:        Dummy statistics
1632  *      @vstats:        Virtual ethernet statistics
1633  *
1634  *      @garp_port:     GARP
1635  *      @mrp_port:      MRP
1636  *
1637  *      @dev:           Class/net/name entry
1638  *      @sysfs_groups:  Space for optional device, statistics and wireless
1639  *                      sysfs groups
1640  *
1641  *      @sysfs_rx_queue_group:  Space for optional per-rx queue attributes
1642  *      @rtnl_link_ops: Rtnl_link_ops
1643  *
1644  *      @gso_max_size:  Maximum size of generic segmentation offload
1645  *      @gso_max_segs:  Maximum number of segments that can be passed to the
1646  *                      NIC for GSO
1647  *
1648  *      @dcbnl_ops:     Data Center Bridging netlink ops
1649  *      @num_tc:        Number of traffic classes in the net device
1650  *      @tc_to_txq:     XXX: need comments on this one
1651  *      @prio_tc_map:   XXX: need comments on this one
1652  *
1653  *      @fcoe_ddp_xid:  Max exchange id for FCoE LRO by ddp
1654  *
1655  *      @priomap:       XXX: need comments on this one
1656  *      @phydev:        Physical device may attach itself
1657  *                      for hardware timestamping
1658  *
1659  *      @qdisc_tx_busylock: lockdep class annotating Qdisc->busylock spinlock
1660  *      @qdisc_running_key: lockdep class annotating Qdisc->running seqcount
1661  *
1662  *      @proto_down:    protocol port state information can be sent to the
1663  *                      switch driver and used to set the phys state of the
1664  *                      switch port.
1665  *
1666  *      FIXME: cleanup struct net_device such that network protocol info
1667  *      moves out.
1668  */
1669
1670 struct net_device {
1671         char                    name[IFNAMSIZ];
1672         struct hlist_node       name_hlist;
1673         struct dev_ifalias      __rcu *ifalias;
1674         /*
1675          *      I/O specific fields
1676          *      FIXME: Merge these and struct ifmap into one
1677          */
1678         unsigned long           mem_end;
1679         unsigned long           mem_start;
1680         unsigned long           base_addr;
1681         int                     irq;
1682
1683         /*
1684          *      Some hardware also needs these fields (state,dev_list,
1685          *      napi_list,unreg_list,close_list) but they are not
1686          *      part of the usual set specified in Space.c.
1687          */
1688
1689         unsigned long           state;
1690
1691         struct list_head        dev_list;
1692         struct list_head        napi_list;
1693         struct list_head        unreg_list;
1694         struct list_head        close_list;
1695         struct list_head        ptype_all;
1696         struct list_head        ptype_specific;
1697
1698         struct {
1699                 struct list_head upper;
1700                 struct list_head lower;
1701         } adj_list;
1702
1703         netdev_features_t       features;
1704         netdev_features_t       hw_features;
1705         netdev_features_t       wanted_features;
1706         netdev_features_t       vlan_features;
1707         netdev_features_t       hw_enc_features;
1708         netdev_features_t       mpls_features;
1709         netdev_features_t       gso_partial_features;
1710
1711         int                     ifindex;
1712         int                     group;
1713
1714         struct net_device_stats stats;
1715
1716         atomic_long_t           rx_dropped;
1717         atomic_long_t           tx_dropped;
1718         atomic_long_t           rx_nohandler;
1719
1720         /* Stats to monitor link on/off, flapping */
1721         atomic_t                carrier_up_count;
1722         atomic_t                carrier_down_count;
1723
1724 #ifdef CONFIG_WIRELESS_EXT
1725         const struct iw_handler_def *wireless_handlers;
1726         struct iw_public_data   *wireless_data;
1727 #endif
1728         const struct net_device_ops *netdev_ops;
1729         const struct ethtool_ops *ethtool_ops;
1730 #ifdef CONFIG_NET_SWITCHDEV
1731         const struct switchdev_ops *switchdev_ops;
1732 #endif
1733 #ifdef CONFIG_NET_L3_MASTER_DEV
1734         const struct l3mdev_ops *l3mdev_ops;
1735 #endif
1736 #if IS_ENABLED(CONFIG_IPV6)
1737         const struct ndisc_ops *ndisc_ops;
1738 #endif
1739
1740 #ifdef CONFIG_XFRM_OFFLOAD
1741         const struct xfrmdev_ops *xfrmdev_ops;
1742 #endif
1743
1744         const struct header_ops *header_ops;
1745
1746         unsigned int            flags;
1747         unsigned int            priv_flags;
1748
1749         unsigned short          gflags;
1750         unsigned short          padded;
1751
1752         unsigned char           operstate;
1753         unsigned char           link_mode;
1754
1755         unsigned char           if_port;
1756         unsigned char           dma;
1757
1758         unsigned int            mtu;
1759         unsigned int            min_mtu;
1760         unsigned int            max_mtu;
1761         unsigned short          type;
1762         unsigned short          hard_header_len;
1763         unsigned char           min_header_len;
1764
1765         unsigned short          needed_headroom;
1766         unsigned short          needed_tailroom;
1767
1768         /* Interface address info. */
1769         unsigned char           perm_addr[MAX_ADDR_LEN];
1770         unsigned char           addr_assign_type;
1771         unsigned char           addr_len;
1772         unsigned short          neigh_priv_len;
1773         unsigned short          dev_id;
1774         unsigned short          dev_port;
1775         spinlock_t              addr_list_lock;
1776         unsigned char           name_assign_type;
1777         bool                    uc_promisc;
1778         struct netdev_hw_addr_list      uc;
1779         struct netdev_hw_addr_list      mc;
1780         struct netdev_hw_addr_list      dev_addrs;
1781
1782 #ifdef CONFIG_SYSFS
1783         struct kset             *queues_kset;
1784 #endif
1785         unsigned int            promiscuity;
1786         unsigned int            allmulti;
1787
1788
1789         /* Protocol-specific pointers */
1790
1791 #if IS_ENABLED(CONFIG_VLAN_8021Q)
1792         struct vlan_info __rcu  *vlan_info;
1793 #endif
1794 #if IS_ENABLED(CONFIG_NET_DSA)
1795         struct dsa_port         *dsa_ptr;
1796 #endif
1797 #if IS_ENABLED(CONFIG_TIPC)
1798         struct tipc_bearer __rcu *tipc_ptr;
1799 #endif
1800         void                    *atalk_ptr;
1801         struct in_device __rcu  *ip_ptr;
1802         struct dn_dev __rcu     *dn_ptr;
1803         struct inet6_dev __rcu  *ip6_ptr;
1804         void                    *ax25_ptr;
1805         struct wireless_dev     *ieee80211_ptr;
1806         struct wpan_dev         *ieee802154_ptr;
1807 #if IS_ENABLED(CONFIG_MPLS_ROUTING)
1808         struct mpls_dev __rcu   *mpls_ptr;
1809 #endif
1810
1811 /*
1812  * Cache lines mostly used on receive path (including eth_type_trans())
1813  */
1814         /* Interface address info used in eth_type_trans() */
1815         unsigned char           *dev_addr;
1816
1817         struct netdev_rx_queue  *_rx;
1818         unsigned int            num_rx_queues;
1819         unsigned int            real_num_rx_queues;
1820
1821         struct bpf_prog __rcu   *xdp_prog;
1822         unsigned long           gro_flush_timeout;
1823         rx_handler_func_t __rcu *rx_handler;
1824         void __rcu              *rx_handler_data;
1825
1826 #ifdef CONFIG_NET_CLS_ACT
1827         struct mini_Qdisc __rcu *miniq_ingress;
1828 #endif
1829         struct netdev_queue __rcu *ingress_queue;
1830 #ifdef CONFIG_NETFILTER_INGRESS
1831         struct nf_hook_entries __rcu *nf_hooks_ingress;
1832 #endif
1833
1834         unsigned char           broadcast[MAX_ADDR_LEN];
1835 #ifdef CONFIG_RFS_ACCEL
1836         struct cpu_rmap         *rx_cpu_rmap;
1837 #endif
1838         struct hlist_node       index_hlist;
1839
1840 /*
1841  * Cache lines mostly used on transmit path
1842  */
1843         struct netdev_queue     *_tx ____cacheline_aligned_in_smp;
1844         unsigned int            num_tx_queues;
1845         unsigned int            real_num_tx_queues;
1846         struct Qdisc            *qdisc;
1847 #ifdef CONFIG_NET_SCHED
1848         DECLARE_HASHTABLE       (qdisc_hash, 4);
1849 #endif
1850         unsigned int            tx_queue_len;
1851         spinlock_t              tx_global_lock;
1852         int                     watchdog_timeo;
1853
1854 #ifdef CONFIG_XPS
1855         struct xps_dev_maps __rcu *xps_maps;
1856 #endif
1857 #ifdef CONFIG_NET_CLS_ACT
1858         struct mini_Qdisc __rcu *miniq_egress;
1859 #endif
1860
1861         /* These may be needed for future network-power-down code. */
1862         struct timer_list       watchdog_timer;
1863
1864         int __percpu            *pcpu_refcnt;
1865         struct list_head        todo_list;
1866
1867         struct list_head        link_watch_list;
1868
1869         enum { NETREG_UNINITIALIZED=0,
1870                NETREG_REGISTERED,       /* completed register_netdevice */
1871                NETREG_UNREGISTERING,    /* called unregister_netdevice */
1872                NETREG_UNREGISTERED,     /* completed unregister todo */
1873                NETREG_RELEASED,         /* called free_netdev */
1874                NETREG_DUMMY,            /* dummy device for NAPI poll */
1875         } reg_state:8;
1876
1877         bool dismantle;
1878
1879         enum {
1880                 RTNL_LINK_INITIALIZED,
1881                 RTNL_LINK_INITIALIZING,
1882         } rtnl_link_state:16;
1883
1884         bool needs_free_netdev;
1885         void (*priv_destructor)(struct net_device *dev);
1886
1887 #ifdef CONFIG_NETPOLL
1888         struct netpoll_info __rcu       *npinfo;
1889 #endif
1890
1891         possible_net_t                  nd_net;
1892
1893         /* mid-layer private */
1894         union {
1895                 void                                    *ml_priv;
1896                 struct pcpu_lstats __percpu             *lstats;
1897                 struct pcpu_sw_netstats __percpu        *tstats;
1898                 struct pcpu_dstats __percpu             *dstats;
1899                 struct pcpu_vstats __percpu             *vstats;
1900         };
1901
1902 #if IS_ENABLED(CONFIG_GARP)
1903         struct garp_port __rcu  *garp_port;
1904 #endif
1905 #if IS_ENABLED(CONFIG_MRP)
1906         struct mrp_port __rcu   *mrp_port;
1907 #endif
1908
1909         struct device           dev;
1910         const struct attribute_group *sysfs_groups[4];
1911         const struct attribute_group *sysfs_rx_queue_group;
1912
1913         const struct rtnl_link_ops *rtnl_link_ops;
1914
1915         /* for setting kernel sock attribute on TCP connection setup */
1916 #define GSO_MAX_SIZE            65536
1917         unsigned int            gso_max_size;
1918 #define GSO_MAX_SEGS            65535
1919         u16                     gso_max_segs;
1920
1921 #ifdef CONFIG_DCB
1922         const struct dcbnl_rtnl_ops *dcbnl_ops;
1923 #endif
1924         u8                      num_tc;
1925         struct netdev_tc_txq    tc_to_txq[TC_MAX_QUEUE];
1926         u8                      prio_tc_map[TC_BITMASK + 1];
1927
1928 #if IS_ENABLED(CONFIG_FCOE)
1929         unsigned int            fcoe_ddp_xid;
1930 #endif
1931 #if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
1932         struct netprio_map __rcu *priomap;
1933 #endif
1934         struct phy_device       *phydev;
1935         struct lock_class_key   *qdisc_tx_busylock;
1936         struct lock_class_key   *qdisc_running_key;
1937         bool                    proto_down;
1938 };
1939 #define to_net_dev(d) container_of(d, struct net_device, dev)
1940
1941 static inline bool netif_elide_gro(const struct net_device *dev)
1942 {
1943         if (!(dev->features & NETIF_F_GRO) || dev->xdp_prog)
1944                 return true;
1945         return false;
1946 }
1947
1948 #define NETDEV_ALIGN            32
1949
1950 static inline
1951 int netdev_get_prio_tc_map(const struct net_device *dev, u32 prio)
1952 {
1953         return dev->prio_tc_map[prio & TC_BITMASK];
1954 }
1955
1956 static inline
1957 int netdev_set_prio_tc_map(struct net_device *dev, u8 prio, u8 tc)
1958 {
1959         if (tc >= dev->num_tc)
1960                 return -EINVAL;
1961
1962         dev->prio_tc_map[prio & TC_BITMASK] = tc & TC_BITMASK;
1963         return 0;
1964 }
1965
1966 int netdev_txq_to_tc(struct net_device *dev, unsigned int txq);
1967 void netdev_reset_tc(struct net_device *dev);
1968 int netdev_set_tc_queue(struct net_device *dev, u8 tc, u16 count, u16 offset);
1969 int netdev_set_num_tc(struct net_device *dev, u8 num_tc);
1970
1971 static inline
1972 int netdev_get_num_tc(struct net_device *dev)
1973 {
1974         return dev->num_tc;
1975 }
1976
1977 static inline
1978 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
1979                                          unsigned int index)
1980 {
1981         return &dev->_tx[index];
1982 }
1983
1984 static inline struct netdev_queue *skb_get_tx_queue(const struct net_device *dev,
1985                                                     const struct sk_buff *skb)
1986 {
1987         return netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
1988 }
1989
1990 static inline void netdev_for_each_tx_queue(struct net_device *dev,
1991                                             void (*f)(struct net_device *,
1992                                                       struct netdev_queue *,
1993                                                       void *),
1994                                             void *arg)
1995 {
1996         unsigned int i;
1997
1998         for (i = 0; i < dev->num_tx_queues; i++)
1999                 f(dev, &dev->_tx[i], arg);
2000 }
2001
2002 #define netdev_lockdep_set_classes(dev)                         \
2003 {                                                               \
2004         static struct lock_class_key qdisc_tx_busylock_key;     \
2005         static struct lock_class_key qdisc_running_key;         \
2006         static struct lock_class_key qdisc_xmit_lock_key;       \
2007         static struct lock_class_key dev_addr_list_lock_key;    \
2008         unsigned int i;                                         \
2009                                                                 \
2010         (dev)->qdisc_tx_busylock = &qdisc_tx_busylock_key;      \
2011         (dev)->qdisc_running_key = &qdisc_running_key;          \
2012         lockdep_set_class(&(dev)->addr_list_lock,               \
2013                           &dev_addr_list_lock_key);             \
2014         for (i = 0; i < (dev)->num_tx_queues; i++)              \
2015                 lockdep_set_class(&(dev)->_tx[i]._xmit_lock,    \
2016                                   &qdisc_xmit_lock_key);        \
2017 }
2018
2019 struct netdev_queue *netdev_pick_tx(struct net_device *dev,
2020                                     struct sk_buff *skb,
2021                                     void *accel_priv);
2022
2023 /* returns the headroom that the master device needs to take in account
2024  * when forwarding to this dev
2025  */
2026 static inline unsigned netdev_get_fwd_headroom(struct net_device *dev)
2027 {
2028         return dev->priv_flags & IFF_PHONY_HEADROOM ? 0 : dev->needed_headroom;
2029 }
2030
2031 static inline void netdev_set_rx_headroom(struct net_device *dev, int new_hr)
2032 {
2033         if (dev->netdev_ops->ndo_set_rx_headroom)
2034                 dev->netdev_ops->ndo_set_rx_headroom(dev, new_hr);
2035 }
2036
2037 /* set the device rx headroom to the dev's default */
2038 static inline void netdev_reset_rx_headroom(struct net_device *dev)
2039 {
2040         netdev_set_rx_headroom(dev, -1);
2041 }
2042
2043 /*
2044  * Net namespace inlines
2045  */
2046 static inline
2047 struct net *dev_net(const struct net_device *dev)
2048 {
2049         return read_pnet(&dev->nd_net);
2050 }
2051
2052 static inline
2053 void dev_net_set(struct net_device *dev, struct net *net)
2054 {
2055         write_pnet(&dev->nd_net, net);
2056 }
2057
2058 /**
2059  *      netdev_priv - access network device private data
2060  *      @dev: network device
2061  *
2062  * Get network device private data
2063  */
2064 static inline void *netdev_priv(const struct net_device *dev)
2065 {
2066         return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
2067 }
2068
2069 /* Set the sysfs physical device reference for the network logical device
2070  * if set prior to registration will cause a symlink during initialization.
2071  */
2072 #define SET_NETDEV_DEV(net, pdev)       ((net)->dev.parent = (pdev))
2073
2074 /* Set the sysfs device type for the network logical device to allow
2075  * fine-grained identification of different network device types. For
2076  * example Ethernet, Wireless LAN, Bluetooth, WiMAX etc.
2077  */
2078 #define SET_NETDEV_DEVTYPE(net, devtype)        ((net)->dev.type = (devtype))
2079
2080 /* Default NAPI poll() weight
2081  * Device drivers are strongly advised to not use bigger value
2082  */
2083 #define NAPI_POLL_WEIGHT 64
2084
2085 /**
2086  *      netif_napi_add - initialize a NAPI context
2087  *      @dev:  network device
2088  *      @napi: NAPI context
2089  *      @poll: polling function
2090  *      @weight: default weight
2091  *
2092  * netif_napi_add() must be used to initialize a NAPI context prior to calling
2093  * *any* of the other NAPI-related functions.
2094  */
2095 void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
2096                     int (*poll)(struct napi_struct *, int), int weight);
2097
2098 /**
2099  *      netif_tx_napi_add - initialize a NAPI context
2100  *      @dev:  network device
2101  *      @napi: NAPI context
2102  *      @poll: polling function
2103  *      @weight: default weight
2104  *
2105  * This variant of netif_napi_add() should be used from drivers using NAPI
2106  * to exclusively poll a TX queue.
2107  * This will avoid we add it into napi_hash[], thus polluting this hash table.
2108  */
2109 static inline void netif_tx_napi_add(struct net_device *dev,
2110                                      struct napi_struct *napi,
2111                                      int (*poll)(struct napi_struct *, int),
2112                                      int weight)
2113 {
2114         set_bit(NAPI_STATE_NO_BUSY_POLL, &napi->state);
2115         netif_napi_add(dev, napi, poll, weight);
2116 }
2117
2118 /**
2119  *  netif_napi_del - remove a NAPI context
2120  *  @napi: NAPI context
2121  *
2122  *  netif_napi_del() removes a NAPI context from the network device NAPI list
2123  */
2124 void netif_napi_del(struct napi_struct *napi);
2125
2126 struct napi_gro_cb {
2127         /* Virtual address of skb_shinfo(skb)->frags[0].page + offset. */
2128         void    *frag0;
2129
2130         /* Length of frag0. */
2131         unsigned int frag0_len;
2132
2133         /* This indicates where we are processing relative to skb->data. */
2134         int     data_offset;
2135
2136         /* This is non-zero if the packet cannot be merged with the new skb. */
2137         u16     flush;
2138
2139         /* Save the IP ID here and check when we get to the transport layer */
2140         u16     flush_id;
2141
2142         /* Number of segments aggregated. */
2143         u16     count;
2144
2145         /* Start offset for remote checksum offload */
2146         u16     gro_remcsum_start;
2147
2148         /* jiffies when first packet was created/queued */
2149         unsigned long age;
2150
2151         /* Used in ipv6_gro_receive() and foo-over-udp */
2152         u16     proto;
2153
2154         /* This is non-zero if the packet may be of the same flow. */
2155         u8      same_flow:1;
2156
2157         /* Used in tunnel GRO receive */
2158         u8      encap_mark:1;
2159
2160         /* GRO checksum is valid */
2161         u8      csum_valid:1;
2162
2163         /* Number of checksums via CHECKSUM_UNNECESSARY */
2164         u8      csum_cnt:3;
2165
2166         /* Free the skb? */
2167         u8      free:2;
2168 #define NAPI_GRO_FREE             1
2169 #define NAPI_GRO_FREE_STOLEN_HEAD 2
2170
2171         /* Used in foo-over-udp, set in udp[46]_gro_receive */
2172         u8      is_ipv6:1;
2173
2174         /* Used in GRE, set in fou/gue_gro_receive */
2175         u8      is_fou:1;
2176
2177         /* Used to determine if flush_id can be ignored */
2178         u8      is_atomic:1;
2179
2180         /* Number of gro_receive callbacks this packet already went through */
2181         u8 recursion_counter:4;
2182
2183         /* 1 bit hole */
2184
2185         /* used to support CHECKSUM_COMPLETE for tunneling protocols */
2186         __wsum  csum;
2187
2188         /* used in skb_gro_receive() slow path */
2189         struct sk_buff *last;
2190 };
2191
2192 #define NAPI_GRO_CB(skb) ((struct napi_gro_cb *)(skb)->cb)
2193
2194 #define GRO_RECURSION_LIMIT 15
2195 static inline int gro_recursion_inc_test(struct sk_buff *skb)
2196 {
2197         return ++NAPI_GRO_CB(skb)->recursion_counter == GRO_RECURSION_LIMIT;
2198 }
2199
2200 typedef struct sk_buff **(*gro_receive_t)(struct sk_buff **, struct sk_buff *);
2201 static inline struct sk_buff **call_gro_receive(gro_receive_t cb,
2202                                                 struct sk_buff **head,
2203                                                 struct sk_buff *skb)
2204 {
2205         if (unlikely(gro_recursion_inc_test(skb))) {
2206                 NAPI_GRO_CB(skb)->flush |= 1;
2207                 return NULL;
2208         }
2209
2210         return cb(head, skb);
2211 }
2212
2213 typedef struct sk_buff **(*gro_receive_sk_t)(struct sock *, struct sk_buff **,
2214                                              struct sk_buff *);
2215 static inline struct sk_buff **call_gro_receive_sk(gro_receive_sk_t cb,
2216                                                    struct sock *sk,
2217                                                    struct sk_buff **head,
2218                                                    struct sk_buff *skb)
2219 {
2220         if (unlikely(gro_recursion_inc_test(skb))) {
2221                 NAPI_GRO_CB(skb)->flush |= 1;
2222                 return NULL;
2223         }
2224
2225         return cb(sk, head, skb);
2226 }
2227
2228 struct packet_type {
2229         __be16                  type;   /* This is really htons(ether_type). */
2230         struct net_device       *dev;   /* NULL is wildcarded here           */
2231         int                     (*func) (struct sk_buff *,
2232                                          struct net_device *,
2233                                          struct packet_type *,
2234                                          struct net_device *);
2235         bool                    (*id_match)(struct packet_type *ptype,
2236                                             struct sock *sk);
2237         void                    *af_packet_priv;
2238         struct list_head        list;
2239 };
2240
2241 struct offload_callbacks {
2242         struct sk_buff          *(*gso_segment)(struct sk_buff *skb,
2243                                                 netdev_features_t features);
2244         struct sk_buff          **(*gro_receive)(struct sk_buff **head,
2245                                                  struct sk_buff *skb);
2246         int                     (*gro_complete)(struct sk_buff *skb, int nhoff);
2247 };
2248
2249 struct packet_offload {
2250         __be16                   type;  /* This is really htons(ether_type). */
2251         u16                      priority;
2252         struct offload_callbacks callbacks;
2253         struct list_head         list;
2254 };
2255
2256 /* often modified stats are per-CPU, other are shared (netdev->stats) */
2257 struct pcpu_sw_netstats {
2258         u64     rx_packets;
2259         u64     rx_bytes;
2260         u64     tx_packets;
2261         u64     tx_bytes;
2262         struct u64_stats_sync   syncp;
2263 };
2264
2265 #define __netdev_alloc_pcpu_stats(type, gfp)                            \
2266 ({                                                                      \
2267         typeof(type) __percpu *pcpu_stats = alloc_percpu_gfp(type, gfp);\
2268         if (pcpu_stats) {                                               \
2269                 int __cpu;                                              \
2270                 for_each_possible_cpu(__cpu) {                          \
2271                         typeof(type) *stat;                             \
2272                         stat = per_cpu_ptr(pcpu_stats, __cpu);          \
2273                         u64_stats_init(&stat->syncp);                   \
2274                 }                                                       \
2275         }                                                               \
2276         pcpu_stats;                                                     \
2277 })
2278
2279 #define netdev_alloc_pcpu_stats(type)                                   \
2280         __netdev_alloc_pcpu_stats(type, GFP_KERNEL)
2281
2282 enum netdev_lag_tx_type {
2283         NETDEV_LAG_TX_TYPE_UNKNOWN,
2284         NETDEV_LAG_TX_TYPE_RANDOM,
2285         NETDEV_LAG_TX_TYPE_BROADCAST,
2286         NETDEV_LAG_TX_TYPE_ROUNDROBIN,
2287         NETDEV_LAG_TX_TYPE_ACTIVEBACKUP,
2288         NETDEV_LAG_TX_TYPE_HASH,
2289 };
2290
2291 struct netdev_lag_upper_info {
2292         enum netdev_lag_tx_type tx_type;
2293 };
2294
2295 struct netdev_lag_lower_state_info {
2296         u8 link_up : 1,
2297            tx_enabled : 1;
2298 };
2299
2300 #include <linux/notifier.h>
2301
2302 /* netdevice notifier chain. Please remember to update the rtnetlink
2303  * notification exclusion list in rtnetlink_event() when adding new
2304  * types.
2305  */
2306 #define NETDEV_UP       0x0001  /* For now you can't veto a device up/down */
2307 #define NETDEV_DOWN     0x0002
2308 #define NETDEV_REBOOT   0x0003  /* Tell a protocol stack a network interface
2309                                    detected a hardware crash and restarted
2310                                    - we can use this eg to kick tcp sessions
2311                                    once done */
2312 #define NETDEV_CHANGE   0x0004  /* Notify device state change */
2313 #define NETDEV_REGISTER 0x0005
2314 #define NETDEV_UNREGISTER       0x0006
2315 #define NETDEV_CHANGEMTU        0x0007 /* notify after mtu change happened */
2316 #define NETDEV_CHANGEADDR       0x0008
2317 #define NETDEV_GOING_DOWN       0x0009
2318 #define NETDEV_CHANGENAME       0x000A
2319 #define NETDEV_FEAT_CHANGE      0x000B
2320 #define NETDEV_BONDING_FAILOVER 0x000C
2321 #define NETDEV_PRE_UP           0x000D
2322 #define NETDEV_PRE_TYPE_CHANGE  0x000E
2323 #define NETDEV_POST_TYPE_CHANGE 0x000F
2324 #define NETDEV_POST_INIT        0x0010
2325 #define NETDEV_UNREGISTER_FINAL 0x0011
2326 #define NETDEV_RELEASE          0x0012
2327 #define NETDEV_NOTIFY_PEERS     0x0013
2328 #define NETDEV_JOIN             0x0014
2329 #define NETDEV_CHANGEUPPER      0x0015
2330 #define NETDEV_RESEND_IGMP      0x0016
2331 #define NETDEV_PRECHANGEMTU     0x0017 /* notify before mtu change happened */
2332 #define NETDEV_CHANGEINFODATA   0x0018
2333 #define NETDEV_BONDING_INFO     0x0019
2334 #define NETDEV_PRECHANGEUPPER   0x001A
2335 #define NETDEV_CHANGELOWERSTATE 0x001B
2336 #define NETDEV_UDP_TUNNEL_PUSH_INFO     0x001C
2337 #define NETDEV_UDP_TUNNEL_DROP_INFO     0x001D
2338 #define NETDEV_CHANGE_TX_QUEUE_LEN      0x001E
2339
2340 int register_netdevice_notifier(struct notifier_block *nb);
2341 int unregister_netdevice_notifier(struct notifier_block *nb);
2342
2343 struct netdev_notifier_info {
2344         struct net_device       *dev;
2345         struct netlink_ext_ack  *extack;
2346 };
2347
2348 struct netdev_notifier_change_info {
2349         struct netdev_notifier_info info; /* must be first */
2350         unsigned int flags_changed;
2351 };
2352
2353 struct netdev_notifier_changeupper_info {
2354         struct netdev_notifier_info info; /* must be first */
2355         struct net_device *upper_dev; /* new upper dev */
2356         bool master; /* is upper dev master */
2357         bool linking; /* is the notification for link or unlink */
2358         void *upper_info; /* upper dev info */
2359 };
2360
2361 struct netdev_notifier_changelowerstate_info {
2362         struct netdev_notifier_info info; /* must be first */
2363         void *lower_state_info; /* is lower dev state */
2364 };
2365
2366 static inline void netdev_notifier_info_init(struct netdev_notifier_info *info,
2367                                              struct net_device *dev)
2368 {
2369         info->dev = dev;
2370         info->extack = NULL;
2371 }
2372
2373 static inline struct net_device *
2374 netdev_notifier_info_to_dev(const struct netdev_notifier_info *info)
2375 {
2376         return info->dev;
2377 }
2378
2379 static inline struct netlink_ext_ack *
2380 netdev_notifier_info_to_extack(const struct netdev_notifier_info *info)
2381 {
2382         return info->extack;
2383 }
2384
2385 int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
2386
2387
2388 extern rwlock_t                         dev_base_lock;          /* Device list lock */
2389
2390 #define for_each_netdev(net, d)         \
2391                 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
2392 #define for_each_netdev_reverse(net, d) \
2393                 list_for_each_entry_reverse(d, &(net)->dev_base_head, dev_list)
2394 #define for_each_netdev_rcu(net, d)             \
2395                 list_for_each_entry_rcu(d, &(net)->dev_base_head, dev_list)
2396 #define for_each_netdev_safe(net, d, n) \
2397                 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
2398 #define for_each_netdev_continue(net, d)                \
2399                 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
2400 #define for_each_netdev_continue_rcu(net, d)            \
2401         list_for_each_entry_continue_rcu(d, &(net)->dev_base_head, dev_list)
2402 #define for_each_netdev_in_bond_rcu(bond, slave)        \
2403                 for_each_netdev_rcu(&init_net, slave)   \
2404                         if (netdev_master_upper_dev_get_rcu(slave) == (bond))
2405 #define net_device_entry(lh)    list_entry(lh, struct net_device, dev_list)
2406
2407 static inline struct net_device *next_net_device(struct net_device *dev)
2408 {
2409         struct list_head *lh;
2410         struct net *net;
2411
2412         net = dev_net(dev);
2413         lh = dev->dev_list.next;
2414         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2415 }
2416
2417 static inline struct net_device *next_net_device_rcu(struct net_device *dev)
2418 {
2419         struct list_head *lh;
2420         struct net *net;
2421
2422         net = dev_net(dev);
2423         lh = rcu_dereference(list_next_rcu(&dev->dev_list));
2424         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2425 }
2426
2427 static inline struct net_device *first_net_device(struct net *net)
2428 {
2429         return list_empty(&net->dev_base_head) ? NULL :
2430                 net_device_entry(net->dev_base_head.next);
2431 }
2432
2433 static inline struct net_device *first_net_device_rcu(struct net *net)
2434 {
2435         struct list_head *lh = rcu_dereference(list_next_rcu(&net->dev_base_head));
2436
2437         return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2438 }
2439
2440 int netdev_boot_setup_check(struct net_device *dev);
2441 unsigned long netdev_boot_base(const char *prefix, int unit);
2442 struct net_device *dev_getbyhwaddr_rcu(struct net *net, unsigned short type,
2443                                        const char *hwaddr);
2444 struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
2445 struct net_device *__dev_getfirstbyhwtype(struct net *net, unsigned short type);
2446 void dev_add_pack(struct packet_type *pt);
2447 void dev_remove_pack(struct packet_type *pt);
2448 void __dev_remove_pack(struct packet_type *pt);
2449 void dev_add_offload(struct packet_offload *po);
2450 void dev_remove_offload(struct packet_offload *po);
2451
2452 int dev_get_iflink(const struct net_device *dev);
2453 int dev_fill_metadata_dst(struct net_device *dev, struct sk_buff *skb);
2454 struct net_device *__dev_get_by_flags(struct net *net, unsigned short flags,
2455                                       unsigned short mask);
2456 struct net_device *dev_get_by_name(struct net *net, const char *name);
2457 struct net_device *dev_get_by_name_rcu(struct net *net, const char *name);
2458 struct net_device *__dev_get_by_name(struct net *net, const char *name);
2459 int dev_alloc_name(struct net_device *dev, const char *name);
2460 int dev_open(struct net_device *dev);
2461 void dev_close(struct net_device *dev);
2462 void dev_close_many(struct list_head *head, bool unlink);
2463 void dev_disable_lro(struct net_device *dev);
2464 int dev_loopback_xmit(struct net *net, struct sock *sk, struct sk_buff *newskb);
2465 int dev_queue_xmit(struct sk_buff *skb);
2466 int dev_queue_xmit_accel(struct sk_buff *skb, void *accel_priv);
2467 int register_netdevice(struct net_device *dev);
2468 void unregister_netdevice_queue(struct net_device *dev, struct list_head *head);
2469 void unregister_netdevice_many(struct list_head *head);
2470 static inline void unregister_netdevice(struct net_device *dev)
2471 {
2472         unregister_netdevice_queue(dev, NULL);
2473 }
2474
2475 int netdev_refcnt_read(const struct net_device *dev);
2476 void free_netdev(struct net_device *dev);
2477 void netdev_freemem(struct net_device *dev);
2478 void synchronize_net(void);
2479 int init_dummy_netdev(struct net_device *dev);
2480
2481 DECLARE_PER_CPU(int, xmit_recursion);
2482 #define XMIT_RECURSION_LIMIT    10
2483
2484 static inline int dev_recursion_level(void)
2485 {
2486         return this_cpu_read(xmit_recursion);
2487 }
2488
2489 struct net_device *dev_get_by_index(struct net *net, int ifindex);
2490 struct net_device *__dev_get_by_index(struct net *net, int ifindex);
2491 struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex);
2492 struct net_device *dev_get_by_napi_id(unsigned int napi_id);
2493 int netdev_get_name(struct net *net, char *name, int ifindex);
2494 int dev_restart(struct net_device *dev);
2495 int skb_gro_receive(struct sk_buff **head, struct sk_buff *skb);
2496
2497 static inline unsigned int skb_gro_offset(const struct sk_buff *skb)
2498 {
2499         return NAPI_GRO_CB(skb)->data_offset;
2500 }
2501
2502 static inline unsigned int skb_gro_len(const struct sk_buff *skb)
2503 {
2504         return skb->len - NAPI_GRO_CB(skb)->data_offset;
2505 }
2506
2507 static inline void skb_gro_pull(struct sk_buff *skb, unsigned int len)
2508 {
2509         NAPI_GRO_CB(skb)->data_offset += len;
2510 }
2511
2512 static inline void *skb_gro_header_fast(struct sk_buff *skb,
2513                                         unsigned int offset)
2514 {
2515         return NAPI_GRO_CB(skb)->frag0 + offset;
2516 }
2517
2518 static inline int skb_gro_header_hard(struct sk_buff *skb, unsigned int hlen)
2519 {
2520         return NAPI_GRO_CB(skb)->frag0_len < hlen;
2521 }
2522
2523 static inline void skb_gro_frag0_invalidate(struct sk_buff *skb)
2524 {
2525         NAPI_GRO_CB(skb)->frag0 = NULL;
2526         NAPI_GRO_CB(skb)->frag0_len = 0;
2527 }
2528
2529 static inline void *skb_gro_header_slow(struct sk_buff *skb, unsigned int hlen,
2530                                         unsigned int offset)
2531 {
2532         if (!pskb_may_pull(skb, hlen))
2533                 return NULL;
2534
2535         skb_gro_frag0_invalidate(skb);
2536         return skb->data + offset;
2537 }
2538
2539 static inline void *skb_gro_network_header(struct sk_buff *skb)
2540 {
2541         return (NAPI_GRO_CB(skb)->frag0 ?: skb->data) +
2542                skb_network_offset(skb);
2543 }
2544
2545 static inline void skb_gro_postpull_rcsum(struct sk_buff *skb,
2546                                         const void *start, unsigned int len)
2547 {
2548         if (NAPI_GRO_CB(skb)->csum_valid)
2549                 NAPI_GRO_CB(skb)->csum = csum_sub(NAPI_GRO_CB(skb)->csum,
2550                                                   csum_partial(start, len, 0));
2551 }
2552
2553 /* GRO checksum functions. These are logical equivalents of the normal
2554  * checksum functions (in skbuff.h) except that they operate on the GRO
2555  * offsets and fields in sk_buff.
2556  */
2557
2558 __sum16 __skb_gro_checksum_complete(struct sk_buff *skb);
2559
2560 static inline bool skb_at_gro_remcsum_start(struct sk_buff *skb)
2561 {
2562         return (NAPI_GRO_CB(skb)->gro_remcsum_start == skb_gro_offset(skb));
2563 }
2564
2565 static inline bool __skb_gro_checksum_validate_needed(struct sk_buff *skb,
2566                                                       bool zero_okay,
2567                                                       __sum16 check)
2568 {
2569         return ((skb->ip_summed != CHECKSUM_PARTIAL ||
2570                 skb_checksum_start_offset(skb) <
2571                  skb_gro_offset(skb)) &&
2572                 !skb_at_gro_remcsum_start(skb) &&
2573                 NAPI_GRO_CB(skb)->csum_cnt == 0 &&
2574                 (!zero_okay || check));
2575 }
2576
2577 static inline __sum16 __skb_gro_checksum_validate_complete(struct sk_buff *skb,
2578                                                            __wsum psum)
2579 {
2580         if (NAPI_GRO_CB(skb)->csum_valid &&
2581             !csum_fold(csum_add(psum, NAPI_GRO_CB(skb)->csum)))
2582                 return 0;
2583
2584         NAPI_GRO_CB(skb)->csum = psum;
2585
2586         return __skb_gro_checksum_complete(skb);
2587 }
2588
2589 static inline void skb_gro_incr_csum_unnecessary(struct sk_buff *skb)
2590 {
2591         if (NAPI_GRO_CB(skb)->csum_cnt > 0) {
2592                 /* Consume a checksum from CHECKSUM_UNNECESSARY */
2593                 NAPI_GRO_CB(skb)->csum_cnt--;
2594         } else {
2595                 /* Update skb for CHECKSUM_UNNECESSARY and csum_level when we
2596                  * verified a new top level checksum or an encapsulated one
2597                  * during GRO. This saves work if we fallback to normal path.
2598                  */
2599                 __skb_incr_checksum_unnecessary(skb);
2600         }
2601 }
2602
2603 #define __skb_gro_checksum_validate(skb, proto, zero_okay, check,       \
2604                                     compute_pseudo)                     \
2605 ({                                                                      \
2606         __sum16 __ret = 0;                                              \
2607         if (__skb_gro_checksum_validate_needed(skb, zero_okay, check))  \
2608                 __ret = __skb_gro_checksum_validate_complete(skb,       \
2609                                 compute_pseudo(skb, proto));            \
2610         if (!__ret)                                                     \
2611                 skb_gro_incr_csum_unnecessary(skb);                     \
2612         __ret;                                                          \
2613 })
2614
2615 #define skb_gro_checksum_validate(skb, proto, compute_pseudo)           \
2616         __skb_gro_checksum_validate(skb, proto, false, 0, compute_pseudo)
2617
2618 #define skb_gro_checksum_validate_zero_check(skb, proto, check,         \
2619                                              compute_pseudo)            \
2620         __skb_gro_checksum_validate(skb, proto, true, check, compute_pseudo)
2621
2622 #define skb_gro_checksum_simple_validate(skb)                           \
2623         __skb_gro_checksum_validate(skb, 0, false, 0, null_compute_pseudo)
2624
2625 static inline bool __skb_gro_checksum_convert_check(struct sk_buff *skb)
2626 {
2627         return (NAPI_GRO_CB(skb)->csum_cnt == 0 &&
2628                 !NAPI_GRO_CB(skb)->csum_valid);
2629 }
2630
2631 static inline void __skb_gro_checksum_convert(struct sk_buff *skb,
2632                                               __sum16 check, __wsum pseudo)
2633 {
2634         NAPI_GRO_CB(skb)->csum = ~pseudo;
2635         NAPI_GRO_CB(skb)->csum_valid = 1;
2636 }
2637
2638 #define skb_gro_checksum_try_convert(skb, proto, check, compute_pseudo) \
2639 do {                                                                    \
2640         if (__skb_gro_checksum_convert_check(skb))                      \
2641                 __skb_gro_checksum_convert(skb, check,                  \
2642                                            compute_pseudo(skb, proto)); \
2643 } while (0)
2644
2645 struct gro_remcsum {
2646         int offset;
2647         __wsum delta;
2648 };
2649
2650 static inline void skb_gro_remcsum_init(struct gro_remcsum *grc)
2651 {
2652         grc->offset = 0;
2653         grc->delta = 0;
2654 }
2655
2656 static inline void *skb_gro_remcsum_process(struct sk_buff *skb, void *ptr,
2657                                             unsigned int off, size_t hdrlen,
2658                                             int start, int offset,
2659                                             struct gro_remcsum *grc,
2660                                             bool nopartial)
2661 {
2662         __wsum delta;
2663         size_t plen = hdrlen + max_t(size_t, offset + sizeof(u16), start);
2664
2665         BUG_ON(!NAPI_GRO_CB(skb)->csum_valid);
2666
2667         if (!nopartial) {
2668                 NAPI_GRO_CB(skb)->gro_remcsum_start = off + hdrlen + start;
2669                 return ptr;
2670         }
2671
2672         ptr = skb_gro_header_fast(skb, off);
2673         if (skb_gro_header_hard(skb, off + plen)) {
2674                 ptr = skb_gro_header_slow(skb, off + plen, off);
2675                 if (!ptr)
2676                         return NULL;
2677         }
2678
2679         delta = remcsum_adjust(ptr + hdrlen, NAPI_GRO_CB(skb)->csum,
2680                                start, offset);
2681
2682         /* Adjust skb->csum since we changed the packet */
2683         NAPI_GRO_CB(skb)->csum = csum_add(NAPI_GRO_CB(skb)->csum, delta);
2684
2685         grc->offset = off + hdrlen + offset;
2686         grc->delta = delta;
2687
2688         return ptr;
2689 }
2690
2691 static inline void skb_gro_remcsum_cleanup(struct sk_buff *skb,
2692                                            struct gro_remcsum *grc)
2693 {
2694         void *ptr;
2695         size_t plen = grc->offset + sizeof(u16);
2696
2697         if (!grc->delta)
2698                 return;
2699
2700         ptr = skb_gro_header_fast(skb, grc->offset);
2701         if (skb_gro_header_hard(skb, grc->offset + sizeof(u16))) {
2702                 ptr = skb_gro_header_slow(skb, plen, grc->offset);
2703                 if (!ptr)
2704                         return;
2705         }
2706
2707         remcsum_unadjust((__sum16 *)ptr, grc->delta);
2708 }
2709
2710 #ifdef CONFIG_XFRM_OFFLOAD
2711 static inline void skb_gro_flush_final(struct sk_buff *skb, struct sk_buff **pp, int flush)
2712 {
2713         if (PTR_ERR(pp) != -EINPROGRESS)
2714                 NAPI_GRO_CB(skb)->flush |= flush;
2715 }
2716 #else
2717 static inline void skb_gro_flush_final(struct sk_buff *skb, struct sk_buff **pp, int flush)
2718 {
2719         NAPI_GRO_CB(skb)->flush |= flush;
2720 }
2721 #endif
2722
2723 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
2724                                   unsigned short type,
2725                                   const void *daddr, const void *saddr,
2726                                   unsigned int len)
2727 {
2728         if (!dev->header_ops || !dev->header_ops->create)
2729                 return 0;
2730
2731         return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
2732 }
2733
2734 static inline int dev_parse_header(const struct sk_buff *skb,
2735                                    unsigned char *haddr)
2736 {
2737         const struct net_device *dev = skb->dev;
2738
2739         if (!dev->header_ops || !dev->header_ops->parse)
2740                 return 0;
2741         return dev->header_ops->parse(skb, haddr);
2742 }
2743
2744 /* ll_header must have at least hard_header_len allocated */
2745 static inline bool dev_validate_header(const struct net_device *dev,
2746                                        char *ll_header, int len)
2747 {
2748         if (likely(len >= dev->hard_header_len))
2749                 return true;
2750         if (len < dev->min_header_len)
2751                 return false;
2752
2753         if (capable(CAP_SYS_RAWIO)) {
2754                 memset(ll_header + len, 0, dev->hard_header_len - len);
2755                 return true;
2756         }
2757
2758         if (dev->header_ops && dev->header_ops->validate)
2759                 return dev->header_ops->validate(ll_header, len);
2760
2761         return false;
2762 }
2763
2764 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr,
2765                            int len, int size);
2766 int register_gifconf(unsigned int family, gifconf_func_t *gifconf);
2767 static inline int unregister_gifconf(unsigned int family)
2768 {
2769         return register_gifconf(family, NULL);
2770 }
2771
2772 #ifdef CONFIG_NET_FLOW_LIMIT
2773 #define FLOW_LIMIT_HISTORY      (1 << 7)  /* must be ^2 and !overflow buckets */
2774 struct sd_flow_limit {
2775         u64                     count;
2776         unsigned int            num_buckets;
2777         unsigned int            history_head;
2778         u16                     history[FLOW_LIMIT_HISTORY];
2779         u8                      buckets[];
2780 };
2781
2782 extern int netdev_flow_limit_table_len;
2783 #endif /* CONFIG_NET_FLOW_LIMIT */
2784
2785 /*
2786  * Incoming packets are placed on per-CPU queues
2787  */
2788 struct softnet_data {
2789         struct list_head        poll_list;
2790         struct sk_buff_head     process_queue;
2791
2792         /* stats */
2793         unsigned int            processed;
2794         unsigned int            time_squeeze;
2795         unsigned int            received_rps;
2796 #ifdef CONFIG_RPS
2797         struct softnet_data     *rps_ipi_list;
2798 #endif
2799 #ifdef CONFIG_NET_FLOW_LIMIT
2800         struct sd_flow_limit __rcu *flow_limit;
2801 #endif
2802         struct Qdisc            *output_queue;
2803         struct Qdisc            **output_queue_tailp;
2804         struct sk_buff          *completion_queue;
2805 #ifdef CONFIG_XFRM_OFFLOAD
2806         struct sk_buff_head     xfrm_backlog;
2807 #endif
2808 #ifdef CONFIG_RPS
2809         /* input_queue_head should be written by cpu owning this struct,
2810          * and only read by other cpus. Worth using a cache line.
2811          */
2812         unsigned int            input_queue_head ____cacheline_aligned_in_smp;
2813
2814         /* Elements below can be accessed between CPUs for RPS/RFS */
2815         call_single_data_t      csd ____cacheline_aligned_in_smp;
2816         struct softnet_data     *rps_ipi_next;
2817         unsigned int            cpu;
2818         unsigned int            input_queue_tail;
2819 #endif
2820         unsigned int            dropped;
2821         struct sk_buff_head     input_pkt_queue;
2822         struct napi_struct      backlog;
2823
2824 };
2825
2826 static inline void input_queue_head_incr(struct softnet_data *sd)
2827 {
2828 #ifdef CONFIG_RPS
2829         sd->input_queue_head++;
2830 #endif
2831 }
2832
2833 static inline void input_queue_tail_incr_save(struct softnet_data *sd,
2834                                               unsigned int *qtail)
2835 {
2836 #ifdef CONFIG_RPS
2837         *qtail = ++sd->input_queue_tail;
2838 #endif
2839 }
2840
2841 DECLARE_PER_CPU_ALIGNED(struct softnet_data, softnet_data);
2842
2843 void __netif_schedule(struct Qdisc *q);
2844 void netif_schedule_queue(struct netdev_queue *txq);
2845
2846 static inline void netif_tx_schedule_all(struct net_device *dev)
2847 {
2848         unsigned int i;
2849
2850         for (i = 0; i < dev->num_tx_queues; i++)
2851                 netif_schedule_queue(netdev_get_tx_queue(dev, i));
2852 }
2853
2854 static __always_inline void netif_tx_start_queue(struct netdev_queue *dev_queue)
2855 {
2856         clear_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2857 }
2858
2859 /**
2860  *      netif_start_queue - allow transmit
2861  *      @dev: network device
2862  *
2863  *      Allow upper layers to call the device hard_start_xmit routine.
2864  */
2865 static inline void netif_start_queue(struct net_device *dev)
2866 {
2867         netif_tx_start_queue(netdev_get_tx_queue(dev, 0));
2868 }
2869
2870 static inline void netif_tx_start_all_queues(struct net_device *dev)
2871 {
2872         unsigned int i;
2873
2874         for (i = 0; i < dev->num_tx_queues; i++) {
2875                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2876                 netif_tx_start_queue(txq);
2877         }
2878 }
2879
2880 void netif_tx_wake_queue(struct netdev_queue *dev_queue);
2881
2882 /**
2883  *      netif_wake_queue - restart transmit
2884  *      @dev: network device
2885  *
2886  *      Allow upper layers to call the device hard_start_xmit routine.
2887  *      Used for flow control when transmit resources are available.
2888  */
2889 static inline void netif_wake_queue(struct net_device *dev)
2890 {
2891         netif_tx_wake_queue(netdev_get_tx_queue(dev, 0));
2892 }
2893
2894 static inline void netif_tx_wake_all_queues(struct net_device *dev)
2895 {
2896         unsigned int i;
2897
2898         for (i = 0; i < dev->num_tx_queues; i++) {
2899                 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2900                 netif_tx_wake_queue(txq);
2901         }
2902 }
2903
2904 static __always_inline void netif_tx_stop_queue(struct netdev_queue *dev_queue)
2905 {
2906         set_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2907 }
2908
2909 /**
2910  *      netif_stop_queue - stop transmitted packets
2911  *      @dev: network device
2912  *
2913  *      Stop upper layers calling the device hard_start_xmit routine.
2914  *      Used for flow control when transmit resources are unavailable.
2915  */
2916 static inline void netif_stop_queue(struct net_device *dev)
2917 {
2918         netif_tx_stop_queue(netdev_get_tx_queue(dev, 0));
2919 }
2920
2921 void netif_tx_stop_all_queues(struct net_device *dev);
2922
2923 static inline bool netif_tx_queue_stopped(const struct netdev_queue *dev_queue)
2924 {
2925         return test_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2926 }
2927
2928 /**
2929  *      netif_queue_stopped - test if transmit queue is flowblocked
2930  *      @dev: network device
2931  *
2932  *      Test if transmit queue on device is currently unable to send.
2933  */
2934 static inline bool netif_queue_stopped(const struct net_device *dev)
2935 {
2936         return netif_tx_queue_stopped(netdev_get_tx_queue(dev, 0));
2937 }
2938
2939 static inline bool netif_xmit_stopped(const struct netdev_queue *dev_queue)
2940 {
2941         return dev_queue->state & QUEUE_STATE_ANY_XOFF;
2942 }
2943
2944 static inline bool
2945 netif_xmit_frozen_or_stopped(const struct netdev_queue *dev_queue)
2946 {
2947         return dev_queue->state & QUEUE_STATE_ANY_XOFF_OR_FROZEN;
2948 }
2949
2950 static inline bool
2951 netif_xmit_frozen_or_drv_stopped(const struct netdev_queue *dev_queue)
2952 {
2953         return dev_queue->state & QUEUE_STATE_DRV_XOFF_OR_FROZEN;
2954 }
2955
2956 /**
2957  *      netdev_txq_bql_enqueue_prefetchw - prefetch bql data for write
2958  *      @dev_queue: pointer to transmit queue
2959  *
2960  * BQL enabled drivers might use this helper in their ndo_start_xmit(),
2961  * to give appropriate hint to the CPU.
2962  */
2963 static inline void netdev_txq_bql_enqueue_prefetchw(struct netdev_queue *dev_queue)
2964 {
2965 #ifdef CONFIG_BQL
2966         prefetchw(&dev_queue->dql.num_queued);
2967 #endif
2968 }
2969
2970 /**
2971  *      netdev_txq_bql_complete_prefetchw - prefetch bql data for write
2972  *      @dev_queue: pointer to transmit queue
2973  *
2974  * BQL enabled drivers might use this helper in their TX completion path,
2975  * to give appropriate hint to the CPU.
2976  */
2977 static inline void netdev_txq_bql_complete_prefetchw(struct netdev_queue *dev_queue)
2978 {
2979 #ifdef CONFIG_BQL
2980         prefetchw(&dev_queue->dql.limit);
2981 #endif
2982 }
2983
2984 static inline void netdev_tx_sent_queue(struct netdev_queue *dev_queue,
2985                                         unsigned int bytes)
2986 {
2987 #ifdef CONFIG_BQL
2988         dql_queued(&dev_queue->dql, bytes);
2989
2990         if (likely(dql_avail(&dev_queue->dql) >= 0))
2991                 return;
2992
2993         set_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
2994
2995         /*
2996          * The XOFF flag must be set before checking the dql_avail below,
2997          * because in netdev_tx_completed_queue we update the dql_completed
2998          * before checking the XOFF flag.
2999          */
3000         smp_mb();
3001
3002         /* check again in case another CPU has just made room avail */
3003         if (unlikely(dql_avail(&dev_queue->dql) >= 0))
3004                 clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
3005 #endif
3006 }
3007
3008 /**
3009  *      netdev_sent_queue - report the number of bytes queued to hardware
3010  *      @dev: network device
3011  *      @bytes: number of bytes queued to the hardware device queue
3012  *
3013  *      Report the number of bytes queued for sending/completion to the network
3014  *      device hardware queue. @bytes should be a good approximation and should
3015  *      exactly match netdev_completed_queue() @bytes
3016  */
3017 static inline void netdev_sent_queue(struct net_device *dev, unsigned int bytes)
3018 {
3019         netdev_tx_sent_queue(netdev_get_tx_queue(dev, 0), bytes);
3020 }
3021
3022 static inline void netdev_tx_completed_queue(struct netdev_queue *dev_queue,
3023                                              unsigned int pkts, unsigned int bytes)
3024 {
3025 #ifdef CONFIG_BQL
3026         if (unlikely(!bytes))
3027                 return;
3028
3029         dql_completed(&dev_queue->dql, bytes);
3030
3031         /*
3032          * Without the memory barrier there is a small possiblity that
3033          * netdev_tx_sent_queue will miss the update and cause the queue to
3034          * be stopped forever
3035          */
3036         smp_mb();
3037
3038         if (dql_avail(&dev_queue->dql) < 0)
3039                 return;
3040
3041         if (test_and_clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state))
3042                 netif_schedule_queue(dev_queue);
3043 #endif
3044 }
3045
3046 /**
3047  *      netdev_completed_queue - report bytes and packets completed by device
3048  *      @dev: network device
3049  *      @pkts: actual number of packets sent over the medium
3050  *      @bytes: actual number of bytes sent over the medium
3051  *
3052  *      Report the number of bytes and packets transmitted by the network device
3053  *      hardware queue over the physical medium, @bytes must exactly match the
3054  *      @bytes amount passed to netdev_sent_queue()
3055  */
3056 static inline void netdev_completed_queue(struct net_device *dev,
3057                                           unsigned int pkts, unsigned int bytes)
3058 {
3059         netdev_tx_completed_queue(netdev_get_tx_queue(dev, 0), pkts, bytes);
3060 }
3061
3062 static inline void netdev_tx_reset_queue(struct netdev_queue *q)
3063 {
3064 #ifdef CONFIG_BQL
3065         clear_bit(__QUEUE_STATE_STACK_XOFF, &q->state);
3066         dql_reset(&q->dql);
3067 #endif
3068 }
3069
3070 /**
3071  *      netdev_reset_queue - reset the packets and bytes count of a network device
3072  *      @dev_queue: network device
3073  *
3074  *      Reset the bytes and packet count of a network device and clear the
3075  *      software flow control OFF bit for this network device
3076  */
3077 static inline void netdev_reset_queue(struct net_device *dev_queue)
3078 {
3079         netdev_tx_reset_queue(netdev_get_tx_queue(dev_queue, 0));
3080 }
3081
3082 /**
3083  *      netdev_cap_txqueue - check if selected tx queue exceeds device queues
3084  *      @dev: network device
3085  *      @queue_index: given tx queue index
3086  *
3087  *      Returns 0 if given tx queue index >= number of device tx queues,
3088  *      otherwise returns the originally passed tx queue index.
3089  */
3090 static inline u16 netdev_cap_txqueue(struct net_device *dev, u16 queue_index)
3091 {
3092         if (unlikely(queue_index >= dev->real_num_tx_queues)) {
3093                 net_warn_ratelimited("%s selects TX queue %d, but real number of TX queues is %d\n",
3094                                      dev->name, queue_index,
3095                                      dev->real_num_tx_queues);
3096                 return 0;
3097         }
3098
3099         return queue_index;
3100 }
3101
3102 /**
3103  *      netif_running - test if up
3104  *      @dev: network device
3105  *
3106  *      Test if the device has been brought up.
3107  */
3108 static inline bool netif_running(const struct net_device *dev)
3109 {
3110         return test_bit(__LINK_STATE_START, &dev->state);
3111 }
3112
3113 /*
3114  * Routines to manage the subqueues on a device.  We only need start,
3115  * stop, and a check if it's stopped.  All other device management is
3116  * done at the overall netdevice level.
3117  * Also test the device if we're multiqueue.
3118  */
3119
3120 /**
3121  *      netif_start_subqueue - allow sending packets on subqueue
3122  *      @dev: network device
3123  *      @queue_index: sub queue index
3124  *
3125  * Start individual transmit queue of a device with multiple transmit queues.
3126  */
3127 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
3128 {
3129         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3130
3131         netif_tx_start_queue(txq);
3132 }
3133
3134 /**
3135  *      netif_stop_subqueue - stop sending packets on subqueue
3136  *      @dev: network device
3137  *      @queue_index: sub queue index
3138  *
3139  * Stop individual transmit queue of a device with multiple transmit queues.
3140  */
3141 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
3142 {
3143         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3144         netif_tx_stop_queue(txq);
3145 }
3146
3147 /**
3148  *      netif_subqueue_stopped - test status of subqueue
3149  *      @dev: network device
3150  *      @queue_index: sub queue index
3151  *
3152  * Check individual transmit queue of a device with multiple transmit queues.
3153  */
3154 static inline bool __netif_subqueue_stopped(const struct net_device *dev,
3155                                             u16 queue_index)
3156 {
3157         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3158
3159         return netif_tx_queue_stopped(txq);
3160 }
3161
3162 static inline bool netif_subqueue_stopped(const struct net_device *dev,
3163                                           struct sk_buff *skb)
3164 {
3165         return __netif_subqueue_stopped(dev, skb_get_queue_mapping(skb));
3166 }
3167
3168 /**
3169  *      netif_wake_subqueue - allow sending packets on subqueue
3170  *      @dev: network device
3171  *      @queue_index: sub queue index
3172  *
3173  * Resume individual transmit queue of a device with multiple transmit queues.
3174  */
3175 static inline void netif_wake_subqueue(struct net_device *dev, u16 queue_index)
3176 {
3177         struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3178
3179         netif_tx_wake_queue(txq);
3180 }
3181
3182 #ifdef CONFIG_XPS
3183 int netif_set_xps_queue(struct net_device *dev, const struct cpumask *mask,
3184                         u16 index);
3185 #else
3186 static inline int netif_set_xps_queue(struct net_device *dev,
3187                                       const struct cpumask *mask,
3188                                       u16 index)
3189 {
3190         return 0;
3191 }
3192 #endif
3193
3194 u16 __skb_tx_hash(const struct net_device *dev, struct sk_buff *skb,
3195                   unsigned int num_tx_queues);
3196
3197 /*
3198  * Returns a Tx hash for the given packet when dev->real_num_tx_queues is used
3199  * as a distribution range limit for the returned value.
3200  */
3201 static inline u16 skb_tx_hash(const struct net_device *dev,
3202                               struct sk_buff *skb)
3203 {
3204         return __skb_tx_hash(dev, skb, dev->real_num_tx_queues);
3205 }
3206
3207 /**
3208  *      netif_is_multiqueue - test if device has multiple transmit queues
3209  *      @dev: network device
3210  *
3211  * Check if device has multiple transmit queues
3212  */
3213 static inline bool netif_is_multiqueue(const struct net_device *dev)
3214 {
3215         return dev->num_tx_queues > 1;
3216 }
3217
3218 int netif_set_real_num_tx_queues(struct net_device *dev, unsigned int txq);
3219
3220 #ifdef CONFIG_SYSFS
3221 int netif_set_real_num_rx_queues(struct net_device *dev, unsigned int rxq);
3222 #else
3223 static inline int netif_set_real_num_rx_queues(struct net_device *dev,
3224                                                 unsigned int rxq)
3225 {
3226         return 0;
3227 }
3228 #endif
3229
3230 #ifdef CONFIG_SYSFS
3231 static inline unsigned int get_netdev_rx_queue_index(
3232                 struct netdev_rx_queue *queue)
3233 {
3234         struct net_device *dev = queue->dev;
3235         int index = queue - dev->_rx;
3236
3237         BUG_ON(index >= dev->num_rx_queues);
3238         return index;
3239 }
3240 #endif
3241
3242 #define DEFAULT_MAX_NUM_RSS_QUEUES      (8)
3243 int netif_get_num_default_rss_queues(void);
3244
3245 enum skb_free_reason {
3246         SKB_REASON_CONSUMED,
3247         SKB_REASON_DROPPED,
3248 };
3249
3250 void __dev_kfree_skb_irq(struct sk_buff *skb, enum skb_free_reason reason);
3251 void __dev_kfree_skb_any(struct sk_buff *skb, enum skb_free_reason reason);
3252
3253 /*
3254  * It is not allowed to call kfree_skb() or consume_skb() from hardware
3255  * interrupt context or with hardware interrupts being disabled.
3256  * (in_irq() || irqs_disabled())
3257  *
3258  * We provide four helpers that can be used in following contexts :
3259  *
3260  * dev_kfree_skb_irq(skb) when caller drops a packet from irq context,
3261  *  replacing kfree_skb(skb)
3262  *
3263  * dev_consume_skb_irq(skb) when caller consumes a packet from irq context.
3264  *  Typically used in place of consume_skb(skb) in TX completion path
3265  *
3266  * dev_kfree_skb_any(skb) when caller doesn't know its current irq context,
3267  *  replacing kfree_skb(skb)
3268  *
3269  * dev_consume_skb_any(skb) when caller doesn't know its current irq context,
3270  *  and consumed a packet. Used in place of consume_skb(skb)
3271  */
3272 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
3273 {
3274         __dev_kfree_skb_irq(skb, SKB_REASON_DROPPED);
3275 }
3276
3277 static inline void dev_consume_skb_irq(struct sk_buff *skb)
3278 {
3279         __dev_kfree_skb_irq(skb, SKB_REASON_CONSUMED);
3280 }
3281
3282 static inline void dev_kfree_skb_any(struct sk_buff *skb)
3283 {
3284         __dev_kfree_skb_any(skb, SKB_REASON_DROPPED);
3285 }
3286
3287 static inline void dev_consume_skb_any(struct sk_buff *skb)
3288 {
3289         __dev_kfree_skb_any(skb, SKB_REASON_CONSUMED);
3290 }
3291
3292 void generic_xdp_tx(struct sk_buff *skb, struct bpf_prog *xdp_prog);
3293 int do_xdp_generic(struct bpf_prog *xdp_prog, struct sk_buff *skb);
3294 int netif_rx(struct sk_buff *skb);
3295 int netif_rx_ni(struct sk_buff *skb);
3296 int netif_receive_skb(struct sk_buff *skb);
3297 int netif_receive_skb_core(struct sk_buff *skb);
3298 gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
3299 void napi_gro_flush(struct napi_struct *napi, bool flush_old);
3300 struct sk_buff *napi_get_frags(struct napi_struct *napi);
3301 gro_result_t napi_gro_frags(struct napi_struct *napi);
3302 struct packet_offload *gro_find_receive_by_type(__be16 type);
3303 struct packet_offload *gro_find_complete_by_type(__be16 type);
3304
3305 static inline void napi_free_frags(struct napi_struct *napi)
3306 {
3307         kfree_skb(napi->skb);
3308         napi->skb = NULL;
3309 }
3310
3311 bool netdev_is_rx_handler_busy(struct net_device *dev);
3312 int netdev_rx_handler_register(struct net_device *dev,
3313                                rx_handler_func_t *rx_handler,
3314                                void *rx_handler_data);
3315 void netdev_rx_handler_unregister(struct net_device *dev);
3316
3317 bool dev_valid_name(const char *name);
3318 int dev_ioctl(struct net *net, unsigned int cmd, void __user *);
3319 int dev_ifconf(struct net *net, struct ifconf *, int);
3320 int dev_ethtool(struct net *net, struct ifreq *);
3321 unsigned int dev_get_flags(const struct net_device *);
3322 int __dev_change_flags(struct net_device *, unsigned int flags);
3323 int dev_change_flags(struct net_device *, unsigned int);
3324 void __dev_notify_flags(struct net_device *, unsigned int old_flags,
3325                         unsigned int gchanges);
3326 int dev_change_name(struct net_device *, const char *);
3327 int dev_set_alias(struct net_device *, const char *, size_t);
3328 int dev_get_alias(const struct net_device *, char *, size_t);
3329 int dev_change_net_namespace(struct net_device *, struct net *, const char *);
3330 int __dev_set_mtu(struct net_device *, int);
3331 int dev_set_mtu(struct net_device *, int);
3332 void dev_set_group(struct net_device *, int);
3333 int dev_set_mac_address(struct net_device *, struct sockaddr *);
3334 int dev_change_carrier(struct net_device *, bool new_carrier);
3335 int dev_get_phys_port_id(struct net_device *dev,
3336                          struct netdev_phys_item_id *ppid);
3337 int dev_get_phys_port_name(struct net_device *dev,
3338                            char *name, size_t len);
3339 int dev_change_proto_down(struct net_device *dev, bool proto_down);
3340 struct sk_buff *validate_xmit_skb_list(struct sk_buff *skb, struct net_device *dev, bool *again);
3341 struct sk_buff *dev_hard_start_xmit(struct sk_buff *skb, struct net_device *dev,
3342                                     struct netdev_queue *txq, int *ret);
3343
3344 typedef int (*bpf_op_t)(struct net_device *dev, struct netdev_bpf *bpf);
3345 int dev_change_xdp_fd(struct net_device *dev, struct netlink_ext_ack *extack,
3346                       int fd, u32 flags);
3347 void __dev_xdp_query(struct net_device *dev, bpf_op_t xdp_op,