include/net/ip6_fib.h

   1 /*
   2  *      Linux INET6 implementation
   3  *
   4  *      Authors:
   5  *      Pedro Roque             <roque@di.fc.ul.pt>
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      as published by the Free Software Foundation; either version
  10  *      2 of the License, or (at your option) any later version.
  11  */
  12
  13 #ifndef _IP6_FIB_H
  14 #define _IP6_FIB_H
  15
  16 #include <linux/ipv6_route.h>
  17 #include <linux/rtnetlink.h>
  18 #include <linux/spinlock.h>
  19 #include <net/dst.h>
  20 #include <net/flow.h>
  21 #include <net/netlink.h>
  22 #include <net/inetpeer.h>
  23
  24 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
  25 #define FIB6_TABLE_HASHSZ 256
  26 #else
  27 #define FIB6_TABLE_HASHSZ 1
  28 #endif
  29
  30 struct rt6_info;
  31
  32 struct fib6_config {
  33         u32             fc_table;
  34         u32             fc_metric;
  35         int             fc_dst_len;
  36         int             fc_src_len;
  37         int             fc_ifindex;
  38         u32             fc_flags;
  39         u32             fc_protocol;
  40         u32             fc_type;        /* only 8 bits are used */
  41
  42         struct in6_addr fc_dst;
  43         struct in6_addr fc_src;
  44         struct in6_addr fc_prefsrc;
  45         struct in6_addr fc_gateway;
  46
  47         unsigned long   fc_expires;
  48         struct nlattr   *fc_mx;
  49         int             fc_mx_len;
  50         int             fc_mp_len;
  51         struct nlattr   *fc_mp;
  52
  53         struct nl_info  fc_nlinfo;
  54 };
  55
  56 struct fib6_node {
  57         struct fib6_node        *parent;
  58         struct fib6_node        *left;
  59         struct fib6_node        *right;
  60 #ifdef CONFIG_IPV6_SUBTREES
  61         struct fib6_node        *subtree;
  62 #endif
  63         struct rt6_info         *leaf;
  64
  65         __u16                   fn_bit;         /* bit key */
  66         __u16                   fn_flags;
  67         int                     fn_sernum;
  68         struct rt6_info         *rr_ptr;
  69 };
  70
  71 #ifndef CONFIG_IPV6_SUBTREES
  72 #define FIB6_SUBTREE(fn)        NULL
  73 #else
  74 #define FIB6_SUBTREE(fn)        ((fn)->subtree)
  75 #endif
  76
  77 struct mx6_config {
  78         const u32 *mx;
  79         DECLARE_BITMAP(mx_valid, RTAX_MAX);
  80 };
  81
  82 /*
  83  *      routing information
  84  *
  85  */
  86
  87 struct rt6key {
  88         struct in6_addr addr;
  89         int             plen;
  90 };
  91
  92 struct fib6_table;
  93
  94 struct rt6_info {
  95         struct dst_entry                dst;
  96
  97         /*
  98          * Tail elements of dst_entry (__refcnt etc.)
  99          * and these elements (rarely used in hot path) are in
 100          * the same cache line.
 101          */
 102         struct fib6_table               *rt6i_table;
 103         struct fib6_node                *rt6i_node;
 104
 105         struct in6_addr                 rt6i_gateway;
 106
 107         /* Multipath routes:
 108          * siblings is a list of rt6_info that have the the same metric/weight,
 109          * destination, but not the same gateway. nsiblings is just a cache
 110          * to speed up lookup.
 111          */
 112         struct list_head                rt6i_siblings;
 113         unsigned int                    rt6i_nsiblings;
 114
 115         atomic_t                        rt6i_ref;
 116
 117         /* These are in a separate cache line. */
 118         struct rt6key                   rt6i_dst ____cacheline_aligned_in_smp;
 119         u32                             rt6i_flags;
 120         struct rt6key                   rt6i_src;
 121         struct rt6key                   rt6i_prefsrc;
 122
 123         struct inet6_dev                *rt6i_idev;
 124         unsigned long                   _rt6i_peer;
 125
 126         u32                             rt6i_metric;
 127         u32                             rt6i_pmtu;
 128         /* more non-fragment space at head required */
 129         unsigned short                  rt6i_nfheader_len;
 130         u8                              rt6i_protocol;
 131 };
 132
 133 static inline struct inet_peer *rt6_peer_ptr(struct rt6_info *rt)
 134 {
 135         return inetpeer_ptr(rt->_rt6i_peer);
 136 }
 137
 138 static inline bool rt6_has_peer(struct rt6_info *rt)
 139 {
 140         return inetpeer_ptr_is_peer(rt->_rt6i_peer);
 141 }
 142
 143 static inline void __rt6_set_peer(struct rt6_info *rt, struct inet_peer *peer)
 144 {
 145         __inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
 146 }
 147
 148 static inline bool rt6_set_peer(struct rt6_info *rt, struct inet_peer *peer)
 149 {
 150         return inetpeer_ptr_set_peer(&rt->_rt6i_peer, peer);
 151 }
 152
 153 static inline void rt6_init_peer(struct rt6_info *rt, struct inet_peer_base *base)
 154 {
 155         inetpeer_init_ptr(&rt->_rt6i_peer, base);
 156 }
 157
 158 static inline void rt6_transfer_peer(struct rt6_info *rt, struct rt6_info *ort)
 159 {
 160         inetpeer_transfer_peer(&rt->_rt6i_peer, &ort->_rt6i_peer);
 161 }
 162
 163 static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
 164 {
 165         return ((struct rt6_info *)dst)->rt6i_idev;
 166 }
 167
 168 static inline void rt6_clean_expires(struct rt6_info *rt)
 169 {
 170         rt->rt6i_flags &= ~RTF_EXPIRES;
 171         rt->dst.expires = 0;
 172 }
 173
 174 static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
 175 {
 176         rt->dst.expires = expires;
 177         rt->rt6i_flags |= RTF_EXPIRES;
 178 }
 179
 180 static inline void rt6_update_expires(struct rt6_info *rt0, int timeout)
 181 {
 182         struct rt6_info *rt;
 183
 184         for (rt = rt0; rt && !(rt->rt6i_flags & RTF_EXPIRES);
 185              rt = (struct rt6_info *)rt->dst.from);
 186         if (rt && rt != rt0)
 187                 rt0->dst.expires = rt->dst.expires;
 188
 189         dst_set_expires(&rt0->dst, timeout);
 190         rt0->rt6i_flags |= RTF_EXPIRES;
 191 }
 192
 193 static inline void ip6_rt_put(struct rt6_info *rt)
 194 {
 195         /* dst_release() accepts a NULL parameter.
 196          * We rely on dst being first structure in struct rt6_info
 197          */
 198         BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
 199         dst_release(&rt->dst);
 200 }
 201
 202 enum fib6_walk_state {
 203 #ifdef CONFIG_IPV6_SUBTREES
 204         FWS_S,
 205 #endif
 206         FWS_L,
 207         FWS_R,
 208         FWS_C,
 209         FWS_U
 210 };
 211
 212 struct fib6_walker {
 213         struct list_head lh;
 214         struct fib6_node *root, *node;
 215         struct rt6_info *leaf;
 216         enum fib6_walk_state state;
 217         bool prune;
 218         unsigned int skip;
 219         unsigned int count;
 220         int (*func)(struct fib6_walker *);
 221         void *args;
 222 };
 223
 224 struct rt6_statistics {
 225         __u32           fib_nodes;
 226         __u32           fib_route_nodes;
 227         __u32           fib_rt_alloc;           /* permanent routes     */
 228         __u32           fib_rt_entries;         /* rt entries in table  */
 229         __u32           fib_rt_cache;           /* cache routes         */
 230         __u32           fib_discarded_routes;
 231 };
 232
 233 #define RTN_TL_ROOT     0x0001
 234 #define RTN_ROOT        0x0002          /* tree root node               */
 235 #define RTN_RTINFO      0x0004          /* node with valid routing info */
 236
 237 /*
 238  *      priority levels (or metrics)
 239  *
 240  */
 241
 242
 243 struct fib6_table {
 244         struct hlist_node       tb6_hlist;
 245         u32                     tb6_id;
 246         rwlock_t                tb6_lock;
 247         struct fib6_node        tb6_root;
 248         struct inet_peer_base   tb6_peers;
 249 };
 250
 251 #define RT6_TABLE_UNSPEC        RT_TABLE_UNSPEC
 252 #define RT6_TABLE_MAIN          RT_TABLE_MAIN
 253 #define RT6_TABLE_DFLT          RT6_TABLE_MAIN
 254 #define RT6_TABLE_INFO          RT6_TABLE_MAIN
 255 #define RT6_TABLE_PREFIX        RT6_TABLE_MAIN
 256
 257 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 258 #define FIB6_TABLE_MIN          1
 259 #define FIB6_TABLE_MAX          RT_TABLE_MAX
 260 #define RT6_TABLE_LOCAL         RT_TABLE_LOCAL
 261 #else
 262 #define FIB6_TABLE_MIN          RT_TABLE_MAIN
 263 #define FIB6_TABLE_MAX          FIB6_TABLE_MIN
 264 #define RT6_TABLE_LOCAL         RT6_TABLE_MAIN
 265 #endif
 266
 267 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
 268                                          struct fib6_table *,
 269                                          struct flowi6 *, int);
 270
 271 /*
 272  *      exported functions
 273  */
 274
 275 struct fib6_table *fib6_get_table(struct net *net, u32 id);
 276 struct fib6_table *fib6_new_table(struct net *net, u32 id);
 277 struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
 278                                    int flags, pol_lookup_t lookup);
 279
 280 struct fib6_node *fib6_lookup(struct fib6_node *root,
 281                               const struct in6_addr *daddr,
 282                               const struct in6_addr *saddr);
 283
 284 struct fib6_node *fib6_locate(struct fib6_node *root,
 285                               const struct in6_addr *daddr, int dst_len,
 286                               const struct in6_addr *saddr, int src_len);
 287
 288 void fib6_clean_all(struct net *net, int (*func)(struct rt6_info *, void *arg),
 289                     void *arg);
 290
 291 int fib6_add(struct fib6_node *root, struct rt6_info *rt,
 292              struct nl_info *info, struct mx6_config *mxc);
 293 int fib6_del(struct rt6_info *rt, struct nl_info *info);
 294
 295 void inet6_rt_notify(int event, struct rt6_info *rt, struct nl_info *info);
 296
 297 void fib6_run_gc(unsigned long expires, struct net *net, bool force);
 298
 299 void fib6_gc_cleanup(void);
 300
 301 int fib6_init(void);
 302
 303 int ipv6_route_open(struct inode *inode, struct file *file);
 304
 305 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 306 int fib6_rules_init(void);
 307 void fib6_rules_cleanup(void);
 308 #else
 309 static inline int               fib6_rules_init(void)
 310 {
 311         return 0;
 312 }
 313 static inline void              fib6_rules_cleanup(void)
 314 {
 315         return ;
 316 }
 317 #endif
 318 #endif