lib/srcdest_table.h

   1 /*
   2  * SRC-DEST Routing Table
   3  *
   4  * Copyright (C) 2017 by David Lamparter & Christian Franke,
   5  *                       Open Source Routing / NetDEF Inc.
   6  *
   7  * This file is part of FreeRangeRouting (FRR)
   8  *
   9  * FRR is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; either version 2, or (at your option) any
  12  * later version.
  13  *
  14  * FRR is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; see the file COPYING; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 #ifndef _ZEBRA_SRC_DEST_TABLE_H
  25 #define _ZEBRA_SRC_DEST_TABLE_H
  26
  27 /* old/IPv4/non-srcdest:
  28  * table -> route_node .info -> [obj]
  29  *
  30  * new/IPv6/srcdest:
  31  * table -...-> srcdest_rnode [prefix = dest] .info -> [obj]
  32  *                                            .src_table ->
  33  *         srcdest table -...-> route_node [prefix = src] .info -> [obj]
  34  *
  35  * non-srcdest routes (src = ::/0) are treated just like before, their
  36  * information being directly there in the info pointer.
  37  *
  38  * srcdest routes are found by looking up destination first, then looking
  39  * up the source in the "src_table".  src_table contains normal route_nodes,
  40  * whose prefix is the _source_ prefix.
  41  *
  42  * NB: info can be NULL on the destination rnode, if there are only srcdest
  43  * routes for a particular destination prefix.
  44  */
  45
  46 #include "prefix.h"
  47 #include "table.h"
  48
  49 #define SRCDEST2STR_BUFFER (2*PREFIX2STR_BUFFER + sizeof(" from "))
  50
  51 /* extended route node for IPv6 srcdest routing */
  52 struct srcdest_rnode;
  53
  54 extern route_table_delegate_t _srcdest_dstnode_delegate;
  55 extern route_table_delegate_t _srcdest_srcnode_delegate;
  56
  57 extern struct route_table *srcdest_table_init(void);
  58 extern struct route_node *srcdest_rnode_get(struct route_table *table,
  59                                             union prefixconstptr dst_pu,
  60                                             const struct prefix_ipv6 *src_p);
  61 extern struct route_node *srcdest_rnode_lookup(struct route_table *table,
  62                                                union prefixconstptr dst_pu,
  63                                                const struct prefix_ipv6 *src_p);
  64 extern void srcdest_rnode_prefixes(struct route_node *rn,
  65                                    const struct prefix **p,
  66                                    const struct prefix **src_p);
  67 extern const char *srcdest2str(const struct prefix *dst_p,
  68                                const struct prefix_ipv6 *src_p,
  69                                char *str, int size);
  70 extern const char *srcdest_rnode2str(struct route_node *rn, char *str,
  71                                      int size);
  72 extern struct route_node *srcdest_route_next(struct route_node *rn);
  73
  74 static inline int rnode_is_dstnode(struct route_node *rn)
  75 {
  76         return rn->table->delegate == &_srcdest_dstnode_delegate;
  77 }
  78
  79 static inline int rnode_is_srcnode(struct route_node *rn)
  80 {
  81         return rn->table->delegate == &_srcdest_srcnode_delegate;
  82 }
  83
  84 static inline struct route_table *srcdest_rnode_table(struct route_node *rn)
  85 {
  86         if (rnode_is_srcnode(rn)) {
  87                 struct route_node *dst_rn = route_table_get_info(rn->table);
  88                 return dst_rn->table;
  89         } else {
  90                 return rn->table;
  91         }
  92 }
  93 static inline void *srcdest_rnode_table_info(struct route_node *rn)
  94 {
  95         return route_table_get_info(srcdest_rnode_table(rn));
  96 }
  97
  98 #endif /* _ZEBRA_SRC_DEST_TABLE_H */