Bug-6562: Support add-path in base BGP NLRI
[bgpcep.git] / bgp / parser-impl / src / main / java / org / opendaylight / protocol / bgp / parser / impl / message / open / GracefulCapabilityHandler.java
index ac321201fbc2cd116ec0704154f118d7b73606d6..5519b7a001975c084fe183b75ff842198ea75d0e 100644 (file)
  */
 package org.opendaylight.protocol.bgp.parser.impl.message.open;
 
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.protocol.util.ByteBufWriteUtil.writeUnsignedShort;
+
+import com.google.common.base.Preconditions;
+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.BGPParsingException;
+import org.opendaylight.protocol.bgp.parser.spi.AddressFamilyRegistry;
+import org.opendaylight.protocol.bgp.parser.spi.CapabilityParser;
 import org.opendaylight.protocol.bgp.parser.spi.CapabilitySerializer;
 import org.opendaylight.protocol.bgp.parser.spi.CapabilityUtil;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.bgp.parameters.CParameters;
-
-final class GracefulCapabilityHandler implements CapabilitySerializer {
-       static final int CODE = 64;
-
-       private static final int RESTART_FLAGS_SIZE = 4; // bits
-       private static final int TIMER_SIZE = 12; // bits
-       private static final int AFI_SIZE = 2; // bytes
-       private static final int SAFI_SIZE = 1; // bytes
-       private static final int AF_FLAGS_SIZE = 1; // bytes
-
-       @Override
-       public byte[] serializeCapability(final CParameters capability) {
-               final byte[] bytes = null;
-
-               // final GracefulCapability param = (GracefulCapability) capability;
-               // final byte[] bytes = new byte[(RESTART_FLAGS_SIZE + TIMER_SIZE + (AFI_SIZE * Byte.SIZE + SAFI_SIZE *
-               // Byte.SIZE +
-               // AF_FLAGS_SIZE
-               // * Byte.SIZE)
-               // * param.getTableTypes().size())
-               // / Byte.SIZE];
-               // if (param.isRestartFlag()) {
-               // bytes[0] = (byte) 0x80;
-               // }
-               // int index = (RESTART_FLAGS_SIZE + TIMER_SIZE) / Byte.SIZE;
-               // for (final Entry<BGPTableType, Boolean> entry : param.getTableTypes().entrySet()) {
-               // final byte[] a = putAfi(entry.getKey().getAddressFamily());
-               // final byte s = putSafi(entry.getKey().getSubsequentAddressFamily());
-               // final byte f = (entry.getValue()) ? (byte) 0x80 : (byte) 0x00;
-               // System.arraycopy(a, 0, bytes, index, AFI_SIZE);
-               // index += AFI_SIZE;
-               // bytes[index] = s;
-               // index += SAFI_SIZE;
-               // bytes[index] = f;
-               // index += AF_FLAGS_SIZE;
-               // }
-
-               return CapabilityUtil.formatCapability(CODE, bytes);
-       }
+import org.opendaylight.protocol.bgp.parser.spi.SubsequentAddressFamilyRegistry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.CParameters;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1Builder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.GracefulRestartCapability;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.GracefulRestartCapability.RestartFlags;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.GracefulRestartCapabilityBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.graceful.restart.capability.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.graceful.restart.capability.Tables.AfiFlags;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.graceful.restart.capability.TablesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public final class GracefulCapabilityHandler implements CapabilityParser, CapabilitySerializer {
+    public static final int CODE = 64;
+
+    private static final Logger LOG = LoggerFactory.getLogger(GracefulCapabilityHandler.class);
+
+    // Restart flag size, in bits
+    private static final int RESTART_FLAGS_SIZE = 4;
+    private static final int RESTART_FLAG_STATE = 0x8000;
+
+    // Restart timer size, in bits
+    private static final int TIMER_SIZE = 12;
+    private static final int TIMER_TOPBITS_MASK = 0x0F;
+
+    // Size of the capability header
+    private static final int HEADER_SIZE = (RESTART_FLAGS_SIZE + TIMER_SIZE) / Byte.SIZE;
+
+    // Length of each AFI/SAFI array member, in bytes
+    private static final int PER_AFI_SAFI_SIZE = 4;
+
+    private static final short AFI_FLAG_FORWARDING_STATE = 0x80;
+
+    private static final int MAX_RESTART_TIME = 4095;
+
+    private final AddressFamilyRegistry afiReg;
+    private final SubsequentAddressFamilyRegistry safiReg;
+
+    public GracefulCapabilityHandler(final AddressFamilyRegistry afiReg, final SubsequentAddressFamilyRegistry safiReg) {
+        this.afiReg = requireNonNull(afiReg);
+        this.safiReg = requireNonNull(safiReg);
+    }
+
+    private void serializeTables(final List<Tables> tables, final ByteBuf bytes) {
+        if (tables == null) {
+            return;
+        }
+        for (final Tables t : tables) {
+            final Class<? extends AddressFamily> afi = t.getAfi();
+            final Integer afival = this.afiReg.numberForClass(afi);
+            Preconditions.checkArgument(afival != null, "Unhandled address family " + afi);
+            bytes.writeShort(afival);
+            final Class<? extends SubsequentAddressFamily> safi = t.getSafi();
+            final Integer safival = this.safiReg.numberForClass(safi);
+            Preconditions.checkArgument(safival != null, "Unhandled subsequent address family " + safi);
+            bytes.writeByte(safival);
+            if (t.getAfiFlags() != null && t.getAfiFlags().isForwardingState()) {
+                bytes.writeByte(AFI_FLAG_FORWARDING_STATE);
+            } else {
+                bytes.writeZero(1);
+            }
+        }
+    }
+
+    private ByteBuf serializeCapability(final GracefulRestartCapability grace) {
+        final List<Tables> tables = grace.getTables();
+        final int tablesSize = (tables != null) ? tables.size() : 0;
+        final ByteBuf bytes = Unpooled.buffer(HEADER_SIZE + (PER_AFI_SAFI_SIZE * tablesSize));
+        int timeval = 0;
+        Integer time = grace.getRestartTime();
+        if (time == null) {
+            time = 0;
+        }
+        Preconditions.checkArgument(time >= 0 && time <= MAX_RESTART_TIME, "Restart time is " + time);
+        timeval = time;
+        final GracefulRestartCapability.RestartFlags flags = grace.getRestartFlags();
+        if (flags != null && flags.isRestartState()) {
+            writeUnsignedShort(RESTART_FLAG_STATE | timeval, bytes);
+        } else {
+            writeUnsignedShort(timeval, bytes);
+        }
+        serializeTables(tables, bytes);
+        return bytes;
+    }
+
+    @Override
+    public void serializeCapability(final CParameters capability, final ByteBuf byteAggregator) {
+        if (capability.getAugmentation(CParameters1.class) == null
+            || capability.getAugmentation(CParameters1.class).getGracefulRestartCapability() == null) {
+            return;
+        }
+        final GracefulRestartCapability grace = capability.getAugmentation(CParameters1.class).getGracefulRestartCapability();
+
+        final ByteBuf bytes = serializeCapability(grace);
+
+        CapabilityUtil.formatCapability(CODE, bytes, byteAggregator);
+    }
+
+    @Override
+    public CParameters parseCapability(final ByteBuf buffer) throws BGPDocumentedException, BGPParsingException {
+        final GracefulRestartCapabilityBuilder cb = new GracefulRestartCapabilityBuilder();
+
+        final int flagBits = (buffer.getByte(0) >> RESTART_FLAGS_SIZE);
+        cb.setRestartFlags(new RestartFlags((flagBits & Byte.SIZE) != 0));
+
+        final int timer = ((buffer.readUnsignedByte() & TIMER_TOPBITS_MASK) << Byte.SIZE) + buffer.readUnsignedByte();
+        cb.setRestartTime(timer);
 
+        final List<Tables> tables = new ArrayList<>();
+        while (buffer.readableBytes() != 0) {
+            final int afiVal = buffer.readShort();
+            final Class<? extends AddressFamily> afi = this.afiReg.classForFamily(afiVal);
+            if (afi == null) {
+                LOG.debug("Ignoring GR capability for unknown address family {}", afiVal);
+                buffer.skipBytes(PER_AFI_SAFI_SIZE - 2);
+                continue;
+            }
+            final int safiVal = buffer.readUnsignedByte();
+            final Class<? extends SubsequentAddressFamily> safi = this.safiReg.classForFamily(safiVal);
+            if (safi == null) {
+                LOG.debug("Ignoring GR capability for unknown subsequent address family {}", safiVal);
+                buffer.skipBytes(1);
+                continue;
+            }
+            final int flags = buffer.readUnsignedByte();
+            tables.add(new TablesBuilder().setAfi(afi).setSafi(safi).setAfiFlags(new AfiFlags((flags & AFI_FLAG_FORWARDING_STATE) != 0)).build());
+        }
+        cb.setTables(tables);
+        return new CParametersBuilder().addAugmentation(CParameters1.class, new CParameters1Builder()
+            .setGracefulRestartCapability(cb.build()).build()).build();
+    }
 }