bgp/linkstate/src/main/java/org/opendaylight/protocol/bgp/linkstate/attribute/PrefixAttributesParser.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.bgp.linkstate.attribute;
   9
  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.BindingSidLabelParser;
  19 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.RangeTlvParser;
  20 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.SrPrefixAttributesParser;
  21 import org.opendaylight.protocol.bgp.linkstate.spi.TlvUtil;
  22 import org.opendaylight.protocol.util.BitArray;
  23 import org.opendaylight.protocol.util.ByteArray;
  24 import org.opendaylight.protocol.util.Ipv4Util;
  25 import org.opendaylight.protocol.util.Ipv6Util;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.ExtendedRouteTag;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.IgpBits.UpDown;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.ProtocolId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.RouteTag;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.LinkStateAttribute;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.PrefixAttributesCase;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.PrefixAttributesCaseBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributes;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributesBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.IgpBitsBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrBindingSidLabel;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrPrefix;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrRange;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IgpMetric;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 @VisibleForTesting
  45 public final class PrefixAttributesParser {
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(PrefixAttributesParser.class);
  48
  49     private PrefixAttributesParser() {
  50         throw new UnsupportedOperationException();
  51     }
  52
  53     private static final int ROUTE_TAG_LENGTH = 4;
  54     private static final int EXTENDED_ROUTE_TAG_LENGTH = 8;
  55
  56     private static final int FLAGS_SIZE = 8;
  57     private static final int UP_DOWN_BIT = 0;
  58
  59     /* Prefix Attribute TLVs */
  60     private static final int IGP_FLAGS = 1152;
  61     private static final int ROUTE_TAG = 1153;
  62     private static final int EXTENDED_ROUTE_TAG = 1154;
  63     private static final int PREFIX_METRIC = 1155;
  64     private static final int FORWARDING_ADDRESS = 1156;
  65     private static final int PREFIX_OPAQUE = 1157;
  66
  67     /* Segment routing TLV */
  68     public static final int PREFIX_SID = 1158;
  69     public static final int RANGE = 1159;
  70     public static final int BINDING_SID = 1160;
  71
  72     /**
  73      * Parse prefix attributes.
  74      *
  75      * @param attributes key is the tlv type and value are the value bytes of the tlv
  76      * @param protocolId to differentiate parsing methods
  77      * @return {@link LinkStateAttribute}
  78      */
  79     static LinkStateAttribute parsePrefixAttributes(final Multimap<Integer, ByteBuf> attributes, final ProtocolId protocolId) {
  80         final PrefixAttributesBuilder builder = new PrefixAttributesBuilder();
  81         final List<RouteTag> routeTags = new ArrayList<>();
  82         final List<ExtendedRouteTag> exRouteTags = new ArrayList<>();
  83         for (final Entry<Integer, ByteBuf> entry : attributes.entries()) {
  84             final int key = entry.getKey();
  85             final ByteBuf value = entry.getValue();
  86             LOG.trace("Prefix attribute TLV {}", key);
  87             parseAttribute(key, value, protocolId, builder, routeTags, exRouteTags);
  88         }
  89         LOG.trace("Finished parsing Prefix Attributes.");
  90         builder.setRouteTags(routeTags);
  91         builder.setExtendedTags(exRouteTags);
  92         return new PrefixAttributesCaseBuilder().setPrefixAttributes(builder.build()).build();
  93     }
  94
  95     private static void parseAttribute(final int key, final ByteBuf value, final ProtocolId protocolId, final PrefixAttributesBuilder builder, final List<RouteTag> routeTags, final List<ExtendedRouteTag> exRouteTags) {
  96         switch (key) {
  97         case IGP_FLAGS:
  98             final BitArray flags = BitArray.valueOf(value, FLAGS_SIZE);
  99             final boolean upDownBit = flags.get(UP_DOWN_BIT);
 100             builder.setIgpBits(new IgpBitsBuilder().setUpDown(new UpDown(upDownBit)).build());
 101             LOG.debug("Parsed IGP flag (up/down bit) : {}", upDownBit);
 102             break;
 103         case ROUTE_TAG:
 104             parseRouteTags(routeTags, value);
 105             break;
 106         case EXTENDED_ROUTE_TAG:
 107             parseExtendedRouteTags(exRouteTags, value);
 108             break;
 109         case PREFIX_METRIC:
 110             final IgpMetric metric = new IgpMetric(value.readUnsignedInt());
 111             builder.setPrefixMetric(metric);
 112             LOG.debug("Parsed Metric: {}", metric);
 113             break;
 114         case FORWARDING_ADDRESS:
 115             final IpAddress fwdAddress = parseForwardingAddress(value);
 116             builder.setOspfForwardingAddress(fwdAddress);
 117             LOG.debug("Parsed FWD Address: {}", fwdAddress);
 118             break;
 119         case PREFIX_OPAQUE:
 120             if (LOG.isDebugEnabled()) {
 121                 LOG.debug("Parsed Opaque value: {}, not preserving it", ByteBufUtil.hexDump(value));
 122             }
 123             break;
 124         case PREFIX_SID:
 125             final SrPrefix prefix = SrPrefixAttributesParser.parseSrPrefix(value, protocolId);
 126             builder.setSrPrefix(prefix);
 127             LOG.debug("Parsed SR Prefix: {}", prefix);
 128             break;
 129         case RANGE:
 130             final SrRange range = RangeTlvParser.parseSrRange(value, protocolId);
 131             builder.setSrRange(range);
 132             LOG.debug("Parsed SR Range: {}", range);
 133             break;
 134         case BINDING_SID:
 135             final SrBindingSidLabel label = BindingSidLabelParser.parseBindingSidLabel(value, protocolId);
 136             builder.setSrBindingSidLabel(label);
 137             LOG.debug("Parsed SR Binding SID {}", label);
 138             break;
 139         default:
 140             LOG.warn("TLV {} is not a valid prefix attribute, ignoring it", key);
 141         }
 142     }
 143
 144     private static void parseRouteTags(final List<RouteTag> routeTags, final ByteBuf value) {
 145         while (value.isReadable()) {
 146             final RouteTag routeTag = new RouteTag(ByteArray.readBytes(value, ROUTE_TAG_LENGTH));
 147             routeTags.add(routeTag);
 148             LOG.debug("Parsed Route Tag: {}", routeTag);
 149         }
 150     }
 151
 152     private static void parseExtendedRouteTags(final List<ExtendedRouteTag> exRouteTags, final ByteBuf value) {
 153         while (value.isReadable()) {
 154             final ExtendedRouteTag exRouteTag = new ExtendedRouteTag(ByteArray.readBytes(value, EXTENDED_ROUTE_TAG_LENGTH));
 155             exRouteTags.add(exRouteTag);
 156             LOG.debug("Parsed Extended Route Tag: {}", exRouteTag);
 157         }
 158     }
 159
 160     private static IpAddress parseForwardingAddress(final ByteBuf value) {
 161         IpAddress fwdAddress = null;
 162         switch (value.readableBytes()) {
 163         case Ipv4Util.IP4_LENGTH:
 164             fwdAddress = new IpAddress(Ipv4Util.addressForByteBuf(value));
 165             break;
 166         case Ipv6Util.IPV6_LENGTH:
 167             fwdAddress = new IpAddress(Ipv6Util.addressForByteBuf(value));
 168             break;
 169         default:
 170             LOG.debug("Ignoring unsupported forwarding address length {}", value.readableBytes());
 171         }
 172         return fwdAddress;
 173     }
 174
 175     static void serializePrefixAttributes(final PrefixAttributesCase prefixAttributesCase, final ByteBuf byteAggregator) {
 176         final PrefixAttributes prefixAtrributes = prefixAttributesCase.getPrefixAttributes();
 177         if (prefixAtrributes.getIgpBits() != null) {
 178             final BitArray igpBit = new BitArray(FLAGS_SIZE);
 179             igpBit.set(UP_DOWN_BIT, prefixAtrributes.getIgpBits().getUpDown().isUpDown());
 180             TlvUtil.writeTLV(IGP_FLAGS, Unpooled.wrappedBuffer(igpBit.array()), byteAggregator);
 181         }
 182         serializeRouteTags(prefixAtrributes.getRouteTags(), byteAggregator);
 183         serializeExtendedRouteTags(prefixAtrributes.getExtendedTags(), byteAggregator);
 184         if (prefixAtrributes.getPrefixMetric() != null) {
 185             TlvUtil.writeTLV(PREFIX_METRIC, Unpooled.copyInt(prefixAtrributes.getPrefixMetric().getValue().intValue()), byteAggregator);
 186         }
 187         serializeForwardingAddress(prefixAtrributes.getOspfForwardingAddress(), byteAggregator);
 188         if (prefixAtrributes.getSrPrefix() != null) {
 189             final ByteBuf buffer = Unpooled.buffer();
 190             SrPrefixAttributesParser.serializeSrPrefix(prefixAtrributes.getSrPrefix(), buffer);
 191             TlvUtil.writeTLV(PREFIX_SID, buffer, byteAggregator);
 192         }
 193         if (prefixAtrributes.getSrRange() != null) {
 194             final ByteBuf sidBuffer = Unpooled.buffer();
 195             RangeTlvParser.serializeSrRange(prefixAtrributes.getSrRange(), sidBuffer);
 196             TlvUtil.writeTLV(RANGE, sidBuffer, byteAggregator);
 197         }
 198         if (prefixAtrributes.getSrBindingSidLabel() != null) {
 199             final ByteBuf sidBuffer = Unpooled.buffer();
 200             BindingSidLabelParser.serializeBindingSidLabel(prefixAtrributes.getSrBindingSidLabel(), sidBuffer);
 201             TlvUtil.writeTLV(BINDING_SID, sidBuffer, byteAggregator);
 202         }
 203     }
 204
 205     private static void serializeRouteTags(final List<RouteTag> routeTags, final ByteBuf byteAggregator) {
 206         if (routeTags != null) {
 207             final ByteBuf routeTagsBuf = Unpooled.buffer();
 208             for (final RouteTag routeTag : routeTags) {
 209                 routeTagsBuf.writeBytes(routeTag.getValue());
 210             }
 211             TlvUtil.writeTLV(ROUTE_TAG, routeTagsBuf, byteAggregator);
 212         }
 213     }
 214
 215     private static void serializeExtendedRouteTags(final List<ExtendedRouteTag> exRouteTags, final ByteBuf byteAggregator) {
 216         if (exRouteTags != null) {
 217             final ByteBuf extendedBuf = Unpooled.buffer();
 218             for (final ExtendedRouteTag exRouteTag : exRouteTags) {
 219                 extendedBuf.writeBytes(exRouteTag.getValue());
 220             }
 221             TlvUtil.writeTLV(EXTENDED_ROUTE_TAG, extendedBuf, byteAggregator);
 222         }
 223     }
 224
 225     private static void serializeForwardingAddress(final IpAddress forwardingAddress, final ByteBuf byteAggregator) {
 226         if (forwardingAddress != null) {
 227             final ByteBuf ospfBuf = Unpooled.buffer();
 228             if (forwardingAddress.getIpv4Address() != null) {
 229                 ospfBuf.writeBytes(Ipv4Util.bytesForAddress(forwardingAddress.getIpv4Address()));
 230             } else if (forwardingAddress.getIpv6Address() != null) {
 231                 ospfBuf.writeBytes(Ipv6Util.bytesForAddress(forwardingAddress.getIpv6Address()));
 232             }
 233             TlvUtil.writeTLV(FORWARDING_ADDRESS, ospfBuf, byteAggregator);
 234         }
 235     }
 236 }