1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. INET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
7 * Definitions for the Interfaces handler.
9 * Version: @(#)dev.h 1.0.10 08/12/93
19 * Moved to /usr/include/linux for NET3
21 #ifndef _LINUX_NETDEVICE_H
22 #define _LINUX_NETDEVICE_H
24 #include <linux/timer.h>
25 #include <linux/bug.h>
26 #include <linux/delay.h>
27 #include <linux/atomic.h>
28 #include <linux/prefetch.h>
29 #include <asm/cache.h>
30 #include <asm/byteorder.h>
31 #include <asm/local.h>
33 #include <linux/percpu.h>
34 #include <linux/rculist.h>
35 #include <linux/workqueue.h>
36 #include <linux/dynamic_queue_limits.h>
38 #include <net/net_namespace.h>
40 #include <net/dcbnl.h>
42 #include <net/netprio_cgroup.h>
45 #include <linux/netdev_features.h>
46 #include <linux/neighbour.h>
47 #include <uapi/linux/netdevice.h>
48 #include <uapi/linux/if_bonding.h>
49 #include <uapi/linux/pkt_cls.h>
50 #include <linux/hashtable.h>
51 #include <linux/rbtree.h>
52 #include <net/net_trackers.h>
53 #include <net/net_debug.h>
60 struct ip_tunnel_parm;
61 struct macsec_context;
63 struct netdev_name_node;
68 /* 802.15.4 specific */
71 /* UDP Tunnel offloads */
72 struct udp_tunnel_info;
73 struct udp_tunnel_nic_info;
74 struct udp_tunnel_nic;
78 void synchronize_net(void);
79 void netdev_set_default_ethtool_ops(struct net_device *dev,
80 const struct ethtool_ops *ops);
82 /* Backlog congestion levels */
83 #define NET_RX_SUCCESS 0 /* keep 'em coming, baby */
84 #define NET_RX_DROP 1 /* packet dropped */
86 #define MAX_NEST_DEV 8
89 * Transmit return codes: transmit return codes originate from three different
92 * - qdisc return codes
93 * - driver transmit return codes
96 * Drivers are allowed to return any one of those in their hard_start_xmit()
97 * function. Real network devices commonly used with qdiscs should only return
98 * the driver transmit return codes though - when qdiscs are used, the actual
99 * transmission happens asynchronously, so the value is not propagated to
100 * higher layers. Virtual network devices transmit synchronously; in this case
101 * the driver transmit return codes are consumed by dev_queue_xmit(), and all
102 * others are propagated to higher layers.
105 /* qdisc ->enqueue() return codes. */
106 #define NET_XMIT_SUCCESS 0x00
107 #define NET_XMIT_DROP 0x01 /* skb dropped */
108 #define NET_XMIT_CN 0x02 /* congestion notification */
109 #define NET_XMIT_MASK 0x0f /* qdisc flags in net/sch_generic.h */
111 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
112 * indicates that the device will soon be dropping packets, or already drops
113 * some packets of the same priority; prompting us to send less aggressively. */
114 #define net_xmit_eval(e) ((e) == NET_XMIT_CN ? 0 : (e))
115 #define net_xmit_errno(e) ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
117 /* Driver transmit return codes */
118 #define NETDEV_TX_MASK 0xf0
121 __NETDEV_TX_MIN = INT_MIN, /* make sure enum is signed */
122 NETDEV_TX_OK = 0x00, /* driver took care of packet */
123 NETDEV_TX_BUSY = 0x10, /* driver tx path was busy*/
125 typedef enum netdev_tx netdev_tx_t;
128 * Current order: NETDEV_TX_MASK > NET_XMIT_MASK >= 0 is significant;
129 * hard_start_xmit() return < NET_XMIT_MASK means skb was consumed.
131 static inline bool dev_xmit_complete(int rc)
134 * Positive cases with an skb consumed by a driver:
135 * - successful transmission (rc == NETDEV_TX_OK)
136 * - error while transmitting (rc < 0)
137 * - error while queueing to a different device (rc & NET_XMIT_MASK)
139 if (likely(rc < NET_XMIT_MASK))
146 * Compute the worst-case header length according to the protocols
150 #if defined(CONFIG_HYPERV_NET)
151 # define LL_MAX_HEADER 128
152 #elif defined(CONFIG_WLAN) || IS_ENABLED(CONFIG_AX25)
153 # if defined(CONFIG_MAC80211_MESH)
154 # define LL_MAX_HEADER 128
156 # define LL_MAX_HEADER 96
159 # define LL_MAX_HEADER 32
162 #if !IS_ENABLED(CONFIG_NET_IPIP) && !IS_ENABLED(CONFIG_NET_IPGRE) && \
163 !IS_ENABLED(CONFIG_IPV6_SIT) && !IS_ENABLED(CONFIG_IPV6_TUNNEL)
164 #define MAX_HEADER LL_MAX_HEADER
166 #define MAX_HEADER (LL_MAX_HEADER + 48)
170 * Old network device statistics. Fields are native words
171 * (unsigned long) so they can be read and written atomically.
174 struct net_device_stats {
175 unsigned long rx_packets;
176 unsigned long tx_packets;
177 unsigned long rx_bytes;
178 unsigned long tx_bytes;
179 unsigned long rx_errors;
180 unsigned long tx_errors;
181 unsigned long rx_dropped;
182 unsigned long tx_dropped;
183 unsigned long multicast;
184 unsigned long collisions;
185 unsigned long rx_length_errors;
186 unsigned long rx_over_errors;
187 unsigned long rx_crc_errors;
188 unsigned long rx_frame_errors;
189 unsigned long rx_fifo_errors;
190 unsigned long rx_missed_errors;
191 unsigned long tx_aborted_errors;
192 unsigned long tx_carrier_errors;
193 unsigned long tx_fifo_errors;
194 unsigned long tx_heartbeat_errors;
195 unsigned long tx_window_errors;
196 unsigned long rx_compressed;
197 unsigned long tx_compressed;
200 /* per-cpu stats, allocated on demand.
201 * Try to fit them in a single cache line, for dev_get_stats() sake.
203 struct net_device_core_stats {
204 unsigned long rx_dropped;
205 unsigned long tx_dropped;
206 unsigned long rx_nohandler;
207 unsigned long rx_otherhost_dropped;
208 } __aligned(4 * sizeof(unsigned long));
210 #include <linux/cache.h>
211 #include <linux/skbuff.h>
214 #include <linux/static_key.h>
215 extern struct static_key_false rps_needed;
216 extern struct static_key_false rfs_needed;
223 struct netdev_hw_addr {
224 struct list_head list;
226 unsigned char addr[MAX_ADDR_LEN];
228 #define NETDEV_HW_ADDR_T_LAN 1
229 #define NETDEV_HW_ADDR_T_SAN 2
230 #define NETDEV_HW_ADDR_T_UNICAST 3
231 #define NETDEV_HW_ADDR_T_MULTICAST 4
236 struct rcu_head rcu_head;
239 struct netdev_hw_addr_list {
240 struct list_head list;
243 /* Auxiliary tree for faster lookup on addition and deletion */
247 #define netdev_hw_addr_list_count(l) ((l)->count)
248 #define netdev_hw_addr_list_empty(l) (netdev_hw_addr_list_count(l) == 0)
249 #define netdev_hw_addr_list_for_each(ha, l) \
250 list_for_each_entry(ha, &(l)->list, list)
252 #define netdev_uc_count(dev) netdev_hw_addr_list_count(&(dev)->uc)
253 #define netdev_uc_empty(dev) netdev_hw_addr_list_empty(&(dev)->uc)
254 #define netdev_for_each_uc_addr(ha, dev) \
255 netdev_hw_addr_list_for_each(ha, &(dev)->uc)
256 #define netdev_for_each_synced_uc_addr(_ha, _dev) \
257 netdev_for_each_uc_addr((_ha), (_dev)) \
260 #define netdev_mc_count(dev) netdev_hw_addr_list_count(&(dev)->mc)
261 #define netdev_mc_empty(dev) netdev_hw_addr_list_empty(&(dev)->mc)
262 #define netdev_for_each_mc_addr(ha, dev) \
263 netdev_hw_addr_list_for_each(ha, &(dev)->mc)
264 #define netdev_for_each_synced_mc_addr(_ha, _dev) \
265 netdev_for_each_mc_addr((_ha), (_dev)) \
272 /* cached hardware header; allow for machine alignment needs. */
273 #define HH_DATA_MOD 16
274 #define HH_DATA_OFF(__len) \
275 (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
276 #define HH_DATA_ALIGN(__len) \
277 (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
278 unsigned long hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
281 /* Reserve HH_DATA_MOD byte-aligned hard_header_len, but at least that much.
283 * dev->hard_header_len ? (dev->hard_header_len +
284 * (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
286 * We could use other alignment values, but we must maintain the
287 * relationship HH alignment <= LL alignment.
289 #define LL_RESERVED_SPACE(dev) \
290 ((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
291 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
292 ((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
295 int (*create) (struct sk_buff *skb, struct net_device *dev,
296 unsigned short type, const void *daddr,
297 const void *saddr, unsigned int len);
298 int (*parse)(const struct sk_buff *skb, unsigned char *haddr);
299 int (*cache)(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
300 void (*cache_update)(struct hh_cache *hh,
301 const struct net_device *dev,
302 const unsigned char *haddr);
303 bool (*validate)(const char *ll_header, unsigned int len);
304 __be16 (*parse_protocol)(const struct sk_buff *skb);
307 /* These flag bits are private to the generic network queueing
308 * layer; they may not be explicitly referenced by any other
312 enum netdev_state_t {
314 __LINK_STATE_PRESENT,
315 __LINK_STATE_NOCARRIER,
316 __LINK_STATE_LINKWATCH_PENDING,
317 __LINK_STATE_DORMANT,
318 __LINK_STATE_TESTING,
322 struct list_head list;
327 * size of gro hash buckets, must less than bit number of
328 * napi_struct::gro_bitmask
330 #define GRO_HASH_BUCKETS 8
333 * Structure for NAPI scheduling similar to tasklet but with weighting
336 /* The poll_list must only be managed by the entity which
337 * changes the state of the NAPI_STATE_SCHED bit. This means
338 * whoever atomically sets that bit can add this napi_struct
339 * to the per-CPU poll_list, and whoever clears that bit
340 * can remove from the list right before clearing the bit.
342 struct list_head poll_list;
346 int defer_hard_irqs_count;
347 unsigned long gro_bitmask;
348 int (*poll)(struct napi_struct *, int);
349 #ifdef CONFIG_NETPOLL
352 struct net_device *dev;
353 struct gro_list gro_hash[GRO_HASH_BUCKETS];
355 struct list_head rx_list; /* Pending GRO_NORMAL skbs */
356 int rx_count; /* length of rx_list */
357 struct hrtimer timer;
358 struct list_head dev_list;
359 struct hlist_node napi_hash_node;
360 unsigned int napi_id;
361 struct task_struct *thread;
365 NAPI_STATE_SCHED, /* Poll is scheduled */
366 NAPI_STATE_MISSED, /* reschedule a napi */
367 NAPI_STATE_DISABLE, /* Disable pending */
368 NAPI_STATE_NPSVC, /* Netpoll - don't dequeue from poll_list */
369 NAPI_STATE_LISTED, /* NAPI added to system lists */
370 NAPI_STATE_NO_BUSY_POLL, /* Do not add in napi_hash, no busy polling */
371 NAPI_STATE_IN_BUSY_POLL, /* sk_busy_loop() owns this NAPI */
372 NAPI_STATE_PREFER_BUSY_POLL, /* prefer busy-polling over softirq processing*/
373 NAPI_STATE_THREADED, /* The poll is performed inside its own thread*/
374 NAPI_STATE_SCHED_THREADED, /* Napi is currently scheduled in threaded mode */
378 NAPIF_STATE_SCHED = BIT(NAPI_STATE_SCHED),
379 NAPIF_STATE_MISSED = BIT(NAPI_STATE_MISSED),
380 NAPIF_STATE_DISABLE = BIT(NAPI_STATE_DISABLE),
381 NAPIF_STATE_NPSVC = BIT(NAPI_STATE_NPSVC),
382 NAPIF_STATE_LISTED = BIT(NAPI_STATE_LISTED),
383 NAPIF_STATE_NO_BUSY_POLL = BIT(NAPI_STATE_NO_BUSY_POLL),
384 NAPIF_STATE_IN_BUSY_POLL = BIT(NAPI_STATE_IN_BUSY_POLL),
385 NAPIF_STATE_PREFER_BUSY_POLL = BIT(NAPI_STATE_PREFER_BUSY_POLL),
386 NAPIF_STATE_THREADED = BIT(NAPI_STATE_THREADED),
387 NAPIF_STATE_SCHED_THREADED = BIT(NAPI_STATE_SCHED_THREADED),
397 typedef enum gro_result gro_result_t;
400 * enum rx_handler_result - Possible return values for rx_handlers.
401 * @RX_HANDLER_CONSUMED: skb was consumed by rx_handler, do not process it
403 * @RX_HANDLER_ANOTHER: Do another round in receive path. This is indicated in
404 * case skb->dev was changed by rx_handler.
405 * @RX_HANDLER_EXACT: Force exact delivery, no wildcard.
406 * @RX_HANDLER_PASS: Do nothing, pass the skb as if no rx_handler was called.
408 * rx_handlers are functions called from inside __netif_receive_skb(), to do
409 * special processing of the skb, prior to delivery to protocol handlers.
411 * Currently, a net_device can only have a single rx_handler registered. Trying
412 * to register a second rx_handler will return -EBUSY.
414 * To register a rx_handler on a net_device, use netdev_rx_handler_register().
415 * To unregister a rx_handler on a net_device, use
416 * netdev_rx_handler_unregister().
418 * Upon return, rx_handler is expected to tell __netif_receive_skb() what to
421 * If the rx_handler consumed the skb in some way, it should return
422 * RX_HANDLER_CONSUMED. This is appropriate when the rx_handler arranged for
423 * the skb to be delivered in some other way.
425 * If the rx_handler changed skb->dev, to divert the skb to another
426 * net_device, it should return RX_HANDLER_ANOTHER. The rx_handler for the
427 * new device will be called if it exists.
429 * If the rx_handler decides the skb should be ignored, it should return
430 * RX_HANDLER_EXACT. The skb will only be delivered to protocol handlers that
431 * are registered on exact device (ptype->dev == skb->dev).
433 * If the rx_handler didn't change skb->dev, but wants the skb to be normally
434 * delivered, it should return RX_HANDLER_PASS.
436 * A device without a registered rx_handler will behave as if rx_handler
437 * returned RX_HANDLER_PASS.
440 enum rx_handler_result {
446 typedef enum rx_handler_result rx_handler_result_t;
447 typedef rx_handler_result_t rx_handler_func_t(struct sk_buff **pskb);
449 void __napi_schedule(struct napi_struct *n);
450 void __napi_schedule_irqoff(struct napi_struct *n);
452 static inline bool napi_disable_pending(struct napi_struct *n)
454 return test_bit(NAPI_STATE_DISABLE, &n->state);
457 static inline bool napi_prefer_busy_poll(struct napi_struct *n)
459 return test_bit(NAPI_STATE_PREFER_BUSY_POLL, &n->state);
462 bool napi_schedule_prep(struct napi_struct *n);
465 * napi_schedule - schedule NAPI poll
468 * Schedule NAPI poll routine to be called if it is not already
471 static inline void napi_schedule(struct napi_struct *n)
473 if (napi_schedule_prep(n))
478 * napi_schedule_irqoff - schedule NAPI poll
481 * Variant of napi_schedule(), assuming hard irqs are masked.
483 static inline void napi_schedule_irqoff(struct napi_struct *n)
485 if (napi_schedule_prep(n))
486 __napi_schedule_irqoff(n);
489 /* Try to reschedule poll. Called by dev->poll() after napi_complete(). */
490 static inline bool napi_reschedule(struct napi_struct *napi)
492 if (napi_schedule_prep(napi)) {
493 __napi_schedule(napi);
499 bool napi_complete_done(struct napi_struct *n, int work_done);
501 * napi_complete - NAPI processing complete
504 * Mark NAPI processing as complete.
505 * Consider using napi_complete_done() instead.
506 * Return false if device should avoid rearming interrupts.
508 static inline bool napi_complete(struct napi_struct *n)
510 return napi_complete_done(n, 0);
513 int dev_set_threaded(struct net_device *dev, bool threaded);
516 * napi_disable - prevent NAPI from scheduling
519 * Stop NAPI from being scheduled on this context.
520 * Waits till any outstanding processing completes.
522 void napi_disable(struct napi_struct *n);
524 void napi_enable(struct napi_struct *n);
527 * napi_synchronize - wait until NAPI is not running
530 * Wait until NAPI is done being scheduled on this context.
531 * Waits till any outstanding processing completes but
532 * does not disable future activations.
534 static inline void napi_synchronize(const struct napi_struct *n)
536 if (IS_ENABLED(CONFIG_SMP))
537 while (test_bit(NAPI_STATE_SCHED, &n->state))
544 * napi_if_scheduled_mark_missed - if napi is running, set the
548 * If napi is running, set the NAPIF_STATE_MISSED, and return true if
551 static inline bool napi_if_scheduled_mark_missed(struct napi_struct *n)
553 unsigned long val, new;
555 val = READ_ONCE(n->state);
557 if (val & NAPIF_STATE_DISABLE)
560 if (!(val & NAPIF_STATE_SCHED))
563 new = val | NAPIF_STATE_MISSED;
564 } while (!try_cmpxchg(&n->state, &val, new));
569 enum netdev_queue_state_t {
570 __QUEUE_STATE_DRV_XOFF,
571 __QUEUE_STATE_STACK_XOFF,
572 __QUEUE_STATE_FROZEN,
575 #define QUEUE_STATE_DRV_XOFF (1 << __QUEUE_STATE_DRV_XOFF)
576 #define QUEUE_STATE_STACK_XOFF (1 << __QUEUE_STATE_STACK_XOFF)
577 #define QUEUE_STATE_FROZEN (1 << __QUEUE_STATE_FROZEN)
579 #define QUEUE_STATE_ANY_XOFF (QUEUE_STATE_DRV_XOFF | QUEUE_STATE_STACK_XOFF)
580 #define QUEUE_STATE_ANY_XOFF_OR_FROZEN (QUEUE_STATE_ANY_XOFF | \
582 #define QUEUE_STATE_DRV_XOFF_OR_FROZEN (QUEUE_STATE_DRV_XOFF | \
586 * __QUEUE_STATE_DRV_XOFF is used by drivers to stop the transmit queue. The
587 * netif_tx_* functions below are used to manipulate this flag. The
588 * __QUEUE_STATE_STACK_XOFF flag is used by the stack to stop the transmit
589 * queue independently. The netif_xmit_*stopped functions below are called
590 * to check if the queue has been stopped by the driver or stack (either
591 * of the XOFF bits are set in the state). Drivers should not need to call
592 * netif_xmit*stopped functions, they should only be using netif_tx_*.
595 struct netdev_queue {
599 struct net_device *dev;
600 netdevice_tracker dev_tracker;
602 struct Qdisc __rcu *qdisc;
603 struct Qdisc *qdisc_sleeping;
607 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
610 unsigned long tx_maxrate;
612 * Number of TX timeouts for this queue
613 * (/sys/class/net/DEV/Q/trans_timeout)
615 atomic_long_t trans_timeout;
617 /* Subordinate device that the queue has been assigned to */
618 struct net_device *sb_dev;
619 #ifdef CONFIG_XDP_SOCKETS
620 struct xsk_buff_pool *pool;
625 spinlock_t _xmit_lock ____cacheline_aligned_in_smp;
628 * Time (in jiffies) of last Tx
630 unsigned long trans_start;
637 } ____cacheline_aligned_in_smp;
639 extern int sysctl_fb_tunnels_only_for_init_net;
640 extern int sysctl_devconf_inherit_init_net;
643 * sysctl_fb_tunnels_only_for_init_net == 0 : For all netns
644 * == 1 : For initns only
647 static inline bool net_has_fallback_tunnels(const struct net *net)
649 #if IS_ENABLED(CONFIG_SYSCTL)
650 int fb_tunnels_only_for_init_net = READ_ONCE(sysctl_fb_tunnels_only_for_init_net);
652 return !fb_tunnels_only_for_init_net ||
653 (net_eq(net, &init_net) && fb_tunnels_only_for_init_net == 1);
659 static inline int net_inherit_devconf(void)
661 #if IS_ENABLED(CONFIG_SYSCTL)
662 return READ_ONCE(sysctl_devconf_inherit_init_net);
668 static inline int netdev_queue_numa_node_read(const struct netdev_queue *q)
670 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
677 static inline void netdev_queue_numa_node_write(struct netdev_queue *q, int node)
679 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
686 * This structure holds an RPS map which can be of variable length. The
687 * map is an array of CPUs.
694 #define RPS_MAP_SIZE(_num) (sizeof(struct rps_map) + ((_num) * sizeof(u16)))
697 * The rps_dev_flow structure contains the mapping of a flow to a CPU, the
698 * tail pointer for that CPU's input queue at the time of last enqueue, and
699 * a hardware filter index.
701 struct rps_dev_flow {
704 unsigned int last_qtail;
706 #define RPS_NO_FILTER 0xffff
709 * The rps_dev_flow_table structure contains a table of flow mappings.
711 struct rps_dev_flow_table {
714 struct rps_dev_flow flows[];
716 #define RPS_DEV_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_dev_flow_table) + \
717 ((_num) * sizeof(struct rps_dev_flow)))
720 * The rps_sock_flow_table contains mappings of flows to the last CPU
721 * on which they were processed by the application (set in recvmsg).
722 * Each entry is a 32bit value. Upper part is the high-order bits
723 * of flow hash, lower part is CPU number.
724 * rps_cpu_mask is used to partition the space, depending on number of
725 * possible CPUs : rps_cpu_mask = roundup_pow_of_two(nr_cpu_ids) - 1
726 * For example, if 64 CPUs are possible, rps_cpu_mask = 0x3f,
727 * meaning we use 32-6=26 bits for the hash.
729 struct rps_sock_flow_table {
732 u32 ents[] ____cacheline_aligned_in_smp;
734 #define RPS_SOCK_FLOW_TABLE_SIZE(_num) (offsetof(struct rps_sock_flow_table, ents[_num]))
736 #define RPS_NO_CPU 0xffff
738 extern u32 rps_cpu_mask;
739 extern struct rps_sock_flow_table __rcu *rps_sock_flow_table;
741 static inline void rps_record_sock_flow(struct rps_sock_flow_table *table,
745 unsigned int index = hash & table->mask;
746 u32 val = hash & ~rps_cpu_mask;
748 /* We only give a hint, preemption can change CPU under us */
749 val |= raw_smp_processor_id();
751 if (table->ents[index] != val)
752 table->ents[index] = val;
756 #ifdef CONFIG_RFS_ACCEL
757 bool rps_may_expire_flow(struct net_device *dev, u16 rxq_index, u32 flow_id,
760 #endif /* CONFIG_RPS */
762 /* This structure contains an instance of an RX queue. */
763 struct netdev_rx_queue {
764 struct xdp_rxq_info xdp_rxq;
766 struct rps_map __rcu *rps_map;
767 struct rps_dev_flow_table __rcu *rps_flow_table;
770 struct net_device *dev;
771 netdevice_tracker dev_tracker;
773 #ifdef CONFIG_XDP_SOCKETS
774 struct xsk_buff_pool *pool;
776 } ____cacheline_aligned_in_smp;
779 * RX queue sysfs structures and functions.
781 struct rx_queue_attribute {
782 struct attribute attr;
783 ssize_t (*show)(struct netdev_rx_queue *queue, char *buf);
784 ssize_t (*store)(struct netdev_rx_queue *queue,
785 const char *buf, size_t len);
788 /* XPS map type and offset of the xps map within net_device->xps_maps[]. */
797 * This structure holds an XPS map which can be of variable length. The
798 * map is an array of queues.
802 unsigned int alloc_len;
806 #define XPS_MAP_SIZE(_num) (sizeof(struct xps_map) + ((_num) * sizeof(u16)))
807 #define XPS_MIN_MAP_ALLOC ((L1_CACHE_ALIGN(offsetof(struct xps_map, queues[1])) \
808 - sizeof(struct xps_map)) / sizeof(u16))
811 * This structure holds all XPS maps for device. Maps are indexed by CPU.
813 * We keep track of the number of cpus/rxqs used when the struct is allocated,
814 * in nr_ids. This will help not accessing out-of-bound memory.
816 * We keep track of the number of traffic classes used when the struct is
817 * allocated, in num_tc. This will be used to navigate the maps, to ensure we're
818 * not crossing its upper bound, as the original dev->num_tc can be updated in
821 struct xps_dev_maps {
825 struct xps_map __rcu *attr_map[]; /* Either CPUs map or RXQs map */
828 #define XPS_CPU_DEV_MAPS_SIZE(_tcs) (sizeof(struct xps_dev_maps) + \
829 (nr_cpu_ids * (_tcs) * sizeof(struct xps_map *)))
831 #define XPS_RXQ_DEV_MAPS_SIZE(_tcs, _rxqs) (sizeof(struct xps_dev_maps) +\
832 (_rxqs * (_tcs) * sizeof(struct xps_map *)))
834 #endif /* CONFIG_XPS */
836 #define TC_MAX_QUEUE 16
837 #define TC_BITMASK 15
838 /* HW offloaded queuing disciplines txq count and offset maps */
839 struct netdev_tc_txq {
844 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
846 * This structure is to hold information about the device
847 * configured to run FCoE protocol stack.
849 struct netdev_fcoe_hbainfo {
850 char manufacturer[64];
851 char serial_number[64];
852 char hardware_version[64];
853 char driver_version[64];
854 char optionrom_version[64];
855 char firmware_version[64];
857 char model_description[256];
861 #define MAX_PHYS_ITEM_ID_LEN 32
863 /* This structure holds a unique identifier to identify some
864 * physical item (port for example) used by a netdevice.
866 struct netdev_phys_item_id {
867 unsigned char id[MAX_PHYS_ITEM_ID_LEN];
868 unsigned char id_len;
871 static inline bool netdev_phys_item_id_same(struct netdev_phys_item_id *a,
872 struct netdev_phys_item_id *b)
874 return a->id_len == b->id_len &&
875 memcmp(a->id, b->id, a->id_len) == 0;
878 typedef u16 (*select_queue_fallback_t)(struct net_device *dev,
880 struct net_device *sb_dev);
882 enum net_device_path_type {
883 DEV_PATH_ETHERNET = 0,
891 struct net_device_path {
892 enum net_device_path_type type;
893 const struct net_device *dev;
902 DEV_PATH_BR_VLAN_KEEP,
903 DEV_PATH_BR_VLAN_TAG,
904 DEV_PATH_BR_VLAN_UNTAG,
905 DEV_PATH_BR_VLAN_UNTAG_HW,
923 #define NET_DEVICE_PATH_STACK_MAX 5
924 #define NET_DEVICE_PATH_VLAN_MAX 2
926 struct net_device_path_stack {
928 struct net_device_path path[NET_DEVICE_PATH_STACK_MAX];
931 struct net_device_path_ctx {
932 const struct net_device *dev;
939 } vlan[NET_DEVICE_PATH_VLAN_MAX];
944 TC_SETUP_QDISC_MQPRIO,
947 TC_SETUP_CLSMATCHALL,
957 TC_SETUP_QDISC_TAPRIO,
966 /* These structures hold the attributes of bpf state that are being passed
967 * to the netdevice through the bpf op.
969 enum bpf_netdev_command {
970 /* Set or clear a bpf program used in the earliest stages of packet
971 * rx. The prog will have been loaded as BPF_PROG_TYPE_XDP. The callee
972 * is responsible for calling bpf_prog_put on any old progs that are
973 * stored. In case of error, the callee need not release the new prog
974 * reference, but on success it takes ownership and must bpf_prog_put
975 * when it is no longer used.
979 /* BPF program for offload callbacks, invoked at program load time. */
980 BPF_OFFLOAD_MAP_ALLOC,
981 BPF_OFFLOAD_MAP_FREE,
985 struct bpf_prog_offload_ops;
986 struct netlink_ext_ack;
988 struct xdp_dev_bulk_queue;
998 struct bpf_xdp_entity {
999 struct bpf_prog *prog;
1000 struct bpf_xdp_link *link;
1004 enum bpf_netdev_command command;
1006 /* XDP_SETUP_PROG */
1009 struct bpf_prog *prog;
1010 struct netlink_ext_ack *extack;
1012 /* BPF_OFFLOAD_MAP_ALLOC, BPF_OFFLOAD_MAP_FREE */
1014 struct bpf_offloaded_map *offmap;
1016 /* XDP_SETUP_XSK_POOL */
1018 struct xsk_buff_pool *pool;
1024 /* Flags for ndo_xsk_wakeup. */
1025 #define XDP_WAKEUP_RX (1 << 0)
1026 #define XDP_WAKEUP_TX (1 << 1)
1028 #ifdef CONFIG_XFRM_OFFLOAD
1029 struct xfrmdev_ops {
1030 int (*xdo_dev_state_add) (struct xfrm_state *x);
1031 void (*xdo_dev_state_delete) (struct xfrm_state *x);
1032 void (*xdo_dev_state_free) (struct xfrm_state *x);
1033 bool (*xdo_dev_offload_ok) (struct sk_buff *skb,
1034 struct xfrm_state *x);
1035 void (*xdo_dev_state_advance_esn) (struct xfrm_state *x);
1039 struct dev_ifalias {
1040 struct rcu_head rcuhead;
1047 struct netdev_net_notifier {
1048 struct list_head list;
1049 struct notifier_block *nb;
1053 * This structure defines the management hooks for network devices.
1054 * The following hooks can be defined; unless noted otherwise, they are
1055 * optional and can be filled with a null pointer.
1057 * int (*ndo_init)(struct net_device *dev);
1058 * This function is called once when a network device is registered.
1059 * The network device can use this for any late stage initialization
1060 * or semantic validation. It can fail with an error code which will
1061 * be propagated back to register_netdev.
1063 * void (*ndo_uninit)(struct net_device *dev);
1064 * This function is called when device is unregistered or when registration
1065 * fails. It is not called if init fails.
1067 * int (*ndo_open)(struct net_device *dev);
1068 * This function is called when a network device transitions to the up
1071 * int (*ndo_stop)(struct net_device *dev);
1072 * This function is called when a network device transitions to the down
1075 * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
1076 * struct net_device *dev);
1077 * Called when a packet needs to be transmitted.
1078 * Returns NETDEV_TX_OK. Can return NETDEV_TX_BUSY, but you should stop
1079 * the queue before that can happen; it's for obsolete devices and weird
1080 * corner cases, but the stack really does a non-trivial amount
1081 * of useless work if you return NETDEV_TX_BUSY.
1082 * Required; cannot be NULL.
1084 * netdev_features_t (*ndo_features_check)(struct sk_buff *skb,
1085 * struct net_device *dev
1086 * netdev_features_t features);
1087 * Called by core transmit path to determine if device is capable of
1088 * performing offload operations on a given packet. This is to give
1089 * the device an opportunity to implement any restrictions that cannot
1090 * be otherwise expressed by feature flags. The check is called with
1091 * the set of features that the stack has calculated and it returns
1092 * those the driver believes to be appropriate.
1094 * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb,
1095 * struct net_device *sb_dev);
1096 * Called to decide which queue to use when device supports multiple
1099 * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
1100 * This function is called to allow device receiver to make
1101 * changes to configuration when multicast or promiscuous is enabled.
1103 * void (*ndo_set_rx_mode)(struct net_device *dev);
1104 * This function is called device changes address list filtering.
1105 * If driver handles unicast address filtering, it should set
1106 * IFF_UNICAST_FLT in its priv_flags.
1108 * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
1109 * This function is called when the Media Access Control address
1110 * needs to be changed. If this interface is not defined, the
1111 * MAC address can not be changed.
1113 * int (*ndo_validate_addr)(struct net_device *dev);
1114 * Test if Media Access Control address is valid for the device.
1116 * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
1117 * Old-style ioctl entry point. This is used internally by the
1118 * appletalk and ieee802154 subsystems but is no longer called by
1119 * the device ioctl handler.
1121 * int (*ndo_siocbond)(struct net_device *dev, struct ifreq *ifr, int cmd);
1122 * Used by the bonding driver for its device specific ioctls:
1123 * SIOCBONDENSLAVE, SIOCBONDRELEASE, SIOCBONDSETHWADDR, SIOCBONDCHANGEACTIVE,
1124 * SIOCBONDSLAVEINFOQUERY, and SIOCBONDINFOQUERY
1126 * * int (*ndo_eth_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
1127 * Called for ethernet specific ioctls: SIOCGMIIPHY, SIOCGMIIREG,
1128 * SIOCSMIIREG, SIOCSHWTSTAMP and SIOCGHWTSTAMP.
1130 * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
1131 * Used to set network devices bus interface parameters. This interface
1132 * is retained for legacy reasons; new devices should use the bus
1133 * interface (PCI) for low level management.
1135 * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
1136 * Called when a user wants to change the Maximum Transfer Unit
1139 * void (*ndo_tx_timeout)(struct net_device *dev, unsigned int txqueue);
1140 * Callback used when the transmitter has not made any progress
1141 * for dev->watchdog ticks.
1143 * void (*ndo_get_stats64)(struct net_device *dev,
1144 * struct rtnl_link_stats64 *storage);
1145 * struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
1146 * Called when a user wants to get the network device usage
1147 * statistics. Drivers must do one of the following:
1148 * 1. Define @ndo_get_stats64 to fill in a zero-initialised
1149 * rtnl_link_stats64 structure passed by the caller.
1150 * 2. Define @ndo_get_stats to update a net_device_stats structure
1151 * (which should normally be dev->stats) and return a pointer to
1152 * it. The structure may be changed asynchronously only if each
1153 * field is written atomically.
1154 * 3. Update dev->stats asynchronously and atomically, and define
1155 * neither operation.
1157 * bool (*ndo_has_offload_stats)(const struct net_device *dev, int attr_id)
1158 * Return true if this device supports offload stats of this attr_id.
1160 * int (*ndo_get_offload_stats)(int attr_id, const struct net_device *dev,
1162 * Get statistics for offload operations by attr_id. Write it into the
1163 * attr_data pointer.
1165 * int (*ndo_vlan_rx_add_vid)(struct net_device *dev, __be16 proto, u16 vid);
1166 * If device supports VLAN filtering this function is called when a
1167 * VLAN id is registered.
1169 * int (*ndo_vlan_rx_kill_vid)(struct net_device *dev, __be16 proto, u16 vid);
1170 * If device supports VLAN filtering this function is called when a
1171 * VLAN id is unregistered.
1173 * void (*ndo_poll_controller)(struct net_device *dev);
1175 * SR-IOV management functions.
1176 * int (*ndo_set_vf_mac)(struct net_device *dev, int vf, u8* mac);
1177 * int (*ndo_set_vf_vlan)(struct net_device *dev, int vf, u16 vlan,
1178 * u8 qos, __be16 proto);
1179 * int (*ndo_set_vf_rate)(struct net_device *dev, int vf, int min_tx_rate,
1181 * int (*ndo_set_vf_spoofchk)(struct net_device *dev, int vf, bool setting);
1182 * int (*ndo_set_vf_trust)(struct net_device *dev, int vf, bool setting);
1183 * int (*ndo_get_vf_config)(struct net_device *dev,
1184 * int vf, struct ifla_vf_info *ivf);
1185 * int (*ndo_set_vf_link_state)(struct net_device *dev, int vf, int link_state);
1186 * int (*ndo_set_vf_port)(struct net_device *dev, int vf,
1187 * struct nlattr *port[]);
1189 * Enable or disable the VF ability to query its RSS Redirection Table and
1190 * Hash Key. This is needed since on some devices VF share this information
1191 * with PF and querying it may introduce a theoretical security risk.
1192 * int (*ndo_set_vf_rss_query_en)(struct net_device *dev, int vf, bool setting);
1193 * int (*ndo_get_vf_port)(struct net_device *dev, int vf, struct sk_buff *skb);
1194 * int (*ndo_setup_tc)(struct net_device *dev, enum tc_setup_type type,
1196 * Called to setup any 'tc' scheduler, classifier or action on @dev.
1197 * This is always called from the stack with the rtnl lock held and netif
1198 * tx queues stopped. This allows the netdevice to perform queue
1199 * management safely.
1201 * Fiber Channel over Ethernet (FCoE) offload functions.
1202 * int (*ndo_fcoe_enable)(struct net_device *dev);
1203 * Called when the FCoE protocol stack wants to start using LLD for FCoE
1204 * so the underlying device can perform whatever needed configuration or
1205 * initialization to support acceleration of FCoE traffic.
1207 * int (*ndo_fcoe_disable)(struct net_device *dev);
1208 * Called when the FCoE protocol stack wants to stop using LLD for FCoE
1209 * so the underlying device can perform whatever needed clean-ups to
1210 * stop supporting acceleration of FCoE traffic.
1212 * int (*ndo_fcoe_ddp_setup)(struct net_device *dev, u16 xid,
1213 * struct scatterlist *sgl, unsigned int sgc);
1214 * Called when the FCoE Initiator wants to initialize an I/O that
1215 * is a possible candidate for Direct Data Placement (DDP). The LLD can
1216 * perform necessary setup and returns 1 to indicate the device is set up
1217 * successfully to perform DDP on this I/O, otherwise this returns 0.
1219 * int (*ndo_fcoe_ddp_done)(struct net_device *dev, u16 xid);
1220 * Called when the FCoE Initiator/Target is done with the DDPed I/O as
1221 * indicated by the FC exchange id 'xid', so the underlying device can
1222 * clean up and reuse resources for later DDP requests.
1224 * int (*ndo_fcoe_ddp_target)(struct net_device *dev, u16 xid,
1225 * struct scatterlist *sgl, unsigned int sgc);
1226 * Called when the FCoE Target wants to initialize an I/O that
1227 * is a possible candidate for Direct Data Placement (DDP). The LLD can
1228 * perform necessary setup and returns 1 to indicate the device is set up
1229 * successfully to perform DDP on this I/O, otherwise this returns 0.
1231 * int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1232 * struct netdev_fcoe_hbainfo *hbainfo);
1233 * Called when the FCoE Protocol stack wants information on the underlying
1234 * device. This information is utilized by the FCoE protocol stack to
1235 * register attributes with Fiber Channel management service as per the
1236 * FC-GS Fabric Device Management Information(FDMI) specification.
1238 * int (*ndo_fcoe_get_wwn)(struct net_device *dev, u64 *wwn, int type);
1239 * Called when the underlying device wants to override default World Wide
1240 * Name (WWN) generation mechanism in FCoE protocol stack to pass its own
1241 * World Wide Port Name (WWPN) or World Wide Node Name (WWNN) to the FCoE
1242 * protocol stack to use.
1245 * int (*ndo_rx_flow_steer)(struct net_device *dev, const struct sk_buff *skb,
1246 * u16 rxq_index, u32 flow_id);
1247 * Set hardware filter for RFS. rxq_index is the target queue index;
1248 * flow_id is a flow ID to be passed to rps_may_expire_flow() later.
1249 * Return the filter ID on success, or a negative error code.
1251 * Slave management functions (for bridge, bonding, etc).
1252 * int (*ndo_add_slave)(struct net_device *dev, struct net_device *slave_dev);
1253 * Called to make another netdev an underling.
1255 * int (*ndo_del_slave)(struct net_device *dev, struct net_device *slave_dev);
1256 * Called to release previously enslaved netdev.
1258 * struct net_device *(*ndo_get_xmit_slave)(struct net_device *dev,
1259 * struct sk_buff *skb,
1261 * Get the xmit slave of master device. If all_slaves is true, function
1262 * assume all the slaves can transmit.
1264 * Feature/offload setting functions.
1265 * netdev_features_t (*ndo_fix_features)(struct net_device *dev,
1266 * netdev_features_t features);
1267 * Adjusts the requested feature flags according to device-specific
1268 * constraints, and returns the resulting flags. Must not modify
1271 * int (*ndo_set_features)(struct net_device *dev, netdev_features_t features);
1272 * Called to update device configuration to new features. Passed
1273 * feature set might be less than what was returned by ndo_fix_features()).
1274 * Must return >0 or -errno if it changed dev->features itself.
1276 * int (*ndo_fdb_add)(struct ndmsg *ndm, struct nlattr *tb[],
1277 * struct net_device *dev,
1278 * const unsigned char *addr, u16 vid, u16 flags,
1279 * struct netlink_ext_ack *extack);
1280 * Adds an FDB entry to dev for addr.
1281 * int (*ndo_fdb_del)(struct ndmsg *ndm, struct nlattr *tb[],
1282 * struct net_device *dev,
1283 * const unsigned char *addr, u16 vid)
1284 * Deletes the FDB entry from dev coresponding to addr.
1285 * int (*ndo_fdb_del_bulk)(struct ndmsg *ndm, struct nlattr *tb[],
1286 * struct net_device *dev,
1288 * struct netlink_ext_ack *extack);
1289 * int (*ndo_fdb_dump)(struct sk_buff *skb, struct netlink_callback *cb,
1290 * struct net_device *dev, struct net_device *filter_dev,
1292 * Used to add FDB entries to dump requests. Implementers should add
1293 * entries to skb and update idx with the number of entries.
1295 * int (*ndo_bridge_setlink)(struct net_device *dev, struct nlmsghdr *nlh,
1296 * u16 flags, struct netlink_ext_ack *extack)
1297 * int (*ndo_bridge_getlink)(struct sk_buff *skb, u32 pid, u32 seq,
1298 * struct net_device *dev, u32 filter_mask,
1300 * int (*ndo_bridge_dellink)(struct net_device *dev, struct nlmsghdr *nlh,
1303 * int (*ndo_change_carrier)(struct net_device *dev, bool new_carrier);
1304 * Called to change device carrier. Soft-devices (like dummy, team, etc)
1305 * which do not represent real hardware may define this to allow their
1306 * userspace components to manage their virtual carrier state. Devices
1307 * that determine carrier state from physical hardware properties (eg
1308 * network cables) or protocol-dependent mechanisms (eg
1309 * USB_CDC_NOTIFY_NETWORK_CONNECTION) should NOT implement this function.
1311 * int (*ndo_get_phys_port_id)(struct net_device *dev,
1312 * struct netdev_phys_item_id *ppid);
1313 * Called to get ID of physical port of this device. If driver does
1314 * not implement this, it is assumed that the hw is not able to have
1315 * multiple net devices on single physical port.
1317 * int (*ndo_get_port_parent_id)(struct net_device *dev,
1318 * struct netdev_phys_item_id *ppid)
1319 * Called to get the parent ID of the physical port of this device.
1321 * void* (*ndo_dfwd_add_station)(struct net_device *pdev,
1322 * struct net_device *dev)
1323 * Called by upper layer devices to accelerate switching or other
1324 * station functionality into hardware. 'pdev is the lowerdev
1325 * to use for the offload and 'dev' is the net device that will
1326 * back the offload. Returns a pointer to the private structure
1327 * the upper layer will maintain.
1328 * void (*ndo_dfwd_del_station)(struct net_device *pdev, void *priv)
1329 * Called by upper layer device to delete the station created
1330 * by 'ndo_dfwd_add_station'. 'pdev' is the net device backing
1331 * the station and priv is the structure returned by the add
1333 * int (*ndo_set_tx_maxrate)(struct net_device *dev,
1334 * int queue_index, u32 maxrate);
1335 * Called when a user wants to set a max-rate limitation of specific
1337 * int (*ndo_get_iflink)(const struct net_device *dev);
1338 * Called to get the iflink value of this device.
1339 * int (*ndo_fill_metadata_dst)(struct net_device *dev, struct sk_buff *skb);
1340 * This function is used to get egress tunnel information for given skb.
1341 * This is useful for retrieving outer tunnel header parameters while
1343 * void (*ndo_set_rx_headroom)(struct net_device *dev, int needed_headroom);
1344 * This function is used to specify the headroom that the skb must
1345 * consider when allocation skb during packet reception. Setting
1346 * appropriate rx headroom value allows avoiding skb head copy on
1347 * forward. Setting a negative value resets the rx headroom to the
1349 * int (*ndo_bpf)(struct net_device *dev, struct netdev_bpf *bpf);
1350 * This function is used to set or query state related to XDP on the
1351 * netdevice and manage BPF offload. See definition of
1352 * enum bpf_netdev_command for details.
1353 * int (*ndo_xdp_xmit)(struct net_device *dev, int n, struct xdp_frame **xdp,
1355 * This function is used to submit @n XDP packets for transmit on a
1356 * netdevice. Returns number of frames successfully transmitted, frames
1357 * that got dropped are freed/returned via xdp_return_frame().
1358 * Returns negative number, means general error invoking ndo, meaning
1359 * no frames were xmit'ed and core-caller will free all frames.
1360 * struct net_device *(*ndo_xdp_get_xmit_slave)(struct net_device *dev,
1361 * struct xdp_buff *xdp);
1362 * Get the xmit slave of master device based on the xdp_buff.
1363 * int (*ndo_xsk_wakeup)(struct net_device *dev, u32 queue_id, u32 flags);
1364 * This function is used to wake up the softirq, ksoftirqd or kthread
1365 * responsible for sending and/or receiving packets on a specific
1366 * queue id bound to an AF_XDP socket. The flags field specifies if
1367 * only RX, only Tx, or both should be woken up using the flags
1368 * XDP_WAKEUP_RX and XDP_WAKEUP_TX.
1369 * struct devlink_port *(*ndo_get_devlink_port)(struct net_device *dev);
1370 * Get devlink port instance associated with a given netdev.
1371 * Called with a reference on the netdevice and devlink locks only,
1372 * rtnl_lock is not held.
1373 * int (*ndo_tunnel_ctl)(struct net_device *dev, struct ip_tunnel_parm *p,
1375 * Add, change, delete or get information on an IPv4 tunnel.
1376 * struct net_device *(*ndo_get_peer_dev)(struct net_device *dev);
1377 * If a device is paired with a peer device, return the peer instance.
1378 * The caller must be under RCU read context.
1379 * int (*ndo_fill_forward_path)(struct net_device_path_ctx *ctx, struct net_device_path *path);
1380 * Get the forwarding path to reach the real device from the HW destination address
1381 * ktime_t (*ndo_get_tstamp)(struct net_device *dev,
1382 * const struct skb_shared_hwtstamps *hwtstamps,
1384 * Get hardware timestamp based on normal/adjustable time or free running
1385 * cycle counter. This function is required if physical clock supports a
1386 * free running cycle counter.
1388 struct net_device_ops {
1389 int (*ndo_init)(struct net_device *dev);
1390 void (*ndo_uninit)(struct net_device *dev);
1391 int (*ndo_open)(struct net_device *dev);
1392 int (*ndo_stop)(struct net_device *dev);
1393 netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
1394 struct net_device *dev);
1395 netdev_features_t (*ndo_features_check)(struct sk_buff *skb,
1396 struct net_device *dev,
1397 netdev_features_t features);
1398 u16 (*ndo_select_queue)(struct net_device *dev,
1399 struct sk_buff *skb,
1400 struct net_device *sb_dev);
1401 void (*ndo_change_rx_flags)(struct net_device *dev,
1403 void (*ndo_set_rx_mode)(struct net_device *dev);
1404 int (*ndo_set_mac_address)(struct net_device *dev,
1406 int (*ndo_validate_addr)(struct net_device *dev);
1407 int (*ndo_do_ioctl)(struct net_device *dev,
1408 struct ifreq *ifr, int cmd);
1409 int (*ndo_eth_ioctl)(struct net_device *dev,
1410 struct ifreq *ifr, int cmd);
1411 int (*ndo_siocbond)(struct net_device *dev,
1412 struct ifreq *ifr, int cmd);
1413 int (*ndo_siocwandev)(struct net_device *dev,
1414 struct if_settings *ifs);
1415 int (*ndo_siocdevprivate)(struct net_device *dev,
1417 void __user *data, int cmd);
1418 int (*ndo_set_config)(struct net_device *dev,
1420 int (*ndo_change_mtu)(struct net_device *dev,
1422 int (*ndo_neigh_setup)(struct net_device *dev,
1423 struct neigh_parms *);
1424 void (*ndo_tx_timeout) (struct net_device *dev,
1425 unsigned int txqueue);
1427 void (*ndo_get_stats64)(struct net_device *dev,
1428 struct rtnl_link_stats64 *storage);
1429 bool (*ndo_has_offload_stats)(const struct net_device *dev, int attr_id);
1430 int (*ndo_get_offload_stats)(int attr_id,
1431 const struct net_device *dev,
1433 struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
1435 int (*ndo_vlan_rx_add_vid)(struct net_device *dev,
1436 __be16 proto, u16 vid);
1437 int (*ndo_vlan_rx_kill_vid)(struct net_device *dev,
1438 __be16 proto, u16 vid);
1439 #ifdef CONFIG_NET_POLL_CONTROLLER
1440 void (*ndo_poll_controller)(struct net_device *dev);
1441 int (*ndo_netpoll_setup)(struct net_device *dev,
1442 struct netpoll_info *info);
1443 void (*ndo_netpoll_cleanup)(struct net_device *dev);
1445 int (*ndo_set_vf_mac)(struct net_device *dev,
1446 int queue, u8 *mac);
1447 int (*ndo_set_vf_vlan)(struct net_device *dev,
1448 int queue, u16 vlan,
1449 u8 qos, __be16 proto);
1450 int (*ndo_set_vf_rate)(struct net_device *dev,
1451 int vf, int min_tx_rate,
1453 int (*ndo_set_vf_spoofchk)(struct net_device *dev,
1454 int vf, bool setting);
1455 int (*ndo_set_vf_trust)(struct net_device *dev,
1456 int vf, bool setting);
1457 int (*ndo_get_vf_config)(struct net_device *dev,
1459 struct ifla_vf_info *ivf);
1460 int (*ndo_set_vf_link_state)(struct net_device *dev,
1461 int vf, int link_state);
1462 int (*ndo_get_vf_stats)(struct net_device *dev,
1464 struct ifla_vf_stats
1466 int (*ndo_set_vf_port)(struct net_device *dev,
1468 struct nlattr *port[]);
1469 int (*ndo_get_vf_port)(struct net_device *dev,
1470 int vf, struct sk_buff *skb);
1471 int (*ndo_get_vf_guid)(struct net_device *dev,
1473 struct ifla_vf_guid *node_guid,
1474 struct ifla_vf_guid *port_guid);
1475 int (*ndo_set_vf_guid)(struct net_device *dev,
1478 int (*ndo_set_vf_rss_query_en)(
1479 struct net_device *dev,
1480 int vf, bool setting);
1481 int (*ndo_setup_tc)(struct net_device *dev,
1482 enum tc_setup_type type,
1484 #if IS_ENABLED(CONFIG_FCOE)
1485 int (*ndo_fcoe_enable)(struct net_device *dev);
1486 int (*ndo_fcoe_disable)(struct net_device *dev);
1487 int (*ndo_fcoe_ddp_setup)(struct net_device *dev,
1489 struct scatterlist *sgl,
1491 int (*ndo_fcoe_ddp_done)(struct net_device *dev,
1493 int (*ndo_fcoe_ddp_target)(struct net_device *dev,
1495 struct scatterlist *sgl,
1497 int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1498 struct netdev_fcoe_hbainfo *hbainfo);
1501 #if IS_ENABLED(CONFIG_LIBFCOE)
1502 #define NETDEV_FCOE_WWNN 0
1503 #define NETDEV_FCOE_WWPN 1
1504 int (*ndo_fcoe_get_wwn)(struct net_device *dev,
1505 u64 *wwn, int type);
1508 #ifdef CONFIG_RFS_ACCEL
1509 int (*ndo_rx_flow_steer)(struct net_device *dev,
1510 const struct sk_buff *skb,
1514 int (*ndo_add_slave)(struct net_device *dev,
1515 struct net_device *slave_dev,
1516 struct netlink_ext_ack *extack);
1517 int (*ndo_del_slave)(struct net_device *dev,
1518 struct net_device *slave_dev);
1519 struct net_device* (*ndo_get_xmit_slave)(struct net_device *dev,
1520 struct sk_buff *skb,
1522 struct net_device* (*ndo_sk_get_lower_dev)(struct net_device *dev,
1524 netdev_features_t (*ndo_fix_features)(struct net_device *dev,
1525 netdev_features_t features);
1526 int (*ndo_set_features)(struct net_device *dev,
1527 netdev_features_t features);
1528 int (*ndo_neigh_construct)(struct net_device *dev,
1529 struct neighbour *n);
1530 void (*ndo_neigh_destroy)(struct net_device *dev,
1531 struct neighbour *n);
1533 int (*ndo_fdb_add)(struct ndmsg *ndm,
1534 struct nlattr *tb[],
1535 struct net_device *dev,
1536 const unsigned char *addr,
1539 struct netlink_ext_ack *extack);
1540 int (*ndo_fdb_del)(struct ndmsg *ndm,
1541 struct nlattr *tb[],
1542 struct net_device *dev,
1543 const unsigned char *addr,
1544 u16 vid, struct netlink_ext_ack *extack);
1545 int (*ndo_fdb_del_bulk)(struct ndmsg *ndm,
1546 struct nlattr *tb[],
1547 struct net_device *dev,
1549 struct netlink_ext_ack *extack);
1550 int (*ndo_fdb_dump)(struct sk_buff *skb,
1551 struct netlink_callback *cb,
1552 struct net_device *dev,
1553 struct net_device *filter_dev,
1555 int (*ndo_fdb_get)(struct sk_buff *skb,
1556 struct nlattr *tb[],
1557 struct net_device *dev,
1558 const unsigned char *addr,
1559 u16 vid, u32 portid, u32 seq,
1560 struct netlink_ext_ack *extack);
1561 int (*ndo_bridge_setlink)(struct net_device *dev,
1562 struct nlmsghdr *nlh,
1564 struct netlink_ext_ack *extack);
1565 int (*ndo_bridge_getlink)(struct sk_buff *skb,
1567 struct net_device *dev,
1570 int (*ndo_bridge_dellink)(struct net_device *dev,
1571 struct nlmsghdr *nlh,
1573 int (*ndo_change_carrier)(struct net_device *dev,
1575 int (*ndo_get_phys_port_id)(struct net_device *dev,
1576 struct netdev_phys_item_id *ppid);
1577 int (*ndo_get_port_parent_id)(struct net_device *dev,
1578 struct netdev_phys_item_id *ppid);
1579 int (*ndo_get_phys_port_name)(struct net_device *dev,
1580 char *name, size_t len);
1581 void* (*ndo_dfwd_add_station)(struct net_device *pdev,
1582 struct net_device *dev);
1583 void (*ndo_dfwd_del_station)(struct net_device *pdev,
1586 int (*ndo_set_tx_maxrate)(struct net_device *dev,
1589 int (*ndo_get_iflink)(const struct net_device *dev);
1590 int (*ndo_fill_metadata_dst)(struct net_device *dev,
1591 struct sk_buff *skb);
1592 void (*ndo_set_rx_headroom)(struct net_device *dev,
1593 int needed_headroom);
1594 int (*ndo_bpf)(struct net_device *dev,
1595 struct netdev_bpf *bpf);
1596 int (*ndo_xdp_xmit)(struct net_device *dev, int n,
1597 struct xdp_frame **xdp,
1599 struct net_device * (*ndo_xdp_get_xmit_slave)(struct net_device *dev,
1600 struct xdp_buff *xdp);
1601 int (*ndo_xsk_wakeup)(struct net_device *dev,
1602 u32 queue_id, u32 flags);
1603 struct devlink_port * (*ndo_get_devlink_port)(struct net_device *dev);
1604 int (*ndo_tunnel_ctl)(struct net_device *dev,
1605 struct ip_tunnel_parm *p, int cmd);
1606 struct net_device * (*ndo_get_peer_dev)(struct net_device *dev);
1607 int (*ndo_fill_forward_path)(struct net_device_path_ctx *ctx,
1608 struct net_device_path *path);
1609 ktime_t (*ndo_get_tstamp)(struct net_device *dev,
1610 const struct skb_shared_hwtstamps *hwtstamps,
1615 * enum netdev_priv_flags - &struct net_device priv_flags
1617 * These are the &struct net_device, they are only set internally
1618 * by drivers and used in the kernel. These flags are invisible to
1619 * userspace; this means that the order of these flags can change
1620 * during any kernel release.
1622 * You should have a pretty good reason to be extending these flags.
1624 * @IFF_802_1Q_VLAN: 802.1Q VLAN device
1625 * @IFF_EBRIDGE: Ethernet bridging device
1626 * @IFF_BONDING: bonding master or slave
1627 * @IFF_ISATAP: ISATAP interface (RFC4214)
1628 * @IFF_WAN_HDLC: WAN HDLC device
1629 * @IFF_XMIT_DST_RELEASE: dev_hard_start_xmit() is allowed to
1631 * @IFF_DONT_BRIDGE: disallow bridging this ether dev
1632 * @IFF_DISABLE_NETPOLL: disable netpoll at run-time
1633 * @IFF_MACVLAN_PORT: device used as macvlan port
1634 * @IFF_BRIDGE_PORT: device used as bridge port
1635 * @IFF_OVS_DATAPATH: device used as Open vSwitch datapath port
1636 * @IFF_TX_SKB_SHARING: The interface supports sharing skbs on transmit
1637 * @IFF_UNICAST_FLT: Supports unicast filtering
1638 * @IFF_TEAM_PORT: device used as team port
1639 * @IFF_SUPP_NOFCS: device supports sending custom FCS
1640 * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
1641 * change when it's running
1642 * @IFF_MACVLAN: Macvlan device
1643 * @IFF_XMIT_DST_RELEASE_PERM: IFF_XMIT_DST_RELEASE not taking into account
1644 * underlying stacked devices
1645 * @IFF_L3MDEV_MASTER: device is an L3 master device
1646 * @IFF_NO_QUEUE: device can run without qdisc attached
1647 * @IFF_OPENVSWITCH: device is a Open vSwitch master
1648 * @IFF_L3MDEV_SLAVE: device is enslaved to an L3 master device
1649 * @IFF_TEAM: device is a team device
1650 * @IFF_RXFH_CONFIGURED: device has had Rx Flow indirection table configured
1651 * @IFF_PHONY_HEADROOM: the headroom value is controlled by an external
1652 * entity (i.e. the master device for bridged veth)
1653 * @IFF_MACSEC: device is a MACsec device
1654 * @IFF_NO_RX_HANDLER: device doesn't support the rx_handler hook
1655 * @IFF_FAILOVER: device is a failover master device
1656 * @IFF_FAILOVER_SLAVE: device is lower dev of a failover master device
1657 * @IFF_L3MDEV_RX_HANDLER: only invoke the rx handler of L3 master device
1658 * @IFF_LIVE_RENAME_OK: rename is allowed while device is up and running
1659 * @IFF_TX_SKB_NO_LINEAR: device/driver is capable of xmitting frames with
1660 * skb_headlen(skb) == 0 (data starts from frag0)
1661 * @IFF_CHANGE_PROTO_DOWN: device supports setting carrier via IFLA_PROTO_DOWN
1663 enum netdev_priv_flags {
1664 IFF_802_1Q_VLAN = 1<<0,
1668 IFF_WAN_HDLC = 1<<4,
1669 IFF_XMIT_DST_RELEASE = 1<<5,
1670 IFF_DONT_BRIDGE = 1<<6,
1671 IFF_DISABLE_NETPOLL = 1<<7,
1672 IFF_MACVLAN_PORT = 1<<8,
1673 IFF_BRIDGE_PORT = 1<<9,
1674 IFF_OVS_DATAPATH = 1<<10,
1675 IFF_TX_SKB_SHARING = 1<<11,
1676 IFF_UNICAST_FLT = 1<<12,
1677 IFF_TEAM_PORT = 1<<13,
1678 IFF_SUPP_NOFCS = 1<<14,
1679 IFF_LIVE_ADDR_CHANGE = 1<<15,
1680 IFF_MACVLAN = 1<<16,
1681 IFF_XMIT_DST_RELEASE_PERM = 1<<17,
1682 IFF_L3MDEV_MASTER = 1<<18,
1683 IFF_NO_QUEUE = 1<<19,
1684 IFF_OPENVSWITCH = 1<<20,
1685 IFF_L3MDEV_SLAVE = 1<<21,
1687 IFF_RXFH_CONFIGURED = 1<<23,
1688 IFF_PHONY_HEADROOM = 1<<24,
1690 IFF_NO_RX_HANDLER = 1<<26,
1691 IFF_FAILOVER = 1<<27,
1692 IFF_FAILOVER_SLAVE = 1<<28,
1693 IFF_L3MDEV_RX_HANDLER = 1<<29,
1694 IFF_LIVE_RENAME_OK = 1<<30,
1695 IFF_TX_SKB_NO_LINEAR = BIT_ULL(31),
1696 IFF_CHANGE_PROTO_DOWN = BIT_ULL(32),
1699 #define IFF_802_1Q_VLAN IFF_802_1Q_VLAN
1700 #define IFF_EBRIDGE IFF_EBRIDGE
1701 #define IFF_BONDING IFF_BONDING
1702 #define IFF_ISATAP IFF_ISATAP
1703 #define IFF_WAN_HDLC IFF_WAN_HDLC
1704 #define IFF_XMIT_DST_RELEASE IFF_XMIT_DST_RELEASE
1705 #define IFF_DONT_BRIDGE IFF_DONT_BRIDGE
1706 #define IFF_DISABLE_NETPOLL IFF_DISABLE_NETPOLL
1707 #define IFF_MACVLAN_PORT IFF_MACVLAN_PORT
1708 #define IFF_BRIDGE_PORT IFF_BRIDGE_PORT
1709 #define IFF_OVS_DATAPATH IFF_OVS_DATAPATH
1710 #define IFF_TX_SKB_SHARING IFF_TX_SKB_SHARING
1711 #define IFF_UNICAST_FLT IFF_UNICAST_FLT
1712 #define IFF_TEAM_PORT IFF_TEAM_PORT
1713 #define IFF_SUPP_NOFCS IFF_SUPP_NOFCS
1714 #define IFF_LIVE_ADDR_CHANGE IFF_LIVE_ADDR_CHANGE
1715 #define IFF_MACVLAN IFF_MACVLAN
1716 #define IFF_XMIT_DST_RELEASE_PERM IFF_XMIT_DST_RELEASE_PERM
1717 #define IFF_L3MDEV_MASTER IFF_L3MDEV_MASTER
1718 #define IFF_NO_QUEUE IFF_NO_QUEUE
1719 #define IFF_OPENVSWITCH IFF_OPENVSWITCH
1720 #define IFF_L3MDEV_SLAVE IFF_L3MDEV_SLAVE
1721 #define IFF_TEAM IFF_TEAM
1722 #define IFF_RXFH_CONFIGURED IFF_RXFH_CONFIGURED
1723 #define IFF_PHONY_HEADROOM IFF_PHONY_HEADROOM
1724 #define IFF_MACSEC IFF_MACSEC
1725 #define IFF_NO_RX_HANDLER IFF_NO_RX_HANDLER
1726 #define IFF_FAILOVER IFF_FAILOVER
1727 #define IFF_FAILOVER_SLAVE IFF_FAILOVER_SLAVE
1728 #define IFF_L3MDEV_RX_HANDLER IFF_L3MDEV_RX_HANDLER
1729 #define IFF_LIVE_RENAME_OK IFF_LIVE_RENAME_OK
1730 #define IFF_TX_SKB_NO_LINEAR IFF_TX_SKB_NO_LINEAR
1732 /* Specifies the type of the struct net_device::ml_priv pointer */
1733 enum netdev_ml_priv_type {
1739 * struct net_device - The DEVICE structure.
1741 * Actually, this whole structure is a big mistake. It mixes I/O
1742 * data with strictly "high-level" data, and it has to know about
1743 * almost every data structure used in the INET module.
1745 * @name: This is the first field of the "visible" part of this structure
1746 * (i.e. as seen by users in the "Space.c" file). It is the name
1749 * @name_node: Name hashlist node
1750 * @ifalias: SNMP alias
1751 * @mem_end: Shared memory end
1752 * @mem_start: Shared memory start
1753 * @base_addr: Device I/O address
1754 * @irq: Device IRQ number
1756 * @state: Generic network queuing layer state, see netdev_state_t
1757 * @dev_list: The global list of network devices
1758 * @napi_list: List entry used for polling NAPI devices
1759 * @unreg_list: List entry when we are unregistering the
1760 * device; see the function unregister_netdev
1761 * @close_list: List entry used when we are closing the device
1762 * @ptype_all: Device-specific packet handlers for all protocols
1763 * @ptype_specific: Device-specific, protocol-specific packet handlers
1765 * @adj_list: Directly linked devices, like slaves for bonding
1766 * @features: Currently active device features
1767 * @hw_features: User-changeable features
1769 * @wanted_features: User-requested features
1770 * @vlan_features: Mask of features inheritable by VLAN devices
1772 * @hw_enc_features: Mask of features inherited by encapsulating devices
1773 * This field indicates what encapsulation
1774 * offloads the hardware is capable of doing,
1775 * and drivers will need to set them appropriately.
1777 * @mpls_features: Mask of features inheritable by MPLS
1778 * @gso_partial_features: value(s) from NETIF_F_GSO\*
1780 * @ifindex: interface index
1781 * @group: The group the device belongs to
1783 * @stats: Statistics struct, which was left as a legacy, use
1784 * rtnl_link_stats64 instead
1786 * @core_stats: core networking counters,
1787 * do not use this in drivers
1788 * @carrier_up_count: Number of times the carrier has been up
1789 * @carrier_down_count: Number of times the carrier has been down
1791 * @wireless_handlers: List of functions to handle Wireless Extensions,
1793 * see <net/iw_handler.h> for details.
1794 * @wireless_data: Instance data managed by the core of wireless extensions
1796 * @netdev_ops: Includes several pointers to callbacks,
1797 * if one wants to override the ndo_*() functions
1798 * @ethtool_ops: Management operations
1799 * @l3mdev_ops: Layer 3 master device operations
1800 * @ndisc_ops: Includes callbacks for different IPv6 neighbour
1801 * discovery handling. Necessary for e.g. 6LoWPAN.
1802 * @xfrmdev_ops: Transformation offload operations
1803 * @tlsdev_ops: Transport Layer Security offload operations
1804 * @header_ops: Includes callbacks for creating,parsing,caching,etc
1805 * of Layer 2 headers.
1807 * @flags: Interface flags (a la BSD)
1808 * @priv_flags: Like 'flags' but invisible to userspace,
1809 * see if.h for the definitions
1810 * @gflags: Global flags ( kept as legacy )
1811 * @padded: How much padding added by alloc_netdev()
1812 * @operstate: RFC2863 operstate
1813 * @link_mode: Mapping policy to operstate
1814 * @if_port: Selectable AUI, TP, ...
1816 * @mtu: Interface MTU value
1817 * @min_mtu: Interface Minimum MTU value
1818 * @max_mtu: Interface Maximum MTU value
1819 * @type: Interface hardware type
1820 * @hard_header_len: Maximum hardware header length.
1821 * @min_header_len: Minimum hardware header length
1823 * @needed_headroom: Extra headroom the hardware may need, but not in all
1824 * cases can this be guaranteed
1825 * @needed_tailroom: Extra tailroom the hardware may need, but not in all
1826 * cases can this be guaranteed. Some cases also use
1827 * LL_MAX_HEADER instead to allocate the skb
1829 * interface address info:
1831 * @perm_addr: Permanent hw address
1832 * @addr_assign_type: Hw address assignment type
1833 * @addr_len: Hardware address length
1834 * @upper_level: Maximum depth level of upper devices.
1835 * @lower_level: Maximum depth level of lower devices.
1836 * @neigh_priv_len: Used in neigh_alloc()
1837 * @dev_id: Used to differentiate devices that share
1838 * the same link layer address
1839 * @dev_port: Used to differentiate devices that share
1841 * @addr_list_lock: XXX: need comments on this one
1842 * @name_assign_type: network interface name assignment type
1843 * @uc_promisc: Counter that indicates promiscuous mode
1844 * has been enabled due to the need to listen to
1845 * additional unicast addresses in a device that
1846 * does not implement ndo_set_rx_mode()
1847 * @uc: unicast mac addresses
1848 * @mc: multicast mac addresses
1849 * @dev_addrs: list of device hw addresses
1850 * @queues_kset: Group of all Kobjects in the Tx and RX queues
1851 * @promiscuity: Number of times the NIC is told to work in
1852 * promiscuous mode; if it becomes 0 the NIC will
1853 * exit promiscuous mode
1854 * @allmulti: Counter, enables or disables allmulticast mode
1856 * @vlan_info: VLAN info
1857 * @dsa_ptr: dsa specific data
1858 * @tipc_ptr: TIPC specific data
1859 * @atalk_ptr: AppleTalk link
1860 * @ip_ptr: IPv4 specific data
1861 * @ip6_ptr: IPv6 specific data
1862 * @ax25_ptr: AX.25 specific data
1863 * @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
1864 * @ieee802154_ptr: IEEE 802.15.4 low-rate Wireless Personal Area Network
1866 * @mpls_ptr: mpls_dev struct pointer
1867 * @mctp_ptr: MCTP specific data
1869 * @dev_addr: Hw address (before bcast,
1870 * because most packets are unicast)
1872 * @_rx: Array of RX queues
1873 * @num_rx_queues: Number of RX queues
1874 * allocated at register_netdev() time
1875 * @real_num_rx_queues: Number of RX queues currently active in device
1876 * @xdp_prog: XDP sockets filter program pointer
1877 * @gro_flush_timeout: timeout for GRO layer in NAPI
1878 * @napi_defer_hard_irqs: If not zero, provides a counter that would
1879 * allow to avoid NIC hard IRQ, on busy queues.
1881 * @rx_handler: handler for received packets
1882 * @rx_handler_data: XXX: need comments on this one
1883 * @miniq_ingress: ingress/clsact qdisc specific data for
1884 * ingress processing
1885 * @ingress_queue: XXX: need comments on this one
1886 * @nf_hooks_ingress: netfilter hooks executed for ingress packets
1887 * @broadcast: hw bcast address
1889 * @rx_cpu_rmap: CPU reverse-mapping for RX completion interrupts,
1890 * indexed by RX queue number. Assigned by driver.
1891 * This must only be set if the ndo_rx_flow_steer
1892 * operation is defined
1893 * @index_hlist: Device index hash chain
1895 * @_tx: Array of TX queues
1896 * @num_tx_queues: Number of TX queues allocated at alloc_netdev_mq() time
1897 * @real_num_tx_queues: Number of TX queues currently active in device
1898 * @qdisc: Root qdisc from userspace point of view
1899 * @tx_queue_len: Max frames per queue allowed
1900 * @tx_global_lock: XXX: need comments on this one
1901 * @xdp_bulkq: XDP device bulk queue
1902 * @xps_maps: all CPUs/RXQs maps for XPS device
1904 * @xps_maps: XXX: need comments on this one
1905 * @miniq_egress: clsact qdisc specific data for
1907 * @nf_hooks_egress: netfilter hooks executed for egress packets
1908 * @qdisc_hash: qdisc hash table
1909 * @watchdog_timeo: Represents the timeout that is used by
1910 * the watchdog (see dev_watchdog())
1911 * @watchdog_timer: List of timers
1913 * @proto_down_reason: reason a netdev interface is held down
1914 * @pcpu_refcnt: Number of references to this device
1915 * @dev_refcnt: Number of references to this device
1916 * @refcnt_tracker: Tracker directory for tracked references to this device
1917 * @todo_list: Delayed register/unregister
1918 * @link_watch_list: XXX: need comments on this one
1920 * @reg_state: Register/unregister state machine
1921 * @dismantle: Device is going to be freed
1922 * @rtnl_link_state: This enum represents the phases of creating
1925 * @needs_free_netdev: Should unregister perform free_netdev?
1926 * @priv_destructor: Called from unregister
1927 * @npinfo: XXX: need comments on this one
1928 * @nd_net: Network namespace this network device is inside
1930 * @ml_priv: Mid-layer private
1931 * @ml_priv_type: Mid-layer private type
1932 * @lstats: Loopback statistics
1933 * @tstats: Tunnel statistics
1934 * @dstats: Dummy statistics
1935 * @vstats: Virtual ethernet statistics
1940 * @dm_private: Drop monitor private
1942 * @dev: Class/net/name entry
1943 * @sysfs_groups: Space for optional device, statistics and wireless
1946 * @sysfs_rx_queue_group: Space for optional per-rx queue attributes
1947 * @rtnl_link_ops: Rtnl_link_ops
1949 * @gso_max_size: Maximum size of generic segmentation offload
1950 * @tso_max_size: Device (as in HW) limit on the max TSO request size
1951 * @gso_max_segs: Maximum number of segments that can be passed to the
1953 * @tso_max_segs: Device (as in HW) limit on the max TSO segment count
1955 * @dcbnl_ops: Data Center Bridging netlink ops
1956 * @num_tc: Number of traffic classes in the net device
1957 * @tc_to_txq: XXX: need comments on this one
1958 * @prio_tc_map: XXX: need comments on this one
1960 * @fcoe_ddp_xid: Max exchange id for FCoE LRO by ddp
1962 * @priomap: XXX: need comments on this one
1963 * @phydev: Physical device may attach itself
1964 * for hardware timestamping
1965 * @sfp_bus: attached &struct sfp_bus structure.
1967 * @qdisc_tx_busylock: lockdep class annotating Qdisc->busylock spinlock
1969 * @proto_down: protocol port state information can be sent to the
1970 * switch driver and used to set the phys state of the
1973 * @wol_enabled: Wake-on-LAN is enabled
1975 * @threaded: napi threaded mode is enabled
1977 * @net_notifier_list: List of per-net netdev notifier block
1978 * that follow this device when it is moved
1979 * to another network namespace.
1981 * @macsec_ops: MACsec offloading ops
1983 * @udp_tunnel_nic_info: static structure describing the UDP tunnel
1984 * offload capabilities of the device
1985 * @udp_tunnel_nic: UDP tunnel offload state
1986 * @xdp_state: stores info on attached XDP BPF programs
1988 * @nested_level: Used as a parameter of spin_lock_nested() of
1989 * dev->addr_list_lock.
1990 * @unlink_list: As netif_addr_lock() can be called recursively,
1991 * keep a list of interfaces to be deleted.
1992 * @gro_max_size: Maximum size of aggregated packet in generic
1993 * receive offload (GRO)
1995 * @dev_addr_shadow: Copy of @dev_addr to catch direct writes.
1996 * @linkwatch_dev_tracker: refcount tracker used by linkwatch.
1997 * @watchdog_dev_tracker: refcount tracker used by watchdog.
1998 * @dev_registered_tracker: tracker for reference held while
2000 * @offload_xstats_l3: L3 HW stats for this netdevice.
2002 * FIXME: cleanup struct net_device such that network protocol info
2007 char name[IFNAMSIZ];
2008 struct netdev_name_node *name_node;
2009 struct dev_ifalias __rcu *ifalias;
2011 * I/O specific fields
2012 * FIXME: Merge these and struct ifmap into one
2014 unsigned long mem_end;
2015 unsigned long mem_start;
2016 unsigned long base_addr;
2019 * Some hardware also needs these fields (state,dev_list,
2020 * napi_list,unreg_list,close_list) but they are not
2021 * part of the usual set specified in Space.c.
2024 unsigned long state;
2026 struct list_head dev_list;
2027 struct list_head napi_list;
2028 struct list_head unreg_list;
2029 struct list_head close_list;
2030 struct list_head ptype_all;
2031 struct list_head ptype_specific;
2034 struct list_head upper;
2035 struct list_head lower;
2038 /* Read-mostly cache-line for fast-path access */
2040 unsigned long long priv_flags;
2041 const struct net_device_ops *netdev_ops;
2043 unsigned short gflags;
2044 unsigned short hard_header_len;
2046 /* Note : dev->mtu is often read without holding a lock.
2047 * Writers usually hold RTNL.
2048 * It is recommended to use READ_ONCE() to annotate the reads,
2049 * and to use WRITE_ONCE() to annotate the writes.
2052 unsigned short needed_headroom;
2053 unsigned short needed_tailroom;
2055 netdev_features_t features;
2056 netdev_features_t hw_features;
2057 netdev_features_t wanted_features;
2058 netdev_features_t vlan_features;
2059 netdev_features_t hw_enc_features;
2060 netdev_features_t mpls_features;
2061 netdev_features_t gso_partial_features;
2063 unsigned int min_mtu;
2064 unsigned int max_mtu;
2065 unsigned short type;
2066 unsigned char min_header_len;
2067 unsigned char name_assign_type;
2071 struct net_device_stats stats; /* not used by modern drivers */
2073 struct net_device_core_stats __percpu *core_stats;
2075 /* Stats to monitor link on/off, flapping */
2076 atomic_t carrier_up_count;
2077 atomic_t carrier_down_count;
2079 #ifdef CONFIG_WIRELESS_EXT
2080 const struct iw_handler_def *wireless_handlers;
2081 struct iw_public_data *wireless_data;
2083 const struct ethtool_ops *ethtool_ops;
2084 #ifdef CONFIG_NET_L3_MASTER_DEV
2085 const struct l3mdev_ops *l3mdev_ops;
2087 #if IS_ENABLED(CONFIG_IPV6)
2088 const struct ndisc_ops *ndisc_ops;
2091 #ifdef CONFIG_XFRM_OFFLOAD
2092 const struct xfrmdev_ops *xfrmdev_ops;
2095 #if IS_ENABLED(CONFIG_TLS_DEVICE)
2096 const struct tlsdev_ops *tlsdev_ops;
2099 const struct header_ops *header_ops;
2101 unsigned char operstate;
2102 unsigned char link_mode;
2104 unsigned char if_port;
2107 /* Interface address info. */
2108 unsigned char perm_addr[MAX_ADDR_LEN];
2109 unsigned char addr_assign_type;
2110 unsigned char addr_len;
2111 unsigned char upper_level;
2112 unsigned char lower_level;
2114 unsigned short neigh_priv_len;
2115 unsigned short dev_id;
2116 unsigned short dev_port;
2117 unsigned short padded;
2119 spinlock_t addr_list_lock;
2122 struct netdev_hw_addr_list uc;
2123 struct netdev_hw_addr_list mc;
2124 struct netdev_hw_addr_list dev_addrs;
2127 struct kset *queues_kset;
2129 #ifdef CONFIG_LOCKDEP
2130 struct list_head unlink_list;
2132 unsigned int promiscuity;
2133 unsigned int allmulti;
2135 #ifdef CONFIG_LOCKDEP
2136 unsigned char nested_level;
2140 /* Protocol-specific pointers */
2142 struct in_device __rcu *ip_ptr;
2143 struct inet6_dev __rcu *ip6_ptr;
2144 #if IS_ENABLED(CONFIG_VLAN_8021Q)
2145 struct vlan_info __rcu *vlan_info;
2147 #if IS_ENABLED(CONFIG_NET_DSA)
2148 struct dsa_port *dsa_ptr;
2150 #if IS_ENABLED(CONFIG_TIPC)
2151 struct tipc_bearer __rcu *tipc_ptr;
2153 #if IS_ENABLED(CONFIG_ATALK)
2156 #if IS_ENABLED(CONFIG_AX25)
2159 #if IS_ENABLED(CONFIG_CFG80211)
2160 struct wireless_dev *ieee80211_ptr;
2162 #if IS_ENABLED(CONFIG_IEEE802154) || IS_ENABLED(CONFIG_6LOWPAN)
2163 struct wpan_dev *ieee802154_ptr;
2165 #if IS_ENABLED(CONFIG_MPLS_ROUTING)
2166 struct mpls_dev __rcu *mpls_ptr;
2168 #if IS_ENABLED(CONFIG_MCTP)
2169 struct mctp_dev __rcu *mctp_ptr;
2173 * Cache lines mostly used on receive path (including eth_type_trans())
2175 /* Interface address info used in eth_type_trans() */
2176 const unsigned char *dev_addr;
2178 struct netdev_rx_queue *_rx;
2179 unsigned int num_rx_queues;
2180 unsigned int real_num_rx_queues;
2182 struct bpf_prog __rcu *xdp_prog;
2183 unsigned long gro_flush_timeout;
2184 int napi_defer_hard_irqs;
2185 #define GRO_LEGACY_MAX_SIZE 65536u
2186 /* TCP minimal MSS is 8 (TCP_MIN_GSO_SIZE),
2187 * and shinfo->gso_segs is a 16bit field.
2189 #define GRO_MAX_SIZE (8 * 65535u)
2190 unsigned int gro_max_size;
2191 rx_handler_func_t __rcu *rx_handler;
2192 void __rcu *rx_handler_data;
2194 #ifdef CONFIG_NET_CLS_ACT
2195 struct mini_Qdisc __rcu *miniq_ingress;
2197 struct netdev_queue __rcu *ingress_queue;
2198 #ifdef CONFIG_NETFILTER_INGRESS
2199 struct nf_hook_entries __rcu *nf_hooks_ingress;
2202 unsigned char broadcast[MAX_ADDR_LEN];
2203 #ifdef CONFIG_RFS_ACCEL
2204 struct cpu_rmap *rx_cpu_rmap;
2206 struct hlist_node index_hlist;
2209 * Cache lines mostly used on transmit path
2211 struct netdev_queue *_tx ____cacheline_aligned_in_smp;
2212 unsigned int num_tx_queues;
2213 unsigned int real_num_tx_queues;
2214 struct Qdisc __rcu *qdisc;
2215 unsigned int tx_queue_len;
2216 spinlock_t tx_global_lock;
2218 struct xdp_dev_bulk_queue __percpu *xdp_bulkq;
2221 struct xps_dev_maps __rcu *xps_maps[XPS_MAPS_MAX];
2223 #ifdef CONFIG_NET_CLS_ACT
2224 struct mini_Qdisc __rcu *miniq_egress;
2226 #ifdef CONFIG_NETFILTER_EGRESS
2227 struct nf_hook_entries __rcu *nf_hooks_egress;
2230 #ifdef CONFIG_NET_SCHED
2231 DECLARE_HASHTABLE (qdisc_hash, 4);
2233 /* These may be needed for future network-power-down code. */
2234 struct timer_list watchdog_timer;
2237 u32 proto_down_reason;
2239 struct list_head todo_list;
2241 #ifdef CONFIG_PCPU_DEV_REFCNT
2242 int __percpu *pcpu_refcnt;
2244 refcount_t dev_refcnt;
2246 struct ref_tracker_dir refcnt_tracker;
2248 struct list_head link_watch_list;
2250 enum { NETREG_UNINITIALIZED=0,
2251 NETREG_REGISTERED, /* completed register_netdevice */
2252 NETREG_UNREGISTERING, /* called unregister_netdevice */
2253 NETREG_UNREGISTERED, /* completed unregister todo */
2254 NETREG_RELEASED, /* called free_netdev */
2255 NETREG_DUMMY, /* dummy device for NAPI poll */
2261 RTNL_LINK_INITIALIZED,
2262 RTNL_LINK_INITIALIZING,
2263 } rtnl_link_state:16;
2265 bool needs_free_netdev;
2266 void (*priv_destructor)(struct net_device *dev);
2268 #ifdef CONFIG_NETPOLL
2269 struct netpoll_info __rcu *npinfo;
2272 possible_net_t nd_net;
2274 /* mid-layer private */
2276 enum netdev_ml_priv_type ml_priv_type;
2279 struct pcpu_lstats __percpu *lstats;
2280 struct pcpu_sw_netstats __percpu *tstats;
2281 struct pcpu_dstats __percpu *dstats;
2284 #if IS_ENABLED(CONFIG_GARP)
2285 struct garp_port __rcu *garp_port;
2287 #if IS_ENABLED(CONFIG_MRP)
2288 struct mrp_port __rcu *mrp_port;
2290 #if IS_ENABLED(CONFIG_NET_DROP_MONITOR)
2291 struct dm_hw_stat_delta __rcu *dm_private;
2294 const struct attribute_group *sysfs_groups[4];
2295 const struct attribute_group *sysfs_rx_queue_group;
2297 const struct rtnl_link_ops *rtnl_link_ops;
2299 /* for setting kernel sock attribute on TCP connection setup */
2300 #define GSO_MAX_SEGS 65535u
2301 #define GSO_LEGACY_MAX_SIZE 65536u
2302 /* TCP minimal MSS is 8 (TCP_MIN_GSO_SIZE),
2303 * and shinfo->gso_segs is a 16bit field.
2305 #define GSO_MAX_SIZE (8 * GSO_MAX_SEGS)
2307 unsigned int gso_max_size;
2308 #define TSO_LEGACY_MAX_SIZE 65536
2309 #define TSO_MAX_SIZE UINT_MAX
2310 unsigned int tso_max_size;
2312 #define TSO_MAX_SEGS U16_MAX
2316 const struct dcbnl_rtnl_ops *dcbnl_ops;
2319 struct netdev_tc_txq tc_to_txq[TC_MAX_QUEUE];
2320 u8 prio_tc_map[TC_BITMASK + 1];
2322 #if IS_ENABLED(CONFIG_FCOE)
2323 unsigned int fcoe_ddp_xid;
2325 #if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
2326 struct netprio_map __rcu *priomap;
2328 struct phy_device *phydev;
2329 struct sfp_bus *sfp_bus;
2330 struct lock_class_key *qdisc_tx_busylock;
2332 unsigned wol_enabled:1;
2333 unsigned threaded:1;
2335 struct list_head net_notifier_list;
2337 #if IS_ENABLED(CONFIG_MACSEC)
2338 /* MACsec management functions */
2339 const struct macsec_ops *macsec_ops;
2341 const struct udp_tunnel_nic_info *udp_tunnel_nic_info;
2342 struct udp_tunnel_nic *udp_tunnel_nic;
2344 /* protected by rtnl_lock */
2345 struct bpf_xdp_entity xdp_state[__MAX_XDP_MODE];
2347 u8 dev_addr_shadow[MAX_ADDR_LEN];
2348 netdevice_tracker linkwatch_dev_tracker;
2349 netdevice_tracker watchdog_dev_tracker;
2350 netdevice_tracker dev_registered_tracker;
2351 struct rtnl_hw_stats64 *offload_xstats_l3;
2353 #define to_net_dev(d) container_of(d, struct net_device, dev)
2355 static inline bool netif_elide_gro(const struct net_device *dev)
2357 if (!(dev->features & NETIF_F_GRO) || dev->xdp_prog)
2362 #define NETDEV_ALIGN 32
2365 int netdev_get_prio_tc_map(const struct net_device *dev, u32 prio)
2367 return dev->prio_tc_map[prio & TC_BITMASK];
2371 int netdev_set_prio_tc_map(struct net_device *dev, u8 prio, u8 tc)
2373 if (tc >= dev->num_tc)
2376 dev->prio_tc_map[prio & TC_BITMASK] = tc & TC_BITMASK;
2380 int netdev_txq_to_tc(struct net_device *dev, unsigned int txq);
2381 void netdev_reset_tc(struct net_device *dev);
2382 int netdev_set_tc_queue(struct net_device *dev, u8 tc, u16 count, u16 offset);
2383 int netdev_set_num_tc(struct net_device *dev, u8 num_tc);
2386 int netdev_get_num_tc(struct net_device *dev)
2391 static inline void net_prefetch(void *p)
2394 #if L1_CACHE_BYTES < 128
2395 prefetch((u8 *)p + L1_CACHE_BYTES);
2399 static inline void net_prefetchw(void *p)
2402 #if L1_CACHE_BYTES < 128
2403 prefetchw((u8 *)p + L1_CACHE_BYTES);
2407 void netdev_unbind_sb_channel(struct net_device *dev,
2408 struct net_device *sb_dev);
2409 int netdev_bind_sb_channel_queue(struct net_device *dev,
2410 struct net_device *sb_dev,
2411 u8 tc, u16 count, u16 offset);
2412 int netdev_set_sb_channel(struct net_device *dev, u16 channel);
2413 static inline int netdev_get_sb_channel(struct net_device *dev)
2415 return max_t(int, -dev->num_tc, 0);
2419 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
2422 return &dev->_tx[index];
2425 static inline struct netdev_queue *skb_get_tx_queue(const struct net_device *dev,
2426 const struct sk_buff *skb)
2428 return netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
2431 static inline void netdev_for_each_tx_queue(struct net_device *dev,
2432 void (*f)(struct net_device *,
2433 struct netdev_queue *,
2439 for (i = 0; i < dev->num_tx_queues; i++)
2440 f(dev, &dev->_tx[i], arg);
2443 #define netdev_lockdep_set_classes(dev) \
2445 static struct lock_class_key qdisc_tx_busylock_key; \
2446 static struct lock_class_key qdisc_xmit_lock_key; \
2447 static struct lock_class_key dev_addr_list_lock_key; \
2450 (dev)->qdisc_tx_busylock = &qdisc_tx_busylock_key; \
2451 lockdep_set_class(&(dev)->addr_list_lock, \
2452 &dev_addr_list_lock_key); \
2453 for (i = 0; i < (dev)->num_tx_queues; i++) \
2454 lockdep_set_class(&(dev)->_tx[i]._xmit_lock, \
2455 &qdisc_xmit_lock_key); \
2458 u16 netdev_pick_tx(struct net_device *dev, struct sk_buff *skb,
2459 struct net_device *sb_dev);
2460 struct netdev_queue *netdev_core_pick_tx(struct net_device *dev,
2461 struct sk_buff *skb,
2462 struct net_device *sb_dev);
2464 /* returns the headroom that the master device needs to take in account
2465 * when forwarding to this dev
2467 static inline unsigned netdev_get_fwd_headroom(struct net_device *dev)
2469 return dev->priv_flags & IFF_PHONY_HEADROOM ? 0 : dev->needed_headroom;
2472 static inline void netdev_set_rx_headroom(struct net_device *dev, int new_hr)
2474 if (dev->netdev_ops->ndo_set_rx_headroom)
2475 dev->netdev_ops->ndo_set_rx_headroom(dev, new_hr);
2478 /* set the device rx headroom to the dev's default */
2479 static inline void netdev_reset_rx_headroom(struct net_device *dev)
2481 netdev_set_rx_headroom(dev, -1);
2484 static inline void *netdev_get_ml_priv(struct net_device *dev,
2485 enum netdev_ml_priv_type type)
2487 if (dev->ml_priv_type != type)
2490 return dev->ml_priv;
2493 static inline void netdev_set_ml_priv(struct net_device *dev,
2495 enum netdev_ml_priv_type type)
2497 WARN(dev->ml_priv_type && dev->ml_priv_type != type,
2498 "Overwriting already set ml_priv_type (%u) with different ml_priv_type (%u)!\n",
2499 dev->ml_priv_type, type);
2500 WARN(!dev->ml_priv_type && dev->ml_priv,
2501 "Overwriting already set ml_priv and ml_priv_type is ML_PRIV_NONE!\n");
2503 dev->ml_priv = ml_priv;
2504 dev->ml_priv_type = type;
2508 * Net namespace inlines
2511 struct net *dev_net(const struct net_device *dev)
2513 return read_pnet(&dev->nd_net);
2517 void dev_net_set(struct net_device *dev, struct net *net)
2519 write_pnet(&dev->nd_net, net);
2523 * netdev_priv - access network device private data
2524 * @dev: network device
2526 * Get network device private data
2528 static inline void *netdev_priv(const struct net_device *dev)
2530 return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
2533 /* Set the sysfs physical device reference for the network logical device
2534 * if set prior to registration will cause a symlink during initialization.
2536 #define SET_NETDEV_DEV(net, pdev) ((net)->dev.parent = (pdev))
2538 /* Set the sysfs device type for the network logical device to allow
2539 * fine-grained identification of different network device types. For
2540 * example Ethernet, Wireless LAN, Bluetooth, WiMAX etc.
2542 #define SET_NETDEV_DEVTYPE(net, devtype) ((net)->dev.type = (devtype))
2544 /* Default NAPI poll() weight
2545 * Device drivers are strongly advised to not use bigger value
2547 #define NAPI_POLL_WEIGHT 64
2549 void netif_napi_add_weight(struct net_device *dev, struct napi_struct *napi,
2550 int (*poll)(struct napi_struct *, int), int weight);
2553 * netif_napi_add() - initialize a NAPI context
2554 * @dev: network device
2555 * @napi: NAPI context
2556 * @poll: polling function
2558 * netif_napi_add() must be used to initialize a NAPI context prior to calling
2559 * *any* of the other NAPI-related functions.
2562 netif_napi_add(struct net_device *dev, struct napi_struct *napi,
2563 int (*poll)(struct napi_struct *, int))
2565 netif_napi_add_weight(dev, napi, poll, NAPI_POLL_WEIGHT);
2569 netif_napi_add_tx_weight(struct net_device *dev,
2570 struct napi_struct *napi,
2571 int (*poll)(struct napi_struct *, int),
2574 set_bit(NAPI_STATE_NO_BUSY_POLL, &napi->state);
2575 netif_napi_add_weight(dev, napi, poll, weight);
2579 * netif_napi_add_tx() - initialize a NAPI context to be used for Tx only
2580 * @dev: network device
2581 * @napi: NAPI context
2582 * @poll: polling function
2584 * This variant of netif_napi_add() should be used from drivers using NAPI
2585 * to exclusively poll a TX queue.
2586 * This will avoid we add it into napi_hash[], thus polluting this hash table.
2588 static inline void netif_napi_add_tx(struct net_device *dev,
2589 struct napi_struct *napi,
2590 int (*poll)(struct napi_struct *, int))
2592 netif_napi_add_tx_weight(dev, napi, poll, NAPI_POLL_WEIGHT);
2596 * __netif_napi_del - remove a NAPI context
2597 * @napi: NAPI context
2599 * Warning: caller must observe RCU grace period before freeing memory
2600 * containing @napi. Drivers might want to call this helper to combine
2601 * all the needed RCU grace periods into a single one.
2603 void __netif_napi_del(struct napi_struct *napi);
2606 * netif_napi_del - remove a NAPI context
2607 * @napi: NAPI context
2609 * netif_napi_del() removes a NAPI context from the network device NAPI list
2611 static inline void netif_napi_del(struct napi_struct *napi)
2613 __netif_napi_del(napi);
2617 struct packet_type {
2618 __be16 type; /* This is really htons(ether_type). */
2619 bool ignore_outgoing;
2620 struct net_device *dev; /* NULL is wildcarded here */
2621 netdevice_tracker dev_tracker;
2622 int (*func) (struct sk_buff *,
2623 struct net_device *,
2624 struct packet_type *,
2625 struct net_device *);
2626 void (*list_func) (struct list_head *,
2627 struct packet_type *,
2628 struct net_device *);
2629 bool (*id_match)(struct packet_type *ptype,
2631 struct net *af_packet_net;
2632 void *af_packet_priv;
2633 struct list_head list;
2636 struct offload_callbacks {
2637 struct sk_buff *(*gso_segment)(struct sk_buff *skb,
2638 netdev_features_t features);
2639 struct sk_buff *(*gro_receive)(struct list_head *head,
2640 struct sk_buff *skb);
2641 int (*gro_complete)(struct sk_buff *skb, int nhoff);
2644 struct packet_offload {
2645 __be16 type; /* This is really htons(ether_type). */
2647 struct offload_callbacks callbacks;
2648 struct list_head list;
2651 /* often modified stats are per-CPU, other are shared (netdev->stats) */
2652 struct pcpu_sw_netstats {
2653 u64_stats_t rx_packets;
2654 u64_stats_t rx_bytes;
2655 u64_stats_t tx_packets;
2656 u64_stats_t tx_bytes;
2657 struct u64_stats_sync syncp;
2658 } __aligned(4 * sizeof(u64));
2660 struct pcpu_lstats {
2661 u64_stats_t packets;
2663 struct u64_stats_sync syncp;
2664 } __aligned(2 * sizeof(u64));
2666 void dev_lstats_read(struct net_device *dev, u64 *packets, u64 *bytes);
2668 static inline void dev_sw_netstats_rx_add(struct net_device *dev, unsigned int len)
2670 struct pcpu_sw_netstats *tstats = this_cpu_ptr(dev->tstats);
2672 u64_stats_update_begin(&tstats->syncp);
2673 u64_stats_add(&tstats->rx_bytes, len);
2674 u64_stats_inc(&tstats->rx_packets);
2675 u64_stats_update_end(&tstats->syncp);
2678 static inline void dev_sw_netstats_tx_add(struct net_device *dev,
2679 unsigned int packets,
2682 struct pcpu_sw_netstats *tstats = this_cpu_ptr(dev->tstats);
2684 u64_stats_update_begin(&tstats->syncp);
2685 u64_stats_add(&tstats->tx_bytes, len);
2686 u64_stats_add(&tstats->tx_packets, packets);
2687 u64_stats_update_end(&tstats->syncp);
2690 static inline void dev_lstats_add(struct net_device *dev, unsigned int len)
2692 struct pcpu_lstats *lstats = this_cpu_ptr(dev->lstats);
2694 u64_stats_update_begin(&lstats->syncp);
2695 u64_stats_add(&lstats->bytes, len);
2696 u64_stats_inc(&lstats->packets);
2697 u64_stats_update_end(&lstats->syncp);
2700 #define __netdev_alloc_pcpu_stats(type, gfp) \
2702 typeof(type) __percpu *pcpu_stats = alloc_percpu_gfp(type, gfp);\
2705 for_each_possible_cpu(__cpu) { \
2706 typeof(type) *stat; \
2707 stat = per_cpu_ptr(pcpu_stats, __cpu); \
2708 u64_stats_init(&stat->syncp); \
2714 #define netdev_alloc_pcpu_stats(type) \
2715 __netdev_alloc_pcpu_stats(type, GFP_KERNEL)
2717 #define devm_netdev_alloc_pcpu_stats(dev, type) \
2719 typeof(type) __percpu *pcpu_stats = devm_alloc_percpu(dev, type);\
2722 for_each_possible_cpu(__cpu) { \
2723 typeof(type) *stat; \
2724 stat = per_cpu_ptr(pcpu_stats, __cpu); \
2725 u64_stats_init(&stat->syncp); \
2731 enum netdev_lag_tx_type {
2732 NETDEV_LAG_TX_TYPE_UNKNOWN,
2733 NETDEV_LAG_TX_TYPE_RANDOM,
2734 NETDEV_LAG_TX_TYPE_BROADCAST,
2735 NETDEV_LAG_TX_TYPE_ROUNDROBIN,
2736 NETDEV_LAG_TX_TYPE_ACTIVEBACKUP,
2737 NETDEV_LAG_TX_TYPE_HASH,
2740 enum netdev_lag_hash {
2741 NETDEV_LAG_HASH_NONE,
2743 NETDEV_LAG_HASH_L34,
2744 NETDEV_LAG_HASH_L23,
2745 NETDEV_LAG_HASH_E23,
2746 NETDEV_LAG_HASH_E34,
2747 NETDEV_LAG_HASH_VLAN_SRCMAC,
2748 NETDEV_LAG_HASH_UNKNOWN,
2751 struct netdev_lag_upper_info {
2752 enum netdev_lag_tx_type tx_type;
2753 enum netdev_lag_hash hash_type;
2756 struct netdev_lag_lower_state_info {
2761 #include <linux/notifier.h>
2763 /* netdevice notifier chain. Please remember to update netdev_cmd_to_name()
2764 * and the rtnetlink notification exclusion list in rtnetlink_event() when
2768 NETDEV_UP = 1, /* For now you can't veto a device up/down */
2770 NETDEV_REBOOT, /* Tell a protocol stack a network interface
2771 detected a hardware crash and restarted
2772 - we can use this eg to kick tcp sessions
2774 NETDEV_CHANGE, /* Notify device state change */
2777 NETDEV_CHANGEMTU, /* notify after mtu change happened */
2778 NETDEV_CHANGEADDR, /* notify after the address change */
2779 NETDEV_PRE_CHANGEADDR, /* notify before the address change */
2783 NETDEV_BONDING_FAILOVER,
2785 NETDEV_PRE_TYPE_CHANGE,
2786 NETDEV_POST_TYPE_CHANGE,
2789 NETDEV_NOTIFY_PEERS,
2793 NETDEV_PRECHANGEMTU, /* notify before mtu change happened */
2794 NETDEV_CHANGEINFODATA,
2795 NETDEV_BONDING_INFO,
2796 NETDEV_PRECHANGEUPPER,
2797 NETDEV_CHANGELOWERSTATE,
2798 NETDEV_UDP_TUNNEL_PUSH_INFO,
2799 NETDEV_UDP_TUNNEL_DROP_INFO,
2800 NETDEV_CHANGE_TX_QUEUE_LEN,
2801 NETDEV_CVLAN_FILTER_PUSH_INFO,
2802 NETDEV_CVLAN_FILTER_DROP_INFO,
2803 NETDEV_SVLAN_FILTER_PUSH_INFO,
2804 NETDEV_SVLAN_FILTER_DROP_INFO,
2805 NETDEV_OFFLOAD_XSTATS_ENABLE,
2806 NETDEV_OFFLOAD_XSTATS_DISABLE,
2807 NETDEV_OFFLOAD_XSTATS_REPORT_USED,
2808 NETDEV_OFFLOAD_XSTATS_REPORT_DELTA,
2810 const char *netdev_cmd_to_name(enum netdev_cmd cmd);
2812 int register_netdevice_notifier(struct notifier_block *nb);
2813 int unregister_netdevice_notifier(struct notifier_block *nb);
2814 int register_netdevice_notifier_net(struct net *net, struct notifier_block *nb);
2815 int unregister_netdevice_notifier_net(struct net *net,
2816 struct notifier_block *nb);
2817 int register_netdevice_notifier_dev_net(struct net_device *dev,
2818 struct notifier_block *nb,
2819 struct netdev_net_notifier *nn);
2820 int unregister_netdevice_notifier_dev_net(struct net_device *dev,
2821 struct notifier_block *nb,
2822 struct netdev_net_notifier *nn);
2824 struct netdev_notifier_info {
2825 struct net_device *dev;
2826 struct netlink_ext_ack *extack;
2829 struct netdev_notifier_info_ext {
2830 struct netdev_notifier_info info; /* must be first */
2836 struct netdev_notifier_change_info {
2837 struct netdev_notifier_info info; /* must be first */
2838 unsigned int flags_changed;
2841 struct netdev_notifier_changeupper_info {
2842 struct netdev_notifier_info info; /* must be first */
2843 struct net_device *upper_dev; /* new upper dev */
2844 bool master; /* is upper dev master */
2845 bool linking; /* is the notification for link or unlink */
2846 void *upper_info; /* upper dev info */
2849 struct netdev_notifier_changelowerstate_info {
2850 struct netdev_notifier_info info; /* must be first */
2851 void *lower_state_info; /* is lower dev state */
2854 struct netdev_notifier_pre_changeaddr_info {
2855 struct netdev_notifier_info info; /* must be first */
2856 const unsigned char *dev_addr;
2859 enum netdev_offload_xstats_type {
2860 NETDEV_OFFLOAD_XSTATS_TYPE_L3 = 1,
2863 struct netdev_notifier_offload_xstats_info {
2864 struct netdev_notifier_info info; /* must be first */
2865 enum netdev_offload_xstats_type type;
2868 /* NETDEV_OFFLOAD_XSTATS_REPORT_DELTA */
2869 struct netdev_notifier_offload_xstats_rd *report_delta;
2870 /* NETDEV_OFFLOAD_XSTATS_REPORT_USED */
2871 struct netdev_notifier_offload_xstats_ru *report_used;
2875 int netdev_offload_xstats_enable(struct net_device *dev,
2876 enum netdev_offload_xstats_type type,
2877 struct netlink_ext_ack *extack);
2878 int netdev_offload_xstats_disable(struct net_device *dev,
2879 enum netdev_offload_xstats_type type);
2880 bool netdev_offload_xstats_enabled(const struct net_device *dev,
2881 enum netdev_offload_xstats_type type);
2882 int netdev_offload_xstats_get(struct net_device *dev,
2883 enum netdev_offload_xstats_type type,
2884 struct rtnl_hw_stats64 *stats, bool *used,
2885 struct netlink_ext_ack *extack);
2887 netdev_offload_xstats_report_delta(struct netdev_notifier_offload_xstats_rd *rd,
2888 const struct rtnl_hw_stats64 *stats);
2890 netdev_offload_xstats_report_used(struct netdev_notifier_offload_xstats_ru *ru);
2891 void netdev_offload_xstats_push_delta(struct net_device *dev,
2892 enum netdev_offload_xstats_type type,
2893 const struct rtnl_hw_stats64 *stats);
2895 static inline void netdev_notifier_info_init(struct netdev_notifier_info *info,
2896 struct net_device *dev)
2899 info->extack = NULL;
2902 static inline struct net_device *
2903 netdev_notifier_info_to_dev(const struct netdev_notifier_info *info)
2908 static inline struct netlink_ext_ack *
2909 netdev_notifier_info_to_extack(const struct netdev_notifier_info *info)
2911 return info->extack;
2914 int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
2917 extern rwlock_t dev_base_lock; /* Device list lock */
2919 #define for_each_netdev(net, d) \
2920 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
2921 #define for_each_netdev_reverse(net, d) \
2922 list_for_each_entry_reverse(d, &(net)->dev_base_head, dev_list)
2923 #define for_each_netdev_rcu(net, d) \
2924 list_for_each_entry_rcu(d, &(net)->dev_base_head, dev_list)
2925 #define for_each_netdev_safe(net, d, n) \
2926 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
2927 #define for_each_netdev_continue(net, d) \
2928 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
2929 #define for_each_netdev_continue_reverse(net, d) \
2930 list_for_each_entry_continue_reverse(d, &(net)->dev_base_head, \
2932 #define for_each_netdev_continue_rcu(net, d) \
2933 list_for_each_entry_continue_rcu(d, &(net)->dev_base_head, dev_list)
2934 #define for_each_netdev_in_bond_rcu(bond, slave) \
2935 for_each_netdev_rcu(&init_net, slave) \
2936 if (netdev_master_upper_dev_get_rcu(slave) == (bond))
2937 #define net_device_entry(lh) list_entry(lh, struct net_device, dev_list)
2939 static inline struct net_device *next_net_device(struct net_device *dev)
2941 struct list_head *lh;
2945 lh = dev->dev_list.next;
2946 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2949 static inline struct net_device *next_net_device_rcu(struct net_device *dev)
2951 struct list_head *lh;
2955 lh = rcu_dereference(list_next_rcu(&dev->dev_list));
2956 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2959 static inline struct net_device *first_net_device(struct net *net)
2961 return list_empty(&net->dev_base_head) ? NULL :
2962 net_device_entry(net->dev_base_head.next);
2965 static inline struct net_device *first_net_device_rcu(struct net *net)
2967 struct list_head *lh = rcu_dereference(list_next_rcu(&net->dev_base_head));
2969 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2972 int netdev_boot_setup_check(struct net_device *dev);
2973 struct net_device *dev_getbyhwaddr_rcu(struct net *net, unsigned short type,
2974 const char *hwaddr);
2975 struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
2976 void dev_add_pack(struct packet_type *pt);
2977 void dev_remove_pack(struct packet_type *pt);
2978 void __dev_remove_pack(struct packet_type *pt);
2979 void dev_add_offload(struct packet_offload *po);
2980 void dev_remove_offload(struct packet_offload *po);
2982 int dev_get_iflink(const struct net_device *dev);
2983 int dev_fill_metadata_dst(struct net_device *dev, struct sk_buff *skb);
2984 int dev_fill_forward_path(const struct net_device *dev, const u8 *daddr,
2985 struct net_device_path_stack *stack);
2986 struct net_device *__dev_get_by_flags(struct net *net, unsigned short flags,
2987 unsigned short mask);
2988 struct net_device *dev_get_by_name(struct net *net, const char *name);
2989 struct net_device *dev_get_by_name_rcu(struct net *net, const char *name);
2990 struct net_device *__dev_get_by_name(struct net *net, const char *name);
2991 bool netdev_name_in_use(struct net *net, const char *name);
2992 int dev_alloc_name(struct net_device *dev, const char *name);
2993 int dev_open(struct net_device *dev, struct netlink_ext_ack *extack);
2994 void dev_close(struct net_device *dev);
2995 void dev_close_many(struct list_head *head, bool unlink);
2996 void dev_disable_lro(struct net_device *dev);
2997 int dev_loopback_xmit(struct net *net, struct sock *sk, struct sk_buff *newskb);
2998 u16 dev_pick_tx_zero(struct net_device *dev, struct sk_buff *skb,
2999 struct net_device *sb_dev);
3000 u16 dev_pick_tx_cpu_id(struct net_device *dev, struct sk_buff *skb,
3001 struct net_device *sb_dev);
3003 int __dev_queue_xmit(struct sk_buff *skb, struct net_device *sb_dev);
3004 int __dev_direct_xmit(struct sk_buff *skb, u16 queue_id);
3006 static inline int dev_queue_xmit(struct sk_buff *skb)
3008 return __dev_queue_xmit(skb, NULL);
3011 static inline int dev_queue_xmit_accel(struct sk_buff *skb,
3012 struct net_device *sb_dev)
3014 return __dev_queue_xmit(skb, sb_dev);
3017 static inline int dev_direct_xmit(struct sk_buff *skb, u16 queue_id)
3021 ret = __dev_direct_xmit(skb, queue_id);
3022 if (!dev_xmit_complete(ret))
3027 int register_netdevice(struct net_device *dev);
3028 void unregister_netdevice_queue(struct net_device *dev, struct list_head *head);
3029 void unregister_netdevice_many(struct list_head *head);
3030 static inline void unregister_netdevice(struct net_device *dev)
3032 unregister_netdevice_queue(dev, NULL);
3035 int netdev_refcnt_read(const struct net_device *dev);
3036 void free_netdev(struct net_device *dev);
3037 void netdev_freemem(struct net_device *dev);
3038 int init_dummy_netdev(struct net_device *dev);
3040 struct net_device *netdev_get_xmit_slave(struct net_device *dev,
3041 struct sk_buff *skb,
3043 struct net_device *netdev_sk_get_lowest_dev(struct net_device *dev,
3045 struct net_device *dev_get_by_index(struct net *net, int ifindex);
3046 struct net_device *__dev_get_by_index(struct net *net, int ifindex);
3047 struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex);
3048 struct net_device *dev_get_by_napi_id(unsigned int napi_id);
3049 int dev_restart(struct net_device *dev);
3052 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
3053 unsigned short type,
3054 const void *daddr, const void *saddr,
3057 if (!dev->header_ops || !dev->header_ops->create)
3060 return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
3063 static inline int dev_parse_header(const struct sk_buff *skb,
3064 unsigned char *haddr)
3066 const struct net_device *dev = skb->dev;
3068 if (!dev->header_ops || !dev->header_ops->parse)
3070 return dev->header_ops->parse(skb, haddr);
3073 static inline __be16 dev_parse_header_protocol(const struct sk_buff *skb)
3075 const struct net_device *dev = skb->dev;
3077 if (!dev->header_ops || !dev->header_ops->parse_protocol)
3079 return dev->header_ops->parse_protocol(skb);
3082 /* ll_header must have at least hard_header_len allocated */
3083 static inline bool dev_validate_header(const struct net_device *dev,
3084 char *ll_header, int len)
3086 if (likely(len >= dev->hard_header_len))
3088 if (len < dev->min_header_len)
3091 if (capable(CAP_SYS_RAWIO)) {
3092 memset(ll_header + len, 0, dev->hard_header_len - len);
3096 if (dev->header_ops && dev->header_ops->validate)
3097 return dev->header_ops->validate(ll_header, len);
3102 static inline bool dev_has_header(const struct net_device *dev)
3104 return dev->header_ops && dev->header_ops->create;
3108 * Incoming packets are placed on per-CPU queues
3110 struct softnet_data {
3111 struct list_head poll_list;
3112 struct sk_buff_head process_queue;
3115 unsigned int processed;
3116 unsigned int time_squeeze;
3117 unsigned int received_rps;
3119 struct softnet_data *rps_ipi_list;
3121 #ifdef CONFIG_NET_FLOW_LIMIT
3122 struct sd_flow_limit __rcu *flow_limit;
3124 struct Qdisc *output_queue;
3125 struct Qdisc **output_queue_tailp;
3126 struct sk_buff *completion_queue;
3127 #ifdef CONFIG_XFRM_OFFLOAD
3128 struct sk_buff_head xfrm_backlog;
3130 /* written and read only by owning cpu: */
3134 #ifdef CONFIG_NET_EGRESS
3139 /* input_queue_head should be written by cpu owning this struct,
3140 * and only read by other cpus. Worth using a cache line.
3142 unsigned int input_queue_head ____cacheline_aligned_in_smp;
3144 /* Elements below can be accessed between CPUs for RPS/RFS */
3145 call_single_data_t csd ____cacheline_aligned_in_smp;
3146 struct softnet_data *rps_ipi_next;
3148 unsigned int input_queue_tail;
3150 unsigned int dropped;
3151 struct sk_buff_head input_pkt_queue;
3152 struct napi_struct backlog;
3154 /* Another possibly contended cache line */
3155 spinlock_t defer_lock ____cacheline_aligned_in_smp;
3157 int defer_ipi_scheduled;
3158 struct sk_buff *defer_list;
3159 call_single_data_t defer_csd;
3162 static inline void input_queue_head_incr(struct softnet_data *sd)
3165 sd->input_queue_head++;
3169 static inline void input_queue_tail_incr_save(struct softnet_data *sd,
3170 unsigned int *qtail)
3173 *qtail = ++sd->input_queue_tail;
3177 DECLARE_PER_CPU_ALIGNED(struct softnet_data, softnet_data);
3179 static inline int dev_recursion_level(void)
3181 return this_cpu_read(softnet_data.xmit.recursion);
3184 #define XMIT_RECURSION_LIMIT 8
3185 static inline bool dev_xmit_recursion(void)
3187 return unlikely(__this_cpu_read(softnet_data.xmit.recursion) >
3188 XMIT_RECURSION_LIMIT);
3191 static inline void dev_xmit_recursion_inc(void)
3193 __this_cpu_inc(softnet_data.xmit.recursion);
3196 static inline void dev_xmit_recursion_dec(void)
3198 __this_cpu_dec(softnet_data.xmit.recursion);
3201 void __netif_schedule(struct Qdisc *q);
3202 void netif_schedule_queue(struct netdev_queue *txq);
3204 static inline void netif_tx_schedule_all(struct net_device *dev)
3208 for (i = 0; i < dev->num_tx_queues; i++)
3209 netif_schedule_queue(netdev_get_tx_queue(dev, i));
3212 static __always_inline void netif_tx_start_queue(struct netdev_queue *dev_queue)
3214 clear_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
3218 * netif_start_queue - allow transmit
3219 * @dev: network device
3221 * Allow upper layers to call the device hard_start_xmit routine.
3223 static inline void netif_start_queue(struct net_device *dev)
3225 netif_tx_start_queue(netdev_get_tx_queue(dev, 0));
3228 static inline void netif_tx_start_all_queues(struct net_device *dev)
3232 for (i = 0; i < dev->num_tx_queues; i++) {
3233 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3234 netif_tx_start_queue(txq);
3238 void netif_tx_wake_queue(struct netdev_queue *dev_queue);
3241 * netif_wake_queue - restart transmit
3242 * @dev: network device
3244 * Allow upper layers to call the device hard_start_xmit routine.
3245 * Used for flow control when transmit resources are available.
3247 static inline void netif_wake_queue(struct net_device *dev)
3249 netif_tx_wake_queue(netdev_get_tx_queue(dev, 0));
3252 static inline void netif_tx_wake_all_queues(struct net_device *dev)
3256 for (i = 0; i < dev->num_tx_queues; i++) {
3257 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3258 netif_tx_wake_queue(txq);
3262 static __always_inline void netif_tx_stop_queue(struct netdev_queue *dev_queue)
3264 set_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
3268 * netif_stop_queue - stop transmitted packets
3269 * @dev: network device
3271 * Stop upper layers calling the device hard_start_xmit routine.
3272 * Used for flow control when transmit resources are unavailable.
3274 static inline void netif_stop_queue(struct net_device *dev)
3276 netif_tx_stop_queue(netdev_get_tx_queue(dev, 0));
3279 void netif_tx_stop_all_queues(struct net_device *dev);
3281 static inline bool netif_tx_queue_stopped(const struct netdev_queue *dev_queue)
3283 return test_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
3287 * netif_queue_stopped - test if transmit queue is flowblocked
3288 * @dev: network device
3290 * Test if transmit queue on device is currently unable to send.
3292 static inline bool netif_queue_stopped(const struct net_device *dev)
3294 return netif_tx_queue_stopped(netdev_get_tx_queue(dev, 0));
3297 static inline bool netif_xmit_stopped(const struct netdev_queue *dev_queue)
3299 return dev_queue->state & QUEUE_STATE_ANY_XOFF;
3303 netif_xmit_frozen_or_stopped(const struct netdev_queue *dev_queue)
3305 return dev_queue->state & QUEUE_STATE_ANY_XOFF_OR_FROZEN;
3309 netif_xmit_frozen_or_drv_stopped(const struct netdev_queue *dev_queue)
3311 return dev_queue->state & QUEUE_STATE_DRV_XOFF_OR_FROZEN;
3315 * netdev_queue_set_dql_min_limit - set dql minimum limit
3316 * @dev_queue: pointer to transmit queue
3317 * @min_limit: dql minimum limit
3319 * Forces xmit_more() to return true until the minimum threshold
3320 * defined by @min_limit is reached (or until the tx queue is
3321 * empty). Warning: to be use with care, misuse will impact the
3324 static inline void netdev_queue_set_dql_min_limit(struct netdev_queue *dev_queue,
3325 unsigned int min_limit)
3328 dev_queue->dql.min_limit = min_limit;
3333 * netdev_txq_bql_enqueue_prefetchw - prefetch bql data for write
3334 * @dev_queue: pointer to transmit queue
3336 * BQL enabled drivers might use this helper in their ndo_start_xmit(),
3337 * to give appropriate hint to the CPU.
3339 static inline void netdev_txq_bql_enqueue_prefetchw(struct netdev_queue *dev_queue)
3342 prefetchw(&dev_queue->dql.num_queued);
3347 * netdev_txq_bql_complete_prefetchw - prefetch bql data for write
3348 * @dev_queue: pointer to transmit queue
3350 * BQL enabled drivers might use this helper in their TX completion path,
3351 * to give appropriate hint to the CPU.
3353 static inline void netdev_txq_bql_complete_prefetchw(struct netdev_queue *dev_queue)
3356 prefetchw(&dev_queue->dql.limit);
3361 * netdev_tx_sent_queue - report the number of bytes queued to a given tx queue
3362 * @dev_queue: network device queue
3363 * @bytes: number of bytes queued to the device queue
3365 * Report the number of bytes queued for sending/completion to the network
3366 * device hardware queue. @bytes should be a good approximation and should
3367 * exactly match netdev_completed_queue() @bytes.
3368 * This is typically called once per packet, from ndo_start_xmit().
3370 static inline void netdev_tx_sent_queue(struct netdev_queue *dev_queue,
3374 dql_queued(&dev_queue->dql, bytes);
3376 if (likely(dql_avail(&dev_queue->dql) >= 0))
3379 set_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
3382 * The XOFF flag must be set before checking the dql_avail below,
3383 * because in netdev_tx_completed_queue we update the dql_completed
3384 * before checking the XOFF flag.
3388 /* check again in case another CPU has just made room avail */
3389 if (unlikely(dql_avail(&dev_queue->dql) >= 0))
3390 clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
3394 /* Variant of netdev_tx_sent_queue() for drivers that are aware
3395 * that they should not test BQL status themselves.
3396 * We do want to change __QUEUE_STATE_STACK_XOFF only for the last
3398 * Returns true if the doorbell must be used to kick the NIC.
3400 static inline bool __netdev_tx_sent_queue(struct netdev_queue *dev_queue,
3406 dql_queued(&dev_queue->dql, bytes);
3408 return netif_tx_queue_stopped(dev_queue);
3410 netdev_tx_sent_queue(dev_queue, bytes);
3415 * netdev_sent_queue - report the number of bytes queued to hardware
3416 * @dev: network device
3417 * @bytes: number of bytes queued to the hardware device queue
3419 * Report the number of bytes queued for sending/completion to the network
3420 * device hardware queue#0. @bytes should be a good approximation and should
3421 * exactly match netdev_completed_queue() @bytes.
3422 * This is typically called once per packet, from ndo_start_xmit().
3424 static inline void netdev_sent_queue(struct net_device *dev, unsigned int bytes)
3426 netdev_tx_sent_queue(netdev_get_tx_queue(dev, 0), bytes);
3429 static inline bool __netdev_sent_queue(struct net_device *dev,
3433 return __netdev_tx_sent_queue(netdev_get_tx_queue(dev, 0), bytes,
3438 * netdev_tx_completed_queue - report number of packets/bytes at TX completion.
3439 * @dev_queue: network device queue
3440 * @pkts: number of packets (currently ignored)
3441 * @bytes: number of bytes dequeued from the device queue
3443 * Must be called at most once per TX completion round (and not per
3444 * individual packet), so that BQL can adjust its limits appropriately.
3446 static inline void netdev_tx_completed_queue(struct netdev_queue *dev_queue,
3447 unsigned int pkts, unsigned int bytes)
3450 if (unlikely(!bytes))
3453 dql_completed(&dev_queue->dql, bytes);
3456 * Without the memory barrier there is a small possiblity that
3457 * netdev_tx_sent_queue will miss the update and cause the queue to
3458 * be stopped forever
3462 if (unlikely(dql_avail(&dev_queue->dql) < 0))
3465 if (test_and_clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state))
3466 netif_schedule_queue(dev_queue);
3471 * netdev_completed_queue - report bytes and packets completed by device
3472 * @dev: network device
3473 * @pkts: actual number of packets sent over the medium
3474 * @bytes: actual number of bytes sent over the medium
3476 * Report the number of bytes and packets transmitted by the network device
3477 * hardware queue over the physical medium, @bytes must exactly match the
3478 * @bytes amount passed to netdev_sent_queue()
3480 static inline void netdev_completed_queue(struct net_device *dev,
3481 unsigned int pkts, unsigned int bytes)
3483 netdev_tx_completed_queue(netdev_get_tx_queue(dev, 0), pkts, bytes);
3486 static inline void netdev_tx_reset_queue(struct netdev_queue *q)
3489 clear_bit(__QUEUE_STATE_STACK_XOFF, &q->state);
3495 * netdev_reset_queue - reset the packets and bytes count of a network device
3496 * @dev_queue: network device
3498 * Reset the bytes and packet count of a network device and clear the
3499 * software flow control OFF bit for this network device
3501 static inline void netdev_reset_queue(struct net_device *dev_queue)
3503 netdev_tx_reset_queue(netdev_get_tx_queue(dev_queue, 0));
3507 * netdev_cap_txqueue - check if selected tx queue exceeds device queues
3508 * @dev: network device
3509 * @queue_index: given tx queue index
3511 * Returns 0 if given tx queue index >= number of device tx queues,
3512 * otherwise returns the originally passed tx queue index.
3514 static inline u16 netdev_cap_txqueue(struct net_device *dev, u16 queue_index)
3516 if (unlikely(queue_index >= dev->real_num_tx_queues)) {
3517 net_warn_ratelimited("%s selects TX queue %d, but real number of TX queues is %d\n",
3518 dev->name, queue_index,
3519 dev->real_num_tx_queues);
3527 * netif_running - test if up
3528 * @dev: network device
3530 * Test if the device has been brought up.
3532 static inline bool netif_running(const struct net_device *dev)
3534 return test_bit(__LINK_STATE_START, &dev->state);
3538 * Routines to manage the subqueues on a device. We only need start,
3539 * stop, and a check if it's stopped. All other device management is
3540 * done at the overall netdevice level.
3541 * Also test the device if we're multiqueue.
3545 * netif_start_subqueue - allow sending packets on subqueue
3546 * @dev: network device
3547 * @queue_index: sub queue index
3549 * Start individual transmit queue of a device with multiple transmit queues.
3551 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
3553 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3555 netif_tx_start_queue(txq);
3559 * netif_stop_subqueue - stop sending packets on subqueue
3560 * @dev: network device
3561 * @queue_index: sub queue index
3563 * Stop individual transmit queue of a device with multiple transmit queues.
3565 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
3567 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3568 netif_tx_stop_queue(txq);
3572 * __netif_subqueue_stopped - test status of subqueue
3573 * @dev: network device
3574 * @queue_index: sub queue index
3576 * Check individual transmit queue of a device with multiple transmit queues.
3578 static inline bool __netif_subqueue_stopped(const struct net_device *dev,
3581 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3583 return netif_tx_queue_stopped(txq);
3587 * netif_subqueue_stopped - test status of subqueue
3588 * @dev: network device
3589 * @skb: sub queue buffer pointer
3591 * Check individual transmit queue of a device with multiple transmit queues.
3593 static inline bool netif_subqueue_stopped(const struct net_device *dev,
3594 struct sk_buff *skb)
3596 return __netif_subqueue_stopped(dev, skb_get_queue_mapping(skb));
3600 * netif_wake_subqueue - allow sending packets on subqueue
3601 * @dev: network device
3602 * @queue_index: sub queue index
3604 * Resume individual transmit queue of a device with multiple transmit queues.
3606 static inline void netif_wake_subqueue(struct net_device *dev, u16 queue_index)
3608 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
3610 netif_tx_wake_queue(txq);
3614 int netif_set_xps_queue(struct net_device *dev, const struct cpumask *mask,
3616 int __netif_set_xps_queue(struct net_device *dev, const unsigned long *mask,
3617 u16 index, enum xps_map_type type);
3620 * netif_attr_test_mask - Test a CPU or Rx queue set in a mask
3621 * @j: CPU/Rx queue index
3622 * @mask: bitmask of all cpus/rx queues
3623 * @nr_bits: number of bits in the bitmask
3625 * Test if a CPU or Rx queue index is set in a mask of all CPU/Rx queues.
3627 static inline bool netif_attr_test_mask(unsigned long j,
3628 const unsigned long *mask,
3629 unsigned int nr_bits)
3631 cpu_max_bits_warn(j, nr_bits);
3632 return test_bit(j, mask);
3636 * netif_attr_test_online - Test for online CPU/Rx queue
3637 * @j: CPU/Rx queue index
3638 * @online_mask: bitmask for CPUs/Rx queues that are online
3639 * @nr_bits: number of bits in the bitmask
3641 * Returns true if a CPU/Rx queue is online.
3643 static inline bool netif_attr_test_online(unsigned long j,
3644 const unsigned long *online_mask,
3645 unsigned int nr_bits)
3647 cpu_max_bits_warn(j, nr_bits);
3650 return test_bit(j, online_mask);
3652 return (j < nr_bits);
3656 * netif_attrmask_next - get the next CPU/Rx queue in a cpu/Rx queues mask
3657 * @n: CPU/Rx queue index
3658 * @srcp: the cpumask/Rx queue mask pointer
3659 * @nr_bits: number of bits in the bitmask
3661 * Returns >= nr_bits if no further CPUs/Rx queues set.
3663 static inline unsigned int netif_attrmask_next(int n, const unsigned long *srcp,
3664 unsigned int nr_bits)
3666 /* n is a prior cpu */
3667 cpu_max_bits_warn(n + 1, nr_bits);
3670 return find_next_bit(srcp, nr_bits, n + 1);
3676 * netif_attrmask_next_and - get the next CPU/Rx queue in \*src1p & \*src2p
3677 * @n: CPU/Rx queue index
3678 * @src1p: the first CPUs/Rx queues mask pointer
3679 * @src2p: the second CPUs/Rx queues mask pointer
3680 * @nr_bits: number of bits in the bitmask
3682 * Returns >= nr_bits if no further CPUs/Rx queues set in both.
3684 static inline int netif_attrmask_next_and(int n, const unsigned long *src1p,
3685 const unsigned long *src2p,
3686 unsigned int nr_bits)
3688 /* n is a prior cpu */
3689 cpu_max_bits_warn(n + 1, nr_bits);
3692 return find_next_and_bit(src1p, src2p, nr_bits, n + 1);
3694 return find_next_bit(src1p, nr_bits, n + 1);
3696 return find_next_bit(src2p, nr_bits, n + 1);
3701 static inline int netif_set_xps_queue(struct net_device *dev,
3702 const struct cpumask *mask,
3708 static inline int __netif_set_xps_queue(struct net_device *dev,
3709 const unsigned long *mask,
3710 u16 index, enum xps_map_type type)
3717 * netif_is_multiqueue - test if device has multiple transmit queues
3718 * @dev: network device
3720 * Check if device has multiple transmit queues
3722 static inline bool netif_is_multiqueue(const struct net_device *dev)
3724 return dev->num_tx_queues > 1;
3727 int netif_set_real_num_tx_queues(struct net_device *dev, unsigned int txq);
3730 int netif_set_real_num_rx_queues(struct net_device *dev, unsigned int rxq);
3732 static inline int netif_set_real_num_rx_queues(struct net_device *dev,
3735 dev->real_num_rx_queues = rxqs;
3739 int netif_set_real_num_queues(struct net_device *dev,
3740 unsigned int txq, unsigned int rxq);
3742 static inline struct netdev_rx_queue *
3743 __netif_get_rx_queue(struct net_device *dev, unsigned int rxq)
3745 return dev->_rx + rxq;
3749 static inline unsigned int get_netdev_rx_queue_index(
3750 struct netdev_rx_queue *queue)
3752 struct net_device *dev = queue->dev;
3753 int index = queue - dev->_rx;
3755 BUG_ON(index >= dev->num_rx_queues);
3760 int netif_get_num_default_rss_queues(void);
3762 enum skb_free_reason {
3763 SKB_REASON_CONSUMED,
3767 void __dev_kfree_skb_irq(struct sk_buff *skb, enum skb_free_reason reason);
3768 void __dev_kfree_skb_any(struct sk_buff *skb, enum skb_free_reason reason);
3771 * It is not allowed to call kfree_skb() or consume_skb() from hardware
3772 * interrupt context or with hardware interrupts being disabled.
3773 * (in_hardirq() || irqs_disabled())
3775 * We provide four helpers that can be used in following contexts :
3777 * dev_kfree_skb_irq(skb) when caller drops a packet from irq context,
3778 * replacing kfree_skb(skb)
3780 * dev_consume_skb_irq(skb) when caller consumes a packet from irq context.
3781 * Typically used in place of consume_skb(skb) in TX completion path
3783 * dev_kfree_skb_any(skb) when caller doesn't know its current irq context,
3784 * replacing kfree_skb(skb)
3786 * dev_consume_skb_any(skb) when caller doesn't know its current irq context,
3787 * and consumed a packet. Used in place of consume_skb(skb)
3789 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
3791 __dev_kfree_skb_irq(skb, SKB_REASON_DROPPED);
3794 static inline void dev_consume_skb_irq(struct sk_buff *skb)
3796 __dev_kfree_skb_irq(skb, SKB_REASON_CONSUMED);
3799 static inline void dev_kfree_skb_any(struct sk_buff *skb)
3801 __dev_kfree_skb_any(skb, SKB_REASON_DROPPED);
3804 static inline void dev_consume_skb_any(struct sk_buff *skb)
3806 __dev_kfree_skb_any(skb, SKB_REASON_CONSUMED);
3809 u32 bpf_prog_run_generic_xdp(struct sk_buff *skb, struct xdp_buff *xdp,
3810 struct bpf_prog *xdp_prog);
3811 void generic_xdp_tx(struct sk_buff *skb, struct bpf_prog *xdp_prog);
3812 int do_xdp_generic(struct bpf_prog *xdp_prog, struct sk_buff *skb);
3813 int netif_rx(struct sk_buff *skb);
3814 int __netif_rx(struct sk_buff *skb);
3816 int netif_receive_skb(struct sk_buff *skb);
3817 int netif_receive_skb_core(struct sk_buff *skb);
3818 void netif_receive_skb_list_internal(struct list_head *head);
3819 void netif_receive_skb_list(struct list_head *head);
3820 gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
3821 void napi_gro_flush(struct napi_struct *napi, bool flush_old);
3822 struct sk_buff *napi_get_frags(struct napi_struct *napi);
3823 void napi_get_frags_check(struct napi_struct *napi);
3824 gro_result_t napi_gro_frags(struct napi_struct *napi);
3825 struct packet_offload *gro_find_receive_by_type(__be16 type);
3826 struct packet_offload *gro_find_complete_by_type(__be16 type);
3828 static inline void napi_free_frags(struct napi_struct *napi)
3830 kfree_skb(napi->skb);
3834 bool netdev_is_rx_handler_busy(struct net_device *dev);
3835 int netdev_rx_handler_register(struct net_device *dev,
3836 rx_handler_func_t *rx_handler,
3837 void *rx_handler_data);
3838 void netdev_rx_handler_unregister(struct net_device *dev);
3840 bool dev_valid_name(const char *name);
3841 static inline bool is_socket_ioctl_cmd(unsigned int cmd)
3843 return _IOC_TYPE(cmd) == SOCK_IOC_TYPE;
3845 int get_user_ifreq(struct ifreq *ifr, void __user **ifrdata, void __user *arg);
3846 int put_user_ifreq(struct ifreq *ifr, void __user *arg);
3847 int dev_ioctl(struct net *net, unsigned int cmd, struct ifreq *ifr,
3848 void __user *data, bool *need_copyout);
3849 int dev_ifconf(struct net *net, struct ifconf __user *ifc);
3850 int dev_ethtool(struct net *net, struct ifreq *ifr, void __user *userdata);
3851 unsigned int dev_get_flags(const struct net_device *);
3852 int __dev_change_flags(struct net_device *dev, unsigned int flags,
3853 struct netlink_ext_ack *extack);
3854 int dev_change_flags(struct net_device *dev, unsigned int flags,
3855 struct netlink_ext_ack *extack);
3856 void __dev_notify_flags(struct net_device *, unsigned int old_flags,
3857 unsigned int gchanges);
3858 int dev_set_alias(struct net_device *, const char *, size_t);
3859 int dev_get_alias(const struct net_device *, char *, size_t);
3860 int __dev_change_net_namespace(struct net_device *dev, struct net *net,
3861 const char *pat, int new_ifindex);
3863 int dev_change_net_namespace(struct net_device *dev, struct net *net,
3866 return __dev_change_net_namespace(dev, net, pat, 0);
3868 int __dev_set_mtu(struct net_device *, int);
3869 int dev_set_mtu(struct net_device *, int);
3870 int dev_pre_changeaddr_notify(struct net_device *dev, const char *addr,
3871 struct netlink_ext_ack *extack);
3872 int dev_set_mac_address(struct net_device *dev, struct sockaddr *sa,
3873 struct netlink_ext_ack *extack);
3874 int dev_set_mac_address_user(struct net_device *dev, struct sockaddr *sa,
3875 struct netlink_ext_ack *extack);
3876 int dev_get_mac_address(struct sockaddr *sa, struct net *net, char *dev_name);
3877 int dev_get_port_parent_id(struct net_device *dev,
3878 struct netdev_phys_item_id *ppid, bool recurse);
3879 bool netdev_port_same_parent_id(struct net_device *a, struct net_device *b);
3880 struct sk_buff *validate_xmit_skb_list(struct sk_buff *skb, struct net_device *dev, bool *again);
3881 struct sk_buff *dev_hard_start_xmit(struct sk_buff *skb, struct net_device *dev,
3882 struct netdev_queue *txq, int *ret);
3884 int bpf_xdp_link_attach(const union bpf_attr *attr, struct bpf_prog *prog);
3885 u8 dev_xdp_prog_count(struct net_device *dev);
3886 u32 dev_xdp_prog_id(struct net_device *dev, enum bpf_xdp_mode mode);
3888 int __dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
3889 int dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
3890 int dev_forward_skb_nomtu(struct net_device *dev, struct sk_buff *skb);
3891 bool is_skb_forwardable(const struct net_device *dev,
3892 const struct sk_buff *skb);
3894 static __always_inline bool __is_skb_forwardable(const struct net_device *dev,
3895 const struct sk_buff *skb,
3896 const bool check_mtu)
3898 const u32 vlan_hdr_len = 4; /* VLAN_HLEN */
3901 if (!(dev->flags & IFF_UP))
3907 len = dev->mtu + dev->hard_header_len + vlan_hdr_len;
3908 if (skb->len <= len)
3911 /* if TSO is enabled, we don't care about the length as the packet
3912 * could be forwarded without being segmented before
3914 if (skb_is_gso(skb))
3920 struct net_device_core_stats __percpu *netdev_core_stats_alloc(struct net_device *dev);
3922 static inline struct net_device_core_stats __percpu *dev_core_stats(struct net_device *dev)
3924 /* This READ_ONCE() pairs with the write in netdev_core_stats_alloc() */
3925 struct net_device_core_stats __percpu *p = READ_ONCE(dev->core_stats);
3930 return netdev_core_stats_alloc(dev);
3933 #define DEV_CORE_STATS_INC(FIELD) \
3934 static inline void dev_core_stats_##FIELD##_inc(struct net_device *dev) \
3936 struct net_device_core_stats __percpu *p; \
3938 p = dev_core_stats(dev); \
3940 this_cpu_inc(p->FIELD); \
3942 DEV_CORE_STATS_INC(rx_dropped)
3943 DEV_CORE_STATS_INC(tx_dropped)
3944 DEV_CORE_STATS_INC(rx_nohandler)
3945 DEV_CORE_STATS_INC(rx_otherhost_dropped)
3947 static __always_inline int ____dev_forward_skb(struct net_device *dev,
3948 struct sk_buff *skb,
3949 const bool check_mtu)
3951 if (skb_orphan_frags(skb, GFP_ATOMIC) ||
3952 unlikely(!__is_skb_forwardable(dev, skb, check_mtu))) {
3953 dev_core_stats_rx_dropped_inc(dev);
3958 skb_scrub_packet(skb, !net_eq(dev_net(dev), dev_net(skb->dev)));
3963 bool dev_nit_active(struct net_device *dev);
3964 void dev_queue_xmit_nit(struct sk_buff *skb, struct net_device *dev);
3966 static inline void __dev_put(struct net_device *dev)
3969 #ifdef CONFIG_PCPU_DEV_REFCNT
3970 this_cpu_dec(*dev->pcpu_refcnt);
3972 refcount_dec(&dev->dev_refcnt);
3977 static inline void __dev_hold(struct net_device *dev)
3980 #ifdef CONFIG_PCPU_DEV_REFCNT
3981 this_cpu_inc(*dev->pcpu_refcnt);
3983 refcount_inc(&dev->dev_refcnt);
3988 static inline void __netdev_tracker_alloc(struct net_device *dev,
3989 netdevice_tracker *tracker,
3992 #ifdef CONFIG_NET_DEV_REFCNT_TRACKER
3993 ref_tracker_alloc(&dev->refcnt_tracker, tracker, gfp);
3997 /* netdev_tracker_alloc() can upgrade a prior untracked reference
3998 * taken by dev_get_by_name()/dev_get_by_index() to a tracked one.
4000 static inline void netdev_tracker_alloc(struct net_device *dev,
4001 netdevice_tracker *tracker, gfp_t gfp)
4003 #ifdef CONFIG_NET_DEV_REFCNT_TRACKER
4004 refcount_dec(&dev->refcnt_tracker.no_tracker);
4005 __netdev_tracker_alloc(dev, tracker, gfp);
4009 static inline void netdev_tracker_free(struct net_device *dev,
4010 netdevice_tracker *tracker)
4012 #ifdef CONFIG_NET_DEV_REFCNT_TRACKER
4013 ref_tracker_free(&dev->refcnt_tracker, tracker);
4017 static inline void netdev_hold(struct net_device *dev,
4018 netdevice_tracker *tracker, gfp_t gfp)
4022 __netdev_tracker_alloc(dev, tracker, gfp);
4026 static inline void netdev_put(struct net_device *dev,
4027 netdevice_tracker *tracker)
4030 netdev_tracker_free(dev, tracker);
4036 * dev_hold - get reference to device
4037 * @dev: network device
4039 * Hold reference to device to keep it from being freed.
4040 * Try using netdev_hold() instead.
4042 static inline void dev_hold(struct net_device *dev)
4044 netdev_hold(dev, NULL, GFP_ATOMIC);
4048 * dev_put - release reference to device
4049 * @dev: network device
4051 * Release reference to device to allow it to be freed.
4052 * Try using netdev_put() instead.
4054 static inline void dev_put(struct net_device *dev)
4056 netdev_put(dev, NULL);
4059 static inline void netdev_ref_replace(struct net_device *odev,
4060 struct net_device *ndev,
4061 netdevice_tracker *tracker,
4065 netdev_tracker_free(odev, tracker);
4071 __netdev_tracker_alloc(ndev, tracker, gfp);
4074 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
4075 * and _off may be called from IRQ context, but it is caller
4076 * who is responsible for serialization of these calls.
4078 * The name carrier is inappropriate, these functions should really be
4079 * called netif_lowerlayer_*() because they represent the state of any
4080 * kind of lower layer not just hardware media.
4082 void linkwatch_fire_event(struct net_device *dev);
4085 * netif_carrier_ok - test if carrier present
4086 * @dev: network device
4088 * Check if carrier is present on device
4090 static inline bool netif_carrier_ok(const struct net_device *dev)
4092 return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
4095 unsigned long dev_trans_start(struct net_device *dev);
4097 void __netdev_watchdog_up(struct net_device *dev);
4099 void netif_carrier_on(struct net_device *dev);
4100 void netif_carrier_off(struct net_device *dev);
4101 void netif_carrier_event(struct net_device *dev);
4104 * netif_dormant_on - mark device as dormant.
4105 * @dev: network device
4107 * Mark device as dormant (as per RFC2863).
4109 * The dormant state indicates that the relevant interface is not
4110 * actually in a condition to pass packets (i.e., it is not 'up') but is
4111 * in a "pending" state, waiting for some external event. For "on-
4112 * demand" interfaces, this new state identifies the situation where the
4113 * interface is waiting for events to place it in the up state.
4115 static inline void netif_dormant_on(struct net_device *dev)
4117 if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
4118 linkwatch_fire_event(dev);
4122 * netif_dormant_off - set device as not dormant.
4123 * @dev: network device
4125 * Device is not in dormant state.
4127 static inline void netif_dormant_off(struct net_device *dev)
4129 if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
4130 linkwatch_fire_event(dev);
4134 * netif_dormant - test if device is dormant
4135 * @dev: network device
4137 * Check if device is dormant.
4139 static inline bool netif_dormant(const struct net_device *dev)
4141 return test_bit(__LINK_STATE_DORMANT, &dev->state);
4146 * netif_testing_on - mark device as under test.
4147 * @dev: network device
4149 * Mark device as under test (as per RFC2863).
4151 * The testing state indicates that some test(s) must be performed on
4152 * the interface. After completion, of the test, the interface state
4153 * will change to up, dormant, or down, as appropriate.
4155 static inline void netif_testing_on(struct net_device *dev)
4157 if (!test_and_set_bit(__LINK_STATE_TESTING, &dev->state))
4158 linkwatch_fire_event(dev);
4162 * netif_testing_off - set device as not under test.
4163 * @dev: network device
4165 * Device is not in testing state.
4167 static inline void netif_testing_off(struct net_device *dev)
4169 if (test_and_clear_bit(__LINK_STATE_TESTING, &dev->state))
4170 linkwatch_fire_event(dev);
4174 * netif_testing - test if device is under test
4175 * @dev: network device
4177 * Check if device is under test
4179 static inline bool netif_testing(const struct net_device *dev)
4181 return test_bit(__LINK_STATE_TESTING, &dev->state);
4186 * netif_oper_up - test if device is operational
4187 * @dev: network device
4189 * Check if carrier is operational
4191 static inline bool netif_oper_up(const struct net_device *dev)
4193 return (dev->operstate == IF_OPER_UP ||
4194 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
4198 * netif_device_present - is device available or removed
4199 * @dev: network device
4201 * Check if device has not been removed from system.
4203 static inline bool netif_device_present(const struct net_device *dev)
4205 return test_bit(__LINK_STATE_PRESENT, &dev->state);
4208 void netif_device_detach(struct net_device *dev);
4210 void netif_device_attach(struct net_device *dev);
4213 * Network interface message level settings
4218 NETIF_MSG_PROBE_BIT,
4220 NETIF_MSG_TIMER_BIT,
4221 NETIF_MSG_IFDOWN_BIT,
4223 NETIF_MSG_RX_ERR_BIT,
4224 NETIF_MSG_TX_ERR_BIT,
4225 NETIF_MSG_TX_QUEUED_BIT,
4227 NETIF_MSG_TX_DONE_BIT,
4228 NETIF_MSG_RX_STATUS_BIT,
4229 NETIF_MSG_PKTDATA_BIT,
4233 /* When you add a new bit above, update netif_msg_class_names array
4234 * in net/ethtool/common.c
4236 NETIF_MSG_CLASS_COUNT,
4238 /* Both ethtool_ops interface and internal driver implementation use u32 */
4239 static_assert(NETIF_MSG_CLASS_COUNT <= 32);
4241 #define __NETIF_MSG_BIT(bit) ((u32)1 << (bit))
4242 #define __NETIF_MSG(name) __NETIF_MSG_BIT(NETIF_MSG_ ## name ## _BIT)
4244 #define NETIF_MSG_DRV __NETIF_MSG(DRV)
4245 #define NETIF_MSG_PROBE __NETIF_MSG(PROBE)
4246 #define NETIF_MSG_LINK __NETIF_MSG(LINK)
4247 #define NETIF_MSG_TIMER __NETIF_MSG(TIMER)
4248 #define NETIF_MSG_IFDOWN __NETIF_MSG(IFDOWN)
4249 #define NETIF_MSG_IFUP __NETIF_MSG(IFUP)
4250 #define NETIF_MSG_RX_ERR __NETIF_MSG(RX_ERR)
4251 #define NETIF_MSG_TX_ERR __NETIF_MSG(TX_ERR)
4252 #define NETIF_MSG_TX_QUEUED __NETIF_MSG(TX_QUEUED)
4253 #define NETIF_MSG_INTR __NETIF_MSG(INTR)
4254 #define NETIF_MSG_TX_DONE __NETIF_MSG(TX_DONE)
4255 #define NETIF_MSG_RX_STATUS __NETIF_MSG(RX_STATUS)
4256 #define NETIF_MSG_PKTDATA __NETIF_MSG(PKTDATA)
4257 #define NETIF_MSG_HW __NETIF_MSG(HW)
4258 #define NETIF_MSG_WOL __NETIF_MSG(WOL)
4260 #define netif_msg_drv(p) ((p)->msg_enable & NETIF_MSG_DRV)
4261 #define netif_msg_probe(p) ((p)->msg_enable & NETIF_MSG_PROBE)
4262 #define netif_msg_link(p) ((p)->msg_enable & NETIF_MSG_LINK)
4263 #define netif_msg_timer(p) ((p)->msg_enable & NETIF_MSG_TIMER)
4264 #define netif_msg_ifdown(p) ((p)->msg_enable & NETIF_MSG_IFDOWN)
4265 #define netif_msg_ifup(p) ((p)->msg_enable & NETIF_MSG_IFUP)
4266 #define netif_msg_rx_err(p) ((p)->msg_enable & NETIF_MSG_RX_ERR)
4267 #define netif_msg_tx_err(p) ((p)->msg_enable & NETIF_MSG_TX_ERR)
4268 #define netif_msg_tx_queued(p) ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
4269 #define netif_msg_intr(p) ((p)->msg_enable & NETIF_MSG_INTR)
4270 #define netif_msg_tx_done(p) ((p)->msg_enable & NETIF_MSG_TX_DONE)
4271 #define netif_msg_rx_status(p) ((p)->msg_enable & NETIF_MSG_RX_STATUS)
4272 #define netif_msg_pktdata(p) ((p)->msg_enable & NETIF_MSG_PKTDATA)
4273 #define netif_msg_hw(p) ((p)->msg_enable & NETIF_MSG_HW)
4274 #define netif_msg_wol(p) ((p)->msg_enable & NETIF_MSG_WOL)
4276 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
4279 if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
4280 return default_msg_enable_bits;
4281 if (debug_value == 0) /* no output */
4283 /* set low N bits */
4284 return (1U << debug_value) - 1;
4287 static inline void __netif_tx_lock(struct netdev_queue *txq, int cpu)
4289 spin_lock(&txq->_xmit_lock);
4290 /* Pairs with READ_ONCE() in __dev_queue_xmit() */
4291 WRITE_ONCE(txq->xmit_lock_owner, cpu);
4294 static inline bool __netif_tx_acquire(struct netdev_queue *txq)
4296 __acquire(&txq->_xmit_lock);
4300 static inline void __netif_tx_release(struct netdev_queue *txq)
4302 __release(&txq->_xmit_lock);
4305 static inline void __netif_tx_lock_bh(struct netdev_queue *txq)
4307 spin_lock_bh(&txq->_xmit_lock);
4308 /* Pairs with READ_ONCE() in __dev_queue_xmit() */
4309 WRITE_ONCE(txq->xmit_lock_owner, smp_processor_id());
4312 static inline bool __netif_tx_trylock(struct netdev_queue *txq)
4314 bool ok = spin_trylock(&txq->_xmit_lock);
4317 /* Pairs with READ_ONCE() in __dev_queue_xmit() */
4318 WRITE_ONCE(txq->xmit_lock_owner, smp_processor_id());
4323 static inline void __netif_tx_unlock(struct netdev_queue *txq)
4325 /* Pairs with READ_ONCE() in __dev_queue_xmit() */
4326 WRITE_ONCE(txq->xmit_lock_owner, -1);
4327 spin_unlock(&txq->_xmit_lock);
4330 static inline void __netif_tx_unlock_bh(struct netdev_queue *txq)
4332 /* Pairs with READ_ONCE() in __dev_queue_xmit() */
4333 WRITE_ONCE(txq->xmit_lock_owner, -1);
4334 spin_unlock_bh(&txq->_xmit_lock);
4338 * txq->trans_start can be read locklessly from dev_watchdog()
4340 static inline void txq_trans_update(struct netdev_queue *txq)
4342 if (txq->xmit_lock_owner != -1)
4343 WRITE_ONCE(txq->trans_start, jiffies);
4346 static inline void txq_trans_cond_update(struct netdev_queue *txq)
4348 unsigned long now = jiffies;
4350 if (READ_ONCE(txq->trans_start) != now)
4351 WRITE_ONCE(txq->trans_start, now);
4354 /* legacy drivers only, netdev_start_xmit() sets txq->trans_start */
4355 static inline void netif_trans_update(struct net_device *dev)
4357 struct netdev_queue *txq = netdev_get_tx_queue(dev, 0);
4359 txq_trans_cond_update(txq);
4363 * netif_tx_lock - grab network device transmit lock
4364 * @dev: network device
4366 * Get network device transmit lock
4368 void netif_tx_lock(struct net_device *dev);
4370 static inline void netif_tx_lock_bh(struct net_device *dev)
4376 void netif_tx_unlock(struct net_device *dev);
4378 static inline void netif_tx_unlock_bh(struct net_device *dev)
4380 netif_tx_unlock(dev);
4384 #define HARD_TX_LOCK(dev, txq, cpu) { \
4385 if ((dev->features & NETIF_F_LLTX) == 0) { \
4386 __netif_tx_lock(txq, cpu); \
4388 __netif_tx_acquire(txq); \
4392 #define HARD_TX_TRYLOCK(dev, txq) \
4393 (((dev->features & NETIF_F_LLTX) == 0) ? \
4394 __netif_tx_trylock(txq) : \
4395 __netif_tx_acquire(txq))
4397 #define HARD_TX_UNLOCK(dev, txq) { \
4398 if ((dev->features & NETIF_F_LLTX) == 0) { \
4399 __netif_tx_unlock(txq); \
4401 __netif_tx_release(txq); \
4405 static inline void netif_tx_disable(struct net_device *dev)
4411 cpu = smp_processor_id();
4412 spin_lock(&dev->tx_global_lock);
4413 for (i = 0; i < dev->num_tx_queues; i++) {
4414 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
4416 __netif_tx_lock(txq, cpu);
4417 netif_tx_stop_queue(txq);
4418 __netif_tx_unlock(txq);
4420 spin_unlock(&dev->tx_global_lock);
4424 static inline void netif_addr_lock(struct net_device *dev)
4426 unsigned char nest_level = 0;
4428 #ifdef CONFIG_LOCKDEP
4429 nest_level = dev->nested_level;
4431 spin_lock_nested(&dev->addr_list_lock, nest_level);
4434 static inline void netif_addr_lock_bh(struct net_device *dev)
4436 unsigned char nest_level = 0;
4438 #ifdef CONFIG_LOCKDEP
4439 nest_level = dev->nested_level;
4442 spin_lock_nested(&dev->addr_list_lock, nest_level);
4445 static inline void netif_addr_unlock(struct net_device *dev)
4447 spin_unlock(&dev->addr_list_lock);
4450 static inline void netif_addr_unlock_bh(struct net_device *dev)
4452 spin_unlock_bh(&dev->addr_list_lock);
4456 * dev_addrs walker. Should be used only for read access. Call with
4457 * rcu_read_lock held.
4459 #define for_each_dev_addr(dev, ha) \
4460 list_for_each_entry_rcu(ha, &dev->dev_addrs.list, list)
4462 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
4464 void ether_setup(struct net_device *dev);
4466 /* Support for loadable net-drivers */
4467 struct net_device *alloc_netdev_mqs(int sizeof_priv, const char *name,
4468 unsigned char name_assign_type,
4469 void (*setup)(struct net_device *),
4470 unsigned int txqs, unsigned int rxqs);
4471 #define alloc_netdev(sizeof_priv, name, name_assign_type, setup) \
4472 alloc_netdev_mqs(sizeof_priv, name, name_assign_type, setup, 1, 1)
4474 #define alloc_netdev_mq(sizeof_priv, name, name_assign_type, setup, count) \
4475 alloc_netdev_mqs(sizeof_priv, name, name_assign_type, setup, count, \
4478 int register_netdev(struct net_device *dev);
4479 void unregister_netdev(struct net_device *dev);
4481 int devm_register_netdev(struct device *dev, struct net_device *ndev);
4483 /* General hardware address lists handling functions */
4484 int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
4485 struct netdev_hw_addr_list *from_list, int addr_len);
4486 void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
4487 struct netdev_hw_addr_list *from_list, int addr_len);
4488 int __hw_addr_sync_dev(struct netdev_hw_addr_list *list,
4489 struct net_device *dev,
4490 int (*sync)(struct net_device *, const unsigned char *),
4491 int (*unsync)(struct net_device *,
4492 const unsigned char *));
4493 int __hw_addr_ref_sync_dev(struct netdev_hw_addr_list *list,
4494 struct net_device *dev,
4495 int (*sync)(struct net_device *,
4496 const unsigned char *, int),
4497 int (*unsync)(struct net_device *,
4498 const unsigned char *, int));
4499 void __hw_addr_ref_unsync_dev(struct netdev_hw_addr_list *list,
4500 struct net_device *dev,
4501 int (*unsync)(struct net_device *,
4502 const unsigned char *, int));
4503 void __hw_addr_unsync_dev(struct netdev_hw_addr_list *list,
4504 struct net_device *dev,
4505 int (*unsync)(struct net_device *,
4506 const unsigned char *));
4507 void __hw_addr_init(struct netdev_hw_addr_list *list);
4509 /* Functions used for device addresses handling */
4510 void dev_addr_mod(struct net_device *dev, unsigned int offset,
4511 const void *addr, size_t len);
4514 __dev_addr_set(struct net_device *dev, const void *addr, size_t len)
4516 dev_addr_mod(dev, 0, addr, len);
4519 static inline void dev_addr_set(struct net_device *dev, const u8 *addr)
4521 __dev_addr_set(dev, addr, dev->addr_len);
4524 int dev_addr_add(struct net_device *dev, const unsigned char *addr,
4525 unsigned char addr_type);
4526 int dev_addr_del(struct net_device *dev, const unsigned char *addr,
4527 unsigned char addr_type);
4529 /* Functions used for unicast addresses handling */
4530 int dev_uc_add(struct net_device *dev, const unsigned char *addr);
4531 int dev_uc_add_excl(struct net_device *dev, const unsigned char *addr);
4532 int dev_uc_del(struct net_device *dev, const unsigned char *addr);
4533 int dev_uc_sync(struct net_device *to, struct net_device *from);
4534 int dev_uc_sync_multiple(struct net_device *to, struct net_device *from);
4535 void dev_uc_unsync(struct net_device *to, struct net_device *from);
4536 void dev_uc_flush(struct net_device *dev);
4537 void dev_uc_init(struct net_device *dev);
4540 * __dev_uc_sync - Synchonize device's unicast list
4541 * @dev: device to sync
4542 * @sync: function to call if address should be added
4543 * @unsync: function to call if address should be removed
4545 * Add newly added addresses to the interface, and release
4546 * addresses that have been deleted.
4548 static inline int __dev_uc_sync(struct net_device *dev,
4549 int (*sync)(struct net_device *,
4550 const unsigned char *),
4551 int (*unsync)(struct net_device *,
4552 const unsigned char *))
4554 return __hw_addr_sync_dev(&dev->uc, dev, sync, unsync);
4558 * __dev_uc_unsync - Remove synchronized addresses from device
4559 * @dev: device to sync
4560 * @unsync: function to call if address should be removed
4562 * Remove all addresses that were added to the device by dev_uc_sync().
4564 static inline void __dev_uc_unsync(struct net_device *dev,
4565 int (*unsync)(struct net_device *,
4566 const unsigned char *))
4568 __hw_addr_unsync_dev(&dev->uc, dev, unsync);
4571 /* Functions used for multicast addresses handling */
4572 int dev_mc_add(struct net_device *dev, const unsigned char *addr);
4573 int dev_mc_add_global(struct net_device *dev, const unsigned char *addr);
4574 int dev_mc_add_excl(struct net_device *dev, const unsigned char *addr);
4575 int dev_mc_del(struct net_device *dev, const unsigned char *addr);
4576 int dev_mc_del_global(struct net_device *dev, const unsigned char *addr);
4577 int dev_mc_sync(struct net_device *to, struct net_device *from);
4578 int dev_mc_sync_multiple(struct net_device *to, struct net_device *from);
4579 void dev_mc_unsync(struct net_device *to, struct net_device *from);
4580 void dev_mc_flush(struct net_device *dev);
4581 void dev_mc_init(struct net_device *dev);
4584 * __dev_mc_sync - Synchonize device's multicast list
4585 * @dev: device to sync
4586 * @sync: function to call if address should be added
4587 * @unsync: function to call if address should be removed
4589 * Add newly added addresses to the interface, and release
4590 * addresses that have been deleted.
4592 static inline int __dev_mc_sync(struct net_device *dev,
4593 int (*sync)(struct net_device *,
4594 const unsigned char *),
4595 int (*unsync)(struct net_device *,
4596 const unsigned char *))
4598 return __hw_addr_sync_dev(&dev->mc, dev, sync, unsync);
4602 * __dev_mc_unsync - Remove synchronized addresses from device
4603 * @dev: device to sync
4604 * @unsync: function to call if address should be removed
4606 * Remove all addresses that were added to the device by dev_mc_sync().
4608 static inline void __dev_mc_unsync(struct net_device *dev,
4609 int (*unsync)(struct net_device *,
4610 const unsigned char *))
4612 __hw_addr_unsync_dev(&dev->mc, dev, unsync);
4615 /* Functions used for secondary unicast and multicast support */
4616 void dev_set_rx_mode(struct net_device *dev);
4617 int dev_set_promiscuity(struct net_device *dev, int inc);
4618 int dev_set_allmulti(struct net_device *dev, int inc);
4619 void netdev_state_change(struct net_device *dev);
4620 void __netdev_notify_peers(struct net_device *dev);
4621 void netdev_notify_peers(struct net_device *dev);
4622 void netdev_features_change(struct net_device *dev);
4623 /* Load a device via the kmod */
4624 void dev_load(struct net *net, const char *name);
4625 struct rtnl_link_stats64 *dev_get_stats(struct net_device *dev,
4626 struct rtnl_link_stats64 *storage);
4627 void netdev_stats_to_stats64(struct rtnl_link_stats64 *stats64,
4628 const struct net_device_stats *netdev_stats);
4629 void dev_fetch_sw_netstats(struct rtnl_link_stats64 *s,
4630 const struct pcpu_sw_netstats __percpu *netstats);
4631 void dev_get_tstats64(struct net_device *dev, struct rtnl_link_stats64 *s);
4633 extern int netdev_max_backlog;
4634 extern int dev_rx_weight;
4635 extern int dev_tx_weight;
4636 extern int gro_normal_batch;
4639 NESTED_SYNC_IMM_BIT,
4640 NESTED_SYNC_TODO_BIT,
4643 #define __NESTED_SYNC_BIT(bit) ((u32)1 << (bit))
4644 #define __NESTED_SYNC(name) __NESTED_SYNC_BIT(NESTED_SYNC_ ## name ## _BIT)
4646 #define NESTED_SYNC_IMM __NESTED_SYNC(IMM)
4647 #define NESTED_SYNC_TODO __NESTED_SYNC(TODO)
4649 struct netdev_nested_priv {
4650 unsigned char flags;
4654 bool netdev_has_upper_dev(struct net_device *dev, struct net_device *upper_dev);
4655 struct net_device *netdev_upper_get_next_dev_rcu(struct net_device *dev,
4656 struct list_head **iter);
4658 /* iterate through upper list, must be called under RCU read lock */
4659 #define netdev_for_each_upper_dev_rcu(dev, updev, iter) \
4660 for (iter = &(dev)->adj_list.upper, \
4661 updev = netdev_upper_get_next_dev_rcu(dev, &(iter)); \
4663 updev = netdev_upper_get_next_dev_rcu(dev, &(iter)))
4665 int netdev_walk_all_upper_dev_rcu(struct net_device *dev,
4666 int (*fn)(struct net_device *upper_dev,
4667 struct netdev_nested_priv *priv),
4668 struct netdev_nested_priv *priv);
4670 bool netdev_has_upper_dev_all_rcu(struct net_device *dev,
4671 struct net_device *upper_dev);
4673 bool netdev_has_any_upper_dev(struct net_device *dev);
4675 void *netdev_lower_get_next_private(struct net_device *dev,
4676 struct list_head **iter);
4677 void *netdev_lower_get_next_private_rcu(struct net_device *dev,
4678 struct list_head **iter);
4680 #define netdev_for_each_lower_private(dev, priv, iter) \
4681 for (iter = (dev)->adj_list.lower.next, \
4682 priv = netdev_lower_get_next_private(dev, &(iter)); \
4684 priv = netdev_lower_get_next_private(dev, &(iter)))
4686 #define netdev_for_each_lower_private_rcu(dev, priv, iter) \
4687 for (iter = &(dev)->adj_list.lower, \
4688 priv = netdev_lower_get_next_private_rcu(dev, &(iter)); \
4690 priv = netdev_lower_get_next_private_rcu(dev, &(iter)))
4692 void *netdev_lower_get_next(struct net_device *dev,
4693 struct list_head **iter);
4695 #define netdev_for_each_lower_dev(dev, ldev, iter) \
4696 for (iter = (dev)->adj_list.lower.next, \
4697 ldev = netdev_lower_get_next(dev, &(iter)); \
4699 ldev = netdev_lower_get_next(dev, &(iter)))
4701 struct net_device *netdev_next_lower_dev_rcu(struct net_device *dev,
4702 struct list_head **iter);
4703 int netdev_walk_all_lower_dev(struct net_device *dev,
4704 int (*fn)(struct net_device *lower_dev,
4705 struct netdev_nested_priv *priv),
4706 struct netdev_nested_priv *priv);
4707 int netdev_walk_all_lower_dev_rcu(struct net_device *dev,
4708 int (*fn)(struct net_device *lower_dev,
4709 struct netdev_nested_priv *priv),
4710 struct netdev_nested_priv *priv);
4712 void *netdev_adjacent_get_private(struct list_head *adj_list);
4713 void *netdev_lower_get_first_private_rcu(struct net_device *dev);
4714 struct net_device *netdev_master_upper_dev_get(struct net_device *dev);
4715 struct net_device *netdev_master_upper_dev_get_rcu(struct net_device *dev);
4716 int netdev_upper_dev_link(struct net_device *dev, struct net_device *upper_dev,
4717 struct netlink_ext_ack *extack);
4718 int netdev_master_upper_dev_link(struct net_device *dev,
4719 struct net_device *upper_dev,
4720 void *upper_priv, void *upper_info,
4721 struct netlink_ext_ack *extack);
4722 void netdev_upper_dev_unlink(struct net_device *dev,
4723 struct net_device *upper_dev);
4724 int netdev_adjacent_change_prepare(struct net_device *old_dev,
4725 struct net_device *new_dev,
4726 struct net_device *dev,
4727 struct netlink_ext_ack *extack);
4728 void netdev_adjacent_change_commit(struct net_device *old_dev,
4729 struct net_device *new_dev,
4730 struct net_device *dev);
4731 void netdev_adjacent_change_abort(struct net_device *old_dev,
4732 struct net_device *new_dev,
4733 struct net_device *dev);
4734 void netdev_adjacent_rename_links(struct net_device *dev, char *oldname);
4735 void *netdev_lower_dev_get_private(struct net_device *dev,
4736 struct net_device *lower_dev);
4737 void netdev_lower_state_changed(struct net_device *lower_dev,
4738 void *lower_state_info);
4740 /* RSS keys are 40 or 52 bytes long */
4741 #define NETDEV_RSS_KEY_LEN 52
4742 extern u8 netdev_rss_key[NETDEV_RSS_KEY_LEN] __read_mostly;
4743 void netdev_rss_key_fill(void *buffer, size_t len);
4745 int skb_checksum_help(struct sk_buff *skb);
4746 int skb_crc32c_csum_help(struct sk_buff *skb);
4747 int skb_csum_hwoffload_help(struct sk_buff *skb,
4748 const netdev_features_t features);
4750 struct sk_buff *__skb_gso_segment(struct sk_buff *skb,
4751 netdev_features_t features, bool tx_path);
4752 struct sk_buff *skb_eth_gso_segment(struct sk_buff *skb,
4753 netdev_features_t features, __be16 type);
4754 struct sk_buff *skb_mac_gso_segment(struct sk_buff *skb,
4755 netdev_features_t features);
4757 struct netdev_bonding_info {
4762 struct netdev_notifier_bonding_info {
4763 struct netdev_notifier_info info; /* must be first */
4764 struct netdev_bonding_info bonding_info;
4767 void netdev_bonding_info_change(struct net_device *dev,
4768 struct netdev_bonding_info *bonding_info);
4770 #if IS_ENABLED(CONFIG_ETHTOOL_NETLINK)
4771 void ethtool_notify(struct net_device *dev, unsigned int cmd, const void *data);
4773 static inline void ethtool_notify(struct net_device *dev, unsigned int cmd,
4780 struct sk_buff *skb_gso_segment(struct sk_buff *skb, netdev_features_t features)
4782 return __skb_gso_segment(skb, features, true);
4784 __be16 skb_network_protocol(struct sk_buff *skb, int *depth);
4786 static inline bool can_checksum_protocol(netdev_features_t features,
4789 if (protocol == htons(ETH_P_FCOE))
4790 return !!(features & NETIF_F_FCOE_CRC);
4792 /* Assume this is an IP checksum (not SCTP CRC) */
4794 if (features & NETIF_F_HW_CSUM) {
4795 /* Can checksum everything */
4800 case htons(ETH_P_IP):
4801 return !!(features & NETIF_F_IP_CSUM);
4802 case htons(ETH_P_IPV6):
4803 return !!(features & NETIF_F_IPV6_CSUM);
4810 void netdev_rx_csum_fault(struct net_device *dev, struct sk_buff *skb);
4812 static inline void netdev_rx_csum_fault(struct net_device *dev,
4813 struct sk_buff *skb)
4817 /* rx skb timestamps */
4818 void net_enable_timestamp(void);
4819 void net_disable_timestamp(void);
4821 static inline ktime_t netdev_get_tstamp(struct net_device *dev,
4822 const struct skb_shared_hwtstamps *hwtstamps,
4825 const struct net_device_ops *ops = dev->netdev_ops;
4827 if (ops->ndo_get_tstamp)
4828 return ops->ndo_get_tstamp(dev, hwtstamps, cycles);
4830 return hwtstamps->hwtstamp;
4833 static inline netdev_tx_t __netdev_start_xmit(const struct net_device_ops *ops,
4834 struct sk_buff *skb, struct net_device *dev,
4837 __this_cpu_write(softnet_data.xmit.more, more);
4838 return ops->ndo_start_xmit(skb, dev);
4841 static inline bool netdev_xmit_more(void)
4843 return __this_cpu_read(softnet_data.xmit.more);
4846 static inline netdev_tx_t netdev_start_xmit(struct sk_buff *skb, struct net_device *dev,
4847 struct netdev_queue *txq, bool more)
4849 const struct net_device_ops *ops = dev->netdev_ops;
4852 rc = __netdev_start_xmit(ops, skb, dev, more);
4853 if (rc == NETDEV_TX_OK)
4854 txq_trans_update(txq);
4859 int netdev_class_create_file_ns(const struct class_attribute *class_attr,
4861 void netdev_class_remove_file_ns(const struct class_attribute *class_attr,
4864 extern const struct kobj_ns_type_operations net_ns_type_operations;
4866 const char *netdev_drivername(const struct net_device *dev);
4868 static inline netdev_features_t netdev_intersect_features(netdev_features_t f1,
4869 netdev_features_t f2)
4871 if ((f1 ^ f2) & NETIF_F_HW_CSUM) {
4872 if (f1 & NETIF_F_HW_CSUM)
4873 f1 |= (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM);
4875 f2 |= (NETIF_F_IP_CSUM|NETIF_F_IPV6_CSUM);
4881 static inline netdev_features_t netdev_get_wanted_features(
4882 struct net_device *dev)
4884 return (dev->features & ~dev->hw_features) | dev->wanted_features;
4886 netdev_features_t netdev_increment_features(netdev_features_t all,
4887 netdev_features_t one, netdev_features_t mask);
4889 /* Allow TSO being used on stacked device :
4890 * Performing the GSO segmentation before last device
4891 * is a performance improvement.
4893 static inline netdev_features_t netdev_add_tso_features(netdev_features_t features,
4894 netdev_features_t mask)
4896 return netdev_increment_features(features, NETIF_F_ALL_TSO, mask);
4899 int __netdev_update_features(struct net_device *dev);
4900 void netdev_update_features(struct net_device *dev);
4901 void netdev_change_features(struct net_device *dev);
4903 void netif_stacked_transfer_operstate(const struct net_device *rootdev,
4904 struct net_device *dev);
4906 netdev_features_t passthru_features_check(struct sk_buff *skb,
4907 struct net_device *dev,
4908 netdev_features_t features);
4909 netdev_features_t netif_skb_features(struct sk_buff *skb);
4911 static inline bool net_gso_ok(netdev_features_t features, int gso_type)
4913 netdev_features_t feature = (netdev_features_t)gso_type << NETIF_F_GSO_SHIFT;
4915 /* check flags correspondence */
4916 BUILD_BUG_ON(SKB_GSO_TCPV4 != (NETIF_F_TSO >> NETIF_F_GSO_SHIFT));
4917 BUILD_BUG_ON(SKB_GSO_DODGY != (NETIF_F_GSO_ROBUST >> NETIF_F_GSO_SHIFT));
4918 BUILD_BUG_ON(SKB_GSO_TCP_ECN != (NETIF_F_TSO_ECN >> NETIF_F_GSO_SHIFT));
4919 BUILD_BUG_ON(SKB_GSO_TCP_FIXEDID != (NETIF_F_TSO_MANGLEID >> NETIF_F_GSO_SHIFT));
4920 BUILD_BUG_ON(SKB_GSO_TCPV6 != (NETIF_F_TSO6 >> NETIF_F_GSO_SHIFT));
4921 BUILD_BUG_ON(SKB_GSO_FCOE != (NETIF_F_FSO >> NETIF_F_GSO_SHIFT));
4922 BUILD_BUG_ON(SKB_GSO_GRE != (NETIF_F_GSO_GRE >> NETIF_F_GSO_SHIFT));
4923 BUILD_BUG_ON(SKB_GSO_GRE_CSUM != (NETIF_F_GSO_GRE_CSUM >> NETIF_F_GSO_SHIFT));
4924 BUILD_BUG_ON(SKB_GSO_IPXIP4 != (NETIF_F_GSO_IPXIP4 >> NETIF_F_GSO_SHIFT));
4925 BUILD_BUG_ON(SKB_GSO_IPXIP6 != (NETIF_F_GSO_IPXIP6 >> NETIF_F_GSO_SHIFT));
4926 BUILD_BUG_ON(SKB_GSO_UDP_TUNNEL != (NETIF_F_GSO_UDP_TUNNEL >> NETIF_F_GSO_SHIFT));
4927 BUILD_BUG_ON(SKB_GSO_UDP_TUNNEL_CSUM != (NETIF_F_GSO_UDP_TUNNEL_CSUM >> NETIF_F_GSO_SHIFT));
4928 BUILD_BUG_ON(SKB_GSO_PARTIAL != (NETIF_F_GSO_PARTIAL >> NETIF_F_GSO_SHIFT));
4929 BUILD_BUG_ON(SKB_GSO_TUNNEL_REMCSUM != (NETIF_F_GSO_TUNNEL_REMCSUM >> NETIF_F_GSO_SHIFT));
4930 BUILD_BUG_ON(SKB_GSO_SCTP != (NETIF_F_GSO_SCTP >> NETIF_F_GSO_SHIFT));
4931 BUILD_BUG_ON(SKB_GSO_ESP != (NETIF_F_GSO_ESP >> NETIF_F_GSO_SHIFT));
4932 BUILD_BUG_ON(SKB_GSO_UDP != (NETIF_F_GSO_UDP >> NETIF_F_GSO_SHIFT));
4933 BUILD_BUG_ON(SKB_GSO_UDP_L4 != (NETIF_F_GSO_UDP_L4 >> NETIF_F_GSO_SHIFT));
4934 BUILD_BUG_ON(SKB_GSO_FRAGLIST != (NETIF_F_GSO_FRAGLIST >> NETIF_F_GSO_SHIFT));
4936 return (features & feature) == feature;
4939 static inline bool skb_gso_ok(struct sk_buff *skb, netdev_features_t features)
4941 return net_gso_ok(features, skb_shinfo(skb)->gso_type) &&
4942 (!skb_has_frag_list(skb) || (features & NETIF_F_FRAGLIST));
4945 static inline bool netif_needs_gso(struct sk_buff *skb,
4946 netdev_features_t features)
4948 return skb_is_gso(skb) && (!skb_gso_ok(skb, features) ||
4949 unlikely((skb->ip_summed != CHECKSUM_PARTIAL) &&
4950 (skb->ip_summed != CHECKSUM_UNNECESSARY)));
4953 void netif_set_tso_max_size(struct net_device *dev, unsigned int size);
4954 void netif_set_tso_max_segs(struct net_device *dev, unsigned int segs);
4955 void netif_inherit_tso_max(struct net_device *to,
4956 const struct net_device *from);
4958 static inline void skb_gso_error_unwind(struct sk_buff *skb, __be16 protocol,
4959 int pulled_hlen, u16 mac_offset,
4962 skb->protocol = protocol;
4963 skb->encapsulation = 1;
4964 skb_push(skb, pulled_hlen);
4965 skb_reset_transport_header(skb);
4966 skb->mac_header = mac_offset;
4967 skb->network_header = skb->mac_header + mac_len;
4968 skb->mac_len = mac_len;
4971 static inline bool netif_is_macsec(const struct net_device *dev)
4973 return dev->priv_flags & IFF_MACSEC;
4976 static inline bool netif_is_macvlan(const struct net_device *dev)
4978 return dev->priv_flags & IFF_MACVLAN;
4981 static inline bool netif_is_macvlan_port(const struct net_device *dev)
4983 return dev->priv_flags & IFF_MACVLAN_PORT;
4986 static inline bool netif_is_bond_master(const struct net_device *dev)
4988 return dev->flags & IFF_MASTER && dev->priv_flags & IFF_BONDING;
4991 static inline bool netif_is_bond_slave(const struct net_device *dev)
4993 return dev->flags & IFF_SLAVE && dev->priv_flags & IFF_BONDING;
4996 static inline bool netif_supports_nofcs(struct net_device *dev)
4998 return dev->priv_flags & IFF_SUPP_NOFCS;
5001 static inline bool netif_has_l3_rx_handler(const struct net_device *dev)
5003 return dev->priv_flags & IFF_L3MDEV_RX_HANDLER;
5006 static inline bool netif_is_l3_master(const struct net_device *dev)
5008 return dev->priv_flags & IFF_L3MDEV_MASTER;
5011 static inline bool netif_is_l3_slave(const struct net_device *dev)
5013 return dev->priv_flags & IFF_L3MDEV_SLAVE;
5016 static inline bool netif_is_bridge_master(const struct net_device *dev)
5018 return dev->priv_flags & IFF_EBRIDGE;
5021 static inline bool netif_is_bridge_port(const struct net_device *dev)
5023 return dev->priv_flags & IFF_BRIDGE_PORT;
5026 static inline bool netif_is_ovs_master(const struct net_device *dev)
5028 return dev->priv_flags & IFF_OPENVSWITCH;
5031 static inline bool netif_is_ovs_port(const struct net_device *dev)
5033 return dev->priv_flags & IFF_OVS_DATAPATH;
5036 static inline bool netif_is_any_bridge_port(const struct net_device *dev)
5038 return netif_is_bridge_port(dev) || netif_is_ovs_port(dev);
5041 static inline bool netif_is_team_master(const struct net_device *dev)
5043 return dev->priv_flags & IFF_TEAM;
5046 static inline bool netif_is_team_port(const struct net_device *dev)
5048 return dev->priv_flags & IFF_TEAM_PORT;
5051 static inline bool netif_is_lag_master(const struct net_device *dev)
5053 return netif_is_bond_master(dev) || netif_is_team_master(dev);
5056 static inline bool netif_is_lag_port(const struct net_device *dev)
5058 return netif_is_bond_slave(dev) || netif_is_team_port(dev);
5061 static inline bool netif_is_rxfh_configured(const struct net_device *dev)
5063 return dev->priv_flags & IFF_RXFH_CONFIGURED;
5066 static inline bool netif_is_failover(const struct net_device *dev)
5068 return dev->priv_flags & IFF_FAILOVER;
5071 static inline bool netif_is_failover_slave(const struct net_device *dev)
5073 return dev->priv_flags & IFF_FAILOVER_SLAVE;
5076 /* This device needs to keep skb dst for qdisc enqueue or ndo_start_xmit() */
5077 static inline void netif_keep_dst(struct net_device *dev)
5079 dev->priv_flags &= ~(IFF_XMIT_DST_RELEASE | IFF_XMIT_DST_RELEASE_PERM);
5082 /* return true if dev can't cope with mtu frames that need vlan tag insertion */
5083 static inline bool netif_reduces_vlan_mtu(struct net_device *dev)
5085 /* TODO: reserve and use an additional IFF bit, if we get more users */
5086 return netif_is_macsec(dev);
5089 extern struct pernet_operations __net_initdata loopback_net_ops;
5091 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5093 /* netdev_printk helpers, similar to dev_printk */
5095 static inline const char *netdev_name(const struct net_device *dev)
5097 if (!dev->name[0] || strchr(dev->name, '%'))
5098 return "(unnamed net_device)";
5102 static inline bool netdev_unregistering(const struct net_device *dev)
5104 return dev->reg_state == NETREG_UNREGISTERING;
5107 static inline const char *netdev_reg_state(const struct net_device *dev)
5109 switch (dev->reg_state) {
5110 case NETREG_UNINITIALIZED: return " (uninitialized)";
5111 case NETREG_REGISTERED: return "";
5112 case NETREG_UNREGISTERING: return " (unregistering)";
5113 case NETREG_UNREGISTERED: return " (unregistered)";
5114 case NETREG_RELEASED: return " (released)";
5115 case NETREG_DUMMY: return " (dummy)";
5118 WARN_ONCE(1, "%s: unknown reg_state %d\n", dev->name, dev->reg_state);
5119 return " (unknown)";
5122 #define MODULE_ALIAS_NETDEV(device) \
5123 MODULE_ALIAS("netdev-" device)
5126 * netdev_WARN() acts like dev_printk(), but with the key difference
5127 * of using a WARN/WARN_ON to get the message out, including the
5128 * file/line information and a backtrace.
5130 #define netdev_WARN(dev, format, args...) \
5131 WARN(1, "netdevice: %s%s: " format, netdev_name(dev), \
5132 netdev_reg_state(dev), ##args)
5134 #define netdev_WARN_ONCE(dev, format, args...) \
5135 WARN_ONCE(1, "netdevice: %s%s: " format, netdev_name(dev), \
5136 netdev_reg_state(dev), ##args)
5139 * The list of packet types we will receive (as opposed to discard)
5140 * and the routines to invoke.
5142 * Why 16. Because with 16 the only overlap we get on a hash of the
5143 * low nibble of the protocol value is RARP/SNAP/X.25.
5157 #define PTYPE_HASH_SIZE (16)
5158 #define PTYPE_HASH_MASK (PTYPE_HASH_SIZE - 1)
5160 extern struct list_head ptype_all __read_mostly;
5161 extern struct list_head ptype_base[PTYPE_HASH_SIZE] __read_mostly;
5163 extern struct net_device *blackhole_netdev;
5165 #endif /* _LINUX_NETDEVICE_H */