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