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 14 static inline int rtnetlink_maybe_send(struct sk_buff *skb, struct net *net, 15 u32 pid, u32 group, int echo) 16 { 17 return !skb ? 0 : rtnetlink_send(skb, net, pid, group, echo); 18 } 19 20 extern int rtnl_unicast(struct sk_buff *skb, struct net *net, u32 pid); 21 extern void rtnl_notify(struct sk_buff *skb, struct net *net, u32 pid, 22 u32 group, const struct nlmsghdr *nlh, gfp_t flags); 23 extern void rtnl_set_sk_err(struct net *net, u32 group, int error); 24 extern int rtnetlink_put_metrics(struct sk_buff *skb, u32 *metrics); 25 extern int rtnl_put_cacheinfo(struct sk_buff *skb, struct dst_entry *dst, 26 u32 id, long expires, u32 error); 27 28 void rtmsg_ifinfo(int type, struct net_device *dev, unsigned int change, gfp_t flags, 29 u32 portid, const struct nlmsghdr *nlh); 30 void rtmsg_ifinfo_newnet(int type, struct net_device *dev, unsigned int change, 31 gfp_t flags, int *new_nsid, int new_ifindex); 32 struct sk_buff *rtmsg_ifinfo_build_skb(int type, struct net_device *dev, 33 unsigned change, u32 event, 34 gfp_t flags, int *new_nsid, 35 int new_ifindex, u32 portid, 36 const struct nlmsghdr *nlh); 37 void rtmsg_ifinfo_send(struct sk_buff *skb, struct net_device *dev, 38 gfp_t flags, u32 portid, const struct nlmsghdr *nlh); 39 40 41 /* RTNL is used as a global lock for all changes to network configuration */ 42 extern void rtnl_lock(void); 43 extern void rtnl_unlock(void); 44 extern int rtnl_trylock(void); 45 extern int rtnl_is_locked(void); 46 extern int rtnl_lock_killable(void); 47 extern bool refcount_dec_and_rtnl_lock(refcount_t *r); 48 49 extern wait_queue_head_t netdev_unregistering_wq; 50 extern atomic_t dev_unreg_count; 51 extern struct rw_semaphore pernet_ops_rwsem; 52 extern struct rw_semaphore net_rwsem; 53 54 #define ASSERT_RTNL() \ 55 WARN_ONCE(!rtnl_is_locked(), \ 56 "RTNL: assertion failed at %s (%d)\n", __FILE__, __LINE__) 57 58 #ifdef CONFIG_PROVE_LOCKING 59 extern bool lockdep_rtnl_is_held(void); 60 #else 61 static inline bool lockdep_rtnl_is_held(void) 62 { 63 return true; 64 } 65 #endif /* #ifdef CONFIG_PROVE_LOCKING */ 66 67 /** 68 * rcu_dereference_rtnl - rcu_dereference with debug checking 69 * @p: The pointer to read, prior to dereferencing 70 * 71 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock() 72 * or RTNL. Note : Please prefer rtnl_dereference() or rcu_dereference() 73 */ 74 #define rcu_dereference_rtnl(p) \ 75 rcu_dereference_check(p, lockdep_rtnl_is_held()) 76 77 /** 78 * rtnl_dereference - fetch RCU pointer when updates are prevented by RTNL 79 * @p: The pointer to read, prior to dereferencing 80 * 81 * Return the value of the specified RCU-protected pointer, but omit 82 * the READ_ONCE(), because caller holds RTNL. 83 */ 84 #define rtnl_dereference(p) \ 85 rcu_dereference_protected(p, lockdep_rtnl_is_held()) 86 87 /** 88 * rcu_replace_pointer_rtnl - replace an RCU pointer under rtnl_lock, returning 89 * its old value 90 * @rp: RCU pointer, whose value is returned 91 * @p: regular pointer 92 * 93 * Perform a replacement under rtnl_lock, where @rp is an RCU-annotated 94 * pointer. The old value of @rp is returned, and @rp is set to @p 95 */ 96 #define rcu_replace_pointer_rtnl(rp, p) \ 97 rcu_replace_pointer(rp, p, lockdep_rtnl_is_held()) 98 99 #ifdef CONFIG_DEBUG_NET_SMALL_RTNL 100 void __rtnl_net_lock(struct net *net); 101 void __rtnl_net_unlock(struct net *net); 102 void rtnl_net_lock(struct net *net); 103 void rtnl_net_unlock(struct net *net); 104 int rtnl_net_lock_cmp_fn(const struct lockdep_map *a, const struct lockdep_map *b); 105 106 bool rtnl_net_is_locked(struct net *net); 107 108 #define ASSERT_RTNL_NET(net) \ 109 WARN_ONCE(!rtnl_net_is_locked(net), \ 110 "RTNL_NET: assertion failed at %s (%d)\n", \ 111 __FILE__, __LINE__) 112 113 bool lockdep_rtnl_net_is_held(struct net *net); 114 115 #define rcu_dereference_rtnl_net(net, p) \ 116 rcu_dereference_check(p, lockdep_rtnl_net_is_held(net)) 117 #define rtnl_net_dereference(net, p) \ 118 rcu_dereference_protected(p, lockdep_rtnl_net_is_held(net)) 119 #define rcu_replace_pointer_rtnl_net(net, rp, p) \ 120 rcu_replace_pointer(rp, p, lockdep_rtnl_net_is_held(net)) 121 #else 122 static inline void __rtnl_net_lock(struct net *net) {} 123 static inline void __rtnl_net_unlock(struct net *net) {} 124 125 static inline void rtnl_net_lock(struct net *net) 126 { 127 rtnl_lock(); 128 } 129 130 static inline void rtnl_net_unlock(struct net *net) 131 { 132 rtnl_unlock(); 133 } 134 135 static inline void ASSERT_RTNL_NET(struct net *net) 136 { 137 ASSERT_RTNL(); 138 } 139 140 #define rcu_dereference_rtnl_net(net, p) \ 141 rcu_dereference_rtnl(p) 142 #define rtnl_net_dereference(net, p) \ 143 rtnl_dereference(p) 144 #define rcu_replace_pointer_rtnl_net(net, rp, p) \ 145 rcu_replace_pointer_rtnl(rp, p) 146 #endif 147 148 static inline struct netdev_queue *dev_ingress_queue(struct net_device *dev) 149 { 150 return rtnl_dereference(dev->ingress_queue); 151 } 152 153 static inline struct netdev_queue *dev_ingress_queue_rcu(struct net_device *dev) 154 { 155 return rcu_dereference(dev->ingress_queue); 156 } 157 158 struct netdev_queue *dev_ingress_queue_create(struct net_device *dev); 159 160 #ifdef CONFIG_NET_INGRESS 161 void net_inc_ingress_queue(void); 162 void net_dec_ingress_queue(void); 163 #endif 164 165 #ifdef CONFIG_NET_EGRESS 166 void net_inc_egress_queue(void); 167 void net_dec_egress_queue(void); 168 void netdev_xmit_skip_txqueue(bool skip); 169 #endif 170 171 void rtnetlink_init(void); 172 void __rtnl_unlock(void); 173 void rtnl_kfree_skbs(struct sk_buff *head, struct sk_buff *tail); 174 175 extern int ndo_dflt_fdb_dump(struct sk_buff *skb, 176 struct netlink_callback *cb, 177 struct net_device *dev, 178 struct net_device *filter_dev, 179 int *idx); 180 extern int ndo_dflt_fdb_add(struct ndmsg *ndm, 181 struct nlattr *tb[], 182 struct net_device *dev, 183 const unsigned char *addr, 184 u16 vid, 185 u16 flags); 186 extern int ndo_dflt_fdb_del(struct ndmsg *ndm, 187 struct nlattr *tb[], 188 struct net_device *dev, 189 const unsigned char *addr, 190 u16 vid); 191 192 extern int ndo_dflt_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq, 193 struct net_device *dev, u16 mode, 194 u32 flags, u32 mask, int nlflags, 195 u32 filter_mask, 196 int (*vlan_fill)(struct sk_buff *skb, 197 struct net_device *dev, 198 u32 filter_mask)); 199 200 extern void rtnl_offload_xstats_notify(struct net_device *dev); 201 202 static inline int rtnl_has_listeners(const struct net *net, u32 group) 203 { 204 struct sock *rtnl = net->rtnl; 205 206 return netlink_has_listeners(rtnl, group); 207 } 208 209 /** 210 * rtnl_notify_needed - check if notification is needed 211 * @net: Pointer to the net namespace 212 * @nlflags: netlink ingress message flags 213 * @group: rtnl group 214 * 215 * Based on the ingress message flags and rtnl group, returns true 216 * if a notification is needed, false otherwise. 217 */ 218 static inline bool 219 rtnl_notify_needed(const struct net *net, u16 nlflags, u32 group) 220 { 221 return (nlflags & NLM_F_ECHO) || rtnl_has_listeners(net, group); 222 } 223 224 void netdev_set_operstate(struct net_device *dev, int newstate); 225 226 #endif /* __LINUX_RTNETLINK_H */ 227