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         __u32                   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 /*
  78  *      routing information
  79  *
  80  */
  81
  82 struct rt6key {
  83         struct in6_addr addr;
  84         int             plen;
  85 };
  86
  87 struct fib6_table;
  88
  89 struct rt6_info {
  90         struct dst_entry                dst;
  91
  92         struct neighbour                *n;
  93
  94         /*
  95          * Tail elements of dst_entry (__refcnt etc.)
  96          * and these elements (rarely used in hot path) are in
  97          * the same cache line.
  98          */
  99         struct fib6_table               *rt6i_table;
 100         struct fib6_node                *rt6i_node;
 101
 102         struct in6_addr                 rt6i_gateway;
 103
 104         /* Multipath routes:
 105          * siblings is a list of rt6_info that have the the same metric/weight,
 106          * destination, but not the same gateway. nsiblings is just a cache
 107          * to speed up lookup.
 108          */
 109         struct list_head                rt6i_siblings;
 110         unsigned int                    rt6i_nsiblings;
 111
 112         atomic_t                        rt6i_ref;
 113
 114         /* These are in a separate cache line. */
 115         struct rt6key                   rt6i_dst ____cacheline_aligned_in_smp;
 116         u32                             rt6i_flags;
 117         struct rt6key                   rt6i_src;
 118         struct rt6key                   rt6i_prefsrc;
 119         u32                             rt6i_metric;
 120         u32                             rt6i_peer_genid;
 121
 122         struct inet6_dev                *rt6i_idev;
 123         unsigned long                   _rt6i_peer;
 124
 125         u32                             rt6i_genid;
 126
 127         /* more non-fragment space at head required */
 128         unsigned short                  rt6i_nfheader_len;
 129
 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         if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
 171                 dst_release(rt->dst.from);
 172
 173         rt->rt6i_flags &= ~RTF_EXPIRES;
 174         rt->dst.from = NULL;
 175 }
 176
 177 static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
 178 {
 179         if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from)
 180                 dst_release(rt->dst.from);
 181
 182         rt->rt6i_flags |= RTF_EXPIRES;
 183         rt->dst.expires = expires;
 184 }
 185
 186 static inline void rt6_update_expires(struct rt6_info *rt, int timeout)
 187 {
 188         if (!(rt->rt6i_flags & RTF_EXPIRES)) {
 189                 if (rt->dst.from)
 190                         dst_release(rt->dst.from);
 191                 /* dst_set_expires relies on expires == 0
 192                  * if it has not been set previously.
 193                  */
 194                 rt->dst.expires = 0;
 195         }
 196
 197         dst_set_expires(&rt->dst, timeout);
 198         rt->rt6i_flags |= RTF_EXPIRES;
 199 }
 200
 201 static inline void rt6_set_from(struct rt6_info *rt, struct rt6_info *from)
 202 {
 203         struct dst_entry *new = (struct dst_entry *) from;
 204
 205         if (!(rt->rt6i_flags & RTF_EXPIRES) && rt->dst.from) {
 206                 if (new == rt->dst.from)
 207                         return;
 208                 dst_release(rt->dst.from);
 209         }
 210
 211         rt->rt6i_flags &= ~RTF_EXPIRES;
 212         rt->dst.from = new;
 213         dst_hold(new);
 214 }
 215
 216 static inline void ip6_rt_put(struct rt6_info *rt)
 217 {
 218         /* dst_release() accepts a NULL parameter.
 219          * We rely on dst being first structure in struct rt6_info
 220          */
 221         BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
 222         dst_release(&rt->dst);
 223 }
 224
 225 struct fib6_walker_t {
 226         struct list_head lh;
 227         struct fib6_node *root, *node;
 228         struct rt6_info *leaf;
 229         unsigned char state;
 230         unsigned char prune;
 231         unsigned int skip;
 232         unsigned int count;
 233         int (*func)(struct fib6_walker_t *);
 234         void *args;
 235 };
 236
 237 struct rt6_statistics {
 238         __u32           fib_nodes;
 239         __u32           fib_route_nodes;
 240         __u32           fib_rt_alloc;           /* permanent routes     */
 241         __u32           fib_rt_entries;         /* rt entries in table  */
 242         __u32           fib_rt_cache;           /* cache routes         */
 243         __u32           fib_discarded_routes;
 244 };
 245
 246 #define RTN_TL_ROOT     0x0001
 247 #define RTN_ROOT        0x0002          /* tree root node               */
 248 #define RTN_RTINFO      0x0004          /* node with valid routing info */
 249
 250 /*
 251  *      priority levels (or metrics)
 252  *
 253  */
 254
 255
 256 struct fib6_table {
 257         struct hlist_node       tb6_hlist;
 258         u32                     tb6_id;
 259         rwlock_t                tb6_lock;
 260         struct fib6_node        tb6_root;
 261         struct inet_peer_base   tb6_peers;
 262 };
 263
 264 #define RT6_TABLE_UNSPEC        RT_TABLE_UNSPEC
 265 #define RT6_TABLE_MAIN          RT_TABLE_MAIN
 266 #define RT6_TABLE_DFLT          RT6_TABLE_MAIN
 267 #define RT6_TABLE_INFO          RT6_TABLE_MAIN
 268 #define RT6_TABLE_PREFIX        RT6_TABLE_MAIN
 269
 270 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 271 #define FIB6_TABLE_MIN          1
 272 #define FIB6_TABLE_MAX          RT_TABLE_MAX
 273 #define RT6_TABLE_LOCAL         RT_TABLE_LOCAL
 274 #else
 275 #define FIB6_TABLE_MIN          RT_TABLE_MAIN
 276 #define FIB6_TABLE_MAX          FIB6_TABLE_MIN
 277 #define RT6_TABLE_LOCAL         RT6_TABLE_MAIN
 278 #endif
 279
 280 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
 281                                          struct fib6_table *,
 282                                          struct flowi6 *, int);
 283
 284 /*
 285  *      exported functions
 286  */
 287
 288 extern struct fib6_table        *fib6_get_table(struct net *net, u32 id);
 289 extern struct fib6_table        *fib6_new_table(struct net *net, u32 id);
 290 extern struct dst_entry         *fib6_rule_lookup(struct net *net,
 291                                                   struct flowi6 *fl6, int flags,
 292                                                   pol_lookup_t lookup);
 293
 294 extern struct fib6_node         *fib6_lookup(struct fib6_node *root,
 295                                              const struct in6_addr *daddr,
 296                                              const struct in6_addr *saddr);
 297
 298 struct fib6_node                *fib6_locate(struct fib6_node *root,
 299                                              const struct in6_addr *daddr, int dst_len,
 300                                              const struct in6_addr *saddr, int src_len);
 301
 302 extern void                     fib6_clean_all_ro(struct net *net,
 303                                                int (*func)(struct rt6_info *, void *arg),
 304                                                int prune, void *arg);
 305
 306 extern void                     fib6_clean_all(struct net *net,
 307                                                int (*func)(struct rt6_info *, void *arg),
 308                                                int prune, void *arg);
 309
 310 extern int                      fib6_add(struct fib6_node *root,
 311                                          struct rt6_info *rt,
 312                                          struct nl_info *info);
 313
 314 extern int                      fib6_del(struct rt6_info *rt,
 315                                          struct nl_info *info);
 316
 317 extern void                     inet6_rt_notify(int event, struct rt6_info *rt,
 318                                                 struct nl_info *info);
 319
 320 extern void                     fib6_run_gc(unsigned long expires,
 321                                             struct net *net);
 322
 323 extern void                     fib6_gc_cleanup(void);
 324
 325 extern int                      fib6_init(void);
 326
 327 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 328 extern int                      fib6_rules_init(void);
 329 extern void                     fib6_rules_cleanup(void);
 330 #else
 331 static inline int               fib6_rules_init(void)
 332 {
 333         return 0;
 334 }
 335 static inline void              fib6_rules_cleanup(void)
 336 {
 337         return ;
 338 }
 339 #endif
 340 #endif