2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
6 * Definitions for the Interfaces handler.
8 * Version: @(#)dev.h 1.0.10 08/12/93
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Corey Minyard <wf-rch!minyard@relay.EU.net>
13 * Donald J. Becker, <becker@cesdis.gsfc.nasa.gov>
14 * Alan Cox, <alan@lxorguk.ukuu.org.uk>
15 * Bjorn Ekwall. <bj0rn@blox.se>
16 * Pekka Riikonen <priikone@poseidon.pspt.fi>
18 * This program is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU General Public License
20 * as published by the Free Software Foundation; either version
21 * 2 of the License, or (at your option) any later version.
23 * Moved to /usr/include/linux for NET3
25 #ifndef _LINUX_NETDEVICE_H
26 #define _LINUX_NETDEVICE_H
28 #include <linux/timer.h>
29 #include <linux/bug.h>
30 #include <linux/delay.h>
31 #include <linux/atomic.h>
32 #include <linux/prefetch.h>
33 #include <asm/cache.h>
34 #include <asm/byteorder.h>
36 #include <linux/percpu.h>
37 #include <linux/rculist.h>
38 #include <linux/dmaengine.h>
39 #include <linux/workqueue.h>
40 #include <linux/dynamic_queue_limits.h>
42 #include <linux/ethtool.h>
43 #include <net/net_namespace.h>
46 #include <net/dcbnl.h>
48 #include <net/netprio_cgroup.h>
50 #include <linux/netdev_features.h>
51 #include <linux/neighbour.h>
52 #include <uapi/linux/netdevice.h>
53 #include <uapi/linux/if_bonding.h>
60 /* 802.15.4 specific */
64 void netdev_set_default_ethtool_ops(struct net_device *dev,
65 const struct ethtool_ops *ops);
67 /* Backlog congestion levels */
68 #define NET_RX_SUCCESS 0 /* keep 'em coming, baby */
69 #define NET_RX_DROP 1 /* packet dropped */
72 * Transmit return codes: transmit return codes originate from three different
75 * - qdisc return codes
76 * - driver transmit return codes
79 * Drivers are allowed to return any one of those in their hard_start_xmit()
80 * function. Real network devices commonly used with qdiscs should only return
81 * the driver transmit return codes though - when qdiscs are used, the actual
82 * transmission happens asynchronously, so the value is not propagated to
83 * higher layers. Virtual network devices transmit synchronously, in this case
84 * the driver transmit return codes are consumed by dev_queue_xmit(), all
85 * others are propagated to higher layers.
88 /* qdisc ->enqueue() return codes. */
89 #define NET_XMIT_SUCCESS 0x00
90 #define NET_XMIT_DROP 0x01 /* skb dropped */
91 #define NET_XMIT_CN 0x02 /* congestion notification */
92 #define NET_XMIT_POLICED 0x03 /* skb is shot by police */
93 #define NET_XMIT_MASK 0x0f /* qdisc flags in net/sch_generic.h */
95 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
96 * indicates that the device will soon be dropping packets, or already drops
97 * some packets of the same priority; prompting us to send less aggressively. */
98 #define net_xmit_eval(e) ((e) == NET_XMIT_CN ? 0 : (e))
99 #define net_xmit_errno(e) ((e) != NET_XMIT_CN ? -ENOBUFS : 0)
101 /* Driver transmit return codes */
102 #define NETDEV_TX_MASK 0xf0
105 __NETDEV_TX_MIN = INT_MIN, /* make sure enum is signed */
106 NETDEV_TX_OK = 0x00, /* driver took care of packet */
107 NETDEV_TX_BUSY = 0x10, /* driver tx path was busy*/
108 NETDEV_TX_LOCKED = 0x20, /* driver tx lock was already taken */
110 typedef enum netdev_tx netdev_tx_t;
113 * Current order: NETDEV_TX_MASK > NET_XMIT_MASK >= 0 is significant;
114 * hard_start_xmit() return < NET_XMIT_MASK means skb was consumed.
116 static inline bool dev_xmit_complete(int rc)
119 * Positive cases with an skb consumed by a driver:
120 * - successful transmission (rc == NETDEV_TX_OK)
121 * - error while transmitting (rc < 0)
122 * - error while queueing to a different device (rc & NET_XMIT_MASK)
124 if (likely(rc < NET_XMIT_MASK))
131 * Compute the worst case header length according to the protocols
135 #if defined(CONFIG_WLAN) || IS_ENABLED(CONFIG_AX25)
136 # if defined(CONFIG_MAC80211_MESH)
137 # define LL_MAX_HEADER 128
139 # define LL_MAX_HEADER 96
142 # define LL_MAX_HEADER 32
145 #if !IS_ENABLED(CONFIG_NET_IPIP) && !IS_ENABLED(CONFIG_NET_IPGRE) && \
146 !IS_ENABLED(CONFIG_IPV6_SIT) && !IS_ENABLED(CONFIG_IPV6_TUNNEL)
147 #define MAX_HEADER LL_MAX_HEADER
149 #define MAX_HEADER (LL_MAX_HEADER + 48)
153 * Old network device statistics. Fields are native words
154 * (unsigned long) so they can be read and written atomically.
157 struct net_device_stats {
158 unsigned long rx_packets;
159 unsigned long tx_packets;
160 unsigned long rx_bytes;
161 unsigned long tx_bytes;
162 unsigned long rx_errors;
163 unsigned long tx_errors;
164 unsigned long rx_dropped;
165 unsigned long tx_dropped;
166 unsigned long multicast;
167 unsigned long collisions;
168 unsigned long rx_length_errors;
169 unsigned long rx_over_errors;
170 unsigned long rx_crc_errors;
171 unsigned long rx_frame_errors;
172 unsigned long rx_fifo_errors;
173 unsigned long rx_missed_errors;
174 unsigned long tx_aborted_errors;
175 unsigned long tx_carrier_errors;
176 unsigned long tx_fifo_errors;
177 unsigned long tx_heartbeat_errors;
178 unsigned long tx_window_errors;
179 unsigned long rx_compressed;
180 unsigned long tx_compressed;
184 #include <linux/cache.h>
185 #include <linux/skbuff.h>
188 #include <linux/static_key.h>
189 extern struct static_key rps_needed;
196 struct netdev_hw_addr {
197 struct list_head list;
198 unsigned char addr[MAX_ADDR_LEN];
200 #define NETDEV_HW_ADDR_T_LAN 1
201 #define NETDEV_HW_ADDR_T_SAN 2
202 #define NETDEV_HW_ADDR_T_SLAVE 3
203 #define NETDEV_HW_ADDR_T_UNICAST 4
204 #define NETDEV_HW_ADDR_T_MULTICAST 5
209 struct rcu_head rcu_head;
212 struct netdev_hw_addr_list {
213 struct list_head list;
217 #define netdev_hw_addr_list_count(l) ((l)->count)
218 #define netdev_hw_addr_list_empty(l) (netdev_hw_addr_list_count(l) == 0)
219 #define netdev_hw_addr_list_for_each(ha, l) \
220 list_for_each_entry(ha, &(l)->list, list)
222 #define netdev_uc_count(dev) netdev_hw_addr_list_count(&(dev)->uc)
223 #define netdev_uc_empty(dev) netdev_hw_addr_list_empty(&(dev)->uc)
224 #define netdev_for_each_uc_addr(ha, dev) \
225 netdev_hw_addr_list_for_each(ha, &(dev)->uc)
227 #define netdev_mc_count(dev) netdev_hw_addr_list_count(&(dev)->mc)
228 #define netdev_mc_empty(dev) netdev_hw_addr_list_empty(&(dev)->mc)
229 #define netdev_for_each_mc_addr(ha, dev) \
230 netdev_hw_addr_list_for_each(ha, &(dev)->mc)
237 /* cached hardware header; allow for machine alignment needs. */
238 #define HH_DATA_MOD 16
239 #define HH_DATA_OFF(__len) \
240 (HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
241 #define HH_DATA_ALIGN(__len) \
242 (((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
243 unsigned long hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
246 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
248 * dev->hard_header_len ? (dev->hard_header_len +
249 * (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
251 * We could use other alignment values, but we must maintain the
252 * relationship HH alignment <= LL alignment.
254 #define LL_RESERVED_SPACE(dev) \
255 ((((dev)->hard_header_len+(dev)->needed_headroom)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
256 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
257 ((((dev)->hard_header_len+(dev)->needed_headroom+(extra))&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
260 int (*create) (struct sk_buff *skb, struct net_device *dev,
261 unsigned short type, const void *daddr,
262 const void *saddr, unsigned int len);
263 int (*parse)(const struct sk_buff *skb, unsigned char *haddr);
264 int (*cache)(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
265 void (*cache_update)(struct hh_cache *hh,
266 const struct net_device *dev,
267 const unsigned char *haddr);
270 /* These flag bits are private to the generic network queueing
271 * layer, they may not be explicitly referenced by any other
275 enum netdev_state_t {
277 __LINK_STATE_PRESENT,
278 __LINK_STATE_NOCARRIER,
279 __LINK_STATE_LINKWATCH_PENDING,
280 __LINK_STATE_DORMANT,
285 * This structure holds at boot time configured netdevice settings. They
286 * are then used in the device probing.
288 struct netdev_boot_setup {
292 #define NETDEV_BOOT_SETUP_MAX 8
294 int __init netdev_boot_setup(char *str);
297 * Structure for NAPI scheduling similar to tasklet but with weighting
300 /* The poll_list must only be managed by the entity which
301 * changes the state of the NAPI_STATE_SCHED bit. This means
302 * whoever atomically sets that bit can add this napi_struct
303 * to the per-cpu poll_list, and whoever clears that bit
304 * can remove from the list right before clearing the bit.
306 struct list_head poll_list;
310 unsigned int gro_count;
311 int (*poll)(struct napi_struct *, int);
312 #ifdef CONFIG_NETPOLL
313 spinlock_t poll_lock;
316 struct net_device *dev;
317 struct sk_buff *gro_list;
319 struct hrtimer timer;
320 struct list_head dev_list;
321 struct hlist_node napi_hash_node;
322 unsigned int napi_id;
326 NAPI_STATE_SCHED, /* Poll is scheduled */
327 NAPI_STATE_DISABLE, /* Disable pending */
328 NAPI_STATE_NPSVC, /* Netpoll - don't dequeue from poll_list */
329 NAPI_STATE_HASHED, /* In NAPI hash */
339 typedef enum gro_result gro_result_t;
342 * enum rx_handler_result - Possible return values for rx_handlers.
343 * @RX_HANDLER_CONSUMED: skb was consumed by rx_handler, do not process it
345 * @RX_HANDLER_ANOTHER: Do another round in receive path. This is indicated in
346 * case skb->dev was changed by rx_handler.
347 * @RX_HANDLER_EXACT: Force exact delivery, no wildcard.
348 * @RX_HANDLER_PASS: Do nothing, passe the skb as if no rx_handler was called.
350 * rx_handlers are functions called from inside __netif_receive_skb(), to do
351 * special processing of the skb, prior to delivery to protocol handlers.
353 * Currently, a net_device can only have a single rx_handler registered. Trying
354 * to register a second rx_handler will return -EBUSY.
356 * To register a rx_handler on a net_device, use netdev_rx_handler_register().
357 * To unregister a rx_handler on a net_device, use
358 * netdev_rx_handler_unregister().
360 * Upon return, rx_handler is expected to tell __netif_receive_skb() what to
363 * If the rx_handler consumed to skb in some way, it should return
364 * RX_HANDLER_CONSUMED. This is appropriate when the rx_handler arranged for
365 * the skb to be delivered in some other ways.
367 * If the rx_handler changed skb->dev, to divert the skb to another
368 * net_device, it should return RX_HANDLER_ANOTHER. The rx_handler for the
369 * new device will be called if it exists.
371 * If the rx_handler consider the skb should be ignored, it should return
372 * RX_HANDLER_EXACT. The skb will only be delivered to protocol handlers that
373 * are registered on exact device (ptype->dev == skb->dev).
375 * If the rx_handler didn't changed skb->dev, but want the skb to be normally
376 * delivered, it should return RX_HANDLER_PASS.
378 * A device without a registered rx_handler will behave as if rx_handler
379 * returned RX_HANDLER_PASS.
382 enum rx_handler_result {
388 typedef enum rx_handler_result rx_handler_result_t;
389 typedef rx_handler_result_t rx_handler_func_t(struct sk_buff **pskb);
391 void __napi_schedule(struct napi_struct *n);
392 void __napi_schedule_irqoff(struct napi_struct *n);
394 static inline bool napi_disable_pending(struct napi_struct *n)
396 return test_bit(NAPI_STATE_DISABLE, &n->state);
400 * napi_schedule_prep - check if napi can be scheduled
403 * Test if NAPI routine is already running, and if not mark
404 * it as running. This is used as a condition variable
405 * insure only one NAPI poll instance runs. We also make
406 * sure there is no pending NAPI disable.
408 static inline bool napi_schedule_prep(struct napi_struct *n)
410 return !napi_disable_pending(n) &&
411 !test_and_set_bit(NAPI_STATE_SCHED, &n->state);
415 * napi_schedule - schedule NAPI poll
418 * Schedule NAPI poll routine to be called if it is not already
421 static inline void napi_schedule(struct napi_struct *n)
423 if (napi_schedule_prep(n))
428 * napi_schedule_irqoff - schedule NAPI poll
431 * Variant of napi_schedule(), assuming hard irqs are masked.
433 static inline void napi_schedule_irqoff(struct napi_struct *n)
435 if (napi_schedule_prep(n))
436 __napi_schedule_irqoff(n);
439 /* Try to reschedule poll. Called by dev->poll() after napi_complete(). */
440 static inline bool napi_reschedule(struct napi_struct *napi)
442 if (napi_schedule_prep(napi)) {
443 __napi_schedule(napi);
449 void __napi_complete(struct napi_struct *n);
450 void napi_complete_done(struct napi_struct *n, int work_done);
452 * napi_complete - NAPI processing complete
455 * Mark NAPI processing as complete.
456 * Consider using napi_complete_done() instead.
458 static inline void napi_complete(struct napi_struct *n)
460 return napi_complete_done(n, 0);
464 * napi_by_id - lookup a NAPI by napi_id
465 * @napi_id: hashed napi_id
467 * lookup @napi_id in napi_hash table
468 * must be called under rcu_read_lock()
470 struct napi_struct *napi_by_id(unsigned int napi_id);
473 * napi_hash_add - add a NAPI to global hashtable
474 * @napi: napi context
476 * generate a new napi_id and store a @napi under it in napi_hash
478 void napi_hash_add(struct napi_struct *napi);
481 * napi_hash_del - remove a NAPI from global table
482 * @napi: napi context
484 * Warning: caller must observe rcu grace period
485 * before freeing memory containing @napi
487 void napi_hash_del(struct napi_struct *napi);
490 * napi_disable - prevent NAPI from scheduling
493 * Stop NAPI from being scheduled on this context.
494 * Waits till any outstanding processing completes.
496 void napi_disable(struct napi_struct *n);
499 * napi_enable - enable NAPI scheduling
502 * Resume NAPI from being scheduled on this context.
503 * Must be paired with napi_disable.
505 static inline void napi_enable(struct napi_struct *n)
507 BUG_ON(!test_bit(NAPI_STATE_SCHED, &n->state));
508 smp_mb__before_atomic();
509 clear_bit(NAPI_STATE_SCHED, &n->state);
510 clear_bit(NAPI_STATE_NPSVC, &n->state);
515 * napi_synchronize - wait until NAPI is not running
518 * Wait until NAPI is done being scheduled on this context.
519 * Waits till any outstanding processing completes but
520 * does not disable future activations.
522 static inline void napi_synchronize(const struct napi_struct *n)
524 while (test_bit(NAPI_STATE_SCHED, &n->state))
528 # define napi_synchronize(n) barrier()
531 enum netdev_queue_state_t {
532 __QUEUE_STATE_DRV_XOFF,
533 __QUEUE_STATE_STACK_XOFF,
534 __QUEUE_STATE_FROZEN,
537 #define QUEUE_STATE_DRV_XOFF (1 << __QUEUE_STATE_DRV_XOFF)
538 #define QUEUE_STATE_STACK_XOFF (1 << __QUEUE_STATE_STACK_XOFF)
539 #define QUEUE_STATE_FROZEN (1 << __QUEUE_STATE_FROZEN)
541 #define QUEUE_STATE_ANY_XOFF (QUEUE_STATE_DRV_XOFF | QUEUE_STATE_STACK_XOFF)
542 #define QUEUE_STATE_ANY_XOFF_OR_FROZEN (QUEUE_STATE_ANY_XOFF | \
544 #define QUEUE_STATE_DRV_XOFF_OR_FROZEN (QUEUE_STATE_DRV_XOFF | \
548 * __QUEUE_STATE_DRV_XOFF is used by drivers to stop the transmit queue. The
549 * netif_tx_* functions below are used to manipulate this flag. The
550 * __QUEUE_STATE_STACK_XOFF flag is used by the stack to stop the transmit
551 * queue independently. The netif_xmit_*stopped functions below are called
552 * to check if the queue has been stopped by the driver or stack (either
553 * of the XOFF bits are set in the state). Drivers should not need to call
554 * netif_xmit*stopped functions, they should only be using netif_tx_*.
557 struct netdev_queue {
561 struct net_device *dev;
562 struct Qdisc __rcu *qdisc;
563 struct Qdisc *qdisc_sleeping;
567 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
573 spinlock_t _xmit_lock ____cacheline_aligned_in_smp;
576 * please use this field instead of dev->trans_start
578 unsigned long trans_start;
581 * Number of TX timeouts for this queue
582 * (/sys/class/net/DEV/Q/trans_timeout)
584 unsigned long trans_timeout;
591 unsigned long tx_maxrate;
592 } ____cacheline_aligned_in_smp;
594 static inline int netdev_queue_numa_node_read(const struct netdev_queue *q)
596 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
603 static inline void netdev_queue_numa_node_write(struct netdev_queue *q, int node)
605 #if defined(CONFIG_XPS) && defined(CONFIG_NUMA)
612 * This structure holds an RPS map which can be of variable length. The
613 * map is an array of CPUs.
620 #define RPS_MAP_SIZE(_num) (sizeof(struct rps_map) + ((_num) * sizeof(u16)))
623 * The rps_dev_flow structure contains the mapping of a flow to a CPU, the
624 * tail pointer for that CPU's input queue at the time of last enqueue, and
625 * a hardware filter index.
627 struct rps_dev_flow {
630 unsigned int last_qtail;
632 #define RPS_NO_FILTER 0xffff
635 * The rps_dev_flow_table structure contains a table of flow mappings.
637 struct rps_dev_flow_table {
640 struct rps_dev_flow flows[0];
642 #define RPS_DEV_FLOW_TABLE_SIZE(_num) (sizeof(struct rps_dev_flow_table) + \
643 ((_num) * sizeof(struct rps_dev_flow)))
646 * The rps_sock_flow_table contains mappings of flows to the last CPU
647 * on which they were processed by the application (set in recvmsg).
648 * Each entry is a 32bit value. Upper part is the high order bits
649 * of flow hash, lower part is cpu number.
650 * rps_cpu_mask is used to partition the space, depending on number of
651 * possible cpus : rps_cpu_mask = roundup_pow_of_two(nr_cpu_ids) - 1
652 * For example, if 64 cpus are possible, rps_cpu_mask = 0x3f,
653 * meaning we use 32-6=26 bits for the hash.
655 struct rps_sock_flow_table {
658 u32 ents[0] ____cacheline_aligned_in_smp;
660 #define RPS_SOCK_FLOW_TABLE_SIZE(_num) (offsetof(struct rps_sock_flow_table, ents[_num]))
662 #define RPS_NO_CPU 0xffff
664 extern u32 rps_cpu_mask;
665 extern struct rps_sock_flow_table __rcu *rps_sock_flow_table;
667 static inline void rps_record_sock_flow(struct rps_sock_flow_table *table,
671 unsigned int index = hash & table->mask;
672 u32 val = hash & ~rps_cpu_mask;
674 /* We only give a hint, preemption can change cpu under us */
675 val |= raw_smp_processor_id();
677 if (table->ents[index] != val)
678 table->ents[index] = val;
682 #ifdef CONFIG_RFS_ACCEL
683 bool rps_may_expire_flow(struct net_device *dev, u16 rxq_index, u32 flow_id,
686 #endif /* CONFIG_RPS */
688 /* This structure contains an instance of an RX queue. */
689 struct netdev_rx_queue {
691 struct rps_map __rcu *rps_map;
692 struct rps_dev_flow_table __rcu *rps_flow_table;
695 struct net_device *dev;
696 } ____cacheline_aligned_in_smp;
699 * RX queue sysfs structures and functions.
701 struct rx_queue_attribute {
702 struct attribute attr;
703 ssize_t (*show)(struct netdev_rx_queue *queue,
704 struct rx_queue_attribute *attr, char *buf);
705 ssize_t (*store)(struct netdev_rx_queue *queue,
706 struct rx_queue_attribute *attr, const char *buf, size_t len);
711 * This structure holds an XPS map which can be of variable length. The
712 * map is an array of queues.
716 unsigned int alloc_len;
720 #define XPS_MAP_SIZE(_num) (sizeof(struct xps_map) + ((_num) * sizeof(u16)))
721 #define XPS_MIN_MAP_ALLOC ((L1_CACHE_BYTES - sizeof(struct xps_map)) \
725 * This structure holds all XPS maps for device. Maps are indexed by CPU.
727 struct xps_dev_maps {
729 struct xps_map __rcu *cpu_map[0];
731 #define XPS_DEV_MAPS_SIZE (sizeof(struct xps_dev_maps) + \
732 (nr_cpu_ids * sizeof(struct xps_map *)))
733 #endif /* CONFIG_XPS */
735 #define TC_MAX_QUEUE 16
736 #define TC_BITMASK 15
737 /* HW offloaded queuing disciplines txq count and offset maps */
738 struct netdev_tc_txq {
743 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
745 * This structure is to hold information about the device
746 * configured to run FCoE protocol stack.
748 struct netdev_fcoe_hbainfo {
749 char manufacturer[64];
750 char serial_number[64];
751 char hardware_version[64];
752 char driver_version[64];
753 char optionrom_version[64];
754 char firmware_version[64];
756 char model_description[256];
760 #define MAX_PHYS_ITEM_ID_LEN 32
762 /* This structure holds a unique identifier to identify some
763 * physical item (port for example) used by a netdevice.
765 struct netdev_phys_item_id {
766 unsigned char id[MAX_PHYS_ITEM_ID_LEN];
767 unsigned char id_len;
770 static inline bool netdev_phys_item_id_same(struct netdev_phys_item_id *a,
771 struct netdev_phys_item_id *b)
773 return a->id_len == b->id_len &&
774 memcmp(a->id, b->id, a->id_len) == 0;
777 typedef u16 (*select_queue_fallback_t)(struct net_device *dev,
778 struct sk_buff *skb);
781 * This structure defines the management hooks for network devices.
782 * The following hooks can be defined; unless noted otherwise, they are
783 * optional and can be filled with a null pointer.
785 * int (*ndo_init)(struct net_device *dev);
786 * This function is called once when network device is registered.
787 * The network device can use this to any late stage initializaton
788 * or semantic validattion. It can fail with an error code which will
789 * be propogated back to register_netdev
791 * void (*ndo_uninit)(struct net_device *dev);
792 * This function is called when device is unregistered or when registration
793 * fails. It is not called if init fails.
795 * int (*ndo_open)(struct net_device *dev);
796 * This function is called when network device transistions to the up
799 * int (*ndo_stop)(struct net_device *dev);
800 * This function is called when network device transistions to the down
803 * netdev_tx_t (*ndo_start_xmit)(struct sk_buff *skb,
804 * struct net_device *dev);
805 * Called when a packet needs to be transmitted.
806 * Returns NETDEV_TX_OK. Can return NETDEV_TX_BUSY, but you should stop
807 * the queue before that can happen; it's for obsolete devices and weird
808 * corner cases, but the stack really does a non-trivial amount
809 * of useless work if you return NETDEV_TX_BUSY.
810 * (can also return NETDEV_TX_LOCKED iff NETIF_F_LLTX)
811 * Required can not be NULL.
813 * u16 (*ndo_select_queue)(struct net_device *dev, struct sk_buff *skb,
814 * void *accel_priv, select_queue_fallback_t fallback);
815 * Called to decide which queue to when device supports multiple
818 * void (*ndo_change_rx_flags)(struct net_device *dev, int flags);
819 * This function is called to allow device receiver to make
820 * changes to configuration when multicast or promiscious is enabled.
822 * void (*ndo_set_rx_mode)(struct net_device *dev);
823 * This function is called device changes address list filtering.
824 * If driver handles unicast address filtering, it should set
825 * IFF_UNICAST_FLT to its priv_flags.
827 * int (*ndo_set_mac_address)(struct net_device *dev, void *addr);
828 * This function is called when the Media Access Control address
829 * needs to be changed. If this interface is not defined, the
830 * mac address can not be changed.
832 * int (*ndo_validate_addr)(struct net_device *dev);
833 * Test if Media Access Control address is valid for the device.
835 * int (*ndo_do_ioctl)(struct net_device *dev, struct ifreq *ifr, int cmd);
836 * Called when a user request an ioctl which can't be handled by
837 * the generic interface code. If not defined ioctl's return
838 * not supported error code.
840 * int (*ndo_set_config)(struct net_device *dev, struct ifmap *map);
841 * Used to set network devices bus interface parameters. This interface
842 * is retained for legacy reason, new devices should use the bus
843 * interface (PCI) for low level management.
845 * int (*ndo_change_mtu)(struct net_device *dev, int new_mtu);
846 * Called when a user wants to change the Maximum Transfer Unit
847 * of a device. If not defined, any request to change MTU will
848 * will return an error.
850 * void (*ndo_tx_timeout)(struct net_device *dev);
851 * Callback uses when the transmitter has not made any progress
852 * for dev->watchdog ticks.
854 * struct rtnl_link_stats64* (*ndo_get_stats64)(struct net_device *dev,
855 * struct rtnl_link_stats64 *storage);
856 * struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
857 * Called when a user wants to get the network device usage
858 * statistics. Drivers must do one of the following:
859 * 1. Define @ndo_get_stats64 to fill in a zero-initialised
860 * rtnl_link_stats64 structure passed by the caller.
861 * 2. Define @ndo_get_stats to update a net_device_stats structure
862 * (which should normally be dev->stats) and return a pointer to
863 * it. The structure may be changed asynchronously only if each
864 * field is written atomically.
865 * 3. Update dev->stats asynchronously and atomically, and define
868 * int (*ndo_vlan_rx_add_vid)(struct net_device *dev, __be16 proto, u16 vid);
869 * If device support VLAN filtering this function is called when a
870 * VLAN id is registered.
872 * int (*ndo_vlan_rx_kill_vid)(struct net_device *dev, __be16 proto, u16 vid);
873 * If device support VLAN filtering this function is called when a
874 * VLAN id is unregistered.
876 * void (*ndo_poll_controller)(struct net_device *dev);
878 * SR-IOV management functions.
879 * int (*ndo_set_vf_mac)(struct net_device *dev, int vf, u8* mac);
880 * int (*ndo_set_vf_vlan)(struct net_device *dev, int vf, u16 vlan, u8 qos);
881 * int (*ndo_set_vf_rate)(struct net_device *dev, int vf, int min_tx_rate,
883 * int (*ndo_set_vf_spoofchk)(struct net_device *dev, int vf, bool setting);
884 * int (*ndo_get_vf_config)(struct net_device *dev,
885 * int vf, struct ifla_vf_info *ivf);
886 * int (*ndo_set_vf_link_state)(struct net_device *dev, int vf, int link_state);
887 * int (*ndo_set_vf_port)(struct net_device *dev, int vf,
888 * struct nlattr *port[]);
890 * Enable or disable the VF ability to query its RSS Redirection Table and
891 * Hash Key. This is needed since on some devices VF share this information
892 * with PF and querying it may adduce a theoretical security risk.
893 * int (*ndo_set_vf_rss_query_en)(struct net_device *dev, int vf, bool setting);
894 * int (*ndo_get_vf_port)(struct net_device *dev, int vf, struct sk_buff *skb);
895 * int (*ndo_setup_tc)(struct net_device *dev, u8 tc)
896 * Called to setup 'tc' number of traffic classes in the net device. This
897 * is always called from the stack with the rtnl lock held and netif tx
898 * queues stopped. This allows the netdevice to perform queue management
901 * Fiber Channel over Ethernet (FCoE) offload functions.
902 * int (*ndo_fcoe_enable)(struct net_device *dev);
903 * Called when the FCoE protocol stack wants to start using LLD for FCoE
904 * so the underlying device can perform whatever needed configuration or
905 * initialization to support acceleration of FCoE traffic.
907 * int (*ndo_fcoe_disable)(struct net_device *dev);
908 * Called when the FCoE protocol stack wants to stop using LLD for FCoE
909 * so the underlying device can perform whatever needed clean-ups to
910 * stop supporting acceleration of FCoE traffic.
912 * int (*ndo_fcoe_ddp_setup)(struct net_device *dev, u16 xid,
913 * struct scatterlist *sgl, unsigned int sgc);
914 * Called when the FCoE Initiator wants to initialize an I/O that
915 * is a possible candidate for Direct Data Placement (DDP). The LLD can
916 * perform necessary setup and returns 1 to indicate the device is set up
917 * successfully to perform DDP on this I/O, otherwise this returns 0.
919 * int (*ndo_fcoe_ddp_done)(struct net_device *dev, u16 xid);
920 * Called when the FCoE Initiator/Target is done with the DDPed I/O as
921 * indicated by the FC exchange id 'xid', so the underlying device can
922 * clean up and reuse resources for later DDP requests.
924 * int (*ndo_fcoe_ddp_target)(struct net_device *dev, u16 xid,
925 * struct scatterlist *sgl, unsigned int sgc);
926 * Called when the FCoE Target wants to initialize an I/O that
927 * is a possible candidate for Direct Data Placement (DDP). The LLD can
928 * perform necessary setup and returns 1 to indicate the device is set up
929 * successfully to perform DDP on this I/O, otherwise this returns 0.
931 * int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
932 * struct netdev_fcoe_hbainfo *hbainfo);
933 * Called when the FCoE Protocol stack wants information on the underlying
934 * device. This information is utilized by the FCoE protocol stack to
935 * register attributes with Fiber Channel management service as per the
936 * FC-GS Fabric Device Management Information(FDMI) specification.
938 * int (*ndo_fcoe_get_wwn)(struct net_device *dev, u64 *wwn, int type);
939 * Called when the underlying device wants to override default World Wide
940 * Name (WWN) generation mechanism in FCoE protocol stack to pass its own
941 * World Wide Port Name (WWPN) or World Wide Node Name (WWNN) to the FCoE
942 * protocol stack to use.
945 * int (*ndo_rx_flow_steer)(struct net_device *dev, const struct sk_buff *skb,
946 * u16 rxq_index, u32 flow_id);
947 * Set hardware filter for RFS. rxq_index is the target queue index;
948 * flow_id is a flow ID to be passed to rps_may_expire_flow() later.
949 * Return the filter ID on success, or a negative error code.
951 * Slave management functions (for bridge, bonding, etc).
952 * int (*ndo_add_slave)(struct net_device *dev, struct net_device *slave_dev);
953 * Called to make another netdev an underling.
955 * int (*ndo_del_slave)(struct net_device *dev, struct net_device *slave_dev);
956 * Called to release previously enslaved netdev.
958 * Feature/offload setting functions.
959 * netdev_features_t (*ndo_fix_features)(struct net_device *dev,
960 * netdev_features_t features);
961 * Adjusts the requested feature flags according to device-specific
962 * constraints, and returns the resulting flags. Must not modify
965 * int (*ndo_set_features)(struct net_device *dev, netdev_features_t features);
966 * Called to update device configuration to new features. Passed
967 * feature set might be less than what was returned by ndo_fix_features()).
968 * Must return >0 or -errno if it changed dev->features itself.
970 * int (*ndo_fdb_add)(struct ndmsg *ndm, struct nlattr *tb[],
971 * struct net_device *dev,
972 * const unsigned char *addr, u16 vid, u16 flags)
973 * Adds an FDB entry to dev for addr.
974 * int (*ndo_fdb_del)(struct ndmsg *ndm, struct nlattr *tb[],
975 * struct net_device *dev,
976 * const unsigned char *addr, u16 vid)
977 * Deletes the FDB entry from dev coresponding to addr.
978 * int (*ndo_fdb_dump)(struct sk_buff *skb, struct netlink_callback *cb,
979 * struct net_device *dev, struct net_device *filter_dev,
981 * Used to add FDB entries to dump requests. Implementers should add
982 * entries to skb and update idx with the number of entries.
984 * int (*ndo_bridge_setlink)(struct net_device *dev, struct nlmsghdr *nlh,
986 * int (*ndo_bridge_getlink)(struct sk_buff *skb, u32 pid, u32 seq,
987 * struct net_device *dev, u32 filter_mask,
989 * int (*ndo_bridge_dellink)(struct net_device *dev, struct nlmsghdr *nlh,
992 * int (*ndo_change_carrier)(struct net_device *dev, bool new_carrier);
993 * Called to change device carrier. Soft-devices (like dummy, team, etc)
994 * which do not represent real hardware may define this to allow their
995 * userspace components to manage their virtual carrier state. Devices
996 * that determine carrier state from physical hardware properties (eg
997 * network cables) or protocol-dependent mechanisms (eg
998 * USB_CDC_NOTIFY_NETWORK_CONNECTION) should NOT implement this function.
1000 * int (*ndo_get_phys_port_id)(struct net_device *dev,
1001 * struct netdev_phys_item_id *ppid);
1002 * Called to get ID of physical port of this device. If driver does
1003 * not implement this, it is assumed that the hw is not able to have
1004 * multiple net devices on single physical port.
1006 * void (*ndo_add_vxlan_port)(struct net_device *dev,
1007 * sa_family_t sa_family, __be16 port);
1008 * Called by vxlan to notiy a driver about the UDP port and socket
1009 * address family that vxlan is listnening to. It is called only when
1010 * a new port starts listening. The operation is protected by the
1011 * vxlan_net->sock_lock.
1013 * void (*ndo_del_vxlan_port)(struct net_device *dev,
1014 * sa_family_t sa_family, __be16 port);
1015 * Called by vxlan to notify the driver about a UDP port and socket
1016 * address family that vxlan is not listening to anymore. The operation
1017 * is protected by the vxlan_net->sock_lock.
1019 * void* (*ndo_dfwd_add_station)(struct net_device *pdev,
1020 * struct net_device *dev)
1021 * Called by upper layer devices to accelerate switching or other
1022 * station functionality into hardware. 'pdev is the lowerdev
1023 * to use for the offload and 'dev' is the net device that will
1024 * back the offload. Returns a pointer to the private structure
1025 * the upper layer will maintain.
1026 * void (*ndo_dfwd_del_station)(struct net_device *pdev, void *priv)
1027 * Called by upper layer device to delete the station created
1028 * by 'ndo_dfwd_add_station'. 'pdev' is the net device backing
1029 * the station and priv is the structure returned by the add
1031 * netdev_tx_t (*ndo_dfwd_start_xmit)(struct sk_buff *skb,
1032 * struct net_device *dev,
1034 * Callback to use for xmit over the accelerated station. This
1035 * is used in place of ndo_start_xmit on accelerated net
1037 * netdev_features_t (*ndo_features_check) (struct sk_buff *skb,
1038 * struct net_device *dev
1039 * netdev_features_t features);
1040 * Called by core transmit path to determine if device is capable of
1041 * performing offload operations on a given packet. This is to give
1042 * the device an opportunity to implement any restrictions that cannot
1043 * be otherwise expressed by feature flags. The check is called with
1044 * the set of features that the stack has calculated and it returns
1045 * those the driver believes to be appropriate.
1046 * int (*ndo_set_tx_maxrate)(struct net_device *dev,
1047 * int queue_index, u32 maxrate);
1048 * Called when a user wants to set a max-rate limitation of specific
1050 * int (*ndo_get_iflink)(const struct net_device *dev);
1051 * Called to get the iflink value of this device.
1052 * void (*ndo_change_proto_down)(struct net_device *dev,
1054 * This function is used to pass protocol port error state information
1055 * to the switch driver. The switch driver can react to the proto_down
1056 * by doing a phys down on the associated switch port.
1057 * int (*ndo_fill_metadata_dst)(struct net_device *dev, struct sk_buff *skb);
1058 * This function is used to get egress tunnel information for given skb.
1059 * This is useful for retrieving outer tunnel header parameters while
1063 struct net_device_ops {
1064 int (*ndo_init)(struct net_device *dev);
1065 void (*ndo_uninit)(struct net_device *dev);
1066 int (*ndo_open)(struct net_device *dev);
1067 int (*ndo_stop)(struct net_device *dev);
1068 netdev_tx_t (*ndo_start_xmit) (struct sk_buff *skb,
1069 struct net_device *dev);
1070 u16 (*ndo_select_queue)(struct net_device *dev,
1071 struct sk_buff *skb,
1073 select_queue_fallback_t fallback);
1074 void (*ndo_change_rx_flags)(struct net_device *dev,
1076 void (*ndo_set_rx_mode)(struct net_device *dev);
1077 int (*ndo_set_mac_address)(struct net_device *dev,
1079 int (*ndo_validate_addr)(struct net_device *dev);
1080 int (*ndo_do_ioctl)(struct net_device *dev,
1081 struct ifreq *ifr, int cmd);
1082 int (*ndo_set_config)(struct net_device *dev,
1084 int (*ndo_change_mtu)(struct net_device *dev,
1086 int (*ndo_neigh_setup)(struct net_device *dev,
1087 struct neigh_parms *);
1088 void (*ndo_tx_timeout) (struct net_device *dev);
1090 struct rtnl_link_stats64* (*ndo_get_stats64)(struct net_device *dev,
1091 struct rtnl_link_stats64 *storage);
1092 struct net_device_stats* (*ndo_get_stats)(struct net_device *dev);
1094 int (*ndo_vlan_rx_add_vid)(struct net_device *dev,
1095 __be16 proto, u16 vid);
1096 int (*ndo_vlan_rx_kill_vid)(struct net_device *dev,
1097 __be16 proto, u16 vid);
1098 #ifdef CONFIG_NET_POLL_CONTROLLER
1099 void (*ndo_poll_controller)(struct net_device *dev);
1100 int (*ndo_netpoll_setup)(struct net_device *dev,
1101 struct netpoll_info *info);
1102 void (*ndo_netpoll_cleanup)(struct net_device *dev);
1104 #ifdef CONFIG_NET_RX_BUSY_POLL
1105 int (*ndo_busy_poll)(struct napi_struct *dev);
1107 int (*ndo_set_vf_mac)(struct net_device *dev,
1108 int queue, u8 *mac);
1109 int (*ndo_set_vf_vlan)(struct net_device *dev,
1110 int queue, u16 vlan, u8 qos);
1111 int (*ndo_set_vf_rate)(struct net_device *dev,
1112 int vf, int min_tx_rate,
1114 int (*ndo_set_vf_spoofchk)(struct net_device *dev,
1115 int vf, bool setting);
1116 int (*ndo_get_vf_config)(struct net_device *dev,
1118 struct ifla_vf_info *ivf);
1119 int (*ndo_set_vf_link_state)(struct net_device *dev,
1120 int vf, int link_state);
1121 int (*ndo_get_vf_stats)(struct net_device *dev,
1123 struct ifla_vf_stats
1125 int (*ndo_set_vf_port)(struct net_device *dev,
1127 struct nlattr *port[]);
1128 int (*ndo_get_vf_port)(struct net_device *dev,
1129 int vf, struct sk_buff *skb);
1130 int (*ndo_set_vf_rss_query_en)(
1131 struct net_device *dev,
1132 int vf, bool setting);
1133 int (*ndo_setup_tc)(struct net_device *dev, u8 tc);
1134 #if IS_ENABLED(CONFIG_FCOE)
1135 int (*ndo_fcoe_enable)(struct net_device *dev);
1136 int (*ndo_fcoe_disable)(struct net_device *dev);
1137 int (*ndo_fcoe_ddp_setup)(struct net_device *dev,
1139 struct scatterlist *sgl,
1141 int (*ndo_fcoe_ddp_done)(struct net_device *dev,
1143 int (*ndo_fcoe_ddp_target)(struct net_device *dev,
1145 struct scatterlist *sgl,
1147 int (*ndo_fcoe_get_hbainfo)(struct net_device *dev,
1148 struct netdev_fcoe_hbainfo *hbainfo);
1151 #if IS_ENABLED(CONFIG_LIBFCOE)
1152 #define NETDEV_FCOE_WWNN 0
1153 #define NETDEV_FCOE_WWPN 1
1154 int (*ndo_fcoe_get_wwn)(struct net_device *dev,
1155 u64 *wwn, int type);
1158 #ifdef CONFIG_RFS_ACCEL
1159 int (*ndo_rx_flow_steer)(struct net_device *dev,
1160 const struct sk_buff *skb,
1164 int (*ndo_add_slave)(struct net_device *dev,
1165 struct net_device *slave_dev);
1166 int (*ndo_del_slave)(struct net_device *dev,
1167 struct net_device *slave_dev);
1168 netdev_features_t (*ndo_fix_features)(struct net_device *dev,
1169 netdev_features_t features);
1170 int (*ndo_set_features)(struct net_device *dev,
1171 netdev_features_t features);
1172 int (*ndo_neigh_construct)(struct neighbour *n);
1173 void (*ndo_neigh_destroy)(struct neighbour *n);
1175 int (*ndo_fdb_add)(struct ndmsg *ndm,
1176 struct nlattr *tb[],
1177 struct net_device *dev,
1178 const unsigned char *addr,
1181 int (*ndo_fdb_del)(struct ndmsg *ndm,
1182 struct nlattr *tb[],
1183 struct net_device *dev,
1184 const unsigned char *addr,
1186 int (*ndo_fdb_dump)(struct sk_buff *skb,
1187 struct netlink_callback *cb,
1188 struct net_device *dev,
1189 struct net_device *filter_dev,
1192 int (*ndo_bridge_setlink)(struct net_device *dev,
1193 struct nlmsghdr *nlh,
1195 int (*ndo_bridge_getlink)(struct sk_buff *skb,
1197 struct net_device *dev,
1200 int (*ndo_bridge_dellink)(struct net_device *dev,
1201 struct nlmsghdr *nlh,
1203 int (*ndo_change_carrier)(struct net_device *dev,
1205 int (*ndo_get_phys_port_id)(struct net_device *dev,
1206 struct netdev_phys_item_id *ppid);
1207 int (*ndo_get_phys_port_name)(struct net_device *dev,
1208 char *name, size_t len);
1209 void (*ndo_add_vxlan_port)(struct net_device *dev,
1210 sa_family_t sa_family,
1212 void (*ndo_del_vxlan_port)(struct net_device *dev,
1213 sa_family_t sa_family,
1216 void* (*ndo_dfwd_add_station)(struct net_device *pdev,
1217 struct net_device *dev);
1218 void (*ndo_dfwd_del_station)(struct net_device *pdev,
1221 netdev_tx_t (*ndo_dfwd_start_xmit) (struct sk_buff *skb,
1222 struct net_device *dev,
1224 int (*ndo_get_lock_subclass)(struct net_device *dev);
1225 netdev_features_t (*ndo_features_check) (struct sk_buff *skb,
1226 struct net_device *dev,
1227 netdev_features_t features);
1228 int (*ndo_set_tx_maxrate)(struct net_device *dev,
1231 int (*ndo_get_iflink)(const struct net_device *dev);
1232 int (*ndo_change_proto_down)(struct net_device *dev,
1234 int (*ndo_fill_metadata_dst)(struct net_device *dev,
1235 struct sk_buff *skb);
1239 * enum net_device_priv_flags - &struct net_device priv_flags
1241 * These are the &struct net_device, they are only set internally
1242 * by drivers and used in the kernel. These flags are invisible to
1243 * userspace, this means that the order of these flags can change
1244 * during any kernel release.
1246 * You should have a pretty good reason to be extending these flags.
1248 * @IFF_802_1Q_VLAN: 802.1Q VLAN device
1249 * @IFF_EBRIDGE: Ethernet bridging device
1250 * @IFF_BONDING: bonding master or slave
1251 * @IFF_ISATAP: ISATAP interface (RFC4214)
1252 * @IFF_WAN_HDLC: WAN HDLC device
1253 * @IFF_XMIT_DST_RELEASE: dev_hard_start_xmit() is allowed to
1255 * @IFF_DONT_BRIDGE: disallow bridging this ether dev
1256 * @IFF_DISABLE_NETPOLL: disable netpoll at run-time
1257 * @IFF_MACVLAN_PORT: device used as macvlan port
1258 * @IFF_BRIDGE_PORT: device used as bridge port
1259 * @IFF_OVS_DATAPATH: device used as Open vSwitch datapath port
1260 * @IFF_TX_SKB_SHARING: The interface supports sharing skbs on transmit
1261 * @IFF_UNICAST_FLT: Supports unicast filtering
1262 * @IFF_TEAM_PORT: device used as team port
1263 * @IFF_SUPP_NOFCS: device supports sending custom FCS
1264 * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
1265 * change when it's running
1266 * @IFF_MACVLAN: Macvlan device
1267 * @IFF_VRF_MASTER: device is a VRF master
1268 * @IFF_NO_QUEUE: device can run without qdisc attached
1269 * @IFF_OPENVSWITCH: device is a Open vSwitch master
1271 enum netdev_priv_flags {
1272 IFF_802_1Q_VLAN = 1<<0,
1276 IFF_WAN_HDLC = 1<<4,
1277 IFF_XMIT_DST_RELEASE = 1<<5,
1278 IFF_DONT_BRIDGE = 1<<6,
1279 IFF_DISABLE_NETPOLL = 1<<7,
1280 IFF_MACVLAN_PORT = 1<<8,
1281 IFF_BRIDGE_PORT = 1<<9,
1282 IFF_OVS_DATAPATH = 1<<10,
1283 IFF_TX_SKB_SHARING = 1<<11,
1284 IFF_UNICAST_FLT = 1<<12,
1285 IFF_TEAM_PORT = 1<<13,
1286 IFF_SUPP_NOFCS = 1<<14,
1287 IFF_LIVE_ADDR_CHANGE = 1<<15,
1288 IFF_MACVLAN = 1<<16,
1289 IFF_XMIT_DST_RELEASE_PERM = 1<<17,
1290 IFF_IPVLAN_MASTER = 1<<18,
1291 IFF_IPVLAN_SLAVE = 1<<19,
1292 IFF_VRF_MASTER = 1<<20,
1293 IFF_NO_QUEUE = 1<<21,
1294 IFF_OPENVSWITCH = 1<<22,
1297 #define IFF_802_1Q_VLAN IFF_802_1Q_VLAN
1298 #define IFF_EBRIDGE IFF_EBRIDGE
1299 #define IFF_BONDING IFF_BONDING
1300 #define IFF_ISATAP IFF_ISATAP
1301 #define IFF_WAN_HDLC IFF_WAN_HDLC
1302 #define IFF_XMIT_DST_RELEASE IFF_XMIT_DST_RELEASE
1303 #define IFF_DONT_BRIDGE IFF_DONT_BRIDGE
1304 #define IFF_DISABLE_NETPOLL IFF_DISABLE_NETPOLL
1305 #define IFF_MACVLAN_PORT IFF_MACVLAN_PORT
1306 #define IFF_BRIDGE_PORT IFF_BRIDGE_PORT
1307 #define IFF_OVS_DATAPATH IFF_OVS_DATAPATH
1308 #define IFF_TX_SKB_SHARING IFF_TX_SKB_SHARING
1309 #define IFF_UNICAST_FLT IFF_UNICAST_FLT
1310 #define IFF_TEAM_PORT IFF_TEAM_PORT
1311 #define IFF_SUPP_NOFCS IFF_SUPP_NOFCS
1312 #define IFF_LIVE_ADDR_CHANGE IFF_LIVE_ADDR_CHANGE
1313 #define IFF_MACVLAN IFF_MACVLAN
1314 #define IFF_XMIT_DST_RELEASE_PERM IFF_XMIT_DST_RELEASE_PERM
1315 #define IFF_IPVLAN_MASTER IFF_IPVLAN_MASTER
1316 #define IFF_IPVLAN_SLAVE IFF_IPVLAN_SLAVE
1317 #define IFF_VRF_MASTER IFF_VRF_MASTER
1318 #define IFF_NO_QUEUE IFF_NO_QUEUE
1319 #define IFF_OPENVSWITCH IFF_OPENVSWITCH
1322 * struct net_device - The DEVICE structure.
1323 * Actually, this whole structure is a big mistake. It mixes I/O
1324 * data with strictly "high-level" data, and it has to know about
1325 * almost every data structure used in the INET module.
1327 * @name: This is the first field of the "visible" part of this structure
1328 * (i.e. as seen by users in the "Space.c" file). It is the name
1331 * @name_hlist: Device name hash chain, please keep it close to name[]
1332 * @ifalias: SNMP alias
1333 * @mem_end: Shared memory end
1334 * @mem_start: Shared memory start
1335 * @base_addr: Device I/O address
1336 * @irq: Device IRQ number
1338 * @carrier_changes: Stats to monitor carrier on<->off transitions
1340 * @state: Generic network queuing layer state, see netdev_state_t
1341 * @dev_list: The global list of network devices
1342 * @napi_list: List entry, that is used for polling napi devices
1343 * @unreg_list: List entry, that is used, when we are unregistering the
1344 * device, see the function unregister_netdev
1345 * @close_list: List entry, that is used, when we are closing the device
1347 * @adj_list: Directly linked devices, like slaves for bonding
1348 * @all_adj_list: All linked devices, *including* neighbours
1349 * @features: Currently active device features
1350 * @hw_features: User-changeable features
1352 * @wanted_features: User-requested features
1353 * @vlan_features: Mask of features inheritable by VLAN devices
1355 * @hw_enc_features: Mask of features inherited by encapsulating devices
1356 * This field indicates what encapsulation
1357 * offloads the hardware is capable of doing,
1358 * and drivers will need to set them appropriately.
1360 * @mpls_features: Mask of features inheritable by MPLS
1362 * @ifindex: interface index
1363 * @group: The group, that the device belongs to
1365 * @stats: Statistics struct, which was left as a legacy, use
1366 * rtnl_link_stats64 instead
1368 * @rx_dropped: Dropped packets by core network,
1369 * do not use this in drivers
1370 * @tx_dropped: Dropped packets by core network,
1371 * do not use this in drivers
1373 * @wireless_handlers: List of functions to handle Wireless Extensions,
1375 * see <net/iw_handler.h> for details.
1376 * @wireless_data: Instance data managed by the core of wireless extensions
1378 * @netdev_ops: Includes several pointers to callbacks,
1379 * if one wants to override the ndo_*() functions
1380 * @ethtool_ops: Management operations
1381 * @header_ops: Includes callbacks for creating,parsing,caching,etc
1382 * of Layer 2 headers.
1384 * @flags: Interface flags (a la BSD)
1385 * @priv_flags: Like 'flags' but invisible to userspace,
1386 * see if.h for the definitions
1387 * @gflags: Global flags ( kept as legacy )
1388 * @padded: How much padding added by alloc_netdev()
1389 * @operstate: RFC2863 operstate
1390 * @link_mode: Mapping policy to operstate
1391 * @if_port: Selectable AUI, TP, ...
1393 * @mtu: Interface MTU value
1394 * @type: Interface hardware type
1395 * @hard_header_len: Hardware header length
1397 * @needed_headroom: Extra headroom the hardware may need, but not in all
1398 * cases can this be guaranteed
1399 * @needed_tailroom: Extra tailroom the hardware may need, but not in all
1400 * cases can this be guaranteed. Some cases also use
1401 * LL_MAX_HEADER instead to allocate the skb
1403 * interface address info:
1405 * @perm_addr: Permanent hw address
1406 * @addr_assign_type: Hw address assignment type
1407 * @addr_len: Hardware address length
1408 * @neigh_priv_len; Used in neigh_alloc(),
1409 * initialized only in atm/clip.c
1410 * @dev_id: Used to differentiate devices that share
1411 * the same link layer address
1412 * @dev_port: Used to differentiate devices that share
1414 * @addr_list_lock: XXX: need comments on this one
1415 * @uc_promisc: Counter, that indicates, that promiscuous mode
1416 * has been enabled due to the need to listen to
1417 * additional unicast addresses in a device that
1418 * does not implement ndo_set_rx_mode()
1419 * @uc: unicast mac addresses
1420 * @mc: multicast mac addresses
1421 * @dev_addrs: list of device hw addresses
1422 * @queues_kset: Group of all Kobjects in the Tx and RX queues
1423 * @promiscuity: Number of times, the NIC is told to work in
1424 * Promiscuous mode, if it becomes 0 the NIC will
1425 * exit from working in Promiscuous mode
1426 * @allmulti: Counter, enables or disables allmulticast mode
1428 * @vlan_info: VLAN info
1429 * @dsa_ptr: dsa specific data
1430 * @tipc_ptr: TIPC specific data
1431 * @atalk_ptr: AppleTalk link
1432 * @ip_ptr: IPv4 specific data
1433 * @dn_ptr: DECnet specific data
1434 * @ip6_ptr: IPv6 specific data
1435 * @ax25_ptr: AX.25 specific data
1436 * @vrf_ptr: VRF specific data
1437 * @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
1439 * @last_rx: Time of last Rx
1440 * @dev_addr: Hw address (before bcast,
1441 * because most packets are unicast)
1443 * @_rx: Array of RX queues
1444 * @num_rx_queues: Number of RX queues
1445 * allocated at register_netdev() time
1446 * @real_num_rx_queues: Number of RX queues currently active in device
1448 * @rx_handler: handler for received packets
1449 * @rx_handler_data: XXX: need comments on this one
1450 * @ingress_queue: XXX: need comments on this one
1451 * @broadcast: hw bcast address
1453 * @rx_cpu_rmap: CPU reverse-mapping for RX completion interrupts,
1454 * indexed by RX queue number. Assigned by driver.
1455 * This must only be set if the ndo_rx_flow_steer
1456 * operation is defined
1457 * @index_hlist: Device index hash chain
1459 * @_tx: Array of TX queues
1460 * @num_tx_queues: Number of TX queues allocated at alloc_netdev_mq() time
1461 * @real_num_tx_queues: Number of TX queues currently active in device
1462 * @qdisc: Root qdisc from userspace point of view
1463 * @tx_queue_len: Max frames per queue allowed
1464 * @tx_global_lock: XXX: need comments on this one
1466 * @xps_maps: XXX: need comments on this one
1468 * @offload_fwd_mark: Offload device fwding mark
1470 * @trans_start: Time (in jiffies) of last Tx
1471 * @watchdog_timeo: Represents the timeout that is used by
1472 * the watchdog ( see dev_watchdog() )
1473 * @watchdog_timer: List of timers
1475 * @pcpu_refcnt: Number of references to this device
1476 * @todo_list: Delayed register/unregister
1477 * @link_watch_list: XXX: need comments on this one
1479 * @reg_state: Register/unregister state machine
1480 * @dismantle: Device is going to be freed
1481 * @rtnl_link_state: This enum represents the phases of creating
1484 * @destructor: Called from unregister,
1485 * can be used to call free_netdev
1486 * @npinfo: XXX: need comments on this one
1487 * @nd_net: Network namespace this network device is inside
1489 * @ml_priv: Mid-layer private
1490 * @lstats: Loopback statistics
1491 * @tstats: Tunnel statistics
1492 * @dstats: Dummy statistics
1493 * @vstats: Virtual ethernet statistics
1498 * @dev: Class/net/name entry
1499 * @sysfs_groups: Space for optional device, statistics and wireless
1502 * @sysfs_rx_queue_group: Space for optional per-rx queue attributes
1503 * @rtnl_link_ops: Rtnl_link_ops
1505 * @gso_max_size: Maximum size of generic segmentation offload
1506 * @gso_max_segs: Maximum number of segments that can be passed to the
1508 * @gso_min_segs: Minimum number of segments that can be passed to the
1511 * @dcbnl_ops: Data Center Bridging netlink ops
1512 * @num_tc: Number of traffic classes in the net device
1513 * @tc_to_txq: XXX: need comments on this one
1514 * @prio_tc_map XXX: need comments on this one
1516 * @fcoe_ddp_xid: Max exchange id for FCoE LRO by ddp
1518 * @priomap: XXX: need comments on this one
1519 * @phydev: Physical device may attach itself
1520 * for hardware timestamping
1522 * @qdisc_tx_busylock: XXX: need comments on this one
1524 * @proto_down: protocol port state information can be sent to the
1525 * switch driver and used to set the phys state of the
1528 * FIXME: cleanup struct net_device such that network protocol info
1533 char name[IFNAMSIZ];
1534 struct hlist_node name_hlist;
1537 * I/O specific fields
1538 * FIXME: Merge these and struct ifmap into one
1540 unsigned long mem_end;
1541 unsigned long mem_start;
1542 unsigned long base_addr;
1545 atomic_t carrier_changes;
1548 * Some hardware also needs these fields (state,dev_list,
1549 * napi_list,unreg_list,close_list) but they are not
1550 * part of the usual set specified in Space.c.
1553 unsigned long state;
1555 struct list_head dev_list;
1556 struct list_head napi_list;
1557 struct list_head unreg_list;
1558 struct list_head close_list;
1559 struct list_head ptype_all;
1560 struct list_head ptype_specific;
1563 struct list_head upper;
1564 struct list_head lower;
1568 struct list_head upper;
1569 struct list_head lower;
1572 netdev_features_t features;
1573 netdev_features_t hw_features;
1574 netdev_features_t wanted_features;
1575 netdev_features_t vlan_features;
1576 netdev_features_t hw_enc_features;
1577 netdev_features_t mpls_features;
1582 struct net_device_stats stats;
1584 atomic_long_t rx_dropped;
1585 atomic_long_t tx_dropped;
1587 #ifdef CONFIG_WIRELESS_EXT
1588 const struct iw_handler_def * wireless_handlers;
1589 struct iw_public_data * wireless_data;
1591 const struct net_device_ops *netdev_ops;
1592 const struct ethtool_ops *ethtool_ops;
1593 #ifdef CONFIG_NET_SWITCHDEV
1594 const struct switchdev_ops *switchdev_ops;
1597 const struct header_ops *header_ops;
1600 unsigned int priv_flags;
1602 unsigned short gflags;
1603 unsigned short padded;
1605 unsigned char operstate;
1606 unsigned char link_mode;
1608 unsigned char if_port;
1612 unsigned short type;
1613 unsigned short hard_header_len;
1615 unsigned short needed_headroom;
1616 unsigned short needed_tailroom;
1618 /* Interface address info. */
1619 unsigned char perm_addr[MAX_ADDR_LEN];
1620 unsigned char addr_assign_type;
1621 unsigned char addr_len;
1622 unsigned short neigh_priv_len;
1623 unsigned short dev_id;
1624 unsigned short dev_port;
1625 spinlock_t addr_list_lock;
1626 unsigned char name_assign_type;
1628 struct netdev_hw_addr_list uc;
1629 struct netdev_hw_addr_list mc;
1630 struct netdev_hw_addr_list dev_addrs;
1633 struct kset *queues_kset;
1635 unsigned int promiscuity;
1636 unsigned int allmulti;
1639 /* Protocol specific pointers */
1641 #if IS_ENABLED(CONFIG_VLAN_8021Q)
1642 struct vlan_info __rcu *vlan_info;
1644 #if IS_ENABLED(CONFIG_NET_DSA)
1645 struct dsa_switch_tree *dsa_ptr;
1647 #if IS_ENABLED(CONFIG_TIPC)
1648 struct tipc_bearer __rcu *tipc_ptr;
1651 struct in_device __rcu *ip_ptr;
1652 struct dn_dev __rcu *dn_ptr;
1653 struct inet6_dev __rcu *ip6_ptr;
1655 struct net_vrf_dev __rcu *vrf_ptr;
1656 struct wireless_dev *ieee80211_ptr;
1657 struct wpan_dev *ieee802154_ptr;
1658 #if IS_ENABLED(CONFIG_MPLS_ROUTING)
1659 struct mpls_dev __rcu *mpls_ptr;
1663 * Cache lines mostly used on receive path (including eth_type_trans())
1665 unsigned long last_rx;
1667 /* Interface address info used in eth_type_trans() */
1668 unsigned char *dev_addr;
1672 struct netdev_rx_queue *_rx;
1674 unsigned int num_rx_queues;
1675 unsigned int real_num_rx_queues;
1679 unsigned long gro_flush_timeout;
1680 rx_handler_func_t __rcu *rx_handler;
1681 void __rcu *rx_handler_data;
1683 #ifdef CONFIG_NET_CLS_ACT
1684 struct tcf_proto __rcu *ingress_cl_list;
1686 struct netdev_queue __rcu *ingress_queue;
1687 #ifdef CONFIG_NETFILTER_INGRESS
1688 struct list_head nf_hooks_ingress;
1691 unsigned char broadcast[MAX_ADDR_LEN];
1692 #ifdef CONFIG_RFS_ACCEL
1693 struct cpu_rmap *rx_cpu_rmap;
1695 struct hlist_node index_hlist;
1698 * Cache lines mostly used on transmit path
1700 struct netdev_queue *_tx ____cacheline_aligned_in_smp;
1701 unsigned int num_tx_queues;
1702 unsigned int real_num_tx_queues;
1703 struct Qdisc *qdisc;
1704 unsigned long tx_queue_len;
1705 spinlock_t tx_global_lock;
1709 struct xps_dev_maps __rcu *xps_maps;
1712 #ifdef CONFIG_NET_SWITCHDEV
1713 u32 offload_fwd_mark;
1716 /* These may be needed for future network-power-down code. */
1719 * trans_start here is expensive for high speed devices on SMP,
1720 * please use netdev_queue->trans_start instead.
1722 unsigned long trans_start;
1724 struct timer_list watchdog_timer;
1726 int __percpu *pcpu_refcnt;
1727 struct list_head todo_list;
1729 struct list_head link_watch_list;
1731 enum { NETREG_UNINITIALIZED=0,
1732 NETREG_REGISTERED, /* completed register_netdevice */
1733 NETREG_UNREGISTERING, /* called unregister_netdevice */
1734 NETREG_UNREGISTERED, /* completed unregister todo */
1735 NETREG_RELEASED, /* called free_netdev */
1736 NETREG_DUMMY, /* dummy device for NAPI poll */
1742 RTNL_LINK_INITIALIZED,
1743 RTNL_LINK_INITIALIZING,
1744 } rtnl_link_state:16;
1746 void (*destructor)(struct net_device *dev);
1748 #ifdef CONFIG_NETPOLL
1749 struct netpoll_info __rcu *npinfo;
1752 possible_net_t nd_net;
1754 /* mid-layer private */
1757 struct pcpu_lstats __percpu *lstats;
1758 struct pcpu_sw_netstats __percpu *tstats;
1759 struct pcpu_dstats __percpu *dstats;
1760 struct pcpu_vstats __percpu *vstats;
1763 struct garp_port __rcu *garp_port;
1764 struct mrp_port __rcu *mrp_port;
1767 const struct attribute_group *sysfs_groups[4];
1768 const struct attribute_group *sysfs_rx_queue_group;
1770 const struct rtnl_link_ops *rtnl_link_ops;
1772 /* for setting kernel sock attribute on TCP connection setup */
1773 #define GSO_MAX_SIZE 65536
1774 unsigned int gso_max_size;
1775 #define GSO_MAX_SEGS 65535
1779 const struct dcbnl_rtnl_ops *dcbnl_ops;
1782 struct netdev_tc_txq tc_to_txq[TC_MAX_QUEUE];
1783 u8 prio_tc_map[TC_BITMASK + 1];
1785 #if IS_ENABLED(CONFIG_FCOE)
1786 unsigned int fcoe_ddp_xid;
1788 #if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
1789 struct netprio_map __rcu *priomap;
1791 struct phy_device *phydev;
1792 struct lock_class_key *qdisc_tx_busylock;
1795 #define to_net_dev(d) container_of(d, struct net_device, dev)
1797 #define NETDEV_ALIGN 32
1800 int netdev_get_prio_tc_map(const struct net_device *dev, u32 prio)
1802 return dev->prio_tc_map[prio & TC_BITMASK];
1806 int netdev_set_prio_tc_map(struct net_device *dev, u8 prio, u8 tc)
1808 if (tc >= dev->num_tc)
1811 dev->prio_tc_map[prio & TC_BITMASK] = tc & TC_BITMASK;
1816 void netdev_reset_tc(struct net_device *dev)
1819 memset(dev->tc_to_txq, 0, sizeof(dev->tc_to_txq));
1820 memset(dev->prio_tc_map, 0, sizeof(dev->prio_tc_map));
1824 int netdev_set_tc_queue(struct net_device *dev, u8 tc, u16 count, u16 offset)
1826 if (tc >= dev->num_tc)
1829 dev->tc_to_txq[tc].count = count;
1830 dev->tc_to_txq[tc].offset = offset;
1835 int netdev_set_num_tc(struct net_device *dev, u8 num_tc)
1837 if (num_tc > TC_MAX_QUEUE)
1840 dev->num_tc = num_tc;
1845 int netdev_get_num_tc(struct net_device *dev)
1851 struct netdev_queue *netdev_get_tx_queue(const struct net_device *dev,
1854 return &dev->_tx[index];
1857 static inline struct netdev_queue *skb_get_tx_queue(const struct net_device *dev,
1858 const struct sk_buff *skb)
1860 return netdev_get_tx_queue(dev, skb_get_queue_mapping(skb));
1863 static inline void netdev_for_each_tx_queue(struct net_device *dev,
1864 void (*f)(struct net_device *,
1865 struct netdev_queue *,
1871 for (i = 0; i < dev->num_tx_queues; i++)
1872 f(dev, &dev->_tx[i], arg);
1875 struct netdev_queue *netdev_pick_tx(struct net_device *dev,
1876 struct sk_buff *skb,
1880 * Net namespace inlines
1883 struct net *dev_net(const struct net_device *dev)
1885 return read_pnet(&dev->nd_net);
1889 void dev_net_set(struct net_device *dev, struct net *net)
1891 write_pnet(&dev->nd_net, net);
1894 static inline bool netdev_uses_dsa(struct net_device *dev)
1896 #if IS_ENABLED(CONFIG_NET_DSA)
1897 if (dev->dsa_ptr != NULL)
1898 return dsa_uses_tagged_protocol(dev->dsa_ptr);
1904 * netdev_priv - access network device private data
1905 * @dev: network device
1907 * Get network device private data
1909 static inline void *netdev_priv(const struct net_device *dev)
1911 return (char *)dev + ALIGN(sizeof(struct net_device), NETDEV_ALIGN);
1914 /* Set the sysfs physical device reference for the network logical device
1915 * if set prior to registration will cause a symlink during initialization.
1917 #define SET_NETDEV_DEV(net, pdev) ((net)->dev.parent = (pdev))
1919 /* Set the sysfs device type for the network logical device to allow
1920 * fine-grained identification of different network device types. For
1921 * example Ethernet, Wirelss LAN, Bluetooth, WiMAX etc.
1923 #define SET_NETDEV_DEVTYPE(net, devtype) ((net)->dev.type = (devtype))
1925 /* Default NAPI poll() weight
1926 * Device drivers are strongly advised to not use bigger value
1928 #define NAPI_POLL_WEIGHT 64
1931 * netif_napi_add - initialize a napi context
1932 * @dev: network device
1933 * @napi: napi context
1934 * @poll: polling function
1935 * @weight: default weight
1937 * netif_napi_add() must be used to initialize a napi context prior to calling
1938 * *any* of the other napi related functions.
1940 void netif_napi_add(struct net_device *dev, struct napi_struct *napi,
1941 int (*poll)(struct napi_struct *, int), int weight);
1944 * netif_napi_del - remove a napi context
1945 * @napi: napi context
1947 * netif_napi_del() removes a napi context from the network device napi list
1949 void netif_napi_del(struct napi_struct *napi);
1951 struct napi_gro_cb {
1952 /* Virtual address of skb_shinfo(skb)->frags[0].page + offset. */
1955 /* Length of frag0. */
1956 unsigned int frag0_len;
1958 /* This indicates where we are processing relative to skb->data. */
1961 /* This is non-zero if the packet cannot be merged with the new skb. */
1964 /* Save the IP ID here and check when we get to the transport layer */
1967 /* Number of segments aggregated. */
1970 /* Start offset for remote checksum offload */
1971 u16 gro_remcsum_start;
1973 /* jiffies when first packet was created/queued */
1976 /* Used in ipv6_gro_receive() and foo-over-udp */
1979 /* This is non-zero if the packet may be of the same flow. */
1982 /* Used in udp_gro_receive */
1985 /* GRO checksum is valid */
1988 /* Number of checksums via CHECKSUM_UNNECESSARY */
1993 #define NAPI_GRO_FREE 1
1994 #define NAPI_GRO_FREE_STOLEN_HEAD 2
1996 /* Used in foo-over-udp, set in udp[46]_gro_receive */
2001 /* used to support CHECKSUM_COMPLETE for tunneling protocols */
2004 /* used in skb_gro_receive() slow path */
2005 struct sk_buff *last;
2008 #define NAPI_GRO_CB(skb) ((struct napi_gro_cb *)(skb)->cb)
2010 struct packet_type {
2011 __be16 type; /* This is really htons(ether_type). */
2012 struct net_device *dev; /* NULL is wildcarded here */
2013 int (*func) (struct sk_buff *,
2014 struct net_device *,
2015 struct packet_type *,
2016 struct net_device *);
2017 bool (*id_match)(struct packet_type *ptype,
2019 void *af_packet_priv;
2020 struct list_head list;
2023 struct offload_callbacks {
2024 struct sk_buff *(*gso_segment)(struct sk_buff *skb,
2025 netdev_features_t features);
2026 struct sk_buff **(*gro_receive)(struct sk_buff **head,
2027 struct sk_buff *skb);
2028 int (*gro_complete)(struct sk_buff *skb, int nhoff);
2031 struct packet_offload {
2032 __be16 type; /* This is really htons(ether_type). */
2034 struct offload_callbacks callbacks;
2035 struct list_head list;
2040 struct udp_offload_callbacks {
2041 struct sk_buff **(*gro_receive)(struct sk_buff **head,
2042 struct sk_buff *skb,
2043 struct udp_offload *uoff);
2044 int (*gro_complete)(struct sk_buff *skb,
2046 struct udp_offload *uoff);
2049 struct udp_offload {
2052 struct udp_offload_callbacks callbacks;
2055 /* often modified stats are per cpu, other are shared (netdev->stats) */
2056 struct pcpu_sw_netstats {
2061 struct u64_stats_sync syncp;
2064 #define netdev_alloc_pcpu_stats(type) \
2066 typeof(type) __percpu *pcpu_stats = alloc_percpu(type); \
2069 for_each_possible_cpu(__cpu) { \
2070 typeof(type) *stat; \
2071 stat = per_cpu_ptr(pcpu_stats, __cpu); \
2072 u64_stats_init(&stat->syncp); \
2078 #include <linux/notifier.h>
2080 /* netdevice notifier chain. Please remember to update the rtnetlink
2081 * notification exclusion list in rtnetlink_event() when adding new
2084 #define NETDEV_UP 0x0001 /* For now you can't veto a device up/down */
2085 #define NETDEV_DOWN 0x0002
2086 #define NETDEV_REBOOT 0x0003 /* Tell a protocol stack a network interface
2087 detected a hardware crash and restarted
2088 - we can use this eg to kick tcp sessions
2090 #define NETDEV_CHANGE 0x0004 /* Notify device state change */
2091 #define NETDEV_REGISTER 0x0005
2092 #define NETDEV_UNREGISTER 0x0006
2093 #define NETDEV_CHANGEMTU 0x0007 /* notify after mtu change happened */
2094 #define NETDEV_CHANGEADDR 0x0008
2095 #define NETDEV_GOING_DOWN 0x0009
2096 #define NETDEV_CHANGENAME 0x000A
2097 #define NETDEV_FEAT_CHANGE 0x000B
2098 #define NETDEV_BONDING_FAILOVER 0x000C
2099 #define NETDEV_PRE_UP 0x000D
2100 #define NETDEV_PRE_TYPE_CHANGE 0x000E
2101 #define NETDEV_POST_TYPE_CHANGE 0x000F
2102 #define NETDEV_POST_INIT 0x0010
2103 #define NETDEV_UNREGISTER_FINAL 0x0011
2104 #define NETDEV_RELEASE 0x0012
2105 #define NETDEV_NOTIFY_PEERS 0x0013
2106 #define NETDEV_JOIN 0x0014
2107 #define NETDEV_CHANGEUPPER 0x0015
2108 #define NETDEV_RESEND_IGMP 0x0016
2109 #define NETDEV_PRECHANGEMTU 0x0017 /* notify before mtu change happened */
2110 #define NETDEV_CHANGEINFODATA 0x0018
2111 #define NETDEV_BONDING_INFO 0x0019
2113 int register_netdevice_notifier(struct notifier_block *nb);
2114 int unregister_netdevice_notifier(struct notifier_block *nb);
2116 struct netdev_notifier_info {
2117 struct net_device *dev;
2120 struct netdev_notifier_change_info {
2121 struct netdev_notifier_info info; /* must be first */
2122 unsigned int flags_changed;
2125 struct netdev_notifier_changeupper_info {
2126 struct netdev_notifier_info info; /* must be first */
2127 struct net_device *upper_dev; /* new upper dev */
2128 bool master; /* is upper dev master */
2129 bool linking; /* is the nofication for link or unlink */
2132 static inline void netdev_notifier_info_init(struct netdev_notifier_info *info,
2133 struct net_device *dev)
2138 static inline struct net_device *
2139 netdev_notifier_info_to_dev(const struct netdev_notifier_info *info)
2144 int call_netdevice_notifiers(unsigned long val, struct net_device *dev);
2147 extern rwlock_t dev_base_lock; /* Device list lock */
2149 #define for_each_netdev(net, d) \
2150 list_for_each_entry(d, &(net)->dev_base_head, dev_list)
2151 #define for_each_netdev_reverse(net, d) \
2152 list_for_each_entry_reverse(d, &(net)->dev_base_head, dev_list)
2153 #define for_each_netdev_rcu(net, d) \
2154 list_for_each_entry_rcu(d, &(net)->dev_base_head, dev_list)
2155 #define for_each_netdev_safe(net, d, n) \
2156 list_for_each_entry_safe(d, n, &(net)->dev_base_head, dev_list)
2157 #define for_each_netdev_continue(net, d) \
2158 list_for_each_entry_continue(d, &(net)->dev_base_head, dev_list)
2159 #define for_each_netdev_continue_rcu(net, d) \
2160 list_for_each_entry_continue_rcu(d, &(net)->dev_base_head, dev_list)
2161 #define for_each_netdev_in_bond_rcu(bond, slave) \
2162 for_each_netdev_rcu(&init_net, slave) \
2163 if (netdev_master_upper_dev_get_rcu(slave) == (bond))
2164 #define net_device_entry(lh) list_entry(lh, struct net_device, dev_list)
2166 static inline struct net_device *next_net_device(struct net_device *dev)
2168 struct list_head *lh;
2172 lh = dev->dev_list.next;
2173 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2176 static inline struct net_device *next_net_device_rcu(struct net_device *dev)
2178 struct list_head *lh;
2182 lh = rcu_dereference(list_next_rcu(&dev->dev_list));
2183 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2186 static inline struct net_device *first_net_device(struct net *net)
2188 return list_empty(&net->dev_base_head) ? NULL :
2189 net_device_entry(net->dev_base_head.next);
2192 static inline struct net_device *first_net_device_rcu(struct net *net)
2194 struct list_head *lh = rcu_dereference(list_next_rcu(&net->dev_base_head));
2196 return lh == &net->dev_base_head ? NULL : net_device_entry(lh);
2199 int netdev_boot_setup_check(struct net_device *dev);
2200 unsigned long netdev_boot_base(const char *prefix, int unit);
2201 struct net_device *dev_getbyhwaddr_rcu(struct net *net, unsigned short type,
2202 const char *hwaddr);
2203 struct net_device *dev_getfirstbyhwtype(struct net *net, unsigned short type);
2204 struct net_device *__dev_getfirstbyhwtype(struct net *net, unsigned short type);
2205 void dev_add_pack(struct packet_type *pt);
2206 void dev_remove_pack(struct packet_type *pt);
2207 void __dev_remove_pack(struct packet_type *pt);
2208 void dev_add_offload(struct packet_offload *po);
2209 void dev_remove_offload(struct packet_offload *po);
2211 int dev_get_iflink(const struct net_device *dev);
2212 int dev_fill_metadata_dst(struct net_device *dev, struct sk_buff *skb);
2213 struct net_device *__dev_get_by_flags(struct net *net, unsigned short flags,
2214 unsigned short mask);
2215 struct net_device *dev_get_by_name(struct net *net, const char *name);
2216 struct net_device *dev_get_by_name_rcu(struct net *net, const char *name);
2217 struct net_device *__dev_get_by_name(struct net *net, const char *name);
2218 int dev_alloc_name(struct net_device *dev, const char *name);
2219 int dev_open(struct net_device *dev);
2220 int dev_close(struct net_device *dev);
2221 int dev_close_many(struct list_head *head, bool unlink);
2222 void dev_disable_lro(struct net_device *dev);
2223 int dev_loopback_xmit(struct sock *sk, struct sk_buff *newskb);
2224 int dev_queue_xmit_sk(struct sock *sk, struct sk_buff *skb);
2225 static inline int dev_queue_xmit(struct sk_buff *skb)
2227 return dev_queue_xmit_sk(skb->sk, skb);
2229 int dev_queue_xmit_accel(struct sk_buff *skb, void *accel_priv);
2230 int register_netdevice(struct net_device *dev);
2231 void unregister_netdevice_queue(struct net_device *dev, struct list_head *head);
2232 void unregister_netdevice_many(struct list_head *head);
2233 static inline void unregister_netdevice(struct net_device *dev)
2235 unregister_netdevice_queue(dev, NULL);
2238 int netdev_refcnt_read(const struct net_device *dev);
2239 void free_netdev(struct net_device *dev);
2240 void netdev_freemem(struct net_device *dev);
2241 void synchronize_net(void);
2242 int init_dummy_netdev(struct net_device *dev);
2244 DECLARE_PER_CPU(int, xmit_recursion);
2245 static inline int dev_recursion_level(void)
2247 return this_cpu_read(xmit_recursion);
2250 struct net_device *dev_get_by_index(struct net *net, int ifindex);
2251 struct net_device *__dev_get_by_index(struct net *net, int ifindex);
2252 struct net_device *dev_get_by_index_rcu(struct net *net, int ifindex);
2253 int netdev_get_name(struct net *net, char *name, int ifindex);
2254 int dev_restart(struct net_device *dev);
2255 int skb_gro_receive(struct sk_buff **head, struct sk_buff *skb);
2257 static inline unsigned int skb_gro_offset(const struct sk_buff *skb)
2259 return NAPI_GRO_CB(skb)->data_offset;
2262 static inline unsigned int skb_gro_len(const struct sk_buff *skb)
2264 return skb->len - NAPI_GRO_CB(skb)->data_offset;
2267 static inline void skb_gro_pull(struct sk_buff *skb, unsigned int len)
2269 NAPI_GRO_CB(skb)->data_offset += len;
2272 static inline void *skb_gro_header_fast(struct sk_buff *skb,
2273 unsigned int offset)
2275 return NAPI_GRO_CB(skb)->frag0 + offset;
2278 static inline int skb_gro_header_hard(struct sk_buff *skb, unsigned int hlen)
2280 return NAPI_GRO_CB(skb)->frag0_len < hlen;
2283 static inline void *skb_gro_header_slow(struct sk_buff *skb, unsigned int hlen,
2284 unsigned int offset)
2286 if (!pskb_may_pull(skb, hlen))
2289 NAPI_GRO_CB(skb)->frag0 = NULL;
2290 NAPI_GRO_CB(skb)->frag0_len = 0;
2291 return skb->data + offset;
2294 static inline void *skb_gro_network_header(struct sk_buff *skb)
2296 return (NAPI_GRO_CB(skb)->frag0 ?: skb->data) +
2297 skb_network_offset(skb);
2300 static inline void skb_gro_postpull_rcsum(struct sk_buff *skb,
2301 const void *start, unsigned int len)
2303 if (NAPI_GRO_CB(skb)->csum_valid)
2304 NAPI_GRO_CB(skb)->csum = csum_sub(NAPI_GRO_CB(skb)->csum,
2305 csum_partial(start, len, 0));
2308 /* GRO checksum functions. These are logical equivalents of the normal
2309 * checksum functions (in skbuff.h) except that they operate on the GRO
2310 * offsets and fields in sk_buff.
2313 __sum16 __skb_gro_checksum_complete(struct sk_buff *skb);
2315 static inline bool skb_at_gro_remcsum_start(struct sk_buff *skb)
2317 return (NAPI_GRO_CB(skb)->gro_remcsum_start == skb_gro_offset(skb));
2320 static inline bool __skb_gro_checksum_validate_needed(struct sk_buff *skb,
2324 return ((skb->ip_summed != CHECKSUM_PARTIAL ||
2325 skb_checksum_start_offset(skb) <
2326 skb_gro_offset(skb)) &&
2327 !skb_at_gro_remcsum_start(skb) &&
2328 NAPI_GRO_CB(skb)->csum_cnt == 0 &&
2329 (!zero_okay || check));
2332 static inline __sum16 __skb_gro_checksum_validate_complete(struct sk_buff *skb,
2335 if (NAPI_GRO_CB(skb)->csum_valid &&
2336 !csum_fold(csum_add(psum, NAPI_GRO_CB(skb)->csum)))
2339 NAPI_GRO_CB(skb)->csum = psum;
2341 return __skb_gro_checksum_complete(skb);
2344 static inline void skb_gro_incr_csum_unnecessary(struct sk_buff *skb)
2346 if (NAPI_GRO_CB(skb)->csum_cnt > 0) {
2347 /* Consume a checksum from CHECKSUM_UNNECESSARY */
2348 NAPI_GRO_CB(skb)->csum_cnt--;
2350 /* Update skb for CHECKSUM_UNNECESSARY and csum_level when we
2351 * verified a new top level checksum or an encapsulated one
2352 * during GRO. This saves work if we fallback to normal path.
2354 __skb_incr_checksum_unnecessary(skb);
2358 #define __skb_gro_checksum_validate(skb, proto, zero_okay, check, \
2361 __sum16 __ret = 0; \
2362 if (__skb_gro_checksum_validate_needed(skb, zero_okay, check)) \
2363 __ret = __skb_gro_checksum_validate_complete(skb, \
2364 compute_pseudo(skb, proto)); \
2366 __skb_mark_checksum_bad(skb); \
2368 skb_gro_incr_csum_unnecessary(skb); \
2372 #define skb_gro_checksum_validate(skb, proto, compute_pseudo) \
2373 __skb_gro_checksum_validate(skb, proto, false, 0, compute_pseudo)
2375 #define skb_gro_checksum_validate_zero_check(skb, proto, check, \
2377 __skb_gro_checksum_validate(skb, proto, true, check, compute_pseudo)
2379 #define skb_gro_checksum_simple_validate(skb) \
2380 __skb_gro_checksum_validate(skb, 0, false, 0, null_compute_pseudo)
2382 static inline bool __skb_gro_checksum_convert_check(struct sk_buff *skb)
2384 return (NAPI_GRO_CB(skb)->csum_cnt == 0 &&
2385 !NAPI_GRO_CB(skb)->csum_valid);
2388 static inline void __skb_gro_checksum_convert(struct sk_buff *skb,
2389 __sum16 check, __wsum pseudo)
2391 NAPI_GRO_CB(skb)->csum = ~pseudo;
2392 NAPI_GRO_CB(skb)->csum_valid = 1;
2395 #define skb_gro_checksum_try_convert(skb, proto, check, compute_pseudo) \
2397 if (__skb_gro_checksum_convert_check(skb)) \
2398 __skb_gro_checksum_convert(skb, check, \
2399 compute_pseudo(skb, proto)); \
2402 struct gro_remcsum {
2407 static inline void skb_gro_remcsum_init(struct gro_remcsum *grc)
2413 static inline void *skb_gro_remcsum_process(struct sk_buff *skb, void *ptr,
2414 unsigned int off, size_t hdrlen,
2415 int start, int offset,
2416 struct gro_remcsum *grc,
2420 size_t plen = hdrlen + max_t(size_t, offset + sizeof(u16), start);
2422 BUG_ON(!NAPI_GRO_CB(skb)->csum_valid);
2425 NAPI_GRO_CB(skb)->gro_remcsum_start = off + hdrlen + start;
2429 ptr = skb_gro_header_fast(skb, off);
2430 if (skb_gro_header_hard(skb, off + plen)) {
2431 ptr = skb_gro_header_slow(skb, off + plen, off);
2436 delta = remcsum_adjust(ptr + hdrlen, NAPI_GRO_CB(skb)->csum,
2439 /* Adjust skb->csum since we changed the packet */
2440 NAPI_GRO_CB(skb)->csum = csum_add(NAPI_GRO_CB(skb)->csum, delta);
2442 grc->offset = off + hdrlen + offset;
2448 static inline void skb_gro_remcsum_cleanup(struct sk_buff *skb,
2449 struct gro_remcsum *grc)
2452 size_t plen = grc->offset + sizeof(u16);
2457 ptr = skb_gro_header_fast(skb, grc->offset);
2458 if (skb_gro_header_hard(skb, grc->offset + sizeof(u16))) {
2459 ptr = skb_gro_header_slow(skb, plen, grc->offset);
2464 remcsum_unadjust((__sum16 *)ptr, grc->delta);
2467 static inline int dev_hard_header(struct sk_buff *skb, struct net_device *dev,
2468 unsigned short type,
2469 const void *daddr, const void *saddr,
2472 if (!dev->header_ops || !dev->header_ops->create)
2475 return dev->header_ops->create(skb, dev, type, daddr, saddr, len);
2478 static inline int dev_parse_header(const struct sk_buff *skb,
2479 unsigned char *haddr)
2481 const struct net_device *dev = skb->dev;
2483 if (!dev->header_ops || !dev->header_ops->parse)
2485 return dev->header_ops->parse(skb, haddr);
2488 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
2489 int register_gifconf(unsigned int family, gifconf_func_t *gifconf);
2490 static inline int unregister_gifconf(unsigned int family)
2492 return register_gifconf(family, NULL);
2495 #ifdef CONFIG_NET_FLOW_LIMIT
2496 #define FLOW_LIMIT_HISTORY (1 << 7) /* must be ^2 and !overflow buckets */
2497 struct sd_flow_limit {
2499 unsigned int num_buckets;
2500 unsigned int history_head;
2501 u16 history[FLOW_LIMIT_HISTORY];
2505 extern int netdev_flow_limit_table_len;
2506 #endif /* CONFIG_NET_FLOW_LIMIT */
2509 * Incoming packets are placed on per-cpu queues
2511 struct softnet_data {
2512 struct list_head poll_list;
2513 struct sk_buff_head process_queue;
2516 unsigned int processed;
2517 unsigned int time_squeeze;
2518 unsigned int cpu_collision;
2519 unsigned int received_rps;
2521 struct softnet_data *rps_ipi_list;
2523 #ifdef CONFIG_NET_FLOW_LIMIT
2524 struct sd_flow_limit __rcu *flow_limit;
2526 struct Qdisc *output_queue;
2527 struct Qdisc **output_queue_tailp;
2528 struct sk_buff *completion_queue;
2531 /* Elements below can be accessed between CPUs for RPS */
2532 struct call_single_data csd ____cacheline_aligned_in_smp;
2533 struct softnet_data *rps_ipi_next;
2535 unsigned int input_queue_head;
2536 unsigned int input_queue_tail;
2538 unsigned int dropped;
2539 struct sk_buff_head input_pkt_queue;
2540 struct napi_struct backlog;
2544 static inline void input_queue_head_incr(struct softnet_data *sd)
2547 sd->input_queue_head++;
2551 static inline void input_queue_tail_incr_save(struct softnet_data *sd,
2552 unsigned int *qtail)
2555 *qtail = ++sd->input_queue_tail;
2559 DECLARE_PER_CPU_ALIGNED(struct softnet_data, softnet_data);
2561 void __netif_schedule(struct Qdisc *q);
2562 void netif_schedule_queue(struct netdev_queue *txq);
2564 static inline void netif_tx_schedule_all(struct net_device *dev)
2568 for (i = 0; i < dev->num_tx_queues; i++)
2569 netif_schedule_queue(netdev_get_tx_queue(dev, i));
2572 static inline void netif_tx_start_queue(struct netdev_queue *dev_queue)
2574 clear_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2578 * netif_start_queue - allow transmit
2579 * @dev: network device
2581 * Allow upper layers to call the device hard_start_xmit routine.
2583 static inline void netif_start_queue(struct net_device *dev)
2585 netif_tx_start_queue(netdev_get_tx_queue(dev, 0));
2588 static inline void netif_tx_start_all_queues(struct net_device *dev)
2592 for (i = 0; i < dev->num_tx_queues; i++) {
2593 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2594 netif_tx_start_queue(txq);
2598 void netif_tx_wake_queue(struct netdev_queue *dev_queue);
2601 * netif_wake_queue - restart transmit
2602 * @dev: network device
2604 * Allow upper layers to call the device hard_start_xmit routine.
2605 * Used for flow control when transmit resources are available.
2607 static inline void netif_wake_queue(struct net_device *dev)
2609 netif_tx_wake_queue(netdev_get_tx_queue(dev, 0));
2612 static inline void netif_tx_wake_all_queues(struct net_device *dev)
2616 for (i = 0; i < dev->num_tx_queues; i++) {
2617 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
2618 netif_tx_wake_queue(txq);
2622 static inline void netif_tx_stop_queue(struct netdev_queue *dev_queue)
2624 set_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2628 * netif_stop_queue - stop transmitted packets
2629 * @dev: network device
2631 * Stop upper layers calling the device hard_start_xmit routine.
2632 * Used for flow control when transmit resources are unavailable.
2634 static inline void netif_stop_queue(struct net_device *dev)
2636 netif_tx_stop_queue(netdev_get_tx_queue(dev, 0));
2639 void netif_tx_stop_all_queues(struct net_device *dev);
2641 static inline bool netif_tx_queue_stopped(const struct netdev_queue *dev_queue)
2643 return test_bit(__QUEUE_STATE_DRV_XOFF, &dev_queue->state);
2647 * netif_queue_stopped - test if transmit queue is flowblocked
2648 * @dev: network device
2650 * Test if transmit queue on device is currently unable to send.
2652 static inline bool netif_queue_stopped(const struct net_device *dev)
2654 return netif_tx_queue_stopped(netdev_get_tx_queue(dev, 0));
2657 static inline bool netif_xmit_stopped(const struct netdev_queue *dev_queue)
2659 return dev_queue->state & QUEUE_STATE_ANY_XOFF;
2663 netif_xmit_frozen_or_stopped(const struct netdev_queue *dev_queue)
2665 return dev_queue->state & QUEUE_STATE_ANY_XOFF_OR_FROZEN;
2669 netif_xmit_frozen_or_drv_stopped(const struct netdev_queue *dev_queue)
2671 return dev_queue->state & QUEUE_STATE_DRV_XOFF_OR_FROZEN;
2675 * netdev_txq_bql_enqueue_prefetchw - prefetch bql data for write
2676 * @dev_queue: pointer to transmit queue
2678 * BQL enabled drivers might use this helper in their ndo_start_xmit(),
2679 * to give appropriate hint to the cpu.
2681 static inline void netdev_txq_bql_enqueue_prefetchw(struct netdev_queue *dev_queue)
2684 prefetchw(&dev_queue->dql.num_queued);
2689 * netdev_txq_bql_complete_prefetchw - prefetch bql data for write
2690 * @dev_queue: pointer to transmit queue
2692 * BQL enabled drivers might use this helper in their TX completion path,
2693 * to give appropriate hint to the cpu.
2695 static inline void netdev_txq_bql_complete_prefetchw(struct netdev_queue *dev_queue)
2698 prefetchw(&dev_queue->dql.limit);
2702 static inline void netdev_tx_sent_queue(struct netdev_queue *dev_queue,
2706 dql_queued(&dev_queue->dql, bytes);
2708 if (likely(dql_avail(&dev_queue->dql) >= 0))
2711 set_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
2714 * The XOFF flag must be set before checking the dql_avail below,
2715 * because in netdev_tx_completed_queue we update the dql_completed
2716 * before checking the XOFF flag.
2720 /* check again in case another CPU has just made room avail */
2721 if (unlikely(dql_avail(&dev_queue->dql) >= 0))
2722 clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state);
2727 * netdev_sent_queue - report the number of bytes queued to hardware
2728 * @dev: network device
2729 * @bytes: number of bytes queued to the hardware device queue
2731 * Report the number of bytes queued for sending/completion to the network
2732 * device hardware queue. @bytes should be a good approximation and should
2733 * exactly match netdev_completed_queue() @bytes
2735 static inline void netdev_sent_queue(struct net_device *dev, unsigned int bytes)
2737 netdev_tx_sent_queue(netdev_get_tx_queue(dev, 0), bytes);
2740 static inline void netdev_tx_completed_queue(struct netdev_queue *dev_queue,
2741 unsigned int pkts, unsigned int bytes)
2744 if (unlikely(!bytes))
2747 dql_completed(&dev_queue->dql, bytes);
2750 * Without the memory barrier there is a small possiblity that
2751 * netdev_tx_sent_queue will miss the update and cause the queue to
2752 * be stopped forever
2756 if (dql_avail(&dev_queue->dql) < 0)
2759 if (test_and_clear_bit(__QUEUE_STATE_STACK_XOFF, &dev_queue->state))
2760 netif_schedule_queue(dev_queue);
2765 * netdev_completed_queue - report bytes and packets completed by device
2766 * @dev: network device
2767 * @pkts: actual number of packets sent over the medium
2768 * @bytes: actual number of bytes sent over the medium
2770 * Report the number of bytes and packets transmitted by the network device
2771 * hardware queue over the physical medium, @bytes must exactly match the
2772 * @bytes amount passed to netdev_sent_queue()
2774 static inline void netdev_completed_queue(struct net_device *dev,
2775 unsigned int pkts, unsigned int bytes)
2777 netdev_tx_completed_queue(netdev_get_tx_queue(dev, 0), pkts, bytes);
2780 static inline void netdev_tx_reset_queue(struct netdev_queue *q)
2783 clear_bit(__QUEUE_STATE_STACK_XOFF, &q->state);
2789 * netdev_reset_queue - reset the packets and bytes count of a network device
2790 * @dev_queue: network device
2792 * Reset the bytes and packet count of a network device and clear the
2793 * software flow control OFF bit for this network device
2795 static inline void netdev_reset_queue(struct net_device *dev_queue)
2797 netdev_tx_reset_queue(netdev_get_tx_queue(dev_queue, 0));
2801 * netdev_cap_txqueue - check if selected tx queue exceeds device queues
2802 * @dev: network device
2803 * @queue_index: given tx queue index
2805 * Returns 0 if given tx queue index >= number of device tx queues,
2806 * otherwise returns the originally passed tx queue index.
2808 static inline u16 netdev_cap_txqueue(struct net_device *dev, u16 queue_index)
2810 if (unlikely(queue_index >= dev->real_num_tx_queues)) {
2811 net_warn_ratelimited("%s selects TX queue %d, but real number of TX queues is %d\n",
2812 dev->name, queue_index,
2813 dev->real_num_tx_queues);
2821 * netif_running - test if up
2822 * @dev: network device
2824 * Test if the device has been brought up.
2826 static inline bool netif_running(const struct net_device *dev)
2828 return test_bit(__LINK_STATE_START, &dev->state);
2832 * Routines to manage the subqueues on a device. We only need start
2833 * stop, and a check if it's stopped. All other device management is
2834 * done at the overall netdevice level.
2835 * Also test the device if we're multiqueue.
2839 * netif_start_subqueue - allow sending packets on subqueue
2840 * @dev: network device
2841 * @queue_index: sub queue index
2843 * Start individual transmit queue of a device with multiple transmit queues.
2845 static inline void netif_start_subqueue(struct net_device *dev, u16 queue_index)
2847 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2849 netif_tx_start_queue(txq);
2853 * netif_stop_subqueue - stop sending packets on subqueue
2854 * @dev: network device
2855 * @queue_index: sub queue index
2857 * Stop individual transmit queue of a device with multiple transmit queues.
2859 static inline void netif_stop_subqueue(struct net_device *dev, u16 queue_index)
2861 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2862 netif_tx_stop_queue(txq);
2866 * netif_subqueue_stopped - test status of subqueue
2867 * @dev: network device
2868 * @queue_index: sub queue index
2870 * Check individual transmit queue of a device with multiple transmit queues.
2872 static inline bool __netif_subqueue_stopped(const struct net_device *dev,
2875 struct netdev_queue *txq = netdev_get_tx_queue(dev, queue_index);
2877 return netif_tx_queue_stopped(txq);
2880 static inline bool netif_subqueue_stopped(const struct net_device *dev,
2881 struct sk_buff *skb)
2883 return __netif_subqueue_stopped(dev, skb_get_queue_mapping(skb));
2886 void netif_wake_subqueue(struct net_device *dev, u16 queue_index);
2889 int netif_set_xps_queue(struct net_device *dev, const struct cpumask *mask,
2892 static inline int netif_set_xps_queue(struct net_device *dev,
2893 const struct cpumask *mask,
2900 u16 __skb_tx_hash(const struct net_device *dev, struct sk_buff *skb,
2901 unsigned int num_tx_queues);
2904 * Returns a Tx hash for the given packet when dev->real_num_tx_queues is used
2905 * as a distribution range limit for the returned value.
2907 static inline u16 skb_tx_hash(const struct net_device *dev,
2908 struct sk_buff *skb)
2910 return __skb_tx_hash(dev, skb, dev->real_num_tx_queues);
2914 * netif_is_multiqueue - test if device has multiple transmit queues
2915 * @dev: network device
2917 * Check if device has multiple transmit queues
2919 static inline bool netif_is_multiqueue(const struct net_device *dev)
2921 return dev->num_tx_queues > 1;
2924 int netif_set_real_num_tx_queues(struct net_device *dev, unsigned int txq);
2927 int netif_set_real_num_rx_queues(struct net_device *dev, unsigned int rxq);
2929 static inline int netif_set_real_num_rx_queues(struct net_device *dev,
2937 static inline unsigned int get_netdev_rx_queue_index(
2938 struct netdev_rx_queue *queue)
2940 struct net_device *dev = queue->dev;
2941 int index = queue - dev->_rx;
2943 BUG_ON(index >= dev->num_rx_queues);
2948 #define DEFAULT_MAX_NUM_RSS_QUEUES (8)
2949 int netif_get_num_default_rss_queues(void);
2951 enum skb_free_reason {
2952 SKB_REASON_CONSUMED,
2956 void __dev_kfree_skb_irq(struct sk_buff *skb, enum skb_free_reason reason);
2957 void __dev_kfree_skb_any(struct sk_buff *skb, enum skb_free_reason reason);
2960 * It is not allowed to call kfree_skb() or consume_skb() from hardware
2961 * interrupt context or with hardware interrupts being disabled.
2962 * (in_irq() || irqs_disabled())
2964 * We provide four helpers that can be used in following contexts :
2966 * dev_kfree_skb_irq(skb) when caller drops a packet from irq context,
2967 * replacing kfree_skb(skb)
2969 * dev_consume_skb_irq(skb) when caller consumes a packet from irq context.
2970 * Typically used in place of consume_skb(skb) in TX completion path
2972 * dev_kfree_skb_any(skb) when caller doesn't know its current irq context,
2973 * replacing kfree_skb(skb)
2975 * dev_consume_skb_any(skb) when caller doesn't know its current irq context,
2976 * and consumed a packet. Used in place of consume_skb(skb)
2978 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
2980 __dev_kfree_skb_irq(skb, SKB_REASON_DROPPED);
2983 static inline void dev_consume_skb_irq(struct sk_buff *skb)
2985 __dev_kfree_skb_irq(skb, SKB_REASON_CONSUMED);
2988 static inline void dev_kfree_skb_any(struct sk_buff *skb)
2990 __dev_kfree_skb_any(skb, SKB_REASON_DROPPED);
2993 static inline void dev_consume_skb_any(struct sk_buff *skb)
2995 __dev_kfree_skb_any(skb, SKB_REASON_CONSUMED);
2998 int netif_rx(struct sk_buff *skb);
2999 int netif_rx_ni(struct sk_buff *skb);
3000 int netif_receive_skb_sk(struct sock *sk, struct sk_buff *skb);
3001 static inline int netif_receive_skb(struct sk_buff *skb)
3003 return netif_receive_skb_sk(skb->sk, skb);
3005 gro_result_t napi_gro_receive(struct napi_struct *napi, struct sk_buff *skb);
3006 void napi_gro_flush(struct napi_struct *napi, bool flush_old);
3007 struct sk_buff *napi_get_frags(struct napi_struct *napi);
3008 gro_result_t napi_gro_frags(struct napi_struct *napi);
3009 struct packet_offload *gro_find_receive_by_type(__be16 type);
3010 struct packet_offload *gro_find_complete_by_type(__be16 type);
3012 static inline void napi_free_frags(struct napi_struct *napi)
3014 kfree_skb(napi->skb);
3018 int netdev_rx_handler_register(struct net_device *dev,
3019 rx_handler_func_t *rx_handler,
3020 void *rx_handler_data);
3021 void netdev_rx_handler_unregister(struct net_device *dev);
3023 bool dev_valid_name(const char *name);
3024 int dev_ioctl(struct net *net, unsigned int cmd, void __user *);
3025 int dev_ethtool(struct net *net, struct ifreq *);
3026 unsigned int dev_get_flags(const struct net_device *);
3027 int __dev_change_flags(struct net_device *, unsigned int flags);
3028 int dev_change_flags(struct net_device *, unsigned int);
3029 void __dev_notify_flags(struct net_device *, unsigned int old_flags,
3030 unsigned int gchanges);
3031 int dev_change_name(struct net_device *, const char *);
3032 int dev_set_alias(struct net_device *, const char *, size_t);
3033 int dev_change_net_namespace(struct net_device *, struct net *, const char *);
3034 int dev_set_mtu(struct net_device *, int);
3035 void dev_set_group(struct net_device *, int);
3036 int dev_set_mac_address(struct net_device *, struct sockaddr *);
3037 int dev_change_carrier(struct net_device *, bool new_carrier);
3038 int dev_get_phys_port_id(struct net_device *dev,
3039 struct netdev_phys_item_id *ppid);
3040 int dev_get_phys_port_name(struct net_device *dev,
3041 char *name, size_t len);
3042 int dev_change_proto_down(struct net_device *dev, bool proto_down);
3043 struct sk_buff *validate_xmit_skb_list(struct sk_buff *skb, struct net_device *dev);
3044 struct sk_buff *dev_hard_start_xmit(struct sk_buff *skb, struct net_device *dev,
3045 struct netdev_queue *txq, int *ret);
3046 int __dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
3047 int dev_forward_skb(struct net_device *dev, struct sk_buff *skb);
3048 bool is_skb_forwardable(struct net_device *dev, struct sk_buff *skb);
3050 extern int netdev_budget;
3052 /* Called by rtnetlink.c:rtnl_unlock() */
3053 void netdev_run_todo(void);
3056 * dev_put - release reference to device
3057 * @dev: network device
3059 * Release reference to device to allow it to be freed.
3061 static inline void dev_put(struct net_device *dev)
3063 this_cpu_dec(*dev->pcpu_refcnt);
3067 * dev_hold - get reference to device
3068 * @dev: network device
3070 * Hold reference to device to keep it from being freed.
3072 static inline void dev_hold(struct net_device *dev)
3074 this_cpu_inc(*dev->pcpu_refcnt);
3077 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
3078 * and _off may be called from IRQ context, but it is caller
3079 * who is responsible for serialization of these calls.
3081 * The name carrier is inappropriate, these functions should really be
3082 * called netif_lowerlayer_*() because they represent the state of any
3083 * kind of lower layer not just hardware media.
3086 void linkwatch_init_dev(struct net_device *dev);
3087 void linkwatch_fire_event(struct net_device *dev);
3088 void linkwatch_forget_dev(struct net_device *dev);
3091 * netif_carrier_ok - test if carrier present
3092 * @dev: network device
3094 * Check if carrier is present on device
3096 static inline bool netif_carrier_ok(const struct net_device *dev)
3098 return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
3101 unsigned long dev_trans_start(struct net_device *dev);
3103 void __netdev_watchdog_up(struct net_device *dev);
3105 void netif_carrier_on(struct net_device *dev);
3107 void netif_carrier_off(struct net_device *dev);
3110 * netif_dormant_on - mark device as dormant.
3111 * @dev: network device
3113 * Mark device as dormant (as per RFC2863).
3115 * The dormant state indicates that the relevant interface is not
3116 * actually in a condition to pass packets (i.e., it is not 'up') but is
3117 * in a "pending" state, waiting for some external event. For "on-
3118 * demand" interfaces, this new state identifies the situation where the
3119 * interface is waiting for events to place it in the up state.
3122 static inline void netif_dormant_on(struct net_device *dev)
3124 if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
3125 linkwatch_fire_event(dev);
3129 * netif_dormant_off - set device as not dormant.
3130 * @dev: network device
3132 * Device is not in dormant state.
3134 static inline void netif_dormant_off(struct net_device *dev)
3136 if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
3137 linkwatch_fire_event(dev);
3141 * netif_dormant - test if carrier present
3142 * @dev: network device
3144 * Check if carrier is present on device
3146 static inline bool netif_dormant(const struct net_device *dev)
3148 return test_bit(__LINK_STATE_DORMANT, &dev->state);
3153 * netif_oper_up - test if device is operational
3154 * @dev: network device
3156 * Check if carrier is operational
3158 static inline bool netif_oper_up(const struct net_device *dev)
3160 return (dev->operstate == IF_OPER_UP ||
3161 dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
3165 * netif_device_present - is device available or removed
3166 * @dev: network device
3168 * Check if device has not been removed from system.
3170 static inline bool netif_device_present(struct net_device *dev)
3172 return test_bit(__LINK_STATE_PRESENT, &dev->state);
3175 void netif_device_detach(struct net_device *dev);
3177 void netif_device_attach(struct net_device *dev);
3180 * Network interface message level settings
3184 NETIF_MSG_DRV = 0x0001,
3185 NETIF_MSG_PROBE = 0x0002,
3186 NETIF_MSG_LINK = 0x0004,
3187 NETIF_MSG_TIMER = 0x0008,
3188 NETIF_MSG_IFDOWN = 0x0010,
3189 NETIF_MSG_IFUP = 0x0020,
3190 NETIF_MSG_RX_ERR = 0x0040,
3191 NETIF_MSG_TX_ERR = 0x0080,
3192 NETIF_MSG_TX_QUEUED = 0x0100,
3193 NETIF_MSG_INTR = 0x0200,
3194 NETIF_MSG_TX_DONE = 0x0400,
3195 NETIF_MSG_RX_STATUS = 0x0800,
3196 NETIF_MSG_PKTDATA = 0x1000,
3197 NETIF_MSG_HW = 0x2000,
3198 NETIF_MSG_WOL = 0x4000,
3201 #define netif_msg_drv(p) ((p)->msg_enable & NETIF_MSG_DRV)
3202 #define netif_msg_probe(p) ((p)->msg_enable & NETIF_MSG_PROBE)
3203 #define netif_msg_link(p) ((p)->msg_enable & NETIF_MSG_LINK)
3204 #define netif_msg_timer(p) ((p)->msg_enable & NETIF_MSG_TIMER)
3205 #define netif_msg_ifdown(p) ((p)->msg_enable & NETIF_MSG_IFDOWN)
3206 #define netif_msg_ifup(p) ((p)->msg_enable & NETIF_MSG_IFUP)
3207 #define netif_msg_rx_err(p) ((p)->msg_enable & NETIF_MSG_RX_ERR)
3208 #define netif_msg_tx_err(p) ((p)->msg_enable & NETIF_MSG_TX_ERR)
3209 #define netif_msg_tx_queued(p) ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
3210 #define netif_msg_intr(p) ((p)->msg_enable & NETIF_MSG_INTR)
3211 #define netif_msg_tx_done(p) ((p)->msg_enable & NETIF_MSG_TX_DONE)
3212 #define netif_msg_rx_status(p) ((p)->msg_enable & NETIF_MSG_RX_STATUS)
3213 #define netif_msg_pktdata(p) ((p)->msg_enable & NETIF_MSG_PKTDATA)
3214 #define netif_msg_hw(p) ((p)->msg_enable & NETIF_MSG_HW)
3215 #define netif_msg_wol(p) ((p)->msg_enable & NETIF_MSG_WOL)
3217 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
3220 if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
3221 return default_msg_enable_bits;
3222 if (debug_value == 0) /* no output */
3224 /* set low N bits */
3225 return (1 << debug_value) - 1;
3228 static inline void __netif_tx_lock(struct netdev_queue *txq, int cpu)
3230 spin_lock(&txq->_xmit_lock);
3231 txq->xmit_lock_owner = cpu;
3234 static inline void __netif_tx_lock_bh(struct netdev_queue *txq)
3236 spin_lock_bh(&txq->_xmit_lock);
3237 txq->xmit_lock_owner = smp_processor_id();
3240 static inline bool __netif_tx_trylock(struct netdev_queue *txq)
3242 bool ok = spin_trylock(&txq->_xmit_lock);
3244 txq->xmit_lock_owner = smp_processor_id();
3248 static inline void __netif_tx_unlock(struct netdev_queue *txq)
3250 txq->xmit_lock_owner = -1;
3251 spin_unlock(&txq->_xmit_lock);
3254 static inline void __netif_tx_unlock_bh(struct netdev_queue *txq)
3256 txq->xmit_lock_owner = -1;
3257 spin_unlock_bh(&txq->_xmit_lock);
3260 static inline void txq_trans_update(struct netdev_queue *txq)
3262 if (txq->xmit_lock_owner != -1)
3263 txq->trans_start = jiffies;
3267 * netif_tx_lock - grab network device transmit lock
3268 * @dev: network device
3270 * Get network device transmit lock
3272 static inline void netif_tx_lock(struct net_device *dev)
3277 spin_lock(&dev->tx_global_lock);
3278 cpu = smp_processor_id();
3279 for (i = 0; i < dev->num_tx_queues; i++) {
3280 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3282 /* We are the only thread of execution doing a
3283 * freeze, but we have to grab the _xmit_lock in
3284 * order to synchronize with threads which are in
3285 * the ->hard_start_xmit() handler and already
3286 * checked the frozen bit.
3288 __netif_tx_lock(txq, cpu);
3289 set_bit(__QUEUE_STATE_FROZEN, &txq->state);
3290 __netif_tx_unlock(txq);
3294 static inline void netif_tx_lock_bh(struct net_device *dev)
3300 static inline void netif_tx_unlock(struct net_device *dev)
3304 for (i = 0; i < dev->num_tx_queues; i++) {
3305 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3307 /* No need to grab the _xmit_lock here. If the
3308 * queue is not stopped for another reason, we
3311 clear_bit(__QUEUE_STATE_FROZEN, &txq->state);
3312 netif_schedule_queue(txq);
3314 spin_unlock(&dev->tx_global_lock);
3317 static inline void netif_tx_unlock_bh(struct net_device *dev)
3319 netif_tx_unlock(dev);
3323 #define HARD_TX_LOCK(dev, txq, cpu) { \
3324 if ((dev->features & NETIF_F_LLTX) == 0) { \
3325 __netif_tx_lock(txq, cpu); \
3329 #define HARD_TX_TRYLOCK(dev, txq) \
3330 (((dev->features & NETIF_F_LLTX) == 0) ? \
3331 __netif_tx_trylock(txq) : \
3334 #define HARD_TX_UNLOCK(dev, txq) { \
3335 if ((dev->features & NETIF_F_LLTX) == 0) { \
3336 __netif_tx_unlock(txq); \
3340 static inline void netif_tx_disable(struct net_device *dev)
3346 cpu = smp_processor_id();
3347 for (i = 0; i < dev->num_tx_queues; i++) {
3348 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
3350 __netif_tx_lock(txq, cpu);
3351 netif_tx_stop_queue(txq);
3352 __netif_tx_unlock(txq);
3357 static inline void netif_addr_lock(struct net_device *dev)
3359 spin_lock(&dev->addr_list_lock);
3362 static inline void netif_addr_lock_nested(struct net_device *dev)
3364 int subclass = SINGLE_DEPTH_NESTING;
3366 if (dev->netdev_ops->ndo_get_lock_subclass)
3367 subclass = dev->netdev_ops->ndo_get_lock_subclass(dev);
3369 spin_lock_nested(&dev->addr_list_lock, subclass);
3372 static inline void netif_addr_lock_bh(struct net_device *dev)
3374 spin_lock_bh(&dev->addr_list_lock);
3377 static inline void netif_addr_unlock(struct net_device *dev)
3379 spin_unlock(&dev->addr_list_lock);
3382 static inline void netif_addr_unlock_bh(struct net_device *dev)
3384 spin_unlock_bh(&dev->addr_list_lock);
3388 * dev_addrs walker. Should be used only for read access. Call with
3389 * rcu_read_lock held.
3391 #define for_each_dev_addr(dev, ha) \
3392 list_for_each_entry_rcu(ha, &dev->dev_addrs.list, list)
3394 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
3396 void ether_setup(struct net_device *dev);
3398 /* Support for loadable net-drivers */
3399 struct net_device *alloc_netdev_mqs(int sizeof_priv, const char *name,
3400 unsigned char name_assign_type,
3401 void (*setup)(struct net_device *),
3402 unsigned int txqs, unsigned int rxqs);
3403 #define alloc_netdev(sizeof_priv, name, name_assign_type, setup) \
3404 alloc_netdev_mqs(sizeof_priv, name, name_assign_type, setup, 1, 1)
3406 #define alloc_netdev_mq(sizeof_priv, name, name_assign_type, setup, count) \
3407 alloc_netdev_mqs(sizeof_priv, name, name_assign_type, setup, count, \
3410 int register_netdev(struct net_device *dev);
3411 void unregister_netdev(struct net_device *dev);
3413 /* General hardware address lists handling functions */
3414 int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
3415 struct netdev_hw_addr_list *from_list, int addr_len);
3416 void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
3417 struct netdev_hw_addr_list *from_list, int addr_len);
3418 int __hw_addr_sync_dev(struct netdev_hw_addr_list *list,
3419 struct net_device *dev,
3420 int (*sync)(struct net_device *, const unsigned char *),
3421 int (*unsync)(struct net_device *,
3422 const unsigned char *));
3423 void __hw_addr_unsync_dev(struct netdev_hw_addr_list *list,
3424 struct net_device *dev,
3425 int (*unsync)(struct net_device *,
3426 const unsigned char *));
3427 void __hw_addr_init(struct netdev_hw_addr_list *list);
3429 /* Functions used for device addresses handling */
3430 int dev_addr_add(struct net_device *dev, const unsigned char *addr,
3431 unsigned char addr_type);
3432 int dev_addr_del(struct net_device *dev, const unsigned char *addr,
3433 unsigned char addr_type);
3434 void dev_addr_flush(struct net_device *dev);
3435 int dev_addr_init(struct net_device *dev);
3437 /* Functions used for unicast addresses handling */
3438 int dev_uc_add(struct net_device *dev, const unsigned char *addr);
3439 int dev_uc_add_excl(struct net_device *dev, const unsigned char *addr);
3440 int dev_uc_del(struct net_device *dev, const unsigned char *addr);
3441 int dev_uc_sync(struct net_device *to, struct net_device *from);
3442 int dev_uc_sync_multiple(struct net_device *to, struct net_device *from);
3443 void dev_uc_unsync(struct net_device *to, struct net_device *from);
3444 void dev_uc_flush(struct net_device *dev);
3445 void dev_uc_init(struct net_device *dev);
3448 * __dev_uc_sync - Synchonize device's unicast list
3449 * @dev: device to sync
3450 * @sync: function to call if address should be added
3451 * @unsync: function to call if address should be removed
3453 * Add newly added addresses to the interface, and release
3454 * addresses that have been deleted.
3456 static inline int __dev_uc_sync(struct net_device *dev,
3457 int (*sync)(struct net_device *,
3458 const unsigned char *),
3459 int (*unsync)(struct net_device *,
3460 const unsigned char *))
3462 return __hw_addr_sync_dev(&dev->uc, dev, sync, unsync);
3466 * __dev_uc_unsync - Remove synchronized addresses from device
3467 * @dev: device to sync
3468 * @unsync: function to call if address should be removed
3470 * Remove all addresses that were added to the device by dev_uc_sync().
3472 static inline void __dev_uc_unsync(struct net_device *dev,
3473 int (*unsync)(struct net_device *,
3474 const unsigned char *))
3476 __hw_addr_unsync_dev(&dev->uc, dev, unsync);
3479 /* Functions used for multicast addresses handling */
3480 int dev_mc_add(struct net_device *dev, const unsigned char *addr);
3481 int dev_mc_add_global(struct net_device *dev, const unsigned char *addr);
3482 int dev_mc_add_excl(struct net_device *dev, const unsigned char *addr);
3483 int dev_mc_del(struct net_device *dev, const unsigned char *addr);
3484 int dev_mc_del_global(struct net_device *dev, const unsigned char *addr);
3485 int dev_mc_sync(struct net_device *to, struct net_device *from);
3486 int dev_mc_sync_multiple(struct net_device *to, struct net_device *from);
3487 void dev_mc_unsync(struct net_device *to, struct net_device *from);
3488 void dev_mc_flush(struct net_device *dev);
3489 void dev_mc_init(struct net_device *dev);
3492 * __dev_mc_sync - Synchonize device's multicast list
3493 * @dev: device to sync
3494 * @sync: function to call if address should be added
3495 * @unsync: function to call if address should be removed
3497 * Add newly added addresses to the interface, and release
3498 * addresses that have been deleted.
3500 static inline int __dev_mc_sync(struct net_device *dev,
3501 int (*sync)(struct net_device *,
3502 const unsigned char *),
3503 int (*unsync)(struct net_device *,
3504 const unsigned char *))
3506 return __hw_addr_sync_dev(&dev->mc, dev, sync, unsync);
3510 * __dev_mc_unsync - Remove synchronized addresses from device
3511 * @dev: device to sync
3512 * @unsync: function to call if address should be removed
3514 * Remove all addresses that were added to the device by dev_mc_sync().
3516 static inline void __dev_mc_unsync(struct net_device *dev,
3517 int (*unsync)(struct net_device *,
3518 const unsigned char *))
3520 __hw_addr_unsync_dev(&dev->mc, dev, unsync);
3523 /* Functions used for secondary unicast and multicast support */
3524 void dev_set_rx_mode(struct net_device *dev);
3525 void __dev_set_rx_mode(struct net_device *dev);
3526 int dev_set_promiscuity(struct net_device *dev, int inc);
3527 int dev_set_allmulti(struct net_device *dev, int inc);
3528 void netdev_state_change(struct net_device *dev);
3529 void netdev_notify_peers(struct net_device *dev);
3530 void netdev_features_change(struct net_device *dev);
3531 /* Load a device via the kmod */
3532 void dev_load(struct net *net, const char *name);
3533 struct rtnl_link_stats64 *dev_get_stats(struct net_device *dev,
3534 struct rtnl_link_stats64 *storage);
3535 void netdev_stats_to_stats64(struct rtnl_link_stats64 *stats64,
3536 const struct net_device_stats *netdev_stats);
3538 extern int netdev_max_backlog;
3539 extern int netdev_tstamp_prequeue;
3540 extern int weight_p;
3541 extern int bpf_jit_enable;
3543 bool netdev_has_upper_dev(struct net_device *dev, struct net_device *upper_dev);
3544 struct net_device *netdev_upper_get_next_dev_rcu(struct net_device *dev,
3545 struct list_head **iter);
3546 struct net_device *netdev_all_upper_get_next_dev_rcu(struct net_device *dev,
3547 struct list_head **iter);
3549 /* iterate through upper list, must be called under RCU read lock */
3550 #define netdev_for_each_upper_dev_rcu(dev, updev, iter) \
3551 for (iter = &(dev)->adj_list.upper, \
3552 updev = netdev_upper_get_next_dev_rcu(dev, &(iter)); \
3554 updev = netdev_upper_get_next_dev_rcu(dev, &(iter)))
3556 /* iterate through upper list, must be called under RCU read lock */
3557 #define netdev_for_each_all_upper_dev_rcu(dev, updev, iter) \
3558 for (iter = &(dev)->all_adj_list.upper, \
3559 updev = netdev_all_upper_get_next_dev_rcu(dev, &(iter)); \
3561 updev = netdev_all_upper_get_next_dev_rcu(dev, &(iter)))
3563 void *netdev_lower_get_next_private(struct net_device *dev,
3564 struct list_head **iter);
3565 void *netdev_lower_get_next_private_rcu(struct net_device *dev,
3566 struct list_head **iter);
3568 #define netdev_for_each_lower_private(dev, priv, iter) \
3569 for (iter = (dev)->adj_list.lower.next, \
3570 priv = netdev_lower_get_next_private(dev, &(iter)); \
3572 priv = netdev_lower_get_next_private(dev, &(iter)))
3574 #define netdev_for_each_lower_private_rcu(dev, priv, iter) \
3575 for (iter = &(dev)->adj_list.lower, \
3576 priv = netdev_lower_get_next_private_rcu(dev, &(iter)); \
3578 priv = netdev_lower_get_next_private_rcu(dev, &(iter)))
3580 void *netdev_lower_get_next(struct net_device *dev,
3581 struct list_head **iter);
3582 #define netdev_for_each_lower_dev(dev, ldev, iter) \
3583 for (iter = &(dev)->adj_list.lower, \
3584 ldev = netdev_lower_get_next(dev, &(iter)); \
3586 ldev = netdev_lower_get_next(dev, &(iter)))
3588 void *netdev_adjacent_get_private(struct list_head *adj_list);
3589 void *netdev_lower_get_first_private_rcu(struct net_device *dev);
3590 struct net_device *netdev_master_upper_dev_get(struct net_device *dev);
3591 struct net_device *netdev_master_upper_dev_get_rcu(struct net_device *dev);
3592 int netdev_upper_dev_link(struct net_device *dev, struct net_device *upper_dev);
3593 int netdev_master_upper_dev_link(struct net_device *dev,
3594 struct net_device *upper_dev);
3595 int netdev_master_upper_dev_link_private(struct net_device *dev,
3596 struct net_device *upper_dev,
3598 void netdev_upper_dev_unlink(struct net_device *dev,
3599 struct net_device *upper_dev);
3600 void netdev_adjacent_rename_links(struct net_device *dev, char *oldname);
3601 void *netdev_lower_dev_get_private(struct net_device *dev,
3602 struct net_device *lower_dev);
3604 /* RSS keys are 40 or 52 bytes long */
3605 #define NETDEV_RSS_KEY_LEN 52
3606 extern u8 netdev_rss_key[NETDEV_RSS_KEY_LEN];
3607 void netdev_rss_key_fill(void *buffer, size_t len);
3609 int dev_get_nest_level(struct net_device *dev,
3610 bool (*type_check)(struct net_device *dev));
3611 int skb_checksum_help(struct sk_buff *skb);
3612 struct sk_buff *__skb_gso_segment(struct sk_buff *skb,
3613 netdev_features_t features, bool tx_path);
3614 struct sk_buff *skb_mac_gso_segment(struct sk_buff *skb,
3615 netdev_features_t features);
3617 struct netdev_bonding_info {
3622 struct netdev_notifier_bonding_info {
3623 struct netdev_notifier_info info; /* must be first */
3624 struct netdev_bonding_info bonding_info;
3627 void netdev_bonding_info_change(struct net_device *dev,
3628 struct netdev_bonding_info *bonding_info);
3631 struct sk_buff *skb_gso_segment(struct sk_buff *skb, netdev_features_t features)
3633 return __skb_gso_segment(skb, features, true);
3635 __be16 skb_network_protocol(struct sk_buff *skb, int *depth);
3637 static inline bool can_checksum_protocol(netdev_features_t features,
3640 return ((features & NETIF_F_GEN_CSUM) ||
3641 ((features & NETIF_F_V4_CSUM) &&
3642 protocol == htons(ETH_P_IP)) ||
3643 ((features & NETIF_F_V6_CSUM) &&
3644 protocol == htons(ETH_P_IPV6)) ||
3645 ((features & NETIF_F_FCOE_CRC) &&
3646 protocol == htons(ETH_P_FCOE)));
3650 void netdev_rx_csum_fault(struct net_device *dev);
3652 static inline void netdev_rx_csum_fault(struct net_device *dev)
3656 /* rx skb timestamps */
3657 void net_enable_timestamp(void);
3658 void net_disable_timestamp(void);
3660 #ifdef CONFIG_PROC_FS
3661 int __init dev_proc_init(void);
3663 #define dev_proc_init() 0
3666 static inline netdev_tx_t __netdev_start_xmit(const struct net_device_ops *ops,
3667 struct sk_buff *skb, struct net_device *dev,
3670 skb->xmit_more = more ? 1 : 0;
3671 return ops->ndo_start_xmit(skb, dev);
3674 static inline netdev_tx_t netdev_start_xmit(struct sk_buff *skb, struct net_device *dev,
3675 struct netdev_queue *txq, bool more)
3677 const struct net_device_ops *ops = dev->netdev_ops;
3680 rc = __netdev_start_xmit(ops, skb, dev, more);
3681 if (rc == NETDEV_TX_OK)
3682 txq_trans_update(txq);
3687 int netdev_class_create_file_ns(struct class_attribute *class_attr,
3689 void netdev_class_remove_file_ns(struct class_attribute *class_attr,
3692 static inline int netdev_class_create_file(struct class_attribute *class_attr)
3694 return netdev_class_create_file_ns(class_attr, NULL);
3697 static inline void netdev_class_remove_file(struct class_attribute *class_attr)
3699 netdev_class_remove_file_ns(class_attr, NULL);
3702 extern struct kobj_ns_type_operations net_ns_type_operations;
3704 const char *netdev_drivername(const struct net_device *dev);
3706 void linkwatch_run_queue(void);
3708 static inline netdev_features_t netdev_intersect_features(netdev_features_t f1,
3709 netdev_features_t f2)
3711 if (f1 & NETIF_F_GEN_CSUM)
3712 f1 |= (NETIF_F_ALL_CSUM & ~NETIF_F_GEN_CSUM);
3713 if (f2 & NETIF_F_GEN_CSUM)
3714 f2 |= (NETIF_F_ALL_CSUM & ~NETIF_F_GEN_CSUM);
3716 if (f1 & NETIF_F_GEN_CSUM)
3717 f1 &= ~(NETIF_F_ALL_CSUM & ~NETIF_F_GEN_CSUM);
3722 static inline netdev_features_t netdev_get_wanted_features(
3723 struct net_device *dev)
3725 return (dev->features & ~dev->hw_features) | dev->wanted_features;
3727 netdev_features_t netdev_increment_features(netdev_features_t all,
3728 netdev_features_t one, netdev_features_t mask);
3730 /* Allow TSO being used on stacked device :
3731 * Performing the GSO segmentation before last device
3732 * is a performance improvement.
3734 static inline netdev_features_t netdev_add_tso_features(netdev_features_t features,
3735 netdev_features_t mask)
3737 return netdev_increment_features(features, NETIF_F_ALL_TSO, mask);
3740 int __netdev_update_features(struct net_device *dev);
3741 void netdev_update_features(struct net_device *dev);
3742 void netdev_change_features(struct net_device *dev);
3744 void netif_stacked_transfer_operstate(const struct net_device *rootdev,
3745 struct net_device *dev);
3747 netdev_features_t passthru_features_check(struct sk_buff *skb,
3748 struct net_device *dev,
3749 netdev_features_t features);
3750 netdev_features_t netif_skb_features(struct sk_buff *skb);
3752 static inline bool net_gso_ok(netdev_features_t features, int gso_type)
3754 netdev_features_t feature = gso_type << NETIF_F_GSO_SHIFT;
3756 /* check flags correspondence */
3757 BUILD_BUG_ON(SKB_GSO_TCPV4 != (NETIF_F_TSO >> NETIF_F_GSO_SHIFT));
3758 BUILD_BUG_ON(SKB_GSO_UDP != (NETIF_F_UFO >> NETIF_F_GSO_SHIFT));
3759 BUILD_BUG_ON(SKB_GSO_DODGY != (NETIF_F_GSO_ROBUST >> NETIF_F_GSO_SHIFT));
3760 BUILD_BUG_ON(SKB_GSO_TCP_ECN != (NETIF_F_TSO_ECN >> NETIF_F_GSO_SHIFT));
3761 BUILD_BUG_ON(SKB_GSO_TCPV6 != (NETIF_F_TSO6 >> NETIF_F_GSO_SHIFT));
3762 BUILD_BUG_ON(SKB_GSO_FCOE != (NETIF_F_FSO >> NETIF_F_GSO_SHIFT));
3763 BUILD_BUG_ON(SKB_GSO_GRE != (NETIF_F_GSO_GRE >> NETIF_F_GSO_SHIFT));
3764 BUILD_BUG_ON(SKB_GSO_GRE_CSUM != (NETIF_F_GSO_GRE_CSUM >> NETIF_F_GSO_SHIFT));
3765 BUILD_BUG_ON(SKB_GSO_IPIP != (NETIF_F_GSO_IPIP >> NETIF_F_GSO_SHIFT));
3766 BUILD_BUG_ON(SKB_GSO_SIT != (NETIF_F_GSO_SIT >> NETIF_F_GSO_SHIFT));
3767 BUILD_BUG_ON(SKB_GSO_UDP_TUNNEL != (NETIF_F_GSO_UDP_TUNNEL >> NETIF_F_GSO_SHIFT));
3768 BUILD_BUG_ON(SKB_GSO_UDP_TUNNEL_CSUM != (NETIF_F_GSO_UDP_TUNNEL_CSUM >> NETIF_F_GSO_SHIFT));
3769 BUILD_BUG_ON(SKB_GSO_TUNNEL_REMCSUM != (NETIF_F_GSO_TUNNEL_REMCSUM >> NETIF_F_GSO_SHIFT));
3771 return (features & feature) == feature;
3774 static inline bool skb_gso_ok(struct sk_buff *skb, netdev_features_t features)
3776 return net_gso_ok(features, skb_shinfo(skb)->gso_type) &&
3777 (!skb_has_frag_list(skb) || (features & NETIF_F_FRAGLIST));
3780 static inline bool netif_needs_gso(struct sk_buff *skb,
3781 netdev_features_t features)
3783 return skb_is_gso(skb) && (!skb_gso_ok(skb, features) ||
3784 unlikely((skb->ip_summed != CHECKSUM_PARTIAL) &&
3785 (skb->ip_summed != CHECKSUM_UNNECESSARY)));
3788 static inline void netif_set_gso_max_size(struct net_device *dev,
3791 dev->gso_max_size = size;
3794 static inline void skb_gso_error_unwind(struct sk_buff *skb, __be16 protocol,
3795 int pulled_hlen, u16 mac_offset,
3798 skb->protocol = protocol;
3799 skb->encapsulation = 1;
3800 skb_push(skb, pulled_hlen);
3801 skb_reset_transport_header(skb);
3802 skb->mac_header = mac_offset;
3803 skb->network_header = skb->mac_header + mac_len;
3804 skb->mac_len = mac_len;
3807 static inline bool netif_is_macvlan(struct net_device *dev)
3809 return dev->priv_flags & IFF_MACVLAN;
3812 static inline bool netif_is_macvlan_port(struct net_device *dev)
3814 return dev->priv_flags & IFF_MACVLAN_PORT;
3817 static inline bool netif_is_ipvlan(struct net_device *dev)
3819 return dev->priv_flags & IFF_IPVLAN_SLAVE;
3822 static inline bool netif_is_ipvlan_port(struct net_device *dev)
3824 return dev->priv_flags & IFF_IPVLAN_MASTER;
3827 static inline bool netif_is_bond_master(struct net_device *dev)
3829 return dev->flags & IFF_MASTER && dev->priv_flags & IFF_BONDING;
3832 static inline bool netif_is_bond_slave(struct net_device *dev)
3834 return dev->flags & IFF_SLAVE && dev->priv_flags & IFF_BONDING;
3837 static inline bool netif_supports_nofcs(struct net_device *dev)
3839 return dev->priv_flags & IFF_SUPP_NOFCS;
3842 static inline bool netif_is_vrf(const struct net_device *dev)
3844 return dev->priv_flags & IFF_VRF_MASTER;
3847 static inline bool netif_is_bridge_master(const struct net_device *dev)
3849 return dev->priv_flags & IFF_EBRIDGE;
3852 static inline bool netif_is_ovs_master(const struct net_device *dev)
3854 return dev->priv_flags & IFF_OPENVSWITCH;
3857 static inline bool netif_index_is_vrf(struct net *net, int ifindex)
3861 #if IS_ENABLED(CONFIG_NET_VRF)
3862 struct net_device *dev;
3869 dev = dev_get_by_index_rcu(net, ifindex);
3871 rc = netif_is_vrf(dev);
3878 /* This device needs to keep skb dst for qdisc enqueue or ndo_start_xmit() */
3879 static inline void netif_keep_dst(struct net_device *dev)
3881 dev->priv_flags &= ~(IFF_XMIT_DST_RELEASE | IFF_XMIT_DST_RELEASE_PERM);
3884 extern struct pernet_operations __net_initdata loopback_net_ops;
3886 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3888 /* netdev_printk helpers, similar to dev_printk */
3890 static inline const char *netdev_name(const struct net_device *dev)
3892 if (!dev->name[0] || strchr(dev->name, '%'))
3893 return "(unnamed net_device)";
3897 static inline const char *netdev_reg_state(const struct net_device *dev)
3899 switch (dev->reg_state) {
3900 case NETREG_UNINITIALIZED: return " (uninitialized)";
3901 case NETREG_REGISTERED: return "";
3902 case NETREG_UNREGISTERING: return " (unregistering)";
3903 case NETREG_UNREGISTERED: return " (unregistered)";
3904 case NETREG_RELEASED: return " (released)";
3905 case NETREG_DUMMY: return " (dummy)";
3908 WARN_ONCE(1, "%s: unknown reg_state %d\n", dev->name, dev->reg_state);
3909 return " (unknown)";
3913 void netdev_printk(const char *level, const struct net_device *dev,
3914 const char *format, ...);
3916 void netdev_emerg(const struct net_device *dev, const char *format, ...);
3918 void netdev_alert(const struct net_device *dev, const char *format, ...);
3920 void netdev_crit(const struct net_device *dev, const char *format, ...);
3922 void netdev_err(const struct net_device *dev, const char *format, ...);
3924 void netdev_warn(const struct net_device *dev, const char *format, ...);
3926 void netdev_notice(const struct net_device *dev, const char *format, ...);
3928 void netdev_info(const struct net_device *dev, const char *format, ...);
3930 #define MODULE_ALIAS_NETDEV(device) \
3931 MODULE_ALIAS("netdev-" device)
3933 #if defined(CONFIG_DYNAMIC_DEBUG)
3934 #define netdev_dbg(__dev, format, args...) \
3936 dynamic_netdev_dbg(__dev, format, ##args); \
3938 #elif defined(DEBUG)
3939 #define netdev_dbg(__dev, format, args...) \
3940 netdev_printk(KERN_DEBUG, __dev, format, ##args)
3942 #define netdev_dbg(__dev, format, args...) \
3945 netdev_printk(KERN_DEBUG, __dev, format, ##args); \
3949 #if defined(VERBOSE_DEBUG)
3950 #define netdev_vdbg netdev_dbg
3953 #define netdev_vdbg(dev, format, args...) \
3956 netdev_printk(KERN_DEBUG, dev, format, ##args); \
3962 * netdev_WARN() acts like dev_printk(), but with the key difference
3963 * of using a WARN/WARN_ON to get the message out, including the
3964 * file/line information and a backtrace.
3966 #define netdev_WARN(dev, format, args...) \
3967 WARN(1, "netdevice: %s%s\n" format, netdev_name(dev), \
3968 netdev_reg_state(dev), ##args)
3970 /* netif printk helpers, similar to netdev_printk */
3972 #define netif_printk(priv, type, level, dev, fmt, args...) \
3974 if (netif_msg_##type(priv)) \
3975 netdev_printk(level, (dev), fmt, ##args); \
3978 #define netif_level(level, priv, type, dev, fmt, args...) \
3980 if (netif_msg_##type(priv)) \
3981 netdev_##level(dev, fmt, ##args); \
3984 #define netif_emerg(priv, type, dev, fmt, args...) \
3985 netif_level(emerg, priv, type, dev, fmt, ##args)
3986 #define netif_alert(priv, type, dev, fmt, args...) \
3987 netif_level(alert, priv, type, dev, fmt, ##args)
3988 #define netif_crit(priv, type, dev, fmt, args...) \
3989 netif_level(crit, priv, type, dev, fmt, ##args)
3990 #define netif_err(priv, type, dev, fmt, args...) \
3991 netif_level(err, priv, type, dev, fmt, ##args)
3992 #define netif_warn(priv, type, dev, fmt, args...) \
3993 netif_level(warn, priv, type, dev, fmt, ##args)
3994 #define netif_notice(priv, type, dev, fmt, args...) \
3995 netif_level(notice, priv, type, dev, fmt, ##args)
3996 #define netif_info(priv, type, dev, fmt, args...) \
3997 netif_level(info, priv, type, dev, fmt, ##args)
3999 #if defined(CONFIG_DYNAMIC_DEBUG)
4000 #define netif_dbg(priv, type, netdev, format, args...) \
4002 if (netif_msg_##type(priv)) \
4003 dynamic_netdev_dbg(netdev, format, ##args); \
4005 #elif defined(DEBUG)
4006 #define netif_dbg(priv, type, dev, format, args...) \
4007 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args)
4009 #define netif_dbg(priv, type, dev, format, args...) \
4012 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
4017 #if defined(VERBOSE_DEBUG)
4018 #define netif_vdbg netif_dbg
4020 #define netif_vdbg(priv, type, dev, format, args...) \
4023 netif_printk(priv, type, KERN_DEBUG, dev, format, ##args); \
4029 * The list of packet types we will receive (as opposed to discard)
4030 * and the routines to invoke.
4032 * Why 16. Because with 16 the only overlap we get on a hash of the
4033 * low nibble of the protocol value is RARP/SNAP/X.25.
4035 * NOTE: That is no longer true with the addition of VLAN tags. Not
4036 * sure which should go first, but I bet it won't make much
4037 * difference if we are running VLANs. The good news is that
4038 * this protocol won't be in the list unless compiled in, so
4039 * the average user (w/out VLANs) will not be adversely affected.
4055 #define PTYPE_HASH_SIZE (16)
4056 #define PTYPE_HASH_MASK (PTYPE_HASH_SIZE - 1)
4058 #endif /* _LINUX_NETDEVICE_H */