rt.h 4.9 KB
Newer Older
1 2 3
/*
 *      BIRD -- OSPF
 *
4
 *      (c) 2000--2004 Ondrej Filip <feela@network.cz>
5 6
 *	(c) 2009--2014 Ondrej Zajicek <santiago@crfreenet.org>
 *	(c) 2009--2014 CZ.NIC z.s.p.o.
7 8 9 10 11 12 13
 *
 *      Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_OSPF_RT_H_
#define _BIRD_OSPF_RT_H_

14

Ondřej Filip's avatar
Ondřej Filip committed
15
#define ORT_NET 0
16
#define ORT_ROUTER 1
Ondřej Filip's avatar
Ondřej Filip committed
17

18
typedef struct orta
Ondřej Filip's avatar
Ondřej Filip committed
19
{
20
  u8 type;			/* RTS_OSPF_* */
21 22
  u8 nhs_reuse;			/* Whether nhs nodes can be reused during merging.
				   See a note in rt.c:add_cand() */
23 24 25 26 27 28 29
  u32 options;
  /*
   * For ORT_ROUTER routes, options field are router-LSA style
   * options, with V,E,B bits. In OSPFv2, ASBRs from another areas
   * (that we know from rt-summary-lsa) have just ORTA_ASBR in
   * options, their real options are unknown.
   */
30
#define ORTA_ASBR OPT_RT_E
31
#define ORTA_ABR  OPT_RT_B
32
  /*
33 34 35 36 37 38 39 40 41 42 43
   * For ORT_NET routes, there are just several flags for external routes:
   *
   * ORTA_PREF for external routes means that the route is preferred in AS
   * external route selection according to 16.4.1. - it is intra-area path using
   * non-backbone area. In other words, the forwarding address (or ASBR if
   * forwarding address is zero) is intra-area (type == RTS_OSPF) and its area
   * is not a backbone.
   *
   * ORTA_NSSA means that the entry represents an NSSA route, and ORTA_PROP
   * means that the NSSA route has propagate-bit set. These flags are used in
   * NSSA translation.
44 45
   */
#define ORTA_PREF 0x80000000
46 47 48
#define ORTA_NSSA 0x40000000
#define ORTA_PROP 0x20000000

Ondřej Filip's avatar
Ondřej Filip committed
49 50
  u32 metric1;
  u32 metric2;
51
  u32 tag;
52
  u32 rid;			/* Router ID of real advertising router */
53
  struct ospf_area *oa;
54 55 56
  struct ospf_area *voa;	/* Used when route is replaced in ospf_rt_sum_tr(),
				   NULL otherwise */
  struct mpnh *nhs;		/* Next hops computed during SPF */
57
  struct top_hash_entry *en;	/* LSA responsible for this orta */
58 59
}
orta;
60

61
typedef struct ort
Ondřej Filip's avatar
Ondřej Filip committed
62
{
63
  /*
64 65 66 67 68 69 70 71 72 73 74
   * Most OSPF routing table entries are for computed OSPF routes, these have
   * defined n.type. There are also few other cases: entries for configured area
   * networks (these have area_net field set) and entries for external routes
   * exported to OSPF (these have external_rte field set). These entries are
   * kept even if they do not contain 'proper' rt entry. That is needed to keep
   * allocated stable UID numbers (fn.uid), which are used as LSA IDs in OSPFv3
   * (see fibnode_to_lsaid()) for related LSAs (network summary LSAs in the
   * first case, external or NSSA LSAs in the second case). Entries for external
   * routes also have a second purpose - to prevent NSSA translation of received
   * NSSA routes if regular external routes were already originated for the same
   * network (see check_nssa_lsa()).
75
   *
76 77 78 79
   * old_* values are here to represent the last route update. old_rta is cached
   * (we keep reference), mainly for multipath nexthops.  old_rta == NULL means
   * route was not in the last update, in that case other old_* values are not
   * valid.
80
   */
81
  orta n;
82 83
  u32 old_metric1, old_metric2, old_tag, old_rid;
  rta *old_rta;
84
  u32 lsa_id;
85
  u8 external_rte;
86
  u8 area_net;
87
  u8 keep;
88 89

  struct fib_node fn;
90 91
}
ort;
92

93 94 95 96
static inline int rt_is_nssa(ort *nf)
{ return nf->n.options & ORTA_NSSA; }


97 98 99 100 101 102
/*
 * Invariants for structs top_hash_entry (nodes of LSA db)
 * enforced by SPF calculation for final nodes (color == INSPF):
 * - only router, network and AS-external LSAs
 * - lsa.age < LSA_MAXAGE
 * - dist < LSINFINITY (or 2*LSINFINITY for ext-LSAs)
103 104
 * - nhs is non-NULL unless the node is oa->rt (calculating router itself)
 * - beware, nhs is not valid after SPF calculation
105 106
 *
 * Invariants for structs orta nodes of fib tables po->rtf, oa->rtr:
107
 * - nodes may be invalid (n.type == 0), in that case other invariants don't hold
108 109
 * - n.metric1 may be at most a small multiple of LSINFINITY,
 *   therefore sums do not overflow
110
 * - n.oa is always non-NULL
111 112
 * - n.nhs is always non-NULL unless it is configured stubnet
 * - n.en is non-NULL for external routes, NULL for intra/inter area routes.
113
 * - oa->rtr does not contain calculating router itself
114
 *
115
 * There are four types of nexthops in nhs fields:
116 117 118
 * - gateway nexthops (non-NULL iface, gw != IPA_NONE)
 * - device nexthops (non-NULL iface, gw == IPA_NONE)
 * - dummy vlink nexthops (NULL iface, gw == IPA_NONE)
119 120 121 122 123 124 125 126 127 128
 * - configured stubnets (nhs is NULL, only RTS_OSPF orta nodes in po->rtf)
 *
 * Dummy vlink nexthops and configured stubnets cannot be mixed with
 * regular ones, nhs field contains either list of gateway+device nodes,
 * one vlink node, or NULL for configured stubnet.
 *
 * Dummy vlink nexthops can appear in both network (rtf) and backbone area router
 * (rtr) tables for regular and inter-area routes, but only if areano > 1. They are
 * replaced in ospf_rt_sum_tr() and removed in ospf_rt_abr1(), therefore cannot
 * appear in ASBR pre-selection and external routes processing.
129 130
 */

131
void ospf_rt_spf(struct ospf_proto *p);
132 133
void ospf_rt_initort(struct fib_node *fn);

134 135

#endif /* _BIRD_OSPF_RT_H_ */