LXR linux/include/linux/inetdevice.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _LINUX_INETDEVICE_H
   3#define _LINUX_INETDEVICE_H
   4
   5#ifdef __KERNEL__
   6
   7#include <linux/bitmap.h>
   8#include <linux/if.h>
   9#include <linux/ip.h>
  10#include <linux/netdevice.h>
  11#include <linux/rcupdate.h>
  12#include <linux/timer.h>
  13#include <linux/sysctl.h>
  14#include <linux/rtnetlink.h>
  15#include <linux/refcount.h>
  16
  17struct ipv4_devconf {
  18        void    *sysctl;
  19        int     data[IPV4_DEVCONF_MAX];
  20        DECLARE_BITMAP(state, IPV4_DEVCONF_MAX);
  21};
  22
  23#define MC_HASH_SZ_LOG 9
  24
  25struct in_device {
  26        struct net_device       *dev;
  27        refcount_t              refcnt;
  28        int                     dead;
  29        struct in_ifaddr        __rcu *ifa_list;/* IP ifaddr chain              */
  30
  31        struct ip_mc_list __rcu *mc_list;       /* IP multicast filter chain    */
  32        struct ip_mc_list __rcu * __rcu *mc_hash;
  33
  34        int                     mc_count;       /* Number of installed mcasts   */
  35        spinlock_t              mc_tomb_lock;
  36        struct ip_mc_list       *mc_tomb;
  37        unsigned long           mr_v1_seen;
  38        unsigned long           mr_v2_seen;
  39        unsigned long           mr_maxdelay;
  40        unsigned long           mr_qi;          /* Query Interval */
  41        unsigned long           mr_qri;         /* Query Response Interval */
  42        unsigned char           mr_qrv;         /* Query Robustness Variable */
  43        unsigned char           mr_gq_running;
  44        unsigned char           mr_ifc_count;
  45        struct timer_list       mr_gq_timer;    /* general query timer */
  46        struct timer_list       mr_ifc_timer;   /* interface change timer */
  47
  48        struct neigh_parms      *arp_parms;
  49        struct ipv4_devconf     cnf;
  50        struct rcu_head         rcu_head;
  51};
  52
  53#define IPV4_DEVCONF(cnf, attr) ((cnf).data[IPV4_DEVCONF_ ## attr - 1])
  54#define IPV4_DEVCONF_ALL(net, attr) \
  55        IPV4_DEVCONF((*(net)->ipv4.devconf_all), attr)
  56
  57static inline int ipv4_devconf_get(struct in_device *in_dev, int index)
  58{
  59        index--;
  60        return in_dev->cnf.data[index];
  61}
  62
  63static inline void ipv4_devconf_set(struct in_device *in_dev, int index,
  64                                    int val)
  65{
  66        index--;
  67        set_bit(index, in_dev->cnf.state);
  68        in_dev->cnf.data[index] = val;
  69}
  70
  71static inline void ipv4_devconf_setall(struct in_device *in_dev)
  72{
  73        bitmap_fill(in_dev->cnf.state, IPV4_DEVCONF_MAX);
  74}
  75
  76#define IN_DEV_CONF_GET(in_dev, attr) \
  77        ipv4_devconf_get((in_dev), IPV4_DEVCONF_ ## attr)
  78#define IN_DEV_CONF_SET(in_dev, attr, val) \
  79        ipv4_devconf_set((in_dev), IPV4_DEVCONF_ ## attr, (val))
  80
  81#define IN_DEV_ANDCONF(in_dev, attr) \
  82        (IPV4_DEVCONF_ALL(dev_net(in_dev->dev), attr) && \
  83         IN_DEV_CONF_GET((in_dev), attr))
  84
  85#define IN_DEV_NET_ORCONF(in_dev, net, attr) \
  86        (IPV4_DEVCONF_ALL(net, attr) || \
  87         IN_DEV_CONF_GET((in_dev), attr))
  88
  89#define IN_DEV_ORCONF(in_dev, attr) \
  90        IN_DEV_NET_ORCONF(in_dev, dev_net(in_dev->dev), attr)
  91
  92#define IN_DEV_MAXCONF(in_dev, attr) \
  93        (max(IPV4_DEVCONF_ALL(dev_net(in_dev->dev), attr), \
  94             IN_DEV_CONF_GET((in_dev), attr)))
  95
  96#define IN_DEV_FORWARD(in_dev)          IN_DEV_CONF_GET((in_dev), FORWARDING)
  97#define IN_DEV_MFORWARD(in_dev)         IN_DEV_ANDCONF((in_dev), MC_FORWARDING)
  98#define IN_DEV_BFORWARD(in_dev)         IN_DEV_ANDCONF((in_dev), BC_FORWARDING)
  99#define IN_DEV_RPFILTER(in_dev)         IN_DEV_MAXCONF((in_dev), RP_FILTER)
 100#define IN_DEV_SRC_VMARK(in_dev)        IN_DEV_ORCONF((in_dev), SRC_VMARK)
 101#define IN_DEV_SOURCE_ROUTE(in_dev)     IN_DEV_ANDCONF((in_dev), \
 102                                                       ACCEPT_SOURCE_ROUTE)
 103#define IN_DEV_ACCEPT_LOCAL(in_dev)     IN_DEV_ORCONF((in_dev), ACCEPT_LOCAL)
 104#define IN_DEV_BOOTP_RELAY(in_dev)      IN_DEV_ANDCONF((in_dev), BOOTP_RELAY)
 105
 106#define IN_DEV_LOG_MARTIANS(in_dev)     IN_DEV_ORCONF((in_dev), LOG_MARTIANS)
 107#define IN_DEV_PROXY_ARP(in_dev)        IN_DEV_ORCONF((in_dev), PROXY_ARP)
 108#define IN_DEV_PROXY_ARP_PVLAN(in_dev)  IN_DEV_CONF_GET(in_dev, PROXY_ARP_PVLAN)
 109#define IN_DEV_SHARED_MEDIA(in_dev)     IN_DEV_ORCONF((in_dev), SHARED_MEDIA)
 110#define IN_DEV_TX_REDIRECTS(in_dev)     IN_DEV_ORCONF((in_dev), SEND_REDIRECTS)
 111#define IN_DEV_SEC_REDIRECTS(in_dev)    IN_DEV_ORCONF((in_dev), \
 112                                                      SECURE_REDIRECTS)
 113#define IN_DEV_IDTAG(in_dev)            IN_DEV_CONF_GET(in_dev, TAG)
 114#define IN_DEV_MEDIUM_ID(in_dev)        IN_DEV_CONF_GET(in_dev, MEDIUM_ID)
 115#define IN_DEV_PROMOTE_SECONDARIES(in_dev) \
 116                                        IN_DEV_ORCONF((in_dev), \
 117                                                      PROMOTE_SECONDARIES)
 118#define IN_DEV_ROUTE_LOCALNET(in_dev)   IN_DEV_ORCONF(in_dev, ROUTE_LOCALNET)
 119#define IN_DEV_NET_ROUTE_LOCALNET(in_dev, net)  \
 120        IN_DEV_NET_ORCONF(in_dev, net, ROUTE_LOCALNET)
 121
 122#define IN_DEV_RX_REDIRECTS(in_dev) \
 123        ((IN_DEV_FORWARD(in_dev) && \
 124          IN_DEV_ANDCONF((in_dev), ACCEPT_REDIRECTS)) \
 125         || (!IN_DEV_FORWARD(in_dev) && \
 126          IN_DEV_ORCONF((in_dev), ACCEPT_REDIRECTS)))
 127
 128#define IN_DEV_IGNORE_ROUTES_WITH_LINKDOWN(in_dev) \
 129        IN_DEV_CONF_GET((in_dev), IGNORE_ROUTES_WITH_LINKDOWN)
 130
 131#define IN_DEV_ARPFILTER(in_dev)        IN_DEV_ORCONF((in_dev), ARPFILTER)
 132#define IN_DEV_ARP_ACCEPT(in_dev)       IN_DEV_ORCONF((in_dev), ARP_ACCEPT)
 133#define IN_DEV_ARP_ANNOUNCE(in_dev)     IN_DEV_MAXCONF((in_dev), ARP_ANNOUNCE)
 134#define IN_DEV_ARP_IGNORE(in_dev)       IN_DEV_MAXCONF((in_dev), ARP_IGNORE)
 135#define IN_DEV_ARP_NOTIFY(in_dev)       IN_DEV_MAXCONF((in_dev), ARP_NOTIFY)
 136
 137struct in_ifaddr {
 138        struct hlist_node       hash;
 139        struct in_ifaddr        __rcu *ifa_next;
 140        struct in_device        *ifa_dev;
 141        struct rcu_head         rcu_head;
 142        __be32                  ifa_local;
 143        __be32                  ifa_address;
 144        __be32                  ifa_mask;
 145        __u32                   ifa_rt_priority;
 146        __be32                  ifa_broadcast;
 147        unsigned char           ifa_scope;
 148        unsigned char           ifa_prefixlen;
 149        __u32                   ifa_flags;
 150        char                    ifa_label[IFNAMSIZ];
 151
 152        /* In seconds, relative to tstamp. Expiry is at tstamp + HZ * lft. */
 153        __u32                   ifa_valid_lft;
 154        __u32                   ifa_preferred_lft;
 155        unsigned long           ifa_cstamp; /* created timestamp */
 156        unsigned long           ifa_tstamp; /* updated timestamp */
 157};
 158
 159struct in_validator_info {
 160        __be32                  ivi_addr;
 161        struct in_device        *ivi_dev;
 162        struct netlink_ext_ack  *extack;
 163};
 164
 165int register_inetaddr_notifier(struct notifier_block *nb);
 166int unregister_inetaddr_notifier(struct notifier_block *nb);
 167int register_inetaddr_validator_notifier(struct notifier_block *nb);
 168int unregister_inetaddr_validator_notifier(struct notifier_block *nb);
 169
 170void inet_netconf_notify_devconf(struct net *net, int event, int type,
 171                                 int ifindex, struct ipv4_devconf *devconf);
 172
 173struct net_device *__ip_dev_find(struct net *net, __be32 addr, bool devref);
 174static inline struct net_device *ip_dev_find(struct net *net, __be32 addr)
 175{
 176        return __ip_dev_find(net, addr, true);
 177}
 178
 179int inet_addr_onlink(struct in_device *in_dev, __be32 a, __be32 b);
 180int devinet_ioctl(struct net *net, unsigned int cmd, struct ifreq *);
 181void devinet_init(void);
 182struct in_device *inetdev_by_index(struct net *, int);
 183__be32 inet_select_addr(const struct net_device *dev, __be32 dst, int scope);
 184__be32 inet_confirm_addr(struct net *net, struct in_device *in_dev, __be32 dst,
 185                         __be32 local, int scope);
 186struct in_ifaddr *inet_ifa_byprefix(struct in_device *in_dev, __be32 prefix,
 187                                    __be32 mask);
 188struct in_ifaddr *inet_lookup_ifaddr_rcu(struct net *net, __be32 addr);
 189static inline bool inet_ifa_match(__be32 addr, const struct in_ifaddr *ifa)
 190{
 191        return !((addr^ifa->ifa_address)&ifa->ifa_mask);
 192}
 193
 194/*
 195 *      Check if a mask is acceptable.
 196 */
 197 
 198static __inline__ bool bad_mask(__be32 mask, __be32 addr)
 199{
 200        __u32 hmask;
 201        if (addr & (mask = ~mask))
 202                return true;
 203        hmask = ntohl(mask);
 204        if (hmask & (hmask+1))
 205                return true;
 206        return false;
 207}
 208
 209#define in_dev_for_each_ifa_rtnl(ifa, in_dev)                   \
 210        for (ifa = rtnl_dereference((in_dev)->ifa_list); ifa;   \
 211             ifa = rtnl_dereference(ifa->ifa_next))
 212
 213#define in_dev_for_each_ifa_rcu(ifa, in_dev)                    \
 214        for (ifa = rcu_dereference((in_dev)->ifa_list); ifa;    \
 215             ifa = rcu_dereference(ifa->ifa_next))
 216
 217static inline struct in_device *__in_dev_get_rcu(const struct net_device *dev)
 218{
 219        return rcu_dereference(dev->ip_ptr);
 220}
 221
 222static inline struct in_device *in_dev_get(const struct net_device *dev)
 223{
 224        struct in_device *in_dev;
 225
 226        rcu_read_lock();
 227        in_dev = __in_dev_get_rcu(dev);
 228        if (in_dev)
 229                refcount_inc(&in_dev->refcnt);
 230        rcu_read_unlock();
 231        return in_dev;
 232}
 233
 234static inline struct in_device *__in_dev_get_rtnl(const struct net_device *dev)
 235{
 236        return rtnl_dereference(dev->ip_ptr);
 237}
 238
 239/* called with rcu_read_lock or rtnl held */
 240static inline bool ip_ignore_linkdown(const struct net_device *dev)
 241{
 242        struct in_device *in_dev;
 243        bool rc = false;
 244
 245        in_dev = rcu_dereference_rtnl(dev->ip_ptr);
 246        if (in_dev &&
 247            IN_DEV_IGNORE_ROUTES_WITH_LINKDOWN(in_dev))
 248                rc = true;
 249
 250        return rc;
 251}
 252
 253static inline struct neigh_parms *__in_dev_arp_parms_get_rcu(const struct net_device *dev)
 254{
 255        struct in_device *in_dev = __in_dev_get_rcu(dev);
 256
 257        return in_dev ? in_dev->arp_parms : NULL;
 258}
 259
 260void in_dev_finish_destroy(struct in_device *idev);
 261
 262static inline void in_dev_put(struct in_device *idev)
 263{
 264        if (refcount_dec_and_test(&idev->refcnt))
 265                in_dev_finish_destroy(idev);
 266}
 267
 268#define __in_dev_put(idev)  refcount_dec(&(idev)->refcnt)
 269#define in_dev_hold(idev)   refcount_inc(&(idev)->refcnt)
 270
 271#endif /* __KERNEL__ */
 272
 273static __inline__ __be32 inet_make_mask(int logmask)
 274{
 275        if (logmask)
 276                return htonl(~((1U<<(32-logmask))-1));
 277        return 0;
 278}
 279
 280static __inline__ int inet_mask_len(__be32 mask)
 281{
 282        __u32 hmask = ntohl(mask);
 283        if (!hmask)
 284                return 0;
 285        return 32 - ffz(~hmask);
 286}
 287
 288
 289#endif /* _LINUX_INETDEVICE_H */
 290