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_trylock(struct net *net); 105 int rtnl_net_lock_killable(struct net *net); 106 int rtnl_net_lock_cmp_fn(const struct lockdep_map *a, const struct lockdep_map *b); 107 108 bool rtnl_net_is_locked(struct net *net); 109 110 #define ASSERT_RTNL_NET(net) \ 111 WARN_ONCE(!rtnl_net_is_locked(net), \ 112 "RTNL_NET: assertion failed at %s (%d)\n", \ 113 __FILE__, __LINE__) 114 115 bool lockdep_rtnl_net_is_held(struct net *net); 116 117 #define rcu_dereference_rtnl_net(net, p) \ 118 rcu_dereference_check(p, lockdep_rtnl_net_is_held(net)) 119 #define rtnl_net_dereference(net, p) \ 120 rcu_dereference_protected(p, lockdep_rtnl_net_is_held(net)) 121 #define rcu_replace_pointer_rtnl_net(net, rp, p) \ 122 rcu_replace_pointer(rp, p, lockdep_rtnl_net_is_held(net)) 123 #else 124 static inline void __rtnl_net_lock(struct net *net) {} 125 static inline void __rtnl_net_unlock(struct net *net) {} 126 127 static inline void rtnl_net_lock(struct net *net) 128 { 129 rtnl_lock(); 130 } 131 132 static inline void rtnl_net_unlock(struct net *net) 133 { 134 rtnl_unlock(); 135 } 136 137 static inline int rtnl_net_trylock(struct net *net) 138 { 139 return rtnl_trylock(); 140 } 141 142 static inline int rtnl_net_lock_killable(struct net *net) 143 { 144 return rtnl_lock_killable(); 145 } 146 147 static inline void ASSERT_RTNL_NET(struct net *net) 148 { 149 ASSERT_RTNL(); 150 } 151 152 #define rcu_dereference_rtnl_net(net, p) \ 153 rcu_dereference_rtnl(p) 154 #define rtnl_net_dereference(net, p) \ 155 rtnl_dereference(p) 156 #define rcu_replace_pointer_rtnl_net(net, rp, p) \ 157 rcu_replace_pointer_rtnl(rp, p) 158 #endif 159 160 static inline struct netdev_queue *dev_ingress_queue(struct net_device *dev) 161 { 162 return rtnl_dereference(dev->ingress_queue); 163 } 164 165 static inline struct netdev_queue *dev_ingress_queue_rcu(struct net_device *dev) 166 { 167 return rcu_dereference(dev->ingress_queue); 168 } 169 170 struct netdev_queue *dev_ingress_queue_create(struct net_device *dev); 171 172 #ifdef CONFIG_NET_INGRESS 173 void net_inc_ingress_queue(void); 174 void net_dec_ingress_queue(void); 175 #endif 176 177 #ifdef CONFIG_NET_EGRESS 178 void net_inc_egress_queue(void); 179 void net_dec_egress_queue(void); 180 void netdev_xmit_skip_txqueue(bool skip); 181 #endif 182 183 void rtnetlink_init(void); 184 void __rtnl_unlock(void); 185 void rtnl_kfree_skbs(struct sk_buff *head, struct sk_buff *tail); 186 187 /* Shared by rtnl_fdb_dump() and various ndo_fdb_dump() helpers. */ 188 struct ndo_fdb_dump_context { 189 unsigned long ifindex; 190 unsigned long fdb_idx; 191 }; 192 193 extern int ndo_dflt_fdb_dump(struct sk_buff *skb, 194 struct netlink_callback *cb, 195 struct net_device *dev, 196 struct net_device *filter_dev, 197 int *idx); 198 extern int ndo_dflt_fdb_add(struct ndmsg *ndm, 199 struct nlattr *tb[], 200 struct net_device *dev, 201 const unsigned char *addr, 202 u16 vid, 203 u16 flags); 204 extern int ndo_dflt_fdb_del(struct ndmsg *ndm, 205 struct nlattr *tb[], 206 struct net_device *dev, 207 const unsigned char *addr, 208 u16 vid); 209 210 extern int ndo_dflt_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq, 211 struct net_device *dev, u16 mode, 212 u32 flags, u32 mask, int nlflags, 213 u32 filter_mask, 214 int (*vlan_fill)(struct sk_buff *skb, 215 struct net_device *dev, 216 u32 filter_mask)); 217 218 extern void rtnl_offload_xstats_notify(struct net_device *dev); 219 220 static inline int rtnl_has_listeners(const struct net *net, u32 group) 221 { 222 struct sock *rtnl = net->rtnl; 223 224 return netlink_has_listeners(rtnl, group); 225 } 226 227 /** 228 * rtnl_notify_needed - check if notification is needed 229 * @net: Pointer to the net namespace 230 * @nlflags: netlink ingress message flags 231 * @group: rtnl group 232 * 233 * Based on the ingress message flags and rtnl group, returns true 234 * if a notification is needed, false otherwise. 235 */ 236 static inline bool 237 rtnl_notify_needed(const struct net *net, u16 nlflags, u32 group) 238 { 239 return (nlflags & NLM_F_ECHO) || rtnl_has_listeners(net, group); 240 } 241 242 void netdev_set_operstate(struct net_device *dev, int newstate); 243 244 #endif /* __LINUX_RTNETLINK_H */ 245