include/linux/rtnetlink.h

   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 struct rw_semaphore pernet_ops_rwsem;
  51 extern struct rw_semaphore net_rwsem;
  52
  53 #ifdef CONFIG_PROVE_LOCKING
  54 extern bool lockdep_rtnl_is_held(void);
  55 #else
  56 static inline bool lockdep_rtnl_is_held(void)
  57 {
  58         return true;
  59 }
  60 #endif /* #ifdef CONFIG_PROVE_LOCKING */
  61
  62 /**
  63  * rcu_dereference_rtnl - rcu_dereference with debug checking
  64  * @p: The pointer to read, prior to dereferencing
  65  *
  66  * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
  67  * or RTNL. Note : Please prefer rtnl_dereference() or rcu_dereference()
  68  */
  69 #define rcu_dereference_rtnl(p)                                 \
  70         rcu_dereference_check(p, lockdep_rtnl_is_held())
  71
  72 /**
  73  * rtnl_dereference - fetch RCU pointer when updates are prevented by RTNL
  74  * @p: The pointer to read, prior to dereferencing
  75  *
  76  * Return the value of the specified RCU-protected pointer, but omit
  77  * the READ_ONCE(), because caller holds RTNL.
  78  */
  79 #define rtnl_dereference(p)                                     \
  80         rcu_dereference_protected(p, lockdep_rtnl_is_held())
  81
  82 /**
  83  * rcu_replace_pointer_rtnl - replace an RCU pointer under rtnl_lock, returning
  84  * its old value
  85  * @rp: RCU pointer, whose value is returned
  86  * @p: regular pointer
  87  *
  88  * Perform a replacement under rtnl_lock, where @rp is an RCU-annotated
  89  * pointer. The old value of @rp is returned, and @rp is set to @p
  90  */
  91 #define rcu_replace_pointer_rtnl(rp, p)                 \
  92         rcu_replace_pointer(rp, p, lockdep_rtnl_is_held())
  93
  94 static inline struct netdev_queue *dev_ingress_queue(struct net_device *dev)
  95 {
  96         return rtnl_dereference(dev->ingress_queue);
  97 }
  98
  99 static inline struct netdev_queue *dev_ingress_queue_rcu(struct net_device *dev)
 100 {
 101         return rcu_dereference(dev->ingress_queue);
 102 }
 103
 104 struct netdev_queue *dev_ingress_queue_create(struct net_device *dev);
 105
 106 #ifdef CONFIG_NET_INGRESS
 107 void net_inc_ingress_queue(void);
 108 void net_dec_ingress_queue(void);
 109 #endif
 110
 111 #ifdef CONFIG_NET_EGRESS
 112 void net_inc_egress_queue(void);
 113 void net_dec_egress_queue(void);
 114 void netdev_xmit_skip_txqueue(bool skip);
 115 #endif
 116
 117 void rtnetlink_init(void);
 118 void __rtnl_unlock(void);
 119 void rtnl_kfree_skbs(struct sk_buff *head, struct sk_buff *tail);
 120
 121 #define ASSERT_RTNL() \
 122         WARN_ONCE(!rtnl_is_locked(), \
 123                   "RTNL: assertion failed at %s (%d)\n", __FILE__,  __LINE__)
 124
 125 extern int ndo_dflt_fdb_dump(struct sk_buff *skb,
 126                              struct netlink_callback *cb,
 127                              struct net_device *dev,
 128                              struct net_device *filter_dev,
 129                              int *idx);
 130 extern int ndo_dflt_fdb_add(struct ndmsg *ndm,
 131                             struct nlattr *tb[],
 132                             struct net_device *dev,
 133                             const unsigned char *addr,
 134                             u16 vid,
 135                             u16 flags);
 136 extern int ndo_dflt_fdb_del(struct ndmsg *ndm,
 137                             struct nlattr *tb[],
 138                             struct net_device *dev,
 139                             const unsigned char *addr,
 140                             u16 vid);
 141
 142 extern int ndo_dflt_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
 143                                    struct net_device *dev, u16 mode,
 144                                    u32 flags, u32 mask, int nlflags,
 145                                    u32 filter_mask,
 146                                    int (*vlan_fill)(struct sk_buff *skb,
 147                                                     struct net_device *dev,
 148                                                     u32 filter_mask));
 149
 150 extern void rtnl_offload_xstats_notify(struct net_device *dev);
 151
 152 static inline int rtnl_has_listeners(const struct net *net, u32 group)
 153 {
 154         struct sock *rtnl = net->rtnl;
 155
 156         return netlink_has_listeners(rtnl, group);
 157 }
 158
 159 /**
 160  * rtnl_notify_needed - check if notification is needed
 161  * @net: Pointer to the net namespace
 162  * @nlflags: netlink ingress message flags
 163  * @group: rtnl group
 164  *
 165  * Based on the ingress message flags and rtnl group, returns true
 166  * if a notification is needed, false otherwise.
 167  */
 168 static inline bool
 169 rtnl_notify_needed(const struct net *net, u16 nlflags, u32 group)
 170 {
 171         return (nlflags & NLM_F_ECHO) || rtnl_has_listeners(net, group);
 172 }
 173
 174 #endif  /* __LINUX_RTNETLINK_H */