include/net/ip6_fib.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *      Linux INET6 implementation
   4  *
   5  *      Authors:
   6  *      Pedro Roque             <roque@di.fc.ul.pt>
   7  */
   8
   9 #ifndef _IP6_FIB_H
  10 #define _IP6_FIB_H
  11
  12 #include <linux/ipv6_route.h>
  13 #include <linux/rtnetlink.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/notifier.h>
  16 #include <net/dst.h>
  17 #include <net/flow.h>
  18 #include <net/ip_fib.h>
  19 #include <net/netlink.h>
  20 #include <net/inetpeer.h>
  21 #include <net/fib_notifier.h>
  22 #include <linux/indirect_call_wrapper.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 #define RT6_DEBUG 2
  31
  32 #if RT6_DEBUG >= 3
  33 #define RT6_TRACE(x...) pr_debug(x)
  34 #else
  35 #define RT6_TRACE(x...) do { ; } while (0)
  36 #endif
  37
  38 struct rt6_info;
  39 struct fib6_info;
  40
  41 struct fib6_config {
  42         u32             fc_table;
  43         u32             fc_metric;
  44         int             fc_dst_len;
  45         int             fc_src_len;
  46         int             fc_ifindex;
  47         u32             fc_flags;
  48         u32             fc_protocol;
  49         u16             fc_type;        /* only 8 bits are used */
  50         u16             fc_delete_all_nh : 1,
  51                         fc_ignore_dev_down:1,
  52                         __unused : 14;
  53         u32             fc_nh_id;
  54
  55         struct in6_addr fc_dst;
  56         struct in6_addr fc_src;
  57         struct in6_addr fc_prefsrc;
  58         struct in6_addr fc_gateway;
  59
  60         unsigned long   fc_expires;
  61         struct nlattr   *fc_mx;
  62         int             fc_mx_len;
  63         int             fc_mp_len;
  64         struct nlattr   *fc_mp;
  65
  66         struct nl_info  fc_nlinfo;
  67         struct nlattr   *fc_encap;
  68         u16             fc_encap_type;
  69         bool            fc_is_fdb;
  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
  96 static inline bool fib6_routes_require_src(const struct net *net)
  97 {
  98         return false;
  99 }
 100
 101 static inline void fib6_routes_require_src_inc(struct net *net) {}
 102 static inline void fib6_routes_require_src_dec(struct net *net) {}
 103
 104 #else
 105
 106 static inline bool fib6_routes_require_src(const struct net *net)
 107 {
 108         return net->ipv6.fib6_routes_require_src > 0;
 109 }
 110
 111 static inline void fib6_routes_require_src_inc(struct net *net)
 112 {
 113         net->ipv6.fib6_routes_require_src++;
 114 }
 115
 116 static inline void fib6_routes_require_src_dec(struct net *net)
 117 {
 118         net->ipv6.fib6_routes_require_src--;
 119 }
 120
 121 #define FIB6_SUBTREE(fn)        (rcu_dereference_protected((fn)->subtree, 1))
 122 #endif
 123
 124 /*
 125  *      routing information
 126  *
 127  */
 128
 129 struct rt6key {
 130         struct in6_addr addr;
 131         int             plen;
 132 };
 133
 134 struct fib6_table;
 135
 136 struct rt6_exception_bucket {
 137         struct hlist_head       chain;
 138         int                     depth;
 139 };
 140
 141 struct rt6_exception {
 142         struct hlist_node       hlist;
 143         struct rt6_info         *rt6i;
 144         unsigned long           stamp;
 145         struct rcu_head         rcu;
 146 };
 147
 148 #define FIB6_EXCEPTION_BUCKET_SIZE_SHIFT 10
 149 #define FIB6_EXCEPTION_BUCKET_SIZE (1 << FIB6_EXCEPTION_BUCKET_SIZE_SHIFT)
 150 #define FIB6_MAX_DEPTH 5
 151
 152 struct fib6_nh {
 153         struct fib_nh_common    nh_common;
 154
 155 #ifdef CONFIG_IPV6_ROUTER_PREF
 156         unsigned long           last_probe;
 157 #endif
 158
 159         struct rt6_info * __percpu *rt6i_pcpu;
 160         struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
 161 };
 162
 163 struct fib6_info {
 164         struct fib6_table               *fib6_table;
 165         struct fib6_info __rcu          *fib6_next;
 166         struct fib6_node __rcu          *fib6_node;
 167
 168         /* Multipath routes:
 169          * siblings is a list of fib6_info that have the same metric/weight,
 170          * destination, but not the same gateway. nsiblings is just a cache
 171          * to speed up lookup.
 172          */
 173         union {
 174                 struct list_head        fib6_siblings;
 175                 struct list_head        nh_list;
 176         };
 177         unsigned int                    fib6_nsiblings;
 178
 179         refcount_t                      fib6_ref;
 180         unsigned long                   expires;
 181         struct dst_metrics              *fib6_metrics;
 182 #define fib6_pmtu               fib6_metrics->metrics[RTAX_MTU-1]
 183
 184         struct rt6key                   fib6_dst;
 185         u32                             fib6_flags;
 186         struct rt6key                   fib6_src;
 187         struct rt6key                   fib6_prefsrc;
 188
 189         u32                             fib6_metric;
 190         u8                              fib6_protocol;
 191         u8                              fib6_type;
 192
 193         u8                              offload;
 194         u8                              trap;
 195         u8                              offload_failed;
 196
 197         u8                              should_flush:1,
 198                                         dst_nocount:1,
 199                                         dst_nopolicy:1,
 200                                         fib6_destroying:1,
 201                                         unused:4;
 202
 203         struct rcu_head                 rcu;
 204         struct nexthop                  *nh;
 205         struct fib6_nh                  fib6_nh[];
 206 };
 207
 208 struct rt6_info {
 209         struct dst_entry                dst;
 210         struct fib6_info __rcu          *from;
 211         int                             sernum;
 212
 213         struct rt6key                   rt6i_dst;
 214         struct rt6key                   rt6i_src;
 215         struct in6_addr                 rt6i_gateway;
 216         struct inet6_dev                *rt6i_idev;
 217         u32                             rt6i_flags;
 218
 219         struct list_head                rt6i_uncached;
 220         struct uncached_list            *rt6i_uncached_list;
 221
 222         /* more non-fragment space at head required */
 223         unsigned short                  rt6i_nfheader_len;
 224 };
 225
 226 struct fib6_result {
 227         struct fib6_nh          *nh;
 228         struct fib6_info        *f6i;
 229         u32                     fib6_flags;
 230         u8                      fib6_type;
 231         struct rt6_info         *rt6;
 232 };
 233
 234 #define for_each_fib6_node_rt_rcu(fn)                                   \
 235         for (rt = rcu_dereference((fn)->leaf); rt;                      \
 236              rt = rcu_dereference(rt->fib6_next))
 237
 238 #define for_each_fib6_walker_rt(w)                                      \
 239         for (rt = (w)->leaf; rt;                                        \
 240              rt = rcu_dereference_protected(rt->fib6_next, 1))
 241
 242 static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
 243 {
 244         return ((struct rt6_info *)dst)->rt6i_idev;
 245 }
 246
 247 static inline bool fib6_requires_src(const struct fib6_info *rt)
 248 {
 249         return rt->fib6_src.plen > 0;
 250 }
 251
 252 static inline void fib6_clean_expires(struct fib6_info *f6i)
 253 {
 254         f6i->fib6_flags &= ~RTF_EXPIRES;
 255         f6i->expires = 0;
 256 }
 257
 258 static inline void fib6_set_expires(struct fib6_info *f6i,
 259                                     unsigned long expires)
 260 {
 261         f6i->expires = expires;
 262         f6i->fib6_flags |= RTF_EXPIRES;
 263 }
 264
 265 static inline bool fib6_check_expired(const struct fib6_info *f6i)
 266 {
 267         if (f6i->fib6_flags & RTF_EXPIRES)
 268                 return time_after(jiffies, f6i->expires);
 269         return false;
 270 }
 271
 272 /* Function to safely get fn->fn_sernum for passed in rt
 273  * and store result in passed in cookie.
 274  * Return true if we can get cookie safely
 275  * Return false if not
 276  */
 277 static inline bool fib6_get_cookie_safe(const struct fib6_info *f6i,
 278                                         u32 *cookie)
 279 {
 280         struct fib6_node *fn;
 281         bool status = false;
 282
 283         fn = rcu_dereference(f6i->fib6_node);
 284
 285         if (fn) {
 286                 *cookie = READ_ONCE(fn->fn_sernum);
 287                 /* pairs with smp_wmb() in __fib6_update_sernum_upto_root() */
 288                 smp_rmb();
 289                 status = true;
 290         }
 291
 292         return status;
 293 }
 294
 295 static inline u32 rt6_get_cookie(const struct rt6_info *rt)
 296 {
 297         struct fib6_info *from;
 298         u32 cookie = 0;
 299
 300         if (rt->sernum)
 301                 return rt->sernum;
 302
 303         rcu_read_lock();
 304
 305         from = rcu_dereference(rt->from);
 306         if (from)
 307                 fib6_get_cookie_safe(from, &cookie);
 308
 309         rcu_read_unlock();
 310
 311         return cookie;
 312 }
 313
 314 static inline void ip6_rt_put(struct rt6_info *rt)
 315 {
 316         /* dst_release() accepts a NULL parameter.
 317          * We rely on dst being first structure in struct rt6_info
 318          */
 319         BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
 320         dst_release(&rt->dst);
 321 }
 322
 323 struct fib6_info *fib6_info_alloc(gfp_t gfp_flags, bool with_fib6_nh);
 324 void fib6_info_destroy_rcu(struct rcu_head *head);
 325
 326 static inline void fib6_info_hold(struct fib6_info *f6i)
 327 {
 328         refcount_inc(&f6i->fib6_ref);
 329 }
 330
 331 static inline bool fib6_info_hold_safe(struct fib6_info *f6i)
 332 {
 333         return refcount_inc_not_zero(&f6i->fib6_ref);
 334 }
 335
 336 static inline void fib6_info_release(struct fib6_info *f6i)
 337 {
 338         if (f6i && refcount_dec_and_test(&f6i->fib6_ref))
 339                 call_rcu(&f6i->rcu, fib6_info_destroy_rcu);
 340 }
 341
 342 enum fib6_walk_state {
 343 #ifdef CONFIG_IPV6_SUBTREES
 344         FWS_S,
 345 #endif
 346         FWS_L,
 347         FWS_R,
 348         FWS_C,
 349         FWS_U
 350 };
 351
 352 struct fib6_walker {
 353         struct list_head lh;
 354         struct fib6_node *root, *node;
 355         struct fib6_info *leaf;
 356         enum fib6_walk_state state;
 357         unsigned int skip;
 358         unsigned int count;
 359         unsigned int skip_in_node;
 360         int (*func)(struct fib6_walker *);
 361         void *args;
 362 };
 363
 364 struct rt6_statistics {
 365         __u32           fib_nodes;              /* all fib6 nodes */
 366         __u32           fib_route_nodes;        /* intermediate nodes */
 367         __u32           fib_rt_entries;         /* rt entries in fib table */
 368         __u32           fib_rt_cache;           /* cached rt entries in exception table */
 369         __u32           fib_discarded_routes;   /* total number of routes delete */
 370
 371         /* The following stats are not protected by any lock */
 372         atomic_t        fib_rt_alloc;           /* total number of routes alloced */
 373         atomic_t        fib_rt_uncache;         /* rt entries in uncached list */
 374 };
 375
 376 #define RTN_TL_ROOT     0x0001
 377 #define RTN_ROOT        0x0002          /* tree root node               */
 378 #define RTN_RTINFO      0x0004          /* node with valid routing info */
 379
 380 /*
 381  *      priority levels (or metrics)
 382  *
 383  */
 384
 385
 386 struct fib6_table {
 387         struct hlist_node       tb6_hlist;
 388         u32                     tb6_id;
 389         spinlock_t              tb6_lock;
 390         struct fib6_node        tb6_root;
 391         struct inet_peer_base   tb6_peers;
 392         unsigned int            flags;
 393         unsigned int            fib_seq;
 394 #define RT6_TABLE_HAS_DFLT_ROUTER       BIT(0)
 395 };
 396
 397 #define RT6_TABLE_UNSPEC        RT_TABLE_UNSPEC
 398 #define RT6_TABLE_MAIN          RT_TABLE_MAIN
 399 #define RT6_TABLE_DFLT          RT6_TABLE_MAIN
 400 #define RT6_TABLE_INFO          RT6_TABLE_MAIN
 401 #define RT6_TABLE_PREFIX        RT6_TABLE_MAIN
 402
 403 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 404 #define FIB6_TABLE_MIN          1
 405 #define FIB6_TABLE_MAX          RT_TABLE_MAX
 406 #define RT6_TABLE_LOCAL         RT_TABLE_LOCAL
 407 #else
 408 #define FIB6_TABLE_MIN          RT_TABLE_MAIN
 409 #define FIB6_TABLE_MAX          FIB6_TABLE_MIN
 410 #define RT6_TABLE_LOCAL         RT6_TABLE_MAIN
 411 #endif
 412
 413 typedef struct rt6_info *(*pol_lookup_t)(struct net *,
 414                                          struct fib6_table *,
 415                                          struct flowi6 *,
 416                                          const struct sk_buff *, int);
 417
 418 struct fib6_entry_notifier_info {
 419         struct fib_notifier_info info; /* must be first */
 420         struct fib6_info *rt;
 421         unsigned int nsiblings;
 422 };
 423
 424 /*
 425  *      exported functions
 426  */
 427
 428 struct fib6_table *fib6_get_table(struct net *net, u32 id);
 429 struct fib6_table *fib6_new_table(struct net *net, u32 id);
 430 struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
 431                                    const struct sk_buff *skb,
 432                                    int flags, pol_lookup_t lookup);
 433
 434 /* called with rcu lock held; can return error pointer
 435  * caller needs to select path
 436  */
 437 int fib6_lookup(struct net *net, int oif, struct flowi6 *fl6,
 438                 struct fib6_result *res, int flags);
 439
 440 /* called with rcu lock held; caller needs to select path */
 441 int fib6_table_lookup(struct net *net, struct fib6_table *table,
 442                       int oif, struct flowi6 *fl6, struct fib6_result *res,
 443                       int strict);
 444
 445 void fib6_select_path(const struct net *net, struct fib6_result *res,
 446                       struct flowi6 *fl6, int oif, bool have_oif_match,
 447                       const struct sk_buff *skb, int strict);
 448 struct fib6_node *fib6_node_lookup(struct fib6_node *root,
 449                                    const struct in6_addr *daddr,
 450                                    const struct in6_addr *saddr);
 451
 452 struct fib6_node *fib6_locate(struct fib6_node *root,
 453                               const struct in6_addr *daddr, int dst_len,
 454                               const struct in6_addr *saddr, int src_len,
 455                               bool exact_match);
 456
 457 void fib6_clean_all(struct net *net, int (*func)(struct fib6_info *, void *arg),
 458                     void *arg);
 459 void fib6_clean_all_skip_notify(struct net *net,
 460                                 int (*func)(struct fib6_info *, void *arg),
 461                                 void *arg);
 462
 463 int fib6_add(struct fib6_node *root, struct fib6_info *rt,
 464              struct nl_info *info, struct netlink_ext_ack *extack);
 465 int fib6_del(struct fib6_info *rt, struct nl_info *info);
 466
 467 static inline
 468 void rt6_get_prefsrc(const struct rt6_info *rt, struct in6_addr *addr)
 469 {
 470         const struct fib6_info *from;
 471
 472         rcu_read_lock();
 473
 474         from = rcu_dereference(rt->from);
 475         if (from) {
 476                 *addr = from->fib6_prefsrc.addr;
 477         } else {
 478                 struct in6_addr in6_zero = {};
 479
 480                 *addr = in6_zero;
 481         }
 482
 483         rcu_read_unlock();
 484 }
 485
 486 int fib6_nh_init(struct net *net, struct fib6_nh *fib6_nh,
 487                  struct fib6_config *cfg, gfp_t gfp_flags,
 488                  struct netlink_ext_ack *extack);
 489 void fib6_nh_release(struct fib6_nh *fib6_nh);
 490 void fib6_nh_release_dsts(struct fib6_nh *fib6_nh);
 491
 492 int call_fib6_entry_notifiers(struct net *net,
 493                               enum fib_event_type event_type,
 494                               struct fib6_info *rt,
 495                               struct netlink_ext_ack *extack);
 496 int call_fib6_multipath_entry_notifiers(struct net *net,
 497                                         enum fib_event_type event_type,
 498                                         struct fib6_info *rt,
 499                                         unsigned int nsiblings,
 500                                         struct netlink_ext_ack *extack);
 501 int call_fib6_entry_notifiers_replace(struct net *net, struct fib6_info *rt);
 502 void fib6_rt_update(struct net *net, struct fib6_info *rt,
 503                     struct nl_info *info);
 504 void inet6_rt_notify(int event, struct fib6_info *rt, struct nl_info *info,
 505                      unsigned int flags);
 506
 507 void fib6_run_gc(unsigned long expires, struct net *net, bool force);
 508
 509 void fib6_gc_cleanup(void);
 510
 511 int fib6_init(void);
 512
 513 struct ipv6_route_iter {
 514         struct seq_net_private p;
 515         struct fib6_walker w;
 516         loff_t skip;
 517         struct fib6_table *tbl;
 518         int sernum;
 519 };
 520
 521 extern const struct seq_operations ipv6_route_seq_ops;
 522
 523 int call_fib6_notifier(struct notifier_block *nb,
 524                        enum fib_event_type event_type,
 525                        struct fib_notifier_info *info);
 526 int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
 527                         struct fib_notifier_info *info);
 528
 529 int __net_init fib6_notifier_init(struct net *net);
 530 void __net_exit fib6_notifier_exit(struct net *net);
 531
 532 unsigned int fib6_tables_seq_read(struct net *net);
 533 int fib6_tables_dump(struct net *net, struct notifier_block *nb,
 534                      struct netlink_ext_ack *extack);
 535
 536 void fib6_update_sernum(struct net *net, struct fib6_info *rt);
 537 void fib6_update_sernum_upto_root(struct net *net, struct fib6_info *rt);
 538 void fib6_update_sernum_stub(struct net *net, struct fib6_info *f6i);
 539
 540 void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
 541 static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
 542 {
 543         return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
 544 }
 545 void fib6_info_hw_flags_set(struct net *net, struct fib6_info *f6i,
 546                             bool offload, bool trap, bool offload_failed);
 547
 548 #if IS_BUILTIN(CONFIG_IPV6) && defined(CONFIG_BPF_SYSCALL)
 549 struct bpf_iter__ipv6_route {
 550         __bpf_md_ptr(struct bpf_iter_meta *, meta);
 551         __bpf_md_ptr(struct fib6_info *, rt);
 552 };
 553 #endif
 554
 555 INDIRECT_CALLABLE_DECLARE(struct rt6_info *ip6_pol_route_output(struct net *net,
 556                                              struct fib6_table *table,
 557                                              struct flowi6 *fl6,
 558                                              const struct sk_buff *skb,
 559                                              int flags));
 560 INDIRECT_CALLABLE_DECLARE(struct rt6_info *ip6_pol_route_input(struct net *net,
 561                                              struct fib6_table *table,
 562                                              struct flowi6 *fl6,
 563                                              const struct sk_buff *skb,
 564                                              int flags));
 565 INDIRECT_CALLABLE_DECLARE(struct rt6_info *__ip6_route_redirect(struct net *net,
 566                                              struct fib6_table *table,
 567                                              struct flowi6 *fl6,
 568                                              const struct sk_buff *skb,
 569                                              int flags));
 570 INDIRECT_CALLABLE_DECLARE(struct rt6_info *ip6_pol_route_lookup(struct net *net,
 571                                              struct fib6_table *table,
 572                                              struct flowi6 *fl6,
 573                                              const struct sk_buff *skb,
 574                                              int flags));
 575 static inline struct rt6_info *pol_lookup_func(pol_lookup_t lookup,
 576                                                 struct net *net,
 577                                                 struct fib6_table *table,
 578                                                 struct flowi6 *fl6,
 579                                                 const struct sk_buff *skb,
 580                                                 int flags)
 581 {
 582         return INDIRECT_CALL_4(lookup,
 583                                ip6_pol_route_output,
 584                                ip6_pol_route_input,
 585                                ip6_pol_route_lookup,
 586                                __ip6_route_redirect,
 587                                net, table, fl6, skb, flags);
 588 }
 589
 590 #ifdef CONFIG_IPV6_MULTIPLE_TABLES
 591 static inline bool fib6_has_custom_rules(const struct net *net)
 592 {
 593         return net->ipv6.fib6_has_custom_rules;
 594 }
 595
 596 int fib6_rules_init(void);
 597 void fib6_rules_cleanup(void);
 598 bool fib6_rule_default(const struct fib_rule *rule);
 599 int fib6_rules_dump(struct net *net, struct notifier_block *nb,
 600                     struct netlink_ext_ack *extack);
 601 unsigned int fib6_rules_seq_read(struct net *net);
 602
 603 static inline bool fib6_rules_early_flow_dissect(struct net *net,
 604                                                  struct sk_buff *skb,
 605                                                  struct flowi6 *fl6,
 606                                                  struct flow_keys *flkeys)
 607 {
 608         unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
 609
 610         if (!net->ipv6.fib6_rules_require_fldissect)
 611                 return false;
 612
 613         skb_flow_dissect_flow_keys(skb, flkeys, flag);
 614         fl6->fl6_sport = flkeys->ports.src;
 615         fl6->fl6_dport = flkeys->ports.dst;
 616         fl6->flowi6_proto = flkeys->basic.ip_proto;
 617
 618         return true;
 619 }
 620 #else
 621 static inline bool fib6_has_custom_rules(const struct net *net)
 622 {
 623         return false;
 624 }
 625 static inline int               fib6_rules_init(void)
 626 {
 627         return 0;
 628 }
 629 static inline void              fib6_rules_cleanup(void)
 630 {
 631         return ;
 632 }
 633 static inline bool fib6_rule_default(const struct fib_rule *rule)
 634 {
 635         return true;
 636 }
 637 static inline int fib6_rules_dump(struct net *net, struct notifier_block *nb,
 638                                   struct netlink_ext_ack *extack)
 639 {
 640         return 0;
 641 }
 642 static inline unsigned int fib6_rules_seq_read(struct net *net)
 643 {
 644         return 0;
 645 }
 646 static inline bool fib6_rules_early_flow_dissect(struct net *net,
 647                                                  struct sk_buff *skb,
 648                                                  struct flowi6 *fl6,
 649                                                  struct flow_keys *flkeys)
 650 {
 651         return false;
 652 }
 653 #endif
 654 #endif