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