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