Merge "BUG-2571 : flowspec-routes model"
[bgpcep.git] / bgp / parser-impl / src / main / java / org / opendaylight / protocol / bgp / parser / impl / message / update / ExtendedCommunitiesAttributeParser.java
index 369fabc76e416c311c674018b90027b3dfa77e02..32dfd6e4e3e98640cb18d2937a1b5aec64bb23ac 100644 (file)
@@ -8,33 +8,75 @@
 package org.opendaylight.protocol.bgp.parser.impl.message.update;
 
 import com.google.common.base.Preconditions;
-import com.google.common.collect.Lists;
-
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
-
+import java.util.ArrayList;
 import java.util.List;
-
 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
+import org.opendaylight.protocol.bgp.parser.BGPError;
 import org.opendaylight.protocol.bgp.parser.spi.AttributeParser;
 import org.opendaylight.protocol.bgp.parser.spi.AttributeSerializer;
 import org.opendaylight.protocol.bgp.parser.spi.AttributeUtil;
+import org.opendaylight.protocol.util.ByteArray;
+import org.opendaylight.protocol.util.ByteBufWriteUtil;
 import org.opendaylight.protocol.util.Ipv4Util;
 import org.opendaylight.protocol.util.ReferenceCache;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.PathAttributes;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.ExtendedCommunities;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.ExtendedCommunitiesBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.PathAttributesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ShortAsNumber;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.ExtendedCommunity;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.AsSpecificExtendedCommunityCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.AsSpecificExtendedCommunityCaseBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.Inet4SpecificExtendedCommunityCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.Inet4SpecificExtendedCommunityCaseBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.OpaqueExtendedCommunityCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.OpaqueExtendedCommunityCaseBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.RouteOriginExtendedCommunityCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.RouteOriginExtendedCommunityCaseBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.RouteTargetExtendedCommunityCase;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.RouteTargetExtendedCommunityCaseBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.as.specific.extended.community._case.AsSpecificExtendedCommunity;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.as.specific.extended.community._case.AsSpecificExtendedCommunityBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.inet4.specific.extended.community._case.Inet4SpecificExtendedCommunity;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.inet4.specific.extended.community._case.Inet4SpecificExtendedCommunityBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.opaque.extended.community._case.OpaqueExtendedCommunity;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.opaque.extended.community._case.OpaqueExtendedCommunityBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.route.origin.extended.community._case.RouteOriginExtendedCommunity;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.route.origin.extended.community._case.RouteOriginExtendedCommunityBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.route.target.extended.community._case.RouteTargetExtendedCommunity;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.extended.community.extended.community.route.target.extended.community._case.RouteTargetExtendedCommunityBuilder;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 
-public final class ExtendedCommunitiesAttributeParser implements AttributeParser,AttributeSerializer {
+public class ExtendedCommunitiesAttributeParser implements AttributeParser,AttributeSerializer {
 
     public static final int TYPE = 16;
 
+    private static final int EXTENDED_COMMUNITY_LENGTH = 6;
+
+    private static final int AS_LOCAL_ADMIN_LENGTH = 4;
+
+    private static final int INET_LOCAL_ADMIN_LENGTH = 2;
+
+    private static final short AS_TYPE_TRANS = 0;
+
+    private static final short AS_TYPE_NON_TRANS = 40;
+
+    private static final short INET_TYPE_TRANS = 1;
+
+    private static final short INET_TYPE_NON_TRANS = 41;
+
+    private static final short OPAQUE_TYPE_TRANS = 3;
+
+    private static final short OPAQUE_TYPE_NON_TRANS = 43;
+
+    private static final short ROUTE_TYPE_ONLY = 2;
+
+    private static final short ROUTE_TARGET_SUBTYPE = 2;
+
+    private static final short ROUTE_ORIGIN_SUBTYPE = 3;
+
     private final ReferenceCache refCache;
 
     public ExtendedCommunitiesAttributeParser(final ReferenceCache refCache) {
@@ -43,73 +85,148 @@ public final class ExtendedCommunitiesAttributeParser implements AttributeParser
 
     @Override
     public void parseAttribute(final ByteBuf buffer, final PathAttributesBuilder builder) throws BGPDocumentedException {
-        final List<ExtendedCommunities> set = Lists.newArrayList();
+        final List<ExtendedCommunities> set = new ArrayList<>();
         while (buffer.isReadable()) {
-            final ExtendedCommunities comm = CommunitiesParser.parseExtendedCommunity(this.refCache, buffer.slice(buffer.readerIndex(), CommunitiesParser.EXTENDED_COMMUNITY_LENGTH));
-            buffer.skipBytes(CommunitiesParser.EXTENDED_COMMUNITY_LENGTH);
+            final ExtendedCommunitiesBuilder exBuilder = new ExtendedCommunitiesBuilder();
+            parseHeader(exBuilder, buffer);
+            final ExtendedCommunities comm = parseExtendedCommunity(this.refCache, exBuilder, buffer.readSlice(EXTENDED_COMMUNITY_LENGTH));
             set.add(comm);
         }
         builder.setExtendedCommunities(set);
     }
 
+    protected void parseHeader(final ExtendedCommunitiesBuilder exBuilder, final ByteBuf buffer) {
+        exBuilder.setCommType(buffer.readUnsignedByte());
+        exBuilder.setCommSubType(buffer.readUnsignedByte());
+    }
+
+    /**
+     * Parse Extended Community according to their type.
+     *
+     * @param refCache
+     * @param comm ExtendedCommunitiesBuilder based on which community type will be new ExtendedCommunity created
+     * @param buffer byte array to be parsed
+     * @return new Specific Extended Community
+     * @throws BGPDocumentedException if the type is not recognized
+     */
+    public ExtendedCommunities parseExtendedCommunity(final ReferenceCache refCache, final ExtendedCommunitiesBuilder comm, final ByteBuf buffer)
+            throws BGPDocumentedException {
+        ExtendedCommunity c = null;
+        switch (comm.getCommType()) {
+        case AS_TYPE_TRANS:
+            c = parseAsTransCommunity(comm, buffer);
+            break;
+        case AS_TYPE_NON_TRANS:
+            ShortAsNumber as = new ShortAsNumber((long) buffer.readUnsignedShort());
+            byte[] value = ByteArray.readBytes(buffer, AS_LOCAL_ADMIN_LENGTH);
+            c = new AsSpecificExtendedCommunityCaseBuilder().setAsSpecificExtendedCommunity(
+                new AsSpecificExtendedCommunityBuilder().setTransitive(true).setGlobalAdministrator(as).setLocalAdministrator(value).build()).build();
+            break;
+        case ROUTE_TYPE_ONLY:
+            as = new ShortAsNumber((long) buffer.readUnsignedShort());
+            value = ByteArray.readBytes(buffer, AS_LOCAL_ADMIN_LENGTH);
+            if (comm.getCommSubType() == ROUTE_TARGET_SUBTYPE) {
+                c = new RouteTargetExtendedCommunityCaseBuilder().setRouteTargetExtendedCommunity(new RouteTargetExtendedCommunityBuilder().setGlobalAdministrator(as).setLocalAdministrator(value).build()).build();
+            } else if (comm.getCommSubType() == ROUTE_ORIGIN_SUBTYPE) {
+                c = new RouteOriginExtendedCommunityCaseBuilder().setRouteOriginExtendedCommunity(new RouteOriginExtendedCommunityBuilder().setGlobalAdministrator(as).setLocalAdministrator(value).build()).build();
+            } else {
+                throw new BGPDocumentedException("Could not parse Extended Community subtype: " + comm.getCommSubType(), BGPError.OPT_ATTR_ERROR);
+            }
+            break;
+        case INET_TYPE_TRANS:
+            c = parseInetTypeCommunity(comm, buffer);
+            break;
+        case INET_TYPE_NON_TRANS:
+            c = new Inet4SpecificExtendedCommunityCaseBuilder().setInet4SpecificExtendedCommunity(
+                new Inet4SpecificExtendedCommunityBuilder().setTransitive(true).setGlobalAdministrator(
+                        Ipv4Util.addressForByteBuf(buffer)).setLocalAdministrator(
+                        ByteArray.readBytes(buffer, INET_LOCAL_ADMIN_LENGTH)).build()).build();
+            break;
+        case OPAQUE_TYPE_TRANS:
+            c = new OpaqueExtendedCommunityCaseBuilder().setOpaqueExtendedCommunity(new OpaqueExtendedCommunityBuilder().setTransitive(false).setValue(ByteArray.readAllBytes(buffer)).build()).build();
+            break;
+        case OPAQUE_TYPE_NON_TRANS:
+            c = new OpaqueExtendedCommunityCaseBuilder().setOpaqueExtendedCommunity(new OpaqueExtendedCommunityBuilder().setTransitive(true).setValue(ByteArray.readAllBytes(buffer)).build()).build();
+            break;
+        default:
+            throw new BGPDocumentedException("Could not parse Extended Community type: " + comm.getCommType(), BGPError.OPT_ATTR_ERROR);
+        }
+        return comm.setExtendedCommunity(c).build();
+    }
+
+    private static ExtendedCommunity parseAsTransCommunity(final ExtendedCommunitiesBuilder comm, final ByteBuf buffer) {
+        final ShortAsNumber as = new ShortAsNumber((long) buffer.readUnsignedShort());
+        final byte[] value = ByteArray.readBytes(buffer, AS_LOCAL_ADMIN_LENGTH);
+        if (comm.getCommSubType() == ROUTE_TARGET_SUBTYPE) {
+            return new RouteTargetExtendedCommunityCaseBuilder().setRouteTargetExtendedCommunity(
+                new RouteTargetExtendedCommunityBuilder().setGlobalAdministrator(as).setLocalAdministrator(value).build()).build();
+        }
+        if (comm.getCommSubType() == ROUTE_ORIGIN_SUBTYPE) {
+            return new RouteOriginExtendedCommunityCaseBuilder().setRouteOriginExtendedCommunity(
+                new RouteOriginExtendedCommunityBuilder().setGlobalAdministrator(as).setLocalAdministrator(value).build()).build();
+        }
+        return new AsSpecificExtendedCommunityCaseBuilder().setAsSpecificExtendedCommunity(
+            new AsSpecificExtendedCommunityBuilder().setTransitive(false).setGlobalAdministrator(as).setLocalAdministrator(value).build()).build();
+    }
+
+    private static ExtendedCommunity parseInetTypeCommunity(final ExtendedCommunitiesBuilder comm, final ByteBuf buffer) {
+        if (comm.getCommSubType() == ROUTE_TARGET_SUBTYPE) {
+            return new RouteTargetExtendedCommunityCaseBuilder().setRouteTargetExtendedCommunity(
+                new RouteTargetExtendedCommunityBuilder().setGlobalAdministrator(new ShortAsNumber((long) buffer.readUnsignedShort()))
+                    .setLocalAdministrator(ByteArray.readBytes(buffer, AS_LOCAL_ADMIN_LENGTH)).build()).build();
+        }
+        if (comm.getCommSubType() == ROUTE_ORIGIN_SUBTYPE) {
+            return new RouteOriginExtendedCommunityCaseBuilder().setRouteOriginExtendedCommunity(
+                new RouteOriginExtendedCommunityBuilder().setGlobalAdministrator(new ShortAsNumber((long) buffer.readUnsignedShort()))
+                    .setLocalAdministrator(ByteArray.readBytes(buffer, AS_LOCAL_ADMIN_LENGTH)).build()).build();
+        }
+        return new Inet4SpecificExtendedCommunityCaseBuilder().setInet4SpecificExtendedCommunity(
+            new Inet4SpecificExtendedCommunityBuilder().setTransitive(false).setGlobalAdministrator(
+                    Ipv4Util.addressForByteBuf(buffer)).setLocalAdministrator(
+                    ByteArray.readBytes(buffer, INET_LOCAL_ADMIN_LENGTH)).build()).build();
+    }
+
     @Override
     public void serializeAttribute(final DataObject attribute, final ByteBuf byteAggregator) {
-        final PathAttributes pathAttributes = (PathAttributes) attribute;
-        final List<ExtendedCommunities> communitiesList = pathAttributes.getExtendedCommunities();
+        Preconditions.checkArgument(attribute instanceof PathAttributes, "Attribute parameter is not a PathAttribute object.");
+        final List<ExtendedCommunities> communitiesList = ((PathAttributes) attribute).getExtendedCommunities();
         if (communitiesList == null) {
             return;
         }
         final ByteBuf extendedCommunitiesBuffer = Unpooled.buffer();
         for (final ExtendedCommunities extendedCommunities : communitiesList) {
-            if (extendedCommunities.getCommSubType() != null) {
-                extendedCommunitiesBuffer.writeShort(extendedCommunities.getCommSubType());
-            }
-            if (extendedCommunities.getExtendedCommunity() instanceof AsSpecificExtendedCommunityCase) {
-                final AsSpecificExtendedCommunityCase asSpecificExtendedCommunity = (AsSpecificExtendedCommunityCase) extendedCommunities.getExtendedCommunity();
-
-                //TODO resolve types correctly
-                extendedCommunitiesBuffer.writeByte(0);
-                extendedCommunitiesBuffer.writeByte(1);
-
-                extendedCommunitiesBuffer.writeShort(asSpecificExtendedCommunity.getAsSpecificExtendedCommunity().getGlobalAdministrator().getValue().shortValue());
-                extendedCommunitiesBuffer.writeBytes(asSpecificExtendedCommunity.getAsSpecificExtendedCommunity().getLocalAdministrator());
-            }
-            if (extendedCommunities.getExtendedCommunity() instanceof Inet4SpecificExtendedCommunityCase) {
-                final Inet4SpecificExtendedCommunityCase inet4SpecificExtendedCommunity = (Inet4SpecificExtendedCommunityCase) extendedCommunities.getExtendedCommunity();
-
-                //TODO resolve types correctly
-                extendedCommunitiesBuffer.writeByte(1);
-                extendedCommunitiesBuffer.writeByte(4);
+            serializeHeader(extendedCommunities, extendedCommunitiesBuffer);
+            serializeExtendedCommunity(extendedCommunities, extendedCommunitiesBuffer);
+        }
+        AttributeUtil.formatAttribute(AttributeUtil.OPTIONAL | AttributeUtil.TRANSITIVE, TYPE, extendedCommunitiesBuffer, byteAggregator);
+    }
 
-                extendedCommunitiesBuffer.writeBytes(Ipv4Util.bytesForAddress(inet4SpecificExtendedCommunity.getInet4SpecificExtendedCommunity().getGlobalAdministrator()));
-                extendedCommunitiesBuffer.writeBytes(inet4SpecificExtendedCommunity.getInet4SpecificExtendedCommunity().getLocalAdministrator());
-            }
-            if (extendedCommunities.getExtendedCommunity() instanceof OpaqueExtendedCommunityCase) {
-                final OpaqueExtendedCommunityCase opaqueExtendedCommunity = (OpaqueExtendedCommunityCase) extendedCommunities.getExtendedCommunity();
-                //TODO resolve types correctly
-                extendedCommunitiesBuffer.writeByte(3);
-                extendedCommunitiesBuffer.writeByte(4);
+    protected void serializeHeader(final ExtendedCommunities extendedCommunities, final ByteBuf extendedCommunitiesBuffer) {
+        ByteBufWriteUtil.writeUnsignedByte(extendedCommunities.getCommType(), extendedCommunitiesBuffer);
+        ByteBufWriteUtil.writeUnsignedByte(extendedCommunities.getCommSubType(), extendedCommunitiesBuffer);
+    }
 
-                extendedCommunitiesBuffer.writeBytes(opaqueExtendedCommunity.getOpaqueExtendedCommunity().getValue());
-            }
-            if (extendedCommunities.getExtendedCommunity() instanceof RouteTargetExtendedCommunityCase) {
-                final RouteTargetExtendedCommunityCase routeTargetExtendedCommunity = (RouteTargetExtendedCommunityCase) extendedCommunities.getExtendedCommunity();
-                //TODO how to determine, which numbering space global administrator number is originated from
-                extendedCommunitiesBuffer.writeByte(0);
-                extendedCommunitiesBuffer.writeByte(2);
-
-                extendedCommunitiesBuffer.writeShort(routeTargetExtendedCommunity.getRouteTargetExtendedCommunity().getGlobalAdministrator().getValue().shortValue());
-                extendedCommunitiesBuffer.writeBytes(routeTargetExtendedCommunity.getRouteTargetExtendedCommunity().getLocalAdministrator());
-            }
-            if (extendedCommunities.getExtendedCommunity() instanceof RouteOriginExtendedCommunityCase) {
-                final RouteOriginExtendedCommunityCase routeOriginExtendedCommunity = (RouteOriginExtendedCommunityCase) extendedCommunities.getExtendedCommunity();
-                //TODO how to determine, which numbering space global administrator number is originated from
-                extendedCommunitiesBuffer.writeByte(2);
-                extendedCommunitiesBuffer.writeByte(3);
-                extendedCommunitiesBuffer.writeShort(routeOriginExtendedCommunity.getRouteOriginExtendedCommunity().getGlobalAdministrator().getValue().shortValue());
-                extendedCommunitiesBuffer.writeBytes(routeOriginExtendedCommunity.getRouteOriginExtendedCommunity().getLocalAdministrator());
-            }
-            AttributeUtil.formatAttribute(AttributeUtil.OPTIONAL, TYPE, extendedCommunitiesBuffer, byteAggregator);
+    public void serializeExtendedCommunity(final ExtendedCommunities extendedCommunities, final ByteBuf buffer) {
+        final ExtendedCommunity ex = extendedCommunities.getExtendedCommunity();
+        if (ex instanceof AsSpecificExtendedCommunityCase) {
+            final AsSpecificExtendedCommunity asSpecificExtendedCommunity = ((AsSpecificExtendedCommunityCase) ex).getAsSpecificExtendedCommunity();
+            ByteBufWriteUtil.writeUnsignedShort(asSpecificExtendedCommunity.getGlobalAdministrator().getValue().intValue(), buffer);
+            buffer.writeBytes(asSpecificExtendedCommunity.getLocalAdministrator());
+        } else if (ex instanceof Inet4SpecificExtendedCommunityCase) {
+            final Inet4SpecificExtendedCommunity inet4SpecificExtendedCommunity = ((Inet4SpecificExtendedCommunityCase) ex).getInet4SpecificExtendedCommunity();
+            ByteBufWriteUtil.writeIpv4Address(inet4SpecificExtendedCommunity.getGlobalAdministrator(), buffer);
+            buffer.writeBytes(inet4SpecificExtendedCommunity.getLocalAdministrator());
+        } else if (ex instanceof OpaqueExtendedCommunityCase) {
+            final OpaqueExtendedCommunity opaqueExtendedCommunity = ((OpaqueExtendedCommunityCase) ex).getOpaqueExtendedCommunity();
+            buffer.writeBytes(opaqueExtendedCommunity.getValue());
+        } else if (ex instanceof RouteTargetExtendedCommunityCase) {
+            final RouteTargetExtendedCommunity routeTarget = ((RouteTargetExtendedCommunityCase) ex).getRouteTargetExtendedCommunity();
+            ByteBufWriteUtil.writeUnsignedShort(routeTarget.getGlobalAdministrator().getValue().intValue(), buffer);
+            buffer.writeBytes(routeTarget.getLocalAdministrator());
+        } else if (ex instanceof RouteOriginExtendedCommunityCase) {
+            final RouteOriginExtendedCommunity routeOriginExtendedCommunity = ((RouteOriginExtendedCommunityCase) ex).getRouteOriginExtendedCommunity();
+            ByteBufWriteUtil.writeUnsignedShort(routeOriginExtendedCommunity.getGlobalAdministrator().getValue().intValue(), buffer);
+            buffer.writeBytes(routeOriginExtendedCommunity.getLocalAdministrator());
         }
     }
 }