]> git.proxmox.com Git - mirror_frr.git/blame - bgpd/bgp_attr.h
bgpd: cleanup vty bgp_node_afi/safi utils
[mirror_frr.git] / bgpd / bgp_attr.h
CommitLineData
718e3744 1/* BGP attributes.
2 Copyright (C) 1996, 97, 98 Kunihiro Ishiguro
3
4This file is part of GNU Zebra.
5
6GNU Zebra is free software; you can redistribute it and/or modify it
7under the terms of the GNU General Public License as published by the
8Free Software Foundation; either version 2, or (at your option) any
9later version.
10
11GNU Zebra is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Zebra; see the file COPYING. If not, write to the Free
18Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
1902111-1307, USA. */
20
00d252cb 21#ifndef _QUAGGA_BGP_ATTR_H
22#define _QUAGGA_BGP_ATTR_H
23
718e3744 24/* Simple bit mapping. */
25#define BITMAP_NBBY 8
26
27#define SET_BITMAP(MAP, NUM) \
28 SET_FLAG (MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
29
30#define CHECK_BITMAP(MAP, NUM) \
31 CHECK_FLAG (MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
32
3b424979 33#define BGP_MED_MAX UINT32_MAX
34
03e214c8 35
718e3744 36/* BGP Attribute type range. */
37#define BGP_ATTR_TYPE_RANGE 256
38#define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
39
40/* BGP Attribute flags. */
41#define BGP_ATTR_FLAG_OPTIONAL 0x80 /* Attribute is optional. */
42#define BGP_ATTR_FLAG_TRANS 0x40 /* Attribute is transitive. */
43#define BGP_ATTR_FLAG_PARTIAL 0x20 /* Attribute is partial. */
44#define BGP_ATTR_FLAG_EXTLEN 0x10 /* Extended length flag. */
45
46/* BGP attribute header must bigger than 2. */
370b64a2 47#define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
03e214c8
PJ
48#define BGP_ATTR_DEFAULT_WEIGHT 32768
49
801a9bcc
DS
50/* Valid lengths for mp_nexthop_len */
51#define BGP_ATTR_NHLEN_IPV4 IPV4_MAX_BYTELEN
945c8fe9 52#define BGP_ATTR_NHLEN_VPNV4 8+IPV4_MAX_BYTELEN
801a9bcc
DS
53#define BGP_ATTR_NHLEN_IPV6_GLOBAL IPV6_MAX_BYTELEN
54#define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
945c8fe9
LB
55#define BGP_ATTR_NHLEN_VPNV6_GLOBAL 8+IPV6_MAX_BYTELEN
56#define BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL ((8+IPV6_MAX_BYTELEN) * 2)
801a9bcc 57
f4c89855
LB
58
59struct bgp_attr_encap_subtlv {
60 struct bgp_attr_encap_subtlv *next; /* for chaining */
61 uint16_t type;
62 uint16_t length;
63 uint8_t value[1]; /* will be extended */
64};
65
fb982c25
PJ
66/* Additional/uncommon BGP attributes.
67 * lazily allocated as and when a struct attr
68 * requires it.
69 */
70struct attr_extra
718e3744 71{
fb982c25 72 /* Multi-Protocol Nexthop, AFI IPv6 */
718e3744 73 struct in6_addr mp_nexthop_global;
74 struct in6_addr mp_nexthop_local;
718e3744 75
718e3744 76 /* Extended Communities attribute. */
77 struct ecommunity *ecommunity;
cbdfbaa5
PJ
78
79 /* Route-Reflector Cluster attribute */
80 struct cluster_list *cluster;
81
718e3744 82 /* Unknown transitive attribute. */
83 struct transit *transit;
cbdfbaa5 84
fb982c25 85 struct in_addr mp_nexthop_global_in;
fb982c25
PJ
86
87 /* Aggregator Router ID attribute */
88 struct in_addr aggregator_addr;
89
90 /* Route Reflector Originator attribute */
91 struct in_addr originator_id;
92
93 /* Local weight, not actually an attribute */
94 u_int32_t weight;
95
96 /* Aggregator ASN */
97 as_t aggregator_as;
98
99 /* MP Nexthop length */
100 u_char mp_nexthop_len;
0d9551dc 101
161995ea
DS
102 /* MP Nexthop preference */
103 u_char mp_nexthop_prefer_global;
104
0d9551dc
DS
105 /* route tag */
106 u_short tag;
f4c89855
LB
107
108 uint16_t encap_tunneltype; /* grr */
109 struct bgp_attr_encap_subtlv *encap_subtlvs; /* rfc5512 */
fb982c25
PJ
110};
111
112/* BGP core attribute structure. */
113struct attr
114{
115 /* AS Path structure */
116 struct aspath *aspath;
117
118 /* Community structure */
119 struct community *community;
120
121 /* Lazily allocated pointer to extra attributes */
122 struct attr_extra *extra;
123
cbdfbaa5
PJ
124 /* Reference count of this attribute. */
125 unsigned long refcnt;
126
127 /* Flag of attribute is set or not. */
128 u_int32_t flag;
129
130 /* Apart from in6_addr, the remaining static attributes */
131 struct in_addr nexthop;
132 u_int32_t med;
133 u_int32_t local_pref;
b892f1dd 134 ifindex_t nh_ifindex;
41367172 135
fb982c25 136 /* Path origin attribute */
cbdfbaa5 137 u_char origin;
3f9c7369
DS
138
139 /* has the route-map changed any attribute?
140 Used on the peer outbound side. */
141 u_int32_t rmap_change_flags;
718e3744 142};
143
3f9c7369 144/* rmap_change_flags definition */
3811f1e2 145#define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
3f9c7369
DS
146#define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
147#define BATTR_REFLECTED (1 << 2)
316e074d 148#define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
3811f1e2
DS
149#define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
150#define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
3f9c7369 151
718e3744 152/* Router Reflector related structure. */
153struct cluster_list
154{
155 unsigned long refcnt;
156 int length;
157 struct in_addr *list;
158};
159
160/* Unknown transit attribute. */
161struct transit
162{
163 unsigned long refcnt;
164 int length;
165 u_char *val;
166};
167
168#define ATTR_FLAG_BIT(X) (1 << ((X) - 1))
169
5e242b0d
DS
170#define BGP_CLUSTER_LIST_LENGTH(attr) \
171 (((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) ? \
172 (attr)->extra->cluster->length : 0)
173
b881c707
PJ
174typedef enum {
175 BGP_ATTR_PARSE_PROCEED = 0,
176 BGP_ATTR_PARSE_ERROR = -1,
177 BGP_ATTR_PARSE_WITHDRAW = -2,
f57000c0
DL
178
179 /* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR */
180 BGP_ATTR_PARSE_ERROR_NOTIFYPLS = -3,
b881c707
PJ
181} bgp_attr_parse_ret_t;
182
3f9c7369
DS
183struct bpacket_attr_vec_arr;
184
718e3744 185/* Prototypes. */
94f2b392 186extern void bgp_attr_init (void);
228da428 187extern void bgp_attr_finish (void);
b881c707
PJ
188extern bgp_attr_parse_ret_t bgp_attr_parse (struct peer *, struct attr *,
189 bgp_size_t, struct bgp_nlri *,
52a51fd3 190 struct bgp_nlri *);
fb982c25
PJ
191extern struct attr_extra *bgp_attr_extra_get (struct attr *);
192extern void bgp_attr_extra_free (struct attr *);
193extern void bgp_attr_dup (struct attr *, struct attr *);
73ac8160
DS
194extern void bgp_attr_deep_dup (struct attr *, struct attr *);
195extern void bgp_attr_deep_free (struct attr *);
94f2b392 196extern struct attr *bgp_attr_intern (struct attr *attr);
3f9c7369 197extern struct attr *bgp_attr_refcount (struct attr *attr);
b881c707 198extern void bgp_attr_unintern_sub (struct attr *);
f6f434b2 199extern void bgp_attr_unintern (struct attr **);
94f2b392 200extern void bgp_attr_flush (struct attr *);
201extern struct attr *bgp_attr_default_set (struct attr *attr, u_char);
202extern struct attr *bgp_attr_default_intern (u_char);
203extern struct attr *bgp_attr_aggregate_intern (struct bgp *, u_char,
5228ad27 204 struct aspath *,
42f7e184 205 struct community *, int as_set, u_char);
8c71e481
PM
206extern bgp_size_t bgp_packet_attribute (struct bgp *bgp, struct peer *,
207 struct stream *, struct attr *,
3f9c7369 208 struct bpacket_attr_vec_arr *vecarr,
8c71e481
PM
209 struct prefix *, afi_t, safi_t,
210 struct peer *, struct prefix_rd *,
adbac85e 211 u_char *, int, u_int32_t);
94f2b392 212extern void bgp_dump_routes_attr (struct stream *, struct attr *,
adbac85e 213 struct prefix *);
ffe11cfb 214extern int attrhash_cmp (const void *, const void *);
923de654 215extern unsigned int attrhash_key_make (void *);
94f2b392 216extern void attr_show_all (struct vty *);
cbdfbaa5
PJ
217extern unsigned long int attr_count (void);
218extern unsigned long int attr_unknown_count (void);
718e3744 219
220/* Cluster list prototypes. */
94f2b392 221extern int cluster_loop_check (struct cluster_list *, struct in_addr);
222extern void cluster_unintern (struct cluster_list *);
718e3744 223
224/* Transit attribute prototypes. */
225void transit_unintern (struct transit *);
00d252cb 226
835315bf
PJ
227/* Below exported for unit-test purposes only */
228struct bgp_attr_parser_args {
229 struct peer *peer;
230 bgp_size_t length; /* attribute data length; */
231 bgp_size_t total; /* total length, inc header */
232 struct attr *attr;
233 u_int8_t type;
234 u_int8_t flags;
235 u_char *startp;
236};
237extern int bgp_mp_reach_parse (struct bgp_attr_parser_args *args,
238 struct bgp_nlri *);
239extern int bgp_mp_unreach_parse (struct bgp_attr_parser_args *args,
240 struct bgp_nlri *);
03292809 241
f4c89855
LB
242extern struct bgp_attr_encap_subtlv *
243encap_tlv_dup(struct bgp_attr_encap_subtlv *orig);
244
245extern void
246bgp_attr_flush_encap(struct attr *attr);
247
8c71e481
PM
248/**
249 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
250 * Typical call sequence is to call _start(), followed by multiple _prefix(),
251 * one for each NLRI that needs to be encoded into the UPDATE message, and
252 * finally the _end() function.
253 */
254extern size_t bgp_packet_mpattr_start(struct stream *s, afi_t afi, safi_t safi,
8a92a8a0
DS
255 afi_t nh_afi,
256 struct bpacket_attr_vec_arr *vecarr,
8c71e481
PM
257 struct attr *attr);
258extern void bgp_packet_mpattr_prefix(struct stream *s, afi_t afi, safi_t safi,
259 struct prefix *p, struct prefix_rd *prd,
adbac85e
DW
260 u_char *tag, int addpath_encode,
261 u_int32_t addpath_tx_id);
93b73dfa
LB
262extern size_t bgp_packet_mpattr_prefix_size(afi_t afi, safi_t safi,
263 struct prefix *p);
8c71e481
PM
264extern void bgp_packet_mpattr_end(struct stream *s, size_t sizep);
265
266extern size_t bgp_packet_mpunreach_start (struct stream *s, afi_t afi,
267 safi_t safi);
268extern void bgp_packet_mpunreach_prefix (struct stream *s, struct prefix *p,
269 afi_t afi, safi_t safi, struct prefix_rd *prd,
adbac85e 270 u_char *tag, int, u_int32_t);
8c71e481
PM
271extern void bgp_packet_mpunreach_end (struct stream *s, size_t attrlen_pnt);
272
3811f1e2
DS
273static inline int
274bgp_rmap_nhop_changed(u_int32_t out_rmap_flags, u_int32_t in_rmap_flags)
275{
276 return ((CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_PEER_ADDRESS) ||
277 CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED) ||
278 CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV4_NHOP_CHANGED) ||
279 CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED) ||
280 CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV6_LL_NHOP_CHANGED) ||
281 CHECK_FLAG(in_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED)) ? 1 : 0);
282}
283
00d252cb 284#endif /* _QUAGGA_BGP_ATTR_H */