xref: /linux-6.15/include/linux/netdevice.h (revision 606d099c)
1 /*
2  * INET		An implementation of the TCP/IP protocol suite for the LINUX
3  *		operating system.  INET is implemented using the  BSD Socket
4  *		interface as the means of communication with the user level.
5  *
6  *		Definitions for the Interfaces handler.
7  *
8  * Version:	@(#)dev.h	1.0.10	08/12/93
9  *
10  * Authors:	Ross Biro
11  *		Fred N. van Kempen, <[email protected]>
12  *		Corey Minyard <[email protected]>
13  *		Donald J. Becker, <[email protected]>
14  *		Alan Cox, <[email protected]>
15  *		Bjorn Ekwall. <[email protected]>
16  *              Pekka Riikonen <[email protected]>
17  *
18  *		This program is free software; you can redistribute it and/or
19  *		modify it under the terms of the GNU General Public License
20  *		as published by the Free Software Foundation; either version
21  *		2 of the License, or (at your option) any later version.
22  *
23  *		Moved to /usr/include/linux for NET3
24  */
25 #ifndef _LINUX_NETDEVICE_H
26 #define _LINUX_NETDEVICE_H
27 
28 #include <linux/if.h>
29 #include <linux/if_ether.h>
30 #include <linux/if_packet.h>
31 
32 #ifdef __KERNEL__
33 #include <linux/timer.h>
34 #include <asm/atomic.h>
35 #include <asm/cache.h>
36 #include <asm/byteorder.h>
37 
38 #include <linux/device.h>
39 #include <linux/percpu.h>
40 #include <linux/dmaengine.h>
41 
42 struct vlan_group;
43 struct ethtool_ops;
44 struct netpoll_info;
45 					/* source back-compat hooks */
46 #define SET_ETHTOOL_OPS(netdev,ops) \
47 	( (netdev)->ethtool_ops = (ops) )
48 
49 #define HAVE_ALLOC_NETDEV		/* feature macro: alloc_xxxdev
50 					   functions are available. */
51 #define HAVE_FREE_NETDEV		/* free_netdev() */
52 #define HAVE_NETDEV_PRIV		/* netdev_priv() */
53 
54 #define NET_XMIT_SUCCESS	0
55 #define NET_XMIT_DROP		1	/* skb dropped			*/
56 #define NET_XMIT_CN		2	/* congestion notification	*/
57 #define NET_XMIT_POLICED	3	/* skb is shot by police	*/
58 #define NET_XMIT_BYPASS		4	/* packet does not leave via dequeue;
59 					   (TC use only - dev_queue_xmit
60 					   returns this as NET_XMIT_SUCCESS) */
61 
62 /* Backlog congestion levels */
63 #define NET_RX_SUCCESS		0   /* keep 'em coming, baby */
64 #define NET_RX_DROP		1  /* packet dropped */
65 #define NET_RX_CN_LOW		2   /* storm alert, just in case */
66 #define NET_RX_CN_MOD		3   /* Storm on its way! */
67 #define NET_RX_CN_HIGH		4   /* The storm is here */
68 #define NET_RX_BAD		5  /* packet dropped due to kernel error */
69 
70 /* NET_XMIT_CN is special. It does not guarantee that this packet is lost. It
71  * indicates that the device will soon be dropping packets, or already drops
72  * some packets of the same priority; prompting us to send less aggressively. */
73 #define net_xmit_eval(e)	((e) == NET_XMIT_CN? 0 : (e))
74 #define net_xmit_errno(e)	((e) != NET_XMIT_CN ? -ENOBUFS : 0)
75 
76 #endif
77 
78 #define MAX_ADDR_LEN	32		/* Largest hardware address length */
79 
80 /* Driver transmit return codes */
81 #define NETDEV_TX_OK 0		/* driver took care of packet */
82 #define NETDEV_TX_BUSY 1	/* driver tx path was busy*/
83 #define NETDEV_TX_LOCKED -1	/* driver tx lock was already taken */
84 
85 /*
86  *	Compute the worst case header length according to the protocols
87  *	used.
88  */
89 
90 #if !defined(CONFIG_AX25) && !defined(CONFIG_AX25_MODULE) && !defined(CONFIG_TR)
91 #define LL_MAX_HEADER	32
92 #else
93 #if defined(CONFIG_AX25) || defined(CONFIG_AX25_MODULE)
94 #define LL_MAX_HEADER	96
95 #else
96 #define LL_MAX_HEADER	48
97 #endif
98 #endif
99 
100 #if !defined(CONFIG_NET_IPIP) && !defined(CONFIG_NET_IPIP_MODULE) && \
101     !defined(CONFIG_NET_IPGRE) &&  !defined(CONFIG_NET_IPGRE_MODULE) && \
102     !defined(CONFIG_IPV6_SIT) && !defined(CONFIG_IPV6_SIT_MODULE) && \
103     !defined(CONFIG_IPV6_TUNNEL) && !defined(CONFIG_IPV6_TUNNEL_MODULE)
104 #define MAX_HEADER LL_MAX_HEADER
105 #else
106 #define MAX_HEADER (LL_MAX_HEADER + 48)
107 #endif
108 
109 /*
110  *	Network device statistics. Akin to the 2.0 ether stats but
111  *	with byte counters.
112  */
113 
114 struct net_device_stats
115 {
116 	unsigned long	rx_packets;		/* total packets received	*/
117 	unsigned long	tx_packets;		/* total packets transmitted	*/
118 	unsigned long	rx_bytes;		/* total bytes received 	*/
119 	unsigned long	tx_bytes;		/* total bytes transmitted	*/
120 	unsigned long	rx_errors;		/* bad packets received		*/
121 	unsigned long	tx_errors;		/* packet transmit problems	*/
122 	unsigned long	rx_dropped;		/* no space in linux buffers	*/
123 	unsigned long	tx_dropped;		/* no space available in linux	*/
124 	unsigned long	multicast;		/* multicast packets received	*/
125 	unsigned long	collisions;
126 
127 	/* detailed rx_errors: */
128 	unsigned long	rx_length_errors;
129 	unsigned long	rx_over_errors;		/* receiver ring buff overflow	*/
130 	unsigned long	rx_crc_errors;		/* recved pkt with crc error	*/
131 	unsigned long	rx_frame_errors;	/* recv'd frame alignment error */
132 	unsigned long	rx_fifo_errors;		/* recv'r fifo overrun		*/
133 	unsigned long	rx_missed_errors;	/* receiver missed packet	*/
134 
135 	/* detailed tx_errors */
136 	unsigned long	tx_aborted_errors;
137 	unsigned long	tx_carrier_errors;
138 	unsigned long	tx_fifo_errors;
139 	unsigned long	tx_heartbeat_errors;
140 	unsigned long	tx_window_errors;
141 
142 	/* for cslip etc */
143 	unsigned long	rx_compressed;
144 	unsigned long	tx_compressed;
145 };
146 
147 
148 /* Media selection options. */
149 enum {
150         IF_PORT_UNKNOWN = 0,
151         IF_PORT_10BASE2,
152         IF_PORT_10BASET,
153         IF_PORT_AUI,
154         IF_PORT_100BASET,
155         IF_PORT_100BASETX,
156         IF_PORT_100BASEFX
157 };
158 
159 #ifdef __KERNEL__
160 
161 #include <linux/cache.h>
162 #include <linux/skbuff.h>
163 
164 struct neighbour;
165 struct neigh_parms;
166 struct sk_buff;
167 
168 struct netif_rx_stats
169 {
170 	unsigned total;
171 	unsigned dropped;
172 	unsigned time_squeeze;
173 	unsigned cpu_collision;
174 };
175 
176 DECLARE_PER_CPU(struct netif_rx_stats, netdev_rx_stat);
177 
178 
179 /*
180  *	We tag multicasts with these structures.
181  */
182 
183 struct dev_mc_list
184 {
185 	struct dev_mc_list	*next;
186 	__u8			dmi_addr[MAX_ADDR_LEN];
187 	unsigned char		dmi_addrlen;
188 	int			dmi_users;
189 	int			dmi_gusers;
190 };
191 
192 struct hh_cache
193 {
194 	struct hh_cache *hh_next;	/* Next entry			     */
195 	atomic_t	hh_refcnt;	/* number of users                   */
196 	__be16		hh_type;	/* protocol identifier, f.e ETH_P_IP
197                                          *  NOTE:  For VLANs, this will be the
198                                          *  encapuslated type. --BLG
199                                          */
200 	u16		hh_len;		/* length of header */
201 	int		(*hh_output)(struct sk_buff *skb);
202 	rwlock_t	hh_lock;
203 
204 	/* cached hardware header; allow for machine alignment needs.        */
205 #define HH_DATA_MOD	16
206 #define HH_DATA_OFF(__len) \
207 	(HH_DATA_MOD - (((__len - 1) & (HH_DATA_MOD - 1)) + 1))
208 #define HH_DATA_ALIGN(__len) \
209 	(((__len)+(HH_DATA_MOD-1))&~(HH_DATA_MOD - 1))
210 	unsigned long	hh_data[HH_DATA_ALIGN(LL_MAX_HEADER) / sizeof(long)];
211 };
212 
213 /* Reserve HH_DATA_MOD byte aligned hard_header_len, but at least that much.
214  * Alternative is:
215  *   dev->hard_header_len ? (dev->hard_header_len +
216  *                           (HH_DATA_MOD - 1)) & ~(HH_DATA_MOD - 1) : 0
217  *
218  * We could use other alignment values, but we must maintain the
219  * relationship HH alignment <= LL alignment.
220  */
221 #define LL_RESERVED_SPACE(dev) \
222 	(((dev)->hard_header_len&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
223 #define LL_RESERVED_SPACE_EXTRA(dev,extra) \
224 	((((dev)->hard_header_len+extra)&~(HH_DATA_MOD - 1)) + HH_DATA_MOD)
225 
226 /* These flag bits are private to the generic network queueing
227  * layer, they may not be explicitly referenced by any other
228  * code.
229  */
230 
231 enum netdev_state_t
232 {
233 	__LINK_STATE_XOFF=0,
234 	__LINK_STATE_START,
235 	__LINK_STATE_PRESENT,
236 	__LINK_STATE_SCHED,
237 	__LINK_STATE_NOCARRIER,
238 	__LINK_STATE_RX_SCHED,
239 	__LINK_STATE_LINKWATCH_PENDING,
240 	__LINK_STATE_DORMANT,
241 	__LINK_STATE_QDISC_RUNNING,
242 };
243 
244 
245 /*
246  * This structure holds at boot time configured netdevice settings. They
247  * are then used in the device probing.
248  */
249 struct netdev_boot_setup {
250 	char name[IFNAMSIZ];
251 	struct ifmap map;
252 };
253 #define NETDEV_BOOT_SETUP_MAX 8
254 
255 extern int __init netdev_boot_setup(char *str);
256 
257 /*
258  *	The DEVICE structure.
259  *	Actually, this whole structure is a big mistake.  It mixes I/O
260  *	data with strictly "high-level" data, and it has to know about
261  *	almost every data structure used in the INET module.
262  *
263  *	FIXME: cleanup struct net_device such that network protocol info
264  *	moves out.
265  */
266 
267 struct net_device
268 {
269 
270 	/*
271 	 * This is the first field of the "visible" part of this structure
272 	 * (i.e. as seen by users in the "Space.c" file).  It is the name
273 	 * the interface.
274 	 */
275 	char			name[IFNAMSIZ];
276 	/* device name hash chain */
277 	struct hlist_node	name_hlist;
278 
279 	/*
280 	 *	I/O specific fields
281 	 *	FIXME: Merge these and struct ifmap into one
282 	 */
283 	unsigned long		mem_end;	/* shared mem end	*/
284 	unsigned long		mem_start;	/* shared mem start	*/
285 	unsigned long		base_addr;	/* device I/O address	*/
286 	unsigned int		irq;		/* device IRQ number	*/
287 
288 	/*
289 	 *	Some hardware also needs these fields, but they are not
290 	 *	part of the usual set specified in Space.c.
291 	 */
292 
293 	unsigned char		if_port;	/* Selectable AUI, TP,..*/
294 	unsigned char		dma;		/* DMA channel		*/
295 
296 	unsigned long		state;
297 
298 	struct net_device	*next;
299 
300 	/* The device initialization function. Called only once. */
301 	int			(*init)(struct net_device *dev);
302 
303 	/* ------- Fields preinitialized in Space.c finish here ------- */
304 
305 	/* Net device features */
306 	unsigned long		features;
307 #define NETIF_F_SG		1	/* Scatter/gather IO. */
308 #define NETIF_F_IP_CSUM		2	/* Can checksum only TCP/UDP over IPv4. */
309 #define NETIF_F_NO_CSUM		4	/* Does not require checksum. F.e. loopack. */
310 #define NETIF_F_HW_CSUM		8	/* Can checksum all the packets. */
311 #define NETIF_F_HIGHDMA		32	/* Can DMA to high memory. */
312 #define NETIF_F_FRAGLIST	64	/* Scatter/gather IO. */
313 #define NETIF_F_HW_VLAN_TX	128	/* Transmit VLAN hw acceleration */
314 #define NETIF_F_HW_VLAN_RX	256	/* Receive VLAN hw acceleration */
315 #define NETIF_F_HW_VLAN_FILTER	512	/* Receive filtering on VLAN */
316 #define NETIF_F_VLAN_CHALLENGED	1024	/* Device cannot handle VLAN packets */
317 #define NETIF_F_GSO		2048	/* Enable software GSO. */
318 #define NETIF_F_LLTX		4096	/* LockLess TX */
319 
320 	/* Segmentation offload features */
321 #define NETIF_F_GSO_SHIFT	16
322 #define NETIF_F_GSO_MASK	0xffff0000
323 #define NETIF_F_TSO		(SKB_GSO_TCPV4 << NETIF_F_GSO_SHIFT)
324 #define NETIF_F_UFO		(SKB_GSO_UDP << NETIF_F_GSO_SHIFT)
325 #define NETIF_F_GSO_ROBUST	(SKB_GSO_DODGY << NETIF_F_GSO_SHIFT)
326 #define NETIF_F_TSO_ECN		(SKB_GSO_TCP_ECN << NETIF_F_GSO_SHIFT)
327 #define NETIF_F_TSO6		(SKB_GSO_TCPV6 << NETIF_F_GSO_SHIFT)
328 
329 	/* List of features with software fallbacks. */
330 #define NETIF_F_GSO_SOFTWARE	(NETIF_F_TSO | NETIF_F_TSO_ECN | NETIF_F_TSO6)
331 
332 #define NETIF_F_GEN_CSUM	(NETIF_F_NO_CSUM | NETIF_F_HW_CSUM)
333 #define NETIF_F_ALL_CSUM	(NETIF_F_IP_CSUM | NETIF_F_GEN_CSUM)
334 
335 	struct net_device	*next_sched;
336 
337 	/* Interface index. Unique device identifier	*/
338 	int			ifindex;
339 	int			iflink;
340 
341 
342 	struct net_device_stats* (*get_stats)(struct net_device *dev);
343 
344 	/* List of functions to handle Wireless Extensions (instead of ioctl).
345 	 * See <net/iw_handler.h> for details. Jean II */
346 	const struct iw_handler_def *	wireless_handlers;
347 	/* Instance data managed by the core of Wireless Extensions. */
348 	struct iw_public_data *	wireless_data;
349 
350 	const struct ethtool_ops *ethtool_ops;
351 
352 	/*
353 	 * This marks the end of the "visible" part of the structure. All
354 	 * fields hereafter are internal to the system, and may change at
355 	 * will (read: may be cleaned up at will).
356 	 */
357 
358 
359 	unsigned int		flags;	/* interface flags (a la BSD)	*/
360 	unsigned short		gflags;
361         unsigned short          priv_flags; /* Like 'flags' but invisible to userspace. */
362 	unsigned short		padded;	/* How much padding added by alloc_netdev() */
363 
364 	unsigned char		operstate; /* RFC2863 operstate */
365 	unsigned char		link_mode; /* mapping policy to operstate */
366 
367 	unsigned		mtu;	/* interface MTU value		*/
368 	unsigned short		type;	/* interface hardware type	*/
369 	unsigned short		hard_header_len;	/* hardware hdr length	*/
370 
371 	struct net_device	*master; /* Pointer to master device of a group,
372 					  * which this device is member of.
373 					  */
374 
375 	/* Interface address info. */
376 	unsigned char		perm_addr[MAX_ADDR_LEN]; /* permanent hw address */
377 	unsigned char		addr_len;	/* hardware address length	*/
378 	unsigned short          dev_id;		/* for shared network cards */
379 
380 	struct dev_mc_list	*mc_list;	/* Multicast mac addresses	*/
381 	int			mc_count;	/* Number of installed mcasts	*/
382 	int			promiscuity;
383 	int			allmulti;
384 
385 
386 	/* Protocol specific pointers */
387 
388 	void 			*atalk_ptr;	/* AppleTalk link 	*/
389 	void			*ip_ptr;	/* IPv4 specific data	*/
390 	void                    *dn_ptr;        /* DECnet specific data */
391 	void                    *ip6_ptr;       /* IPv6 specific data */
392 	void			*ec_ptr;	/* Econet specific data	*/
393 	void			*ax25_ptr;	/* AX.25 specific data */
394 
395 /*
396  * Cache line mostly used on receive path (including eth_type_trans())
397  */
398 	struct list_head	poll_list ____cacheline_aligned_in_smp;
399 					/* Link to poll list	*/
400 
401 	int			(*poll) (struct net_device *dev, int *quota);
402 	int			quota;
403 	int			weight;
404 	unsigned long		last_rx;	/* Time of last Rx	*/
405 	/* Interface address info used in eth_type_trans() */
406 	unsigned char		dev_addr[MAX_ADDR_LEN];	/* hw address, (before bcast
407 							because most packets are unicast) */
408 
409 	unsigned char		broadcast[MAX_ADDR_LEN];	/* hw bcast add	*/
410 
411 /*
412  * Cache line mostly used on queue transmit path (qdisc)
413  */
414 	/* device queue lock */
415 	spinlock_t		queue_lock ____cacheline_aligned_in_smp;
416 	struct Qdisc		*qdisc;
417 	struct Qdisc		*qdisc_sleeping;
418 	struct list_head	qdisc_list;
419 	unsigned long		tx_queue_len;	/* Max frames per queue allowed */
420 
421 	/* Partially transmitted GSO packet. */
422 	struct sk_buff		*gso_skb;
423 
424 	/* ingress path synchronizer */
425 	spinlock_t		ingress_lock;
426 	struct Qdisc		*qdisc_ingress;
427 
428 /*
429  * One part is mostly used on xmit path (device)
430  */
431 	/* hard_start_xmit synchronizer */
432 	spinlock_t		_xmit_lock ____cacheline_aligned_in_smp;
433 	/* cpu id of processor entered to hard_start_xmit or -1,
434 	   if nobody entered there.
435 	 */
436 	int			xmit_lock_owner;
437 	void			*priv;	/* pointer to private data	*/
438 	int			(*hard_start_xmit) (struct sk_buff *skb,
439 						    struct net_device *dev);
440 	/* These may be needed for future network-power-down code. */
441 	unsigned long		trans_start;	/* Time (in jiffies) of last Tx	*/
442 
443 	int			watchdog_timeo; /* used by dev_watchdog() */
444 	struct timer_list	watchdog_timer;
445 
446 /*
447  * refcnt is a very hot point, so align it on SMP
448  */
449 	/* Number of references to this device */
450 	atomic_t		refcnt ____cacheline_aligned_in_smp;
451 
452 	/* delayed register/unregister */
453 	struct list_head	todo_list;
454 	/* device index hash chain */
455 	struct hlist_node	index_hlist;
456 
457 	/* register/unregister state machine */
458 	enum { NETREG_UNINITIALIZED=0,
459 	       NETREG_REGISTERED,	/* completed register_netdevice */
460 	       NETREG_UNREGISTERING,	/* called unregister_netdevice */
461 	       NETREG_UNREGISTERED,	/* completed unregister todo */
462 	       NETREG_RELEASED,		/* called free_netdev */
463 	} reg_state;
464 
465 	/* Called after device is detached from network. */
466 	void			(*uninit)(struct net_device *dev);
467 	/* Called after last user reference disappears. */
468 	void			(*destructor)(struct net_device *dev);
469 
470 	/* Pointers to interface service routines.	*/
471 	int			(*open)(struct net_device *dev);
472 	int			(*stop)(struct net_device *dev);
473 #define HAVE_NETDEV_POLL
474 	int			(*hard_header) (struct sk_buff *skb,
475 						struct net_device *dev,
476 						unsigned short type,
477 						void *daddr,
478 						void *saddr,
479 						unsigned len);
480 	int			(*rebuild_header)(struct sk_buff *skb);
481 #define HAVE_MULTICAST
482 	void			(*set_multicast_list)(struct net_device *dev);
483 #define HAVE_SET_MAC_ADDR
484 	int			(*set_mac_address)(struct net_device *dev,
485 						   void *addr);
486 #define HAVE_PRIVATE_IOCTL
487 	int			(*do_ioctl)(struct net_device *dev,
488 					    struct ifreq *ifr, int cmd);
489 #define HAVE_SET_CONFIG
490 	int			(*set_config)(struct net_device *dev,
491 					      struct ifmap *map);
492 #define HAVE_HEADER_CACHE
493 	int			(*hard_header_cache)(struct neighbour *neigh,
494 						     struct hh_cache *hh);
495 	void			(*header_cache_update)(struct hh_cache *hh,
496 						       struct net_device *dev,
497 						       unsigned char *  haddr);
498 #define HAVE_CHANGE_MTU
499 	int			(*change_mtu)(struct net_device *dev, int new_mtu);
500 
501 #define HAVE_TX_TIMEOUT
502 	void			(*tx_timeout) (struct net_device *dev);
503 
504 	void			(*vlan_rx_register)(struct net_device *dev,
505 						    struct vlan_group *grp);
506 	void			(*vlan_rx_add_vid)(struct net_device *dev,
507 						   unsigned short vid);
508 	void			(*vlan_rx_kill_vid)(struct net_device *dev,
509 						    unsigned short vid);
510 
511 	int			(*hard_header_parse)(struct sk_buff *skb,
512 						     unsigned char *haddr);
513 	int			(*neigh_setup)(struct net_device *dev, struct neigh_parms *);
514 #ifdef CONFIG_NETPOLL
515 	struct netpoll_info	*npinfo;
516 #endif
517 #ifdef CONFIG_NET_POLL_CONTROLLER
518 	void                    (*poll_controller)(struct net_device *dev);
519 #endif
520 
521 	/* bridge stuff */
522 	struct net_bridge_port	*br_port;
523 
524 	/* class/net/name entry */
525 	struct class_device	class_dev;
526 	/* space for optional statistics and wireless sysfs groups */
527 	struct attribute_group  *sysfs_groups[3];
528 };
529 
530 #define	NETDEV_ALIGN		32
531 #define	NETDEV_ALIGN_CONST	(NETDEV_ALIGN - 1)
532 
533 static inline void *netdev_priv(struct net_device *dev)
534 {
535 	return (char *)dev + ((sizeof(struct net_device)
536 					+ NETDEV_ALIGN_CONST)
537 				& ~NETDEV_ALIGN_CONST);
538 }
539 
540 #define SET_MODULE_OWNER(dev) do { } while (0)
541 /* Set the sysfs physical device reference for the network logical device
542  * if set prior to registration will cause a symlink during initialization.
543  */
544 #define SET_NETDEV_DEV(net, pdev)	((net)->class_dev.dev = (pdev))
545 
546 struct packet_type {
547 	__be16			type;	/* This is really htons(ether_type). */
548 	struct net_device	*dev;	/* NULL is wildcarded here	     */
549 	int			(*func) (struct sk_buff *,
550 					 struct net_device *,
551 					 struct packet_type *,
552 					 struct net_device *);
553 	struct sk_buff		*(*gso_segment)(struct sk_buff *skb,
554 						int features);
555 	int			(*gso_send_check)(struct sk_buff *skb);
556 	void			*af_packet_priv;
557 	struct list_head	list;
558 };
559 
560 #include <linux/interrupt.h>
561 #include <linux/notifier.h>
562 
563 extern struct net_device		loopback_dev;		/* The loopback */
564 extern struct net_device		*dev_base;		/* All devices */
565 extern rwlock_t				dev_base_lock;		/* Device list lock */
566 
567 extern int 			netdev_boot_setup_check(struct net_device *dev);
568 extern unsigned long		netdev_boot_base(const char *prefix, int unit);
569 extern struct net_device    *dev_getbyhwaddr(unsigned short type, char *hwaddr);
570 extern struct net_device *dev_getfirstbyhwtype(unsigned short type);
571 extern void		dev_add_pack(struct packet_type *pt);
572 extern void		dev_remove_pack(struct packet_type *pt);
573 extern void		__dev_remove_pack(struct packet_type *pt);
574 
575 extern struct net_device	*dev_get_by_flags(unsigned short flags,
576 						  unsigned short mask);
577 extern struct net_device	*dev_get_by_name(const char *name);
578 extern struct net_device	*__dev_get_by_name(const char *name);
579 extern int		dev_alloc_name(struct net_device *dev, const char *name);
580 extern int		dev_open(struct net_device *dev);
581 extern int		dev_close(struct net_device *dev);
582 extern int		dev_queue_xmit(struct sk_buff *skb);
583 extern int		register_netdevice(struct net_device *dev);
584 extern int		unregister_netdevice(struct net_device *dev);
585 extern void		free_netdev(struct net_device *dev);
586 extern void		synchronize_net(void);
587 extern int 		register_netdevice_notifier(struct notifier_block *nb);
588 extern int		unregister_netdevice_notifier(struct notifier_block *nb);
589 extern int		call_netdevice_notifiers(unsigned long val, void *v);
590 extern struct net_device	*dev_get_by_index(int ifindex);
591 extern struct net_device	*__dev_get_by_index(int ifindex);
592 extern int		dev_restart(struct net_device *dev);
593 #ifdef CONFIG_NETPOLL_TRAP
594 extern int		netpoll_trap(void);
595 #endif
596 
597 typedef int gifconf_func_t(struct net_device * dev, char __user * bufptr, int len);
598 extern int		register_gifconf(unsigned int family, gifconf_func_t * gifconf);
599 static inline int unregister_gifconf(unsigned int family)
600 {
601 	return register_gifconf(family, NULL);
602 }
603 
604 /*
605  * Incoming packets are placed on per-cpu queues so that
606  * no locking is needed.
607  */
608 
609 struct softnet_data
610 {
611 	struct net_device	*output_queue;
612 	struct sk_buff_head	input_pkt_queue;
613 	struct list_head	poll_list;
614 	struct sk_buff		*completion_queue;
615 
616 	struct net_device	backlog_dev;	/* Sorry. 8) */
617 #ifdef CONFIG_NET_DMA
618 	struct dma_chan		*net_dma;
619 #endif
620 };
621 
622 DECLARE_PER_CPU(struct softnet_data,softnet_data);
623 
624 #define HAVE_NETIF_QUEUE
625 
626 extern void __netif_schedule(struct net_device *dev);
627 
628 static inline void netif_schedule(struct net_device *dev)
629 {
630 	if (!test_bit(__LINK_STATE_XOFF, &dev->state))
631 		__netif_schedule(dev);
632 }
633 
634 static inline void netif_start_queue(struct net_device *dev)
635 {
636 	clear_bit(__LINK_STATE_XOFF, &dev->state);
637 }
638 
639 static inline void netif_wake_queue(struct net_device *dev)
640 {
641 #ifdef CONFIG_NETPOLL_TRAP
642 	if (netpoll_trap())
643 		return;
644 #endif
645 	if (test_and_clear_bit(__LINK_STATE_XOFF, &dev->state))
646 		__netif_schedule(dev);
647 }
648 
649 static inline void netif_stop_queue(struct net_device *dev)
650 {
651 #ifdef CONFIG_NETPOLL_TRAP
652 	if (netpoll_trap())
653 		return;
654 #endif
655 	set_bit(__LINK_STATE_XOFF, &dev->state);
656 }
657 
658 static inline int netif_queue_stopped(const struct net_device *dev)
659 {
660 	return test_bit(__LINK_STATE_XOFF, &dev->state);
661 }
662 
663 static inline int netif_running(const struct net_device *dev)
664 {
665 	return test_bit(__LINK_STATE_START, &dev->state);
666 }
667 
668 
669 /* Use this variant when it is known for sure that it
670  * is executing from interrupt context.
671  */
672 static inline void dev_kfree_skb_irq(struct sk_buff *skb)
673 {
674 	if (atomic_dec_and_test(&skb->users)) {
675 		struct softnet_data *sd;
676 		unsigned long flags;
677 
678 		local_irq_save(flags);
679 		sd = &__get_cpu_var(softnet_data);
680 		skb->next = sd->completion_queue;
681 		sd->completion_queue = skb;
682 		raise_softirq_irqoff(NET_TX_SOFTIRQ);
683 		local_irq_restore(flags);
684 	}
685 }
686 
687 /* Use this variant in places where it could be invoked
688  * either from interrupt or non-interrupt context.
689  */
690 extern void dev_kfree_skb_any(struct sk_buff *skb);
691 
692 #define HAVE_NETIF_RX 1
693 extern int		netif_rx(struct sk_buff *skb);
694 extern int		netif_rx_ni(struct sk_buff *skb);
695 #define HAVE_NETIF_RECEIVE_SKB 1
696 extern int		netif_receive_skb(struct sk_buff *skb);
697 extern int		dev_valid_name(const char *name);
698 extern int		dev_ioctl(unsigned int cmd, void __user *);
699 extern int		dev_ethtool(struct ifreq *);
700 extern unsigned		dev_get_flags(const struct net_device *);
701 extern int		dev_change_flags(struct net_device *, unsigned);
702 extern int		dev_change_name(struct net_device *, char *);
703 extern int		dev_set_mtu(struct net_device *, int);
704 extern int		dev_set_mac_address(struct net_device *,
705 					    struct sockaddr *);
706 extern int		dev_hard_start_xmit(struct sk_buff *skb,
707 					    struct net_device *dev);
708 
709 extern void		dev_init(void);
710 
711 extern int		netdev_budget;
712 
713 /* Called by rtnetlink.c:rtnl_unlock() */
714 extern void netdev_run_todo(void);
715 
716 static inline void dev_put(struct net_device *dev)
717 {
718 	atomic_dec(&dev->refcnt);
719 }
720 
721 static inline void dev_hold(struct net_device *dev)
722 {
723 	atomic_inc(&dev->refcnt);
724 }
725 
726 /* Carrier loss detection, dial on demand. The functions netif_carrier_on
727  * and _off may be called from IRQ context, but it is caller
728  * who is responsible for serialization of these calls.
729  *
730  * The name carrier is inappropriate, these functions should really be
731  * called netif_lowerlayer_*() because they represent the state of any
732  * kind of lower layer not just hardware media.
733  */
734 
735 extern void linkwatch_fire_event(struct net_device *dev);
736 
737 static inline int netif_carrier_ok(const struct net_device *dev)
738 {
739 	return !test_bit(__LINK_STATE_NOCARRIER, &dev->state);
740 }
741 
742 extern void __netdev_watchdog_up(struct net_device *dev);
743 
744 extern void netif_carrier_on(struct net_device *dev);
745 
746 extern void netif_carrier_off(struct net_device *dev);
747 
748 static inline void netif_dormant_on(struct net_device *dev)
749 {
750 	if (!test_and_set_bit(__LINK_STATE_DORMANT, &dev->state))
751 		linkwatch_fire_event(dev);
752 }
753 
754 static inline void netif_dormant_off(struct net_device *dev)
755 {
756 	if (test_and_clear_bit(__LINK_STATE_DORMANT, &dev->state))
757 		linkwatch_fire_event(dev);
758 }
759 
760 static inline int netif_dormant(const struct net_device *dev)
761 {
762 	return test_bit(__LINK_STATE_DORMANT, &dev->state);
763 }
764 
765 
766 static inline int netif_oper_up(const struct net_device *dev) {
767 	return (dev->operstate == IF_OPER_UP ||
768 		dev->operstate == IF_OPER_UNKNOWN /* backward compat */);
769 }
770 
771 /* Hot-plugging. */
772 static inline int netif_device_present(struct net_device *dev)
773 {
774 	return test_bit(__LINK_STATE_PRESENT, &dev->state);
775 }
776 
777 extern void netif_device_detach(struct net_device *dev);
778 
779 extern void netif_device_attach(struct net_device *dev);
780 
781 /*
782  * Network interface message level settings
783  */
784 #define HAVE_NETIF_MSG 1
785 
786 enum {
787 	NETIF_MSG_DRV		= 0x0001,
788 	NETIF_MSG_PROBE		= 0x0002,
789 	NETIF_MSG_LINK		= 0x0004,
790 	NETIF_MSG_TIMER		= 0x0008,
791 	NETIF_MSG_IFDOWN	= 0x0010,
792 	NETIF_MSG_IFUP		= 0x0020,
793 	NETIF_MSG_RX_ERR	= 0x0040,
794 	NETIF_MSG_TX_ERR	= 0x0080,
795 	NETIF_MSG_TX_QUEUED	= 0x0100,
796 	NETIF_MSG_INTR		= 0x0200,
797 	NETIF_MSG_TX_DONE	= 0x0400,
798 	NETIF_MSG_RX_STATUS	= 0x0800,
799 	NETIF_MSG_PKTDATA	= 0x1000,
800 	NETIF_MSG_HW		= 0x2000,
801 	NETIF_MSG_WOL		= 0x4000,
802 };
803 
804 #define netif_msg_drv(p)	((p)->msg_enable & NETIF_MSG_DRV)
805 #define netif_msg_probe(p)	((p)->msg_enable & NETIF_MSG_PROBE)
806 #define netif_msg_link(p)	((p)->msg_enable & NETIF_MSG_LINK)
807 #define netif_msg_timer(p)	((p)->msg_enable & NETIF_MSG_TIMER)
808 #define netif_msg_ifdown(p)	((p)->msg_enable & NETIF_MSG_IFDOWN)
809 #define netif_msg_ifup(p)	((p)->msg_enable & NETIF_MSG_IFUP)
810 #define netif_msg_rx_err(p)	((p)->msg_enable & NETIF_MSG_RX_ERR)
811 #define netif_msg_tx_err(p)	((p)->msg_enable & NETIF_MSG_TX_ERR)
812 #define netif_msg_tx_queued(p)	((p)->msg_enable & NETIF_MSG_TX_QUEUED)
813 #define netif_msg_intr(p)	((p)->msg_enable & NETIF_MSG_INTR)
814 #define netif_msg_tx_done(p)	((p)->msg_enable & NETIF_MSG_TX_DONE)
815 #define netif_msg_rx_status(p)	((p)->msg_enable & NETIF_MSG_RX_STATUS)
816 #define netif_msg_pktdata(p)	((p)->msg_enable & NETIF_MSG_PKTDATA)
817 #define netif_msg_hw(p)		((p)->msg_enable & NETIF_MSG_HW)
818 #define netif_msg_wol(p)	((p)->msg_enable & NETIF_MSG_WOL)
819 
820 static inline u32 netif_msg_init(int debug_value, int default_msg_enable_bits)
821 {
822 	/* use default */
823 	if (debug_value < 0 || debug_value >= (sizeof(u32) * 8))
824 		return default_msg_enable_bits;
825 	if (debug_value == 0)	/* no output */
826 		return 0;
827 	/* set low N bits */
828 	return (1 << debug_value) - 1;
829 }
830 
831 /* Test if receive needs to be scheduled */
832 static inline int __netif_rx_schedule_prep(struct net_device *dev)
833 {
834 	return !test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state);
835 }
836 
837 /* Test if receive needs to be scheduled but only if up */
838 static inline int netif_rx_schedule_prep(struct net_device *dev)
839 {
840 	return netif_running(dev) && __netif_rx_schedule_prep(dev);
841 }
842 
843 /* Add interface to tail of rx poll list. This assumes that _prep has
844  * already been called and returned 1.
845  */
846 
847 extern void __netif_rx_schedule(struct net_device *dev);
848 
849 /* Try to reschedule poll. Called by irq handler. */
850 
851 static inline void netif_rx_schedule(struct net_device *dev)
852 {
853 	if (netif_rx_schedule_prep(dev))
854 		__netif_rx_schedule(dev);
855 }
856 
857 /* Try to reschedule poll. Called by dev->poll() after netif_rx_complete().
858  * Do not inline this?
859  */
860 static inline int netif_rx_reschedule(struct net_device *dev, int undo)
861 {
862 	if (netif_rx_schedule_prep(dev)) {
863 		unsigned long flags;
864 
865 		dev->quota += undo;
866 
867 		local_irq_save(flags);
868 		list_add_tail(&dev->poll_list, &__get_cpu_var(softnet_data).poll_list);
869 		__raise_softirq_irqoff(NET_RX_SOFTIRQ);
870 		local_irq_restore(flags);
871 		return 1;
872 	}
873 	return 0;
874 }
875 
876 /* Remove interface from poll list: it must be in the poll list
877  * on current cpu. This primitive is called by dev->poll(), when
878  * it completes the work. The device cannot be out of poll list at this
879  * moment, it is BUG().
880  */
881 static inline void netif_rx_complete(struct net_device *dev)
882 {
883 	unsigned long flags;
884 
885 	local_irq_save(flags);
886 	BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
887 	list_del(&dev->poll_list);
888 	smp_mb__before_clear_bit();
889 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
890 	local_irq_restore(flags);
891 }
892 
893 static inline void netif_poll_disable(struct net_device *dev)
894 {
895 	while (test_and_set_bit(__LINK_STATE_RX_SCHED, &dev->state))
896 		/* No hurry. */
897 		schedule_timeout_interruptible(1);
898 }
899 
900 static inline void netif_poll_enable(struct net_device *dev)
901 {
902 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
903 }
904 
905 /* same as netif_rx_complete, except that local_irq_save(flags)
906  * has already been issued
907  */
908 static inline void __netif_rx_complete(struct net_device *dev)
909 {
910 	BUG_ON(!test_bit(__LINK_STATE_RX_SCHED, &dev->state));
911 	list_del(&dev->poll_list);
912 	smp_mb__before_clear_bit();
913 	clear_bit(__LINK_STATE_RX_SCHED, &dev->state);
914 }
915 
916 static inline void netif_tx_lock(struct net_device *dev)
917 {
918 	spin_lock(&dev->_xmit_lock);
919 	dev->xmit_lock_owner = smp_processor_id();
920 }
921 
922 static inline void netif_tx_lock_bh(struct net_device *dev)
923 {
924 	spin_lock_bh(&dev->_xmit_lock);
925 	dev->xmit_lock_owner = smp_processor_id();
926 }
927 
928 static inline int netif_tx_trylock(struct net_device *dev)
929 {
930 	int ok = spin_trylock(&dev->_xmit_lock);
931 	if (likely(ok))
932 		dev->xmit_lock_owner = smp_processor_id();
933 	return ok;
934 }
935 
936 static inline void netif_tx_unlock(struct net_device *dev)
937 {
938 	dev->xmit_lock_owner = -1;
939 	spin_unlock(&dev->_xmit_lock);
940 }
941 
942 static inline void netif_tx_unlock_bh(struct net_device *dev)
943 {
944 	dev->xmit_lock_owner = -1;
945 	spin_unlock_bh(&dev->_xmit_lock);
946 }
947 
948 static inline void netif_tx_disable(struct net_device *dev)
949 {
950 	netif_tx_lock_bh(dev);
951 	netif_stop_queue(dev);
952 	netif_tx_unlock_bh(dev);
953 }
954 
955 /* These functions live elsewhere (drivers/net/net_init.c, but related) */
956 
957 extern void		ether_setup(struct net_device *dev);
958 
959 /* Support for loadable net-drivers */
960 extern struct net_device *alloc_netdev(int sizeof_priv, const char *name,
961 				       void (*setup)(struct net_device *));
962 extern int		register_netdev(struct net_device *dev);
963 extern void		unregister_netdev(struct net_device *dev);
964 /* Functions used for multicast support */
965 extern void		dev_mc_upload(struct net_device *dev);
966 extern int 		dev_mc_delete(struct net_device *dev, void *addr, int alen, int all);
967 extern int		dev_mc_add(struct net_device *dev, void *addr, int alen, int newonly);
968 extern void		dev_mc_discard(struct net_device *dev);
969 extern void		dev_set_promiscuity(struct net_device *dev, int inc);
970 extern void		dev_set_allmulti(struct net_device *dev, int inc);
971 extern void		netdev_state_change(struct net_device *dev);
972 extern void		netdev_features_change(struct net_device *dev);
973 /* Load a device via the kmod */
974 extern void		dev_load(const char *name);
975 extern void		dev_mcast_init(void);
976 extern int		netdev_max_backlog;
977 extern int		weight_p;
978 extern int		netdev_set_master(struct net_device *dev, struct net_device *master);
979 extern int skb_checksum_help(struct sk_buff *skb);
980 extern struct sk_buff *skb_gso_segment(struct sk_buff *skb, int features);
981 #ifdef CONFIG_BUG
982 extern void netdev_rx_csum_fault(struct net_device *dev);
983 #else
984 static inline void netdev_rx_csum_fault(struct net_device *dev)
985 {
986 }
987 #endif
988 /* rx skb timestamps */
989 extern void		net_enable_timestamp(void);
990 extern void		net_disable_timestamp(void);
991 
992 #ifdef CONFIG_PROC_FS
993 extern void *dev_seq_start(struct seq_file *seq, loff_t *pos);
994 extern void *dev_seq_next(struct seq_file *seq, void *v, loff_t *pos);
995 extern void dev_seq_stop(struct seq_file *seq, void *v);
996 #endif
997 
998 extern void linkwatch_run_queue(void);
999 
1000 static inline int net_gso_ok(int features, int gso_type)
1001 {
1002 	int feature = gso_type << NETIF_F_GSO_SHIFT;
1003 	return (features & feature) == feature;
1004 }
1005 
1006 static inline int skb_gso_ok(struct sk_buff *skb, int features)
1007 {
1008 	return net_gso_ok(features, skb_shinfo(skb)->gso_type);
1009 }
1010 
1011 static inline int netif_needs_gso(struct net_device *dev, struct sk_buff *skb)
1012 {
1013 	return skb_is_gso(skb) &&
1014 	       (!skb_gso_ok(skb, dev->features) ||
1015 		unlikely(skb->ip_summed != CHECKSUM_PARTIAL));
1016 }
1017 
1018 /* On bonding slaves other than the currently active slave, suppress
1019  * duplicates except for 802.3ad ETH_P_SLOW, alb non-mcast/bcast, and
1020  * ARP on active-backup slaves with arp_validate enabled.
1021  */
1022 static inline int skb_bond_should_drop(struct sk_buff *skb)
1023 {
1024 	struct net_device *dev = skb->dev;
1025 	struct net_device *master = dev->master;
1026 
1027 	if (master &&
1028 	    (dev->priv_flags & IFF_SLAVE_INACTIVE)) {
1029 		if ((dev->priv_flags & IFF_SLAVE_NEEDARP) &&
1030 		    skb->protocol == __constant_htons(ETH_P_ARP))
1031 			return 0;
1032 
1033 		if (master->priv_flags & IFF_MASTER_ALB) {
1034 			if (skb->pkt_type != PACKET_BROADCAST &&
1035 			    skb->pkt_type != PACKET_MULTICAST)
1036 				return 0;
1037 		}
1038 		if (master->priv_flags & IFF_MASTER_8023AD &&
1039 		    skb->protocol == __constant_htons(ETH_P_SLOW))
1040 			return 0;
1041 
1042 		return 1;
1043 	}
1044 	return 0;
1045 }
1046 
1047 #endif /* __KERNEL__ */
1048 
1049 #endif	/* _LINUX_DEV_H */
1050