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.attribute;
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.collect.Multimap;
12 import io.netty.buffer.ByteBuf;
13 import io.netty.buffer.ByteBufUtil;
14 import io.netty.buffer.Unpooled;
15 import java.util.ArrayList;
16 import java.util.List;
17 import java.util.Map.Entry;
18 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.SrPrefixAttributesParser;
19 import org.opendaylight.protocol.bgp.linkstate.spi.TlvUtil;
20 import org.opendaylight.protocol.util.BitArray;
21 import org.opendaylight.protocol.util.ByteArray;
22 import org.opendaylight.protocol.util.Ipv4Util;
23 import org.opendaylight.protocol.util.Ipv6Util;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.ExtendedRouteTag;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.IgpBits.UpDown;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.RouteTag;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.IgpBitsBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrPrefix;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.path.attributes.linkstate.path.attribute.LinkStateAttribute;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.path.attributes.linkstate.path.attribute.link.state.attribute.PrefixAttributesCase;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.path.attributes.linkstate.path.attribute.link.state.attribute.PrefixAttributesCaseBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.path.attributes.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributes;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.path.attributes.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IgpMetric;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 public final class PrefixAttributesParser {
42 private static final Logger LOG = LoggerFactory.getLogger(PrefixAttributesParser.class);
44 private PrefixAttributesParser() {
45 throw new UnsupportedOperationException();
48 private static final int ROUTE_TAG_LENGTH = 4;
49 private static final int EXTENDED_ROUTE_TAG_LENGTH = 8;
51 private static final int FLAGS_SIZE = 8;
52 private static final int UP_DOWN_BIT = 0;
54 /* Prefix Attribute TLVs */
55 private static final int IGP_FLAGS = 1152;
56 private static final int ROUTE_TAG = 1153;
57 private static final int EXTENDED_ROUTE_TAG = 1154;
58 private static final int PREFIX_METRIC = 1155;
59 private static final int FORWARDING_ADDRESS = 1156;
60 private static final int PREFIX_OPAQUE = 1157;
62 /* Segment routing TLV */
63 private static final int PREFIX_SID = 1158;
66 * Parse prefix attributes.
68 * @param attributes key is the tlv type and value are the value bytes of the tlv
69 * @return {@link LinkStateAttribute}
71 static LinkStateAttribute parsePrefixAttributes(final Multimap<Integer, ByteBuf> attributes) {
72 final PrefixAttributesBuilder builder = new PrefixAttributesBuilder();
73 final List<RouteTag> routeTags = new ArrayList<>();
74 final List<ExtendedRouteTag> exRouteTags = new ArrayList<>();
75 for (final Entry<Integer, ByteBuf> entry : attributes.entries()) {
76 final int key = entry.getKey();
77 final ByteBuf value = entry.getValue();
78 LOG.trace("Prefix attribute TLV {}", key);
81 final BitArray flags = BitArray.valueOf(value, FLAGS_SIZE);
82 final boolean upDownBit = flags.get(UP_DOWN_BIT);
83 builder.setIgpBits(new IgpBitsBuilder().setUpDown(new UpDown(upDownBit)).build());
84 LOG.debug("Parsed IGP flag (up/down bit) : {}", upDownBit);
87 while (value.isReadable()) {
88 final RouteTag routeTag = new RouteTag(ByteArray.readBytes(value, ROUTE_TAG_LENGTH));
89 routeTags.add(routeTag);
90 LOG.debug("Parsed Route Tag: {}", routeTag);
93 case EXTENDED_ROUTE_TAG:
94 while (value.isReadable()) {
95 final ExtendedRouteTag exRouteTag = new ExtendedRouteTag(ByteArray.readBytes(value, EXTENDED_ROUTE_TAG_LENGTH));
96 exRouteTags.add(exRouteTag);
97 LOG.debug("Parsed Extended Route Tag: {}", exRouteTag);
101 final IgpMetric metric = new IgpMetric(value.readUnsignedInt());
102 builder.setPrefixMetric(metric);
103 LOG.debug("Parsed Metric: {}", metric);
105 case FORWARDING_ADDRESS:
106 final IpAddress fwdAddress = parseForwardingAddress(value);
107 builder.setOspfForwardingAddress(fwdAddress);
108 LOG.debug("Parsed FWD Address: {}", fwdAddress);
111 LOG.debug("Parsed Opaque value: {}, not preserving it", ByteBufUtil.hexDump(value));
114 final SrPrefix prefix = SrPrefixAttributesParser.parseSrPrefix(value);
115 builder.setSrPrefix(prefix);
116 LOG.debug("Parsed SR Prefix: {}", prefix);
119 LOG.warn("TLV {} is not a valid prefix attribute, ignoring it", key);
122 LOG.trace("Finished parsing Prefix Attributes.");
123 builder.setRouteTags(routeTags);
124 builder.setExtendedTags(exRouteTags);
125 return new PrefixAttributesCaseBuilder().setPrefixAttributes(builder.build()).build();
128 private static IpAddress parseForwardingAddress(final ByteBuf value) {
129 IpAddress fwdAddress = null;
130 switch (value.readableBytes()) {
131 case Ipv4Util.IP4_LENGTH:
132 fwdAddress = new IpAddress(Ipv4Util.addressForByteBuf(value));
134 case Ipv6Util.IPV6_LENGTH:
135 fwdAddress = new IpAddress(Ipv6Util.addressForByteBuf(value));
138 LOG.debug("Ignoring unsupported forwarding address length {}", value.readableBytes());
143 static void serializePrefixAttributes(final PrefixAttributesCase prefixAttributesCase, final ByteBuf byteAggregator) {
144 final PrefixAttributes prefixAtrributes = prefixAttributesCase.getPrefixAttributes();
145 if (prefixAtrributes.getIgpBits() != null) {
146 final BitArray igpBit = new BitArray(FLAGS_SIZE);
147 igpBit.set(UP_DOWN_BIT, prefixAtrributes.getIgpBits().getUpDown().isUpDown());
148 TlvUtil.writeTLV(IGP_FLAGS, Unpooled.wrappedBuffer(igpBit.array()), byteAggregator);
150 if (prefixAtrributes.getRouteTags() != null) {
151 final ByteBuf routeTagsBuf = Unpooled.buffer();
152 for (final RouteTag routeTag : prefixAtrributes.getRouteTags()) {
153 routeTagsBuf.writeBytes(routeTag.getValue());
155 TlvUtil.writeTLV(ROUTE_TAG, routeTagsBuf, byteAggregator);
157 final List<ExtendedRouteTag> routeTagList = prefixAtrributes.getExtendedTags();
158 if (routeTagList != null) {
159 final ByteBuf extendedBuf = Unpooled.buffer();
160 for (final ExtendedRouteTag extendedRouteTag : routeTagList) {
161 extendedBuf.writeBytes(extendedRouteTag.getValue());
163 TlvUtil.writeTLV(EXTENDED_ROUTE_TAG, extendedBuf, byteAggregator);
165 serializeForwardingAddress(prefixAtrributes.getOspfForwardingAddress(), byteAggregator);
166 if (prefixAtrributes.getPrefixMetric() != null) {
167 TlvUtil.writeTLV(PREFIX_METRIC, Unpooled.copyInt(prefixAtrributes.getPrefixMetric().getValue().intValue()), byteAggregator);
169 if (prefixAtrributes.getSrPrefix() != null) {
170 final ByteBuf b = Unpooled.buffer();
171 SrPrefixAttributesParser.serializeSrPrefix(prefixAtrributes.getSrPrefix(), b);
172 TlvUtil.writeTLV(PREFIX_SID, b, byteAggregator);
177 private static void serializeForwardingAddress(final IpAddress forwardingAddress, final ByteBuf byteAggregator) {
178 if (forwardingAddress != null) {
179 final ByteBuf ospfBuf = Unpooled.buffer();
180 if (forwardingAddress.getIpv4Address() != null) {
181 ospfBuf.writeBytes(Ipv4Util.bytesForAddress(forwardingAddress.getIpv4Address()));
182 } else if (forwardingAddress.getIpv6Address() != null) {
183 ospfBuf.writeBytes(Ipv6Util.bytesForAddress(forwardingAddress.getIpv6Address()));
185 TlvUtil.writeTLV(FORWARDING_ADDRESS, ospfBuf, byteAggregator);