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 <linux/notifier.h>
  20 #include <net/dst.h>
  21 #include <net/flow.h>
  22 #include <net/netlink.h>
  23 #include <net/inetpeer.h>
  24 #include <net/fib_notifier.h>
  25
  26 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
  27 #define FIB6_TABLE_HASHSZ 256
  28 #else
  29 #define FIB6_TABLE_HASHSZ 1
  30 #endif
  31
  32 #define RT6_DEBUG 2
  33
  34 #if RT6_DEBUG >= 3
  35 #define RT6_TRACE(x...) pr_debug(x)
  36 #else
  37 #define RT6_TRACE(x...) do { ; } while (0)
  38 #endif
  39
  40 struct rt6_info;
  41 struct fib6_info;
  42
  43 struct fib6_config {
  44         u32             fc_table;
  45         u32             fc_metric;
  46         int             fc_dst_len;
  47         int             fc_src_len;
  48         int             fc_ifindex;
  49         u32             fc_flags;
  50         u32             fc_protocol;
  51         u16             fc_type;        /* only 8 bits are used */
  52         u16             fc_delete_all_nh : 1,
  53                         fc_ignore_dev_down:1,
  54                         __unused : 14;
  55
  56         struct in6_addr fc_dst;
  57         struct in6_addr fc_src;
  58         struct in6_addr fc_prefsrc;
  59         struct in6_addr fc_gateway;
  60
  61         unsigned long   fc_expires;
  62         struct nlattr   *fc_mx;
  63         int             fc_mx_len;
  64         int             fc_mp_len;
  65         struct nlattr   *fc_mp;
  66
  67         struct nl_info  fc_nlinfo;
  68         struct nlattr   *fc_encap;
  69         u16             fc_encap_type;
  70 };
  71
  72 struct fib6_node {
  73         struct fib6_node __rcu  *parent;
  74         struct fib6_node __rcu  *left;
  75         struct fib6_node __rcu  *right;
  76 #ifdef CONFIG_IPV6_SUBTREES
  77         struct fib6_node __rcu  *subtree;
  78 #endif
  79         struct fib6_info __rcu  *leaf;
  80
  81         __u16                   fn_bit;         /* bit key */
  82         __u16                   fn_flags;
  83         int                     fn_sernum;
  84         struct fib6_info __rcu  *rr_ptr;
  85         struct rcu_head         rcu;
  86 };
  87
  88 struct fib6_gc_args {
  89         int                     timeout;
  90         int                     more;
  91 };
  92
  93 #ifndef CONFIG_IPV6_SUBTREES
  94 #define FIB6_SUBTREE(fn)        NULL
  95 #else
  96 #define FIB6_SUBTREE(fn)        (rcu_dereference_protected((fn)->subtree, 1))
  97 #endif
  98
  99 /*
 100  *      routing information
 101  *
 102  */
 103
 104 struct rt6key {
 105         struct in6_addr addr;
 106         int             plen;
 107 };
 108
 109 struct fib6_table;
 110
 111 struct rt6_exception_bucket {
 112         struct hlist_head       chain;
 113         int                     depth;
 114 };
 115
 116 struct rt6_exception {
 117         struct hlist_node       hlist;
 118         struct rt6_info         *rt6i;
 119         unsigned long           stamp;
 120         struct rcu_head         rcu;
 121 };
 122
 123 #define FIB6_EXCEPTION_BUCKET_SIZE_SHIFT 10
 124 #define FIB6_EXCEPTION_BUCKET_SIZE (1 << FIB6_EXCEPTION_BUCKET_SIZE_SHIFT)
 125 #define FIB6_MAX_DEPTH 5
 126
 127 struct fib6_nh {
 128         struct in6_addr         nh_gw;
 129         bool                    fib_nh_has_gw;
 130         struct net_device       *nh_dev;
 131         struct lwtunnel_state   *nh_lwtstate;
 132
 133         unsigned int            nh_flags;
 134         atomic_t                nh_upper_bound;
 135         int                     nh_weight;
 136 };
 137
 138 struct fib6_info {
 139         struct fib6_table               *fib6_table;
 140         struct fib6_info __rcu          *fib6_next;
 141         struct fib6_node __rcu          *fib6_node;
 142
 143         /* Multipath routes:
 144          * siblings is a list of fib6_info that have the the same metric/weight,
 145          * destination, but not the same gateway. nsiblings is just a cache
 146          * to speed up lookup.
 147          */
 148         struct list_head                fib6_siblings;
 149         unsigned int                    fib6_nsiblings;
 150
 151         atomic_t                        fib6_ref;
 152         unsigned long                   expires;
 153         struct dst_metrics              *fib6_metrics;
 154 #define fib6_pmtu               fib6_metrics->metrics[RTAX_MTU-1]
 155
 156         struct rt6key                   fib6_dst;
 157         u32                             fib6_flags;
 158         struct rt6key                   fib6_src;
 159         struct rt6key                   fib6_prefsrc;
 160
 161         struct rt6_info * __percpu      *rt6i_pcpu;
 162         struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
 163
 164 #ifdef CONFIG_IPV6_ROUTER_PREF
 165         unsigned long                   last_probe;
 166 #endif
 167
 168         u32                             fib6_metric;
 169         u8                              fib6_protocol;
 170         u8                              fib6_type;
 171         u8                              exception_bucket_flushed:1,
 172                                         should_flush:1,
 173                                         dst_nocount:1,
 174                                         dst_nopolicy:1,
 175                                         dst_host:1,
 176                                         unused:3;
 177
 178         struct fib6_nh                  fib6_nh;
 179         struct rcu_head                 rcu;
 180 };
 181
 182 struct rt6_info {
 183         struct dst_entry                dst;
 184         struct fib6_info __rcu          *from;
 185
 186         struct rt6key                   rt6i_dst;
 187         struct rt6key                   rt6i_src;
 188         struct in6_addr                 rt6i_gateway;
 189         struct inet6_dev                *rt6i_idev;
 190         u32                             rt6i_flags;
 191
 192         struct list_head                rt6i_uncached;
 193         struct uncached_list            *rt6i_uncached_list;
 194
 195         /* more non-fragment space at head required */
 196         unsigned short                  rt6i_nfheader_len;
 197 };
 198
 199 #define for_each_fib6_node_rt_rcu(fn)                                   \
 200         for (rt = rcu_dereference((fn)->leaf); rt;                      \
 201              rt = rcu_dereference(rt->fib6_next))
 202
 203 #define for_each_fib6_walker_rt(w)                                      \
 204         for (rt = (w)->leaf; rt;                                        \
 205              rt = rcu_dereference_protected(rt->fib6_next, 1))
 206
 207 static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
 208 {
 209         return ((struct rt6_info *)dst)->rt6i_idev;
 210 }
 211
 212 static inline void fib6_clean_expires(struct fib6_info *f6i)
 213 {
 214         f6i->fib6_flags &= ~RTF_EXPIRES;
 215         f6i->expires = 0;
 216 }
 217
 218 static inline void fib6_set_expires(struct fib6_info *f6i,
 219                                     unsigned long expires)
 220 {
 221         f6i->expires = expires;
 222         f6i->fib6_flags |= RTF_EXPIRES;
 223 }
 224
 225 static inline bool fib6_check_expired(const struct fib6_info *f6i)
 226 {
 227         if (f6i->fib6_flags & RTF_EXPIRES)
 228                 return time_after(jiffies, f6i->expires);
 229         return false;
 230 }
 231
 232 /* Function to safely get fn->sernum for passed in rt
 233  * and store result in passed in cookie.
 234  * Return true if we can get cookie safely
 235  * Return false if not
 236  */
 237 static inline bool fib6_get_cookie_safe(const struct fib6_info *f6i,
 238                                         u32 *cookie)
 239 {
 240         struct fib6_node *fn;
 241         bool status = false;
 242
 243         fn = rcu_dereference(f6i->fib6_node);
 244
 245         if (fn) {
 246                 *cookie = fn->fn_sernum;
 247                 /* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
 248                 smp_rmb();
 249                 status = true;
 250         }
 251
 252         return status;
 253 }
 254
 255 static inline u32 rt6_get_cookie(const struct rt6_info *rt)
 256 {
 257         struct fib6_info *from;
 258         u32 cookie = 0;
 259
 260         rcu_read_lock();
 261
 262         from = rcu_dereference(rt->from);
 263         if (from && (rt->rt6i_flags & RTF_PCPU ||
 264             unlikely(!list_empty(&rt->rt6i_uncached))))
 265                 fib6_get_cookie_safe(from, &cookie);
 266
 267         rcu_read_unlock();
 268
 269         return cookie;
 270 }
 271
 272 static inline void ip6_rt_put(struct rt6_info *rt)
 273 {
 274         /* dst_release() accepts a NULL parameter.
 275          * We rely on dst being first structure in struct rt6_info
 276          */
 277         BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
 278         dst_release(&rt->dst);
 279 }
 280
 281 struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
 282 void fib6_info_destroy_rcu(struct rcu_head *head);
 283
 284 static inline void fib6_info_hold(struct fib6_info *f6i)
 285 {
 286         atomic_inc(&f6i->fib6_ref);
 287 }
 288
 289 static inline bool fib6_info_hold_safe(struct fib6_info *f6i)
 290 {
 291         return atomic_inc_not_zero(&f6i->fib6_ref);
 292 }
 293
 294 static inline void fib6_info_release(struct fib6_info *f6i)
 295 {
 296         if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
 297                 call_rcu(&f6i->rcu, fib6_info_destroy_rcu);
 298 }
 299
 300 enum fib6_walk_state {
 301 #ifdef CONFIG_IPV6_SUBTREES
 302         FWS_S,
 303 #endif
 304         FWS_L,
 305         FWS_R,
 306         FWS_C,
 307         FWS_U
 308 };
 309
 310 struct fib6_walker {
 311         struct list_head lh;
 312         struct fib6_node *root, *node;
 313         struct fib6_info *leaf;
 314         enum fib6_walk_state state;
 315         unsigned int skip;
 316         unsigned int count;
 317         int (*func)(struct fib6_walker *);
 318         void *args;
 319 };
 320
 321 struct rt6_statistics {
 322         __u32           fib_nodes;              /* all fib6 nodes */
 323         __u32           fib_route_nodes;        /* intermediate nodes */
 324         __u32           fib_rt_entries;         /* rt entries in fib table */
 325         __u32           fib_rt_cache;           /* cached rt entries in exception table */
 326         __u32           fib_discarded_routes;   /* total number of routes delete */
 327
 328         /* The following stats are not protected by any lock */
 329         atomic_t        fib_rt_alloc;           /* total number of routes alloced */
 330         atomic_t        fib_rt_uncache;         /* rt entries in uncached list */
 331 };
 332
 333 #define RTN_TL_ROOT     0x0001
 334 #define RTN_ROOT        0x0002          /* tree root node               */
 335 #define RTN_RTINFO      0x0004          /* node with valid routing info */
 336
 337 /*
 338  *      priority levels (or metrics)
 339  *
 340  */
 341
 342
 343 struct fib6_table {
 344         struct hlist_node       tb6_hlist;
 345         u32                     tb6_id;
 346         spinlock_t              tb6_lock;
 347         struct fib6_node        tb6_root;
 348         struct inet_peer_base   tb6_peers;
 349         unsigned int            flags;
 350         unsigned int            fib_seq;
 351 #define RT6_TABLE_HAS_DFLT_ROUTER       BIT(0)
 352 };
 353
 354 #define RT6_TABLE_UNSPEC        RT_TABLE_UNSPEC
 355 #define RT6_TABLE_MAIN          RT_TABLE_MAIN
 356 #define RT6_TABLE_DFLT          RT6_TABLE_MAIN
 357 #define RT6_TABLE_INFO          RT6_TABLE_MAIN
 358 #define RT6_TABLE_PREFIX        RT6_TABLE_MAIN
 359
 360 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 361 #define FIB6_TABLE_MIN          1
 362 #define FIB6_TABLE_MAX          RT_TABLE_MAX
 363 #define RT6_TABLE_LOCAL         RT_TABLE_LOCAL
 364 #else
 365 #define FIB6_TABLE_MIN          RT_TABLE_MAIN
 366 #define FIB6_TABLE_MAX          FIB6_TABLE_MIN
 367 #define RT6_TABLE_LOCAL         RT6_TABLE_MAIN
 368 #endif
 369
 370 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
 371                                          struct fib6_table *,
 372                                          struct flowi6 *,
 373                                          const struct sk_buff *, int);
 374
 375 struct fib6_entry_notifier_info {
 376         struct fib_notifier_info info; /* must be first */
 377         struct fib6_info *rt;
 378 };
 379
 380 /*
 381  *      exported functions
 382  */
 383
 384 struct fib6_table *fib6_get_table(struct net *net, u32 id);
 385 struct fib6_table *fib6_new_table(struct net *net, u32 id);
 386 struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
 387                                    const struct sk_buff *skb,
 388                                    int flags, pol_lookup_t lookup);
 389
 390 /* called with rcu lock held; can return error pointer
 391  * caller needs to select path
 392  */
 393 struct fib6_info *fib6_lookup(struct net *net, int oif, struct flowi6 *fl6,
 394                               int flags);
 395
 396 /* called with rcu lock held; caller needs to select path */
 397 struct fib6_info *fib6_table_lookup(struct net *net, struct fib6_table *table,
 398                                     int oif, struct flowi6 *fl6, int strict);
 399
 400 struct fib6_info *fib6_multipath_select(const struct net *net,
 401                                         struct fib6_info *match,
 402                                         struct flowi6 *fl6, int oif,
 403                                         const struct sk_buff *skb, int strict);
 404
 405 struct fib6_node *fib6_node_lookup(struct fib6_node *root,
 406                                    const struct in6_addr *daddr,
 407                                    const struct in6_addr *saddr);
 408
 409 struct fib6_node *fib6_locate(struct fib6_node *root,
 410                               const struct in6_addr *daddr, int dst_len,
 411                               const struct in6_addr *saddr, int src_len,
 412                               bool exact_match);
 413
 414 void fib6_clean_all(struct net *net, int (*func)(struct fib6_info *, void *arg),
 415                     void *arg);
 416 void fib6_clean_all_skip_notify(struct net *net,
 417                                 int (*func)(struct fib6_info *, void *arg),
 418                                 void *arg);
 419
 420 int fib6_add(struct fib6_node *root, struct fib6_info *rt,
 421              struct nl_info *info, struct netlink_ext_ack *extack);
 422 int fib6_del(struct fib6_info *rt, struct nl_info *info);
 423
 424 static inline
 425 void rt6_get_prefsrc(const struct rt6_info *rt, struct in6_addr *addr)
 426 {
 427         const struct fib6_info *from;
 428
 429         rcu_read_lock();
 430
 431         from = rcu_dereference(rt->from);
 432         if (from) {
 433                 *addr = from->fib6_prefsrc.addr;
 434         } else {
 435                 struct in6_addr in6_zero = {};
 436
 437                 *addr = in6_zero;
 438         }
 439
 440         rcu_read_unlock();
 441 }
 442
 443 static inline struct net_device *fib6_info_nh_dev(const struct fib6_info *f6i)
 444 {
 445         return f6i->fib6_nh.nh_dev;
 446 }
 447
 448 int fib6_nh_init(struct net *net, struct fib6_nh *fib6_nh,
 449                  struct fib6_config *cfg, gfp_t gfp_flags,
 450                  struct netlink_ext_ack *extack);
 451 void fib6_nh_release(struct fib6_nh *fib6_nh);
 452
 453 static inline
 454 struct lwtunnel_state *fib6_info_nh_lwt(const struct fib6_info *f6i)
 455 {
 456         return f6i->fib6_nh.nh_lwtstate;
 457 }
 458
 459 void inet6_rt_notify(int event, struct fib6_info *rt, struct nl_info *info,
 460                      unsigned int flags);
 461
 462 void fib6_run_gc(unsigned long expires, struct net *net, bool force);
 463
 464 void fib6_gc_cleanup(void);
 465
 466 int fib6_init(void);
 467
 468 struct ipv6_route_iter {
 469         struct seq_net_private p;
 470         struct fib6_walker w;
 471         loff_t skip;
 472         struct fib6_table *tbl;
 473         int sernum;
 474 };
 475
 476 extern const struct seq_operations ipv6_route_seq_ops;
 477
 478 int call_fib6_notifier(struct notifier_block *nb, struct net *net,
 479                        enum fib_event_type event_type,
 480                        struct fib_notifier_info *info);
 481 int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
 482                         struct fib_notifier_info *info);
 483
 484 int __net_init fib6_notifier_init(struct net *net);
 485 void __net_exit fib6_notifier_exit(struct net *net);
 486
 487 unsigned int fib6_tables_seq_read(struct net *net);
 488 int fib6_tables_dump(struct net *net, struct notifier_block *nb);
 489
 490 void fib6_update_sernum(struct net *net, struct fib6_info *rt);
 491 void fib6_update_sernum_upto_root(struct net *net, struct fib6_info *rt);
 492
 493 void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
 494 static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
 495 {
 496         return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
 497 }
 498
 499 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 500 int fib6_rules_init(void);
 501 void fib6_rules_cleanup(void);
 502 bool fib6_rule_default(const struct fib_rule *rule);
 503 int fib6_rules_dump(struct net *net, struct notifier_block *nb);
 504 unsigned int fib6_rules_seq_read(struct net *net);
 505
 506 static inline bool fib6_rules_early_flow_dissect(struct net *net,
 507                                                  struct sk_buff *skb,
 508                                                  struct flowi6 *fl6,
 509                                                  struct flow_keys *flkeys)
 510 {
 511         unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
 512
 513         if (!net->ipv6.fib6_rules_require_fldissect)
 514                 return false;
 515
 516         skb_flow_dissect_flow_keys(skb, flkeys, flag);
 517         fl6->fl6_sport = flkeys->ports.src;
 518         fl6->fl6_dport = flkeys->ports.dst;
 519         fl6->flowi6_proto = flkeys->basic.ip_proto;
 520
 521         return true;
 522 }
 523 #else
 524 static inline int               fib6_rules_init(void)
 525 {
 526         return 0;
 527 }
 528 static inline void              fib6_rules_cleanup(void)
 529 {
 530         return ;
 531 }
 532 static inline bool fib6_rule_default(const struct fib_rule *rule)
 533 {
 534         return true;
 535 }
 536 static inline int fib6_rules_dump(struct net *net, struct notifier_block *nb)
 537 {
 538         return 0;
 539 }
 540 static inline unsigned int fib6_rules_seq_read(struct net *net)
 541 {
 542         return 0;
 543 }
 544 static inline bool fib6_rules_early_flow_dissect(struct net *net,
 545                                                  struct sk_buff *skb,
 546                                                  struct flowi6 *fl6,
 547                                                  struct flow_keys *flkeys)
 548 {
 549         return false;
 550 }
 551 #endif
 552 #endif