2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.protocol.bgp.linkstate.impl.attribute;
10 import static org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.binding.sid.sub.tlvs.Ipv4PrefixSidParser.PREFIX_SID;
11 import static org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.binding.sid.sub.tlvs.Ipv6PrefixSidParser.IPV6_PREFIX_SID;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.collect.Multimap;
15 import io.netty.buffer.ByteBuf;
16 import io.netty.buffer.ByteBufUtil;
17 import io.netty.buffer.Unpooled;
18 import java.util.ArrayList;
19 import java.util.List;
20 import java.util.Map.Entry;
21 import org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.BindingSidLabelParser;
22 import org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.Ipv6SrPrefixAttributesParser;
23 import org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.RangeTlvParser;
24 import org.opendaylight.protocol.bgp.linkstate.impl.attribute.sr.SrPrefixAttributesParser;
25 import org.opendaylight.protocol.bgp.linkstate.spi.TlvUtil;
26 import org.opendaylight.protocol.util.BitArray;
27 import org.opendaylight.protocol.util.ByteArray;
28 import org.opendaylight.protocol.util.Ipv4Util;
29 import org.opendaylight.protocol.util.Ipv6Util;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.ExtendedRouteTag;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.IgpBits.UpDown;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.ProtocolId;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.RouteTag;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.LinkStateAttribute;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.PrefixAttributesCase;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.PrefixAttributesCaseBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributes;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributesBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.prefix.state.IgpBits;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.prefix.state.IgpBitsBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.prefix.state.Ipv6SrPrefix;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.prefix.state.SrBindingSidLabels;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.prefix.state.SrPrefix;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.prefix.state.SrRange;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IgpMetric;
47 import org.opendaylight.yangtools.yang.common.netty.ByteBufUtils;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 public final class PrefixAttributesParser {
54 /* Segment routing TLV */
55 public static final int BINDING_SID = 1160;
56 private static final Logger LOG = LoggerFactory.getLogger(PrefixAttributesParser.class);
57 private static final int ROUTE_TAG_LENGTH = 4;
58 private static final int EXTENDED_ROUTE_TAG_LENGTH = 8;
59 private static final int FLAGS_SIZE = 8;
60 private static final int UP_DOWN_BIT = 0;
61 private static final int OSPF_NO_UNICAST = 1;
62 private static final int OSPF_LOCAL_ADDRESS = 2;
63 private static final int OSPF_PROPAGATE_ADDRESS = 3;
64 /* Prefix Attribute TLVs */
65 private static final int IGP_FLAGS = 1152;
66 private static final int ROUTE_TAG = 1153;
67 private static final int EXTENDED_ROUTE_TAG = 1154;
68 private static final int PREFIX_METRIC = 1155;
69 private static final int FORWARDING_ADDRESS = 1156;
70 private static final int PREFIX_OPAQUE = 1157;
71 private static final int RANGE = 1159;
73 private PrefixAttributesParser() {
78 * Parse prefix attributes.
80 * @param attributes key is the tlv type and value are the value bytes of the tlv
81 * @param protocolId to differentiate parsing methods
82 * @return {@link LinkStateAttribute}
84 static LinkStateAttribute parsePrefixAttributes(final Multimap<Integer, ByteBuf> attributes,
85 final ProtocolId protocolId) {
86 final PrefixAttributesBuilder builder = new PrefixAttributesBuilder();
87 final List<RouteTag> routeTags = new ArrayList<>();
88 final List<ExtendedRouteTag> exRouteTags = new ArrayList<>();
89 for (final Entry<Integer, ByteBuf> entry : attributes.entries()) {
90 final int key = entry.getKey();
91 final ByteBuf value = entry.getValue();
92 LOG.trace("Prefix attribute TLV {}", key);
93 parseAttribute(key, value, protocolId, builder, routeTags, exRouteTags);
95 LOG.trace("Finished parsing Prefix Attributes.");
96 builder.setRouteTags(routeTags);
97 builder.setExtendedTags(exRouteTags);
98 return new PrefixAttributesCaseBuilder().setPrefixAttributes(builder.build()).build();
101 private static void parseAttribute(final int key, final ByteBuf value, final ProtocolId protocolId,
102 final PrefixAttributesBuilder builder, final List<RouteTag> routeTags,
103 final List<ExtendedRouteTag> exRouteTags) {
106 parseIgpFags(builder, value);
109 parseRouteTags(routeTags, value);
111 case EXTENDED_ROUTE_TAG:
112 parseExtendedRouteTags(exRouteTags, value);
115 final IgpMetric metric = new IgpMetric(ByteBufUtils.readUint32(value));
116 builder.setPrefixMetric(metric);
117 LOG.debug("Parsed Metric: {}", metric);
119 case FORWARDING_ADDRESS:
120 final IpAddress fwdAddress = parseForwardingAddress(value);
121 builder.setOspfForwardingAddress(fwdAddress);
122 LOG.debug("Parsed FWD Address: {}", fwdAddress);
125 if (LOG.isDebugEnabled()) {
126 LOG.debug("Parsed Opaque value: {}, not preserving it", ByteBufUtil.hexDump(value));
130 final SrPrefix prefix = SrPrefixAttributesParser.parseSrPrefix(value, protocolId);
131 builder.setSrPrefix(prefix);
132 LOG.debug("Parsed SR Prefix: {}", prefix);
134 case IPV6_PREFIX_SID:
135 final Ipv6SrPrefix ipv6Prefix = Ipv6SrPrefixAttributesParser.parseSrIpv6Prefix(value);
136 builder.setIpv6SrPrefix(ipv6Prefix);
137 LOG.debug("Parsed Ipv6 SR Prefix: {}", ipv6Prefix);
140 final SrRange range = RangeTlvParser.parseSrRange(value, protocolId);
141 builder.setSrRange(range);
142 LOG.debug("Parsed SR Range: {}", range);
145 parseBindingSid(builder, value, protocolId);
148 LOG.warn("TLV {} is not a valid prefix attribute, ignoring it", key);
152 private static void parseIgpFags(final PrefixAttributesBuilder builder, final ByteBuf value) {
153 final BitArray flags = BitArray.valueOf(value, FLAGS_SIZE);
154 final boolean upDownBit = flags.get(UP_DOWN_BIT);
155 builder.setIgpBits(new IgpBitsBuilder().setUpDown(new UpDown(upDownBit)).setIsIsUpDown(upDownBit)
156 .setOspfNoUnicast(flags.get(OSPF_NO_UNICAST))
157 .setOspfLocalAddress(flags.get(OSPF_LOCAL_ADDRESS))
158 .setOspfPropagateNssa(flags.get(OSPF_PROPAGATE_ADDRESS)).build());
159 LOG.debug("Parsed IGP flag (up/down bit) : {}", upDownBit);
162 private static void parseBindingSid(final PrefixAttributesBuilder builder, final ByteBuf value,
163 final ProtocolId protocolId) {
164 final List<SrBindingSidLabels> labels;
165 if (builder.getSrBindingSidLabels() != null) {
166 labels = builder.getSrBindingSidLabels();
168 labels = new ArrayList<>();
169 builder.setSrBindingSidLabels(labels);
171 final SrBindingSidLabels label = BindingSidLabelParser.parseBindingSidLabel(value, protocolId);
173 LOG.debug("Parsed SR Binding SID {}", label);
176 private static void parseRouteTags(final List<RouteTag> routeTags, final ByteBuf value) {
177 while (value.isReadable()) {
178 final RouteTag routeTag = new RouteTag(ByteArray.readBytes(value, ROUTE_TAG_LENGTH));
179 routeTags.add(routeTag);
180 LOG.debug("Parsed Route Tag: {}", routeTag);
184 private static void parseExtendedRouteTags(final List<ExtendedRouteTag> exRouteTags, final ByteBuf value) {
185 while (value.isReadable()) {
186 final ExtendedRouteTag exRouteTag = new ExtendedRouteTag(ByteArray.readBytes(value,
187 EXTENDED_ROUTE_TAG_LENGTH));
188 exRouteTags.add(exRouteTag);
189 LOG.debug("Parsed Extended Route Tag: {}", exRouteTag);
193 private static IpAddress parseForwardingAddress(final ByteBuf value) {
194 switch (value.readableBytes()) {
195 case Ipv4Util.IP4_LENGTH:
196 return new IpAddress(Ipv4Util.addressForByteBuf(value));
197 case Ipv6Util.IPV6_LENGTH:
198 return new IpAddress(Ipv6Util.addressForByteBuf(value));
200 LOG.debug("Ignoring unsupported forwarding address length {}", value.readableBytes());
205 static void serializePrefixAttributes(final PrefixAttributesCase prefixAttributesCase,
206 final ByteBuf byteAggregator) {
207 final PrefixAttributes prefixAtrributes = prefixAttributesCase.getPrefixAttributes();
208 if (prefixAtrributes.getIgpBits() != null) {
209 final BitArray igpBit = new BitArray(FLAGS_SIZE);
210 final IgpBits igpBits = prefixAtrributes.getIgpBits();
211 igpBit.set(UP_DOWN_BIT, igpBits.getUpDown().isUpDown() || igpBits.isIsIsUpDown());
212 igpBit.set(OSPF_NO_UNICAST, igpBits.isOspfNoUnicast());
213 igpBit.set(OSPF_LOCAL_ADDRESS, igpBits.isOspfLocalAddress());
214 igpBit.set(OSPF_PROPAGATE_ADDRESS, igpBits.isOspfPropagateNssa());
215 TlvUtil.writeTLV(IGP_FLAGS, Unpooled.wrappedBuffer(igpBit.array()), byteAggregator);
217 serializeRouteTags(prefixAtrributes.getRouteTags(), byteAggregator);
218 serializeExtendedRouteTags(prefixAtrributes.getExtendedTags(), byteAggregator);
219 serializePrefixMetric(prefixAtrributes.getPrefixMetric(), byteAggregator);
220 serializeForwardingAddress(prefixAtrributes.getOspfForwardingAddress(), byteAggregator);
221 serializeSrPrefix(prefixAtrributes.getSrPrefix(), byteAggregator);
222 serializeIpv6SrPrefix(prefixAtrributes.getIpv6SrPrefix(), byteAggregator);
223 serializeSrRange(prefixAtrributes.getSrRange(), byteAggregator);
224 serializeSrBindingLabel(prefixAtrributes.getSrBindingSidLabels(), byteAggregator);
227 private static void serializeSrBindingLabel(final List<SrBindingSidLabels> srBindingSidLabels,
228 final ByteBuf byteAggregator) {
229 if (srBindingSidLabels != null) {
230 for (final SrBindingSidLabels bindingSid : srBindingSidLabels) {
231 final ByteBuf sidBuffer = Unpooled.buffer();
232 BindingSidLabelParser.serializeBindingSidAttributes(bindingSid.getWeight(), bindingSid.getFlags(),
233 bindingSid.getBindingSubTlvs(), sidBuffer);
234 TlvUtil.writeTLV(PrefixAttributesParser.BINDING_SID, sidBuffer, byteAggregator);
239 private static void serializeSrRange(final SrRange srRange, final ByteBuf byteAggregator) {
240 if (srRange != null) {
241 final ByteBuf sidBuffer = Unpooled.buffer();
242 RangeTlvParser.serializeSrRange(srRange, sidBuffer);
243 TlvUtil.writeTLV(RANGE, sidBuffer, byteAggregator);
247 private static void serializeIpv6SrPrefix(final Ipv6SrPrefix ipv6SrPrefix, final ByteBuf byteAggregator) {
248 if (ipv6SrPrefix != null) {
249 final ByteBuf buffer = Unpooled.buffer();
250 Ipv6SrPrefixAttributesParser.serializeIpv6SrPrefix(ipv6SrPrefix, buffer);
251 TlvUtil.writeTLV(IPV6_PREFIX_SID, buffer, byteAggregator);
255 private static void serializeSrPrefix(final SrPrefix srPrefix, final ByteBuf byteAggregator) {
256 if (srPrefix != null) {
257 final ByteBuf buffer = Unpooled.buffer();
258 SrPrefixAttributesParser.serializeSrPrefix(srPrefix, buffer);
259 TlvUtil.writeTLV(PREFIX_SID, buffer, byteAggregator);
263 private static void serializePrefixMetric(final IgpMetric prefixMetric, final ByteBuf byteAggregator) {
264 if (prefixMetric != null) {
265 TlvUtil.writeTLV(PREFIX_METRIC, Unpooled.copyInt(prefixMetric.getValue().intValue()), byteAggregator);
269 private static void serializeRouteTags(final List<RouteTag> routeTags, final ByteBuf byteAggregator) {
270 if (routeTags != null) {
271 final ByteBuf routeTagsBuf = Unpooled.buffer();
272 for (final RouteTag routeTag : routeTags) {
273 routeTagsBuf.writeBytes(routeTag.getValue());
275 TlvUtil.writeTLV(ROUTE_TAG, routeTagsBuf, byteAggregator);
279 private static void serializeExtendedRouteTags(final List<ExtendedRouteTag> exRouteTags,
280 final ByteBuf byteAggregator) {
281 if (exRouteTags != null) {
282 final ByteBuf extendedBuf = Unpooled.buffer();
283 for (final ExtendedRouteTag exRouteTag : exRouteTags) {
284 extendedBuf.writeBytes(exRouteTag.getValue());
286 TlvUtil.writeTLV(EXTENDED_ROUTE_TAG, extendedBuf, byteAggregator);
290 private static void serializeForwardingAddress(final IpAddress forwardingAddress, final ByteBuf byteAggregator) {
291 if (forwardingAddress != null) {
292 final ByteBuf ospfBuf = Unpooled.buffer();
293 if (forwardingAddress.getIpv4Address() != null) {
294 ospfBuf.writeBytes(Ipv4Util.bytesForAddress(forwardingAddress.getIpv4Address()));
295 } else if (forwardingAddress.getIpv6Address() != null) {
296 ospfBuf.writeBytes(Ipv6Util.bytesForAddress(forwardingAddress.getIpv6Address()));
298 TlvUtil.writeTLV(FORWARDING_ADDRESS, ospfBuf, byteAggregator);