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.BitSet;
  17 import java.util.List;
  18 import java.util.Map.Entry;
  19 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.SrPrefixAttributesParser;
  20 import org.opendaylight.protocol.bgp.linkstate.spi.TlvUtil;
  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;
  38
  39 @VisibleForTesting
  40 public final class PrefixAttributesParser {
  41
  42     private static final Logger LOG = LoggerFactory.getLogger(PrefixAttributesParser.class);
  43
  44     private PrefixAttributesParser() {
  45         throw new UnsupportedOperationException();
  46     }
  47
  48     private static final int ROUTE_TAG_LENGTH = 4;
  49     private static final int EXTENDED_ROUTE_TAG_LENGTH = 8;
  50     private static final int UP_DOWN_BIT = 7;
  51
  52     /* Prefix Attribute TLVs */
  53     private static final int IGP_FLAGS = 1152;
  54     private static final int ROUTE_TAG = 1153;
  55     private static final int EXTENDED_ROUTE_TAG = 1154;
  56     private static final int PREFIX_METRIC = 1155;
  57     private static final int FORWARDING_ADDRESS = 1156;
  58     private static final int PREFIX_OPAQUE = 1157;
  59
  60     /* Segment routing TLV */
  61     private static final int PREFIX_SID = 1158;
  62
  63     /**
  64      * Parse prefix attributes.
  65      *
  66      * @param attributes key is the tlv type and value are the value bytes of the tlv
  67      * @return {@link LinkStateAttribute}
  68      */
  69     static LinkStateAttribute parsePrefixAttributes(final Multimap<Integer, ByteBuf> attributes) {
  70         final PrefixAttributesBuilder builder = new PrefixAttributesBuilder();
  71         final List<RouteTag> routeTags = new ArrayList<>();
  72         final List<ExtendedRouteTag> exRouteTags = new ArrayList<>();
  73         for (final Entry<Integer, ByteBuf> entry : attributes.entries()) {
  74             final int key = entry.getKey();
  75             final ByteBuf value = entry.getValue();
  76             LOG.trace("Prefix attribute TLV {}", key);
  77             switch (key) {
  78             case IGP_FLAGS:
  79                 final BitSet flags = BitSet.valueOf(ByteArray.readAllBytes(value));
  80                 final boolean upDownBit = flags.get(UP_DOWN_BIT);
  81                 builder.setIgpBits(new IgpBitsBuilder().setUpDown(new UpDown(upDownBit)).build());
  82                 LOG.debug("Parsed IGP flag (up/down bit) : {}", upDownBit);
  83                 break;
  84             case ROUTE_TAG:
  85                 while (value.isReadable()) {
  86                     final RouteTag routeTag = new RouteTag(ByteArray.readBytes(value, ROUTE_TAG_LENGTH));
  87                     routeTags.add(routeTag);
  88                     LOG.debug("Parsed Route Tag: {}", routeTag);
  89                 }
  90                 break;
  91             case EXTENDED_ROUTE_TAG:
  92                 while (value.isReadable()) {
  93                     final ExtendedRouteTag exRouteTag = new ExtendedRouteTag(ByteArray.readBytes(value, EXTENDED_ROUTE_TAG_LENGTH));
  94                     exRouteTags.add(exRouteTag);
  95                     LOG.debug("Parsed Extended Route Tag: {}", exRouteTag);
  96                 }
  97                 break;
  98             case PREFIX_METRIC:
  99                 final IgpMetric metric = new IgpMetric(value.readUnsignedInt());
 100                 builder.setPrefixMetric(metric);
 101                 LOG.debug("Parsed Metric: {}", metric);
 102                 break;
 103             case FORWARDING_ADDRESS:
 104                 final IpAddress fwdAddress = parseForwardingAddress(value);
 105                 builder.setOspfForwardingAddress(fwdAddress);
 106                 LOG.debug("Parsed FWD Address: {}", fwdAddress);
 107                 break;
 108             case PREFIX_OPAQUE:
 109                 LOG.debug("Parsed Opaque value: {}, not preserving it", ByteBufUtil.hexDump(value));
 110                 break;
 111             case PREFIX_SID:
 112                 final SrPrefix prefix = SrPrefixAttributesParser.parseSrPrefix(value);
 113                 builder.setSrPrefix(prefix);
 114                 LOG.debug("Parsed SR Prefix: {}", prefix);
 115                 break;
 116             default:
 117                 LOG.warn("TLV {} is not a valid prefix attribute, ignoring it", key);
 118             }
 119         }
 120         LOG.trace("Finished parsing Prefix Attributes.");
 121         builder.setRouteTags(routeTags);
 122         builder.setExtendedTags(exRouteTags);
 123         return new PrefixAttributesCaseBuilder().setPrefixAttributes(builder.build()).build();
 124     }
 125
 126     private static IpAddress parseForwardingAddress(final ByteBuf value) {
 127         IpAddress fwdAddress = null;
 128         switch (value.readableBytes()) {
 129         case Ipv4Util.IP4_LENGTH:
 130             fwdAddress = new IpAddress(Ipv4Util.addressForByteBuf(value));
 131             break;
 132         case Ipv6Util.IPV6_LENGTH:
 133             fwdAddress = new IpAddress(Ipv6Util.addressForByteBuf(value));
 134             break;
 135         default:
 136             LOG.debug("Ignoring unsupported forwarding address length {}", value.readableBytes());
 137         }
 138         return fwdAddress;
 139     }
 140
 141     static void serializePrefixAttributes(final PrefixAttributesCase prefixAttributesCase, final ByteBuf byteAggregator) {
 142         final PrefixAttributes prefixAtrributes = prefixAttributesCase.getPrefixAttributes();
 143         if (prefixAtrributes.getIgpBits() != null) {
 144             final BitSet igpBit = new BitSet();
 145             final Boolean bit = prefixAtrributes.getIgpBits().getUpDown().isUpDown();
 146             if (bit != null) {
 147                 igpBit.set(UP_DOWN_BIT, bit);
 148             }
 149             TlvUtil.writeTLV(IGP_FLAGS, Unpooled.wrappedBuffer(igpBit.toByteArray()), byteAggregator);
 150         }
 151         if (prefixAtrributes.getRouteTags() != null) {
 152             final ByteBuf routeTagsBuf = Unpooled.buffer();
 153             for (final RouteTag routeTag : prefixAtrributes.getRouteTags()) {
 154                 routeTagsBuf.writeBytes(routeTag.getValue());
 155             }
 156             TlvUtil.writeTLV(ROUTE_TAG, routeTagsBuf, byteAggregator);
 157         }
 158         final List<ExtendedRouteTag> routeTagList = prefixAtrributes.getExtendedTags();
 159         if (routeTagList != null) {
 160             final ByteBuf extendedBuf = Unpooled.buffer();
 161             for (final ExtendedRouteTag extendedRouteTag : routeTagList) {
 162                 extendedBuf.writeBytes(extendedRouteTag.getValue());
 163             }
 164             TlvUtil.writeTLV(EXTENDED_ROUTE_TAG, extendedBuf, byteAggregator);
 165         }
 166         serializeForwardingAddress(prefixAtrributes.getOspfForwardingAddress(), byteAggregator);
 167         if (prefixAtrributes.getPrefixMetric() != null) {
 168             TlvUtil.writeTLV(PREFIX_METRIC, Unpooled.copyInt(prefixAtrributes.getPrefixMetric().getValue().intValue()), byteAggregator);
 169         }
 170         if (prefixAtrributes.getSrPrefix() != null) {
 171             final ByteBuf b = Unpooled.buffer();
 172             SrPrefixAttributesParser.serializeSrPrefix(prefixAtrributes.getSrPrefix(), b);
 173             TlvUtil.writeTLV(PREFIX_SID, b, byteAggregator);
 174         }
 175
 176     }
 177
 178     private static void serializeForwardingAddress(final IpAddress forwardingAddress, final ByteBuf byteAggregator) {
 179         if (forwardingAddress != null) {
 180             final ByteBuf ospfBuf = Unpooled.buffer();
 181             if (forwardingAddress.getIpv4Address() != null) {
 182                 ospfBuf.writeBytes(Ipv4Util.bytesForAddress(forwardingAddress.getIpv4Address()));
 183             } else if (forwardingAddress.getIpv6Address() != null) {
 184                 ospfBuf.writeBytes(Ipv6Util.bytesForAddress(forwardingAddress.getIpv6Address()));
 185             }
 186             TlvUtil.writeTLV(FORWARDING_ADDRESS, ospfBuf, byteAggregator);
 187         }
 188     }
 189 }