xref: /linux-6.15/include/linux/rtnetlink.h (revision 22f367a6)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_RTNETLINK_H
3 #define __LINUX_RTNETLINK_H
4 
5 
6 #include <linux/mutex.h>
7 #include <linux/netdevice.h>
8 #include <linux/wait.h>
9 #include <linux/refcount.h>
10 #include <uapi/linux/rtnetlink.h>
11 
12 extern int rtnetlink_send(struct sk_buff *skb, struct net *net, u32 pid, u32 group, int echo);
13 extern int rtnl_unicast(struct sk_buff *skb, struct net *net, u32 pid);
14 extern void rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid,
15 			u32 group, const struct nlmsghdr *nlh, gfp_t flags);
16 extern void rtnl_set_sk_err(struct net *net, u32 group, int error);
17 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics);
18 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst,
19 			      u32 id, long expires, u32 error);
20 
21 void rtmsg_ifinfo(int type, struct net_device *dev, unsigned int change, gfp_t flags,
22 		  u32 portid, const struct nlmsghdr *nlh);
23 void rtmsg_ifinfo_newnet(int type, struct net_device *dev, unsigned int change,
24 			 gfp_t flags, int *new_nsid, int new_ifindex);
25 struct sk_buff *rtmsg_ifinfo_build_skb(int type, struct net_device *dev,
26 				       unsigned change, u32 event,
27 				       gfp_t flags, int *new_nsid,
28 				       int new_ifindex, u32 portid,
29 				       const struct nlmsghdr *nlh);
30 void rtmsg_ifinfo_send(struct sk_buff *skb, struct net_device *dev,
31 		       gfp_t flags, u32 portid, const struct nlmsghdr *nlh);
32 
33 
34 /* RTNL is used as a global lock for all changes to network configuration  */
35 extern void rtnl_lock(void);
36 extern void rtnl_unlock(void);
37 extern int rtnl_trylock(void);
38 extern int rtnl_is_locked(void);
39 extern int rtnl_lock_killable(void);
40 extern bool refcount_dec_and_rtnl_lock(refcount_t *r);
41 
42 extern wait_queue_head_t netdev_unregistering_wq;
43 extern struct rw_semaphore pernet_ops_rwsem;
44 extern struct rw_semaphore net_rwsem;
45 
46 #ifdef CONFIG_PROVE_LOCKING
47 extern bool lockdep_rtnl_is_held(void);
48 #else
49 static inline bool lockdep_rtnl_is_held(void)
50 {
51 	return true;
52 }
53 #endif /* #ifdef CONFIG_PROVE_LOCKING */
54 
55 /**
56  * rcu_dereference_rtnl - rcu_dereference with debug checking
57  * @p: The pointer to read, prior to dereferencing
58  *
59  * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
60  * or RTNL. Note : Please prefer rtnl_dereference() or rcu_dereference()
61  */
62 #define rcu_dereference_rtnl(p)					\
63 	rcu_dereference_check(p, lockdep_rtnl_is_held())
64 
65 /**
66  * rcu_dereference_bh_rtnl - rcu_dereference_bh with debug checking
67  * @p: The pointer to read, prior to dereference
68  *
69  * Do an rcu_dereference_bh(p), but check caller either holds rcu_read_lock_bh()
70  * or RTNL. Note : Please prefer rtnl_dereference() or rcu_dereference_bh()
71  */
72 #define rcu_dereference_bh_rtnl(p)				\
73 	rcu_dereference_bh_check(p, lockdep_rtnl_is_held())
74 
75 /**
76  * rtnl_dereference - fetch RCU pointer when updates are prevented by RTNL
77  * @p: The pointer to read, prior to dereferencing
78  *
79  * Return the value of the specified RCU-protected pointer, but omit
80  * the READ_ONCE(), because caller holds RTNL.
81  */
82 #define rtnl_dereference(p)					\
83 	rcu_dereference_protected(p, lockdep_rtnl_is_held())
84 
85 static inline struct netdev_queue *dev_ingress_queue(struct net_device *dev)
86 {
87 	return rtnl_dereference(dev->ingress_queue);
88 }
89 
90 static inline struct netdev_queue *dev_ingress_queue_rcu(struct net_device *dev)
91 {
92 	return rcu_dereference(dev->ingress_queue);
93 }
94 
95 struct netdev_queue *dev_ingress_queue_create(struct net_device *dev);
96 
97 #ifdef CONFIG_NET_INGRESS
98 void net_inc_ingress_queue(void);
99 void net_dec_ingress_queue(void);
100 #endif
101 
102 #ifdef CONFIG_NET_EGRESS
103 void net_inc_egress_queue(void);
104 void net_dec_egress_queue(void);
105 void netdev_xmit_skip_txqueue(bool skip);
106 #endif
107 
108 void rtnetlink_init(void);
109 void __rtnl_unlock(void);
110 void rtnl_kfree_skbs(struct sk_buff *head, struct sk_buff *tail);
111 
112 #define ASSERT_RTNL() \
113 	WARN_ONCE(!rtnl_is_locked(), \
114 		  "RTNL: assertion failed at %s (%d)\n", __FILE__,  __LINE__)
115 
116 extern int ndo_dflt_fdb_dump(struct sk_buff *skb,
117 			     struct netlink_callback *cb,
118 			     struct net_device *dev,
119 			     struct net_device *filter_dev,
120 			     int *idx);
121 extern int ndo_dflt_fdb_add(struct ndmsg *ndm,
122 			    struct nlattr *tb[],
123 			    struct net_device *dev,
124 			    const unsigned char *addr,
125 			    u16 vid,
126 			    u16 flags);
127 extern int ndo_dflt_fdb_del(struct ndmsg *ndm,
128 			    struct nlattr *tb[],
129 			    struct net_device *dev,
130 			    const unsigned char *addr,
131 			    u16 vid);
132 
133 extern int ndo_dflt_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
134 				   struct net_device *dev, u16 mode,
135 				   u32 flags, u32 mask, int nlflags,
136 				   u32 filter_mask,
137 				   int (*vlan_fill)(struct sk_buff *skb,
138 						    struct net_device *dev,
139 						    u32 filter_mask));
140 
141 extern void rtnl_offload_xstats_notify(struct net_device *dev);
142 
143 #endif	/* __LINUX_RTNETLINK_H */
144