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
  41         struct in6_addr fc_dst;
  42         struct in6_addr fc_src;
  43         struct in6_addr fc_prefsrc;
  44         struct in6_addr fc_gateway;
  45
  46         unsigned long   fc_expires;
  47         struct nlattr   *fc_mx;
  48         int             fc_mx_len;
  49
  50         struct nl_info  fc_nlinfo;
  51 };
  52
  53 struct fib6_node {
  54         struct fib6_node        *parent;
  55         struct fib6_node        *left;
  56         struct fib6_node        *right;
  57 #ifdef CONFIG_IPV6_SUBTREES
  58         struct fib6_node        *subtree;
  59 #endif
  60         struct rt6_info         *leaf;
  61
  62         __u16                   fn_bit;         /* bit key */
  63         __u16                   fn_flags;
  64         __u32                   fn_sernum;
  65         struct rt6_info         *rr_ptr;
  66         struct rcu_head         rcu;
  67 };
  68
  69 #ifndef CONFIG_IPV6_SUBTREES
  70 #define FIB6_SUBTREE(fn)        NULL
  71 #else
  72 #define FIB6_SUBTREE(fn)        ((fn)->subtree)
  73 #endif
  74
  75 /*
  76  *      routing information
  77  *
  78  */
  79
  80 struct rt6key {
  81         struct in6_addr addr;
  82         int             plen;
  83 };
  84
  85 struct fib6_table;
  86
  87 struct rt6_info {
  88         struct dst_entry                dst;
  89
  90 #define rt6i_dev                        dst.dev
  91 #define rt6i_expires                    dst.expires
  92
  93         /*
  94          * Tail elements of dst_entry (__refcnt etc.)
  95          * and these elements (rarely used in hot path) are in
  96          * the same cache line.
  97          */
  98         struct fib6_table               *rt6i_table;
  99         struct fib6_node __rcu          *rt6i_node;
 100
 101         struct in6_addr                 rt6i_gateway;
 102
 103         atomic_t                        rt6i_ref;
 104
 105         /* These are in a separate cache line. */
 106         struct rt6key                   rt6i_dst ____cacheline_aligned_in_smp;
 107         u32                             rt6i_flags;
 108         struct rt6key                   rt6i_src;
 109         struct rt6key                   rt6i_prefsrc;
 110         u32                             rt6i_metric;
 111         u32                             rt6i_peer_genid;
 112
 113         struct inet6_dev                *rt6i_idev;
 114         struct inet_peer                *rt6i_peer;
 115
 116 #ifdef CONFIG_XFRM
 117         u32                             rt6i_flow_cache_genid;
 118 #endif
 119         /* more non-fragment space at head required */
 120         unsigned short                  rt6i_nfheader_len;
 121
 122         u8                              rt6i_protocol;
 123 };
 124
 125 static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
 126 {
 127         return ((struct rt6_info *)dst)->rt6i_idev;
 128 }
 129
 130 /* Function to safely get fn->sernum for passed in rt
 131  * and store result in passed in cookie.
 132  * Return true if we can get cookie safely
 133  * Return false if not
 134  */
 135 static inline bool rt6_get_cookie_safe(const struct rt6_info *rt,
 136                                        u32 *cookie)
 137 {
 138         struct fib6_node *fn;
 139         bool status = false;
 140
 141         rcu_read_lock();
 142         fn = rcu_dereference(rt->rt6i_node);
 143
 144         if (fn) {
 145                 *cookie = fn->fn_sernum;
 146                 status = true;
 147         }
 148
 149         rcu_read_unlock();
 150         return status;
 151 }
 152
 153 static inline u32 rt6_get_cookie(const struct rt6_info *rt)
 154 {
 155         u32 cookie = 0;
 156
 157         rt6_get_cookie_safe(rt, &cookie);
 158
 159         return cookie;
 160 }
 161
 162 struct fib6_walker_t {
 163         struct list_head lh;
 164         struct fib6_node *root, *node;
 165         struct rt6_info *leaf;
 166         unsigned char state;
 167         unsigned char prune;
 168         unsigned int skip;
 169         unsigned int count;
 170         int (*func)(struct fib6_walker_t *);
 171         void *args;
 172 };
 173
 174 struct rt6_statistics {
 175         __u32           fib_nodes;
 176         __u32           fib_route_nodes;
 177         __u32           fib_rt_alloc;           /* permanent routes     */
 178         __u32           fib_rt_entries;         /* rt entries in table  */
 179         __u32           fib_rt_cache;           /* cache routes         */
 180         __u32           fib_discarded_routes;
 181 };
 182
 183 #define RTN_TL_ROOT     0x0001
 184 #define RTN_ROOT        0x0002          /* tree root node               */
 185 #define RTN_RTINFO      0x0004          /* node with valid routing info */
 186
 187 /*
 188  *      priority levels (or metrics)
 189  *
 190  */
 191
 192
 193 struct fib6_table {
 194         struct hlist_node       tb6_hlist;
 195         u32                     tb6_id;
 196         rwlock_t                tb6_lock;
 197         struct fib6_node        tb6_root;
 198 };
 199
 200 #define RT6_TABLE_UNSPEC        RT_TABLE_UNSPEC
 201 #define RT6_TABLE_MAIN          RT_TABLE_MAIN
 202 #define RT6_TABLE_DFLT          RT6_TABLE_MAIN
 203 #define RT6_TABLE_INFO          RT6_TABLE_MAIN
 204 #define RT6_TABLE_PREFIX        RT6_TABLE_MAIN
 205
 206 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 207 #define FIB6_TABLE_MIN          1
 208 #define FIB6_TABLE_MAX          RT_TABLE_MAX
 209 #define RT6_TABLE_LOCAL         RT_TABLE_LOCAL
 210 #else
 211 #define FIB6_TABLE_MIN          RT_TABLE_MAIN
 212 #define FIB6_TABLE_MAX          FIB6_TABLE_MIN
 213 #define RT6_TABLE_LOCAL         RT6_TABLE_MAIN
 214 #endif
 215
 216 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
 217                                          struct fib6_table *,
 218                                          struct flowi6 *, int);
 219
 220 /*
 221  *      exported functions
 222  */
 223
 224 extern struct fib6_table        *fib6_get_table(struct net *net, u32 id);
 225 extern struct fib6_table        *fib6_new_table(struct net *net, u32 id);
 226 extern struct dst_entry         *fib6_rule_lookup(struct net *net,
 227                                                   struct flowi6 *fl6, int flags,
 228                                                   pol_lookup_t lookup);
 229
 230 extern struct fib6_node         *fib6_lookup(struct fib6_node *root,
 231                                              const struct in6_addr *daddr,
 232                                              const struct in6_addr *saddr);
 233
 234 struct fib6_node                *fib6_locate(struct fib6_node *root,
 235                                              const struct in6_addr *daddr, int dst_len,
 236                                              const struct in6_addr *saddr, int src_len);
 237
 238 extern void                     fib6_clean_all(struct net *net,
 239                                                int (*func)(struct rt6_info *, void *arg),
 240                                                int prune, void *arg);
 241
 242 extern int                      fib6_add(struct fib6_node *root,
 243                                          struct rt6_info *rt,
 244                                          struct nl_info *info);
 245
 246 extern int                      fib6_del(struct rt6_info *rt,
 247                                          struct nl_info *info);
 248
 249 extern void                     inet6_rt_notify(int event, struct rt6_info *rt,
 250                                                 struct nl_info *info);
 251
 252 extern void                     fib6_run_gc(unsigned long expires,
 253                                             struct net *net, bool force);
 254
 255 extern void                     fib6_gc_cleanup(void);
 256
 257 extern int                      fib6_init(void);
 258
 259 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 260 extern int                      fib6_rules_init(void);
 261 extern void                     fib6_rules_cleanup(void);
 262 #else
 263 static inline int               fib6_rules_init(void)
 264 {
 265         return 0;
 266 }
 267 static inline void              fib6_rules_cleanup(void)
 268 {
 269         return ;
 270 }
 271 #endif
 272 #endif