bgp/parser-impl/src/main/java/org/opendaylight/protocol/bgp/parser/impl/message/open/LlGracefulCapabilityHandler.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.parser.impl.message.open;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.Unpooled;
  15 import java.util.Map;
  16 import org.opendaylight.protocol.bgp.parser.spi.AddressFamilyRegistry;
  17 import org.opendaylight.protocol.bgp.parser.spi.CapabilityParser;
  18 import org.opendaylight.protocol.bgp.parser.spi.CapabilitySerializer;
  19 import org.opendaylight.protocol.bgp.parser.spi.CapabilityUtil;
  20 import org.opendaylight.protocol.bgp.parser.spi.SubsequentAddressFamilyRegistry;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParameters;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapability;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapabilityBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.Tables;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.TablesBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.TablesKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.AddressFamily;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.SubsequentAddressFamily;
  33 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
  34 import org.opendaylight.yangtools.yang.common.Uint32;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 public final class LlGracefulCapabilityHandler implements CapabilityParser, CapabilitySerializer {
  39     public static final int CODE = 71;
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(LlGracefulCapabilityHandler.class);
  42
  43     // size of AFI (16 bits) and SAFI (8bits) fields in bytes
  44     private static final int AFI_SAFI_SIZE = 3;
  45
  46     private static final int AFI_FLAGS_SIZE = 1;
  47     private static final int STALE_TIME_SIZE = 3;
  48
  49     private static final int PER_TABLE_SIZE = AFI_SAFI_SIZE + AFI_FLAGS_SIZE + STALE_TIME_SIZE;
  50
  51     private static final int MAX_STALE_TIME = 16777215;
  52     private static final byte AFI_FLAG_FORWARDING_STATE = (byte) 0x80;
  53
  54     private final AddressFamilyRegistry afiReg;
  55     private final SubsequentAddressFamilyRegistry safiReg;
  56
  57     public LlGracefulCapabilityHandler(final AddressFamilyRegistry afiReg,
  58                                        final SubsequentAddressFamilyRegistry safiReg) {
  59         this.afiReg = requireNonNull(afiReg);
  60         this.safiReg = requireNonNull(safiReg);
  61     }
  62
  63     @Override
  64     public CParameters parseCapability(final ByteBuf buffer) {
  65         final BindingMap.Builder<TablesKey, Tables> tables = BindingMap.builder();
  66
  67         while (buffer.isReadable()) {
  68             final short afival = buffer.readShort();
  69             final Class<? extends AddressFamily> afi = this.afiReg.classForFamily(afival);
  70             if (afi == null) {
  71                 LOG.debug("Ignoring GR capability for unknown address family {}", afival);
  72                 buffer.skipBytes(PER_TABLE_SIZE - 2);
  73                 continue;
  74             }
  75
  76             final byte safival = buffer.readByte();
  77             final Class<? extends SubsequentAddressFamily> safi = this.safiReg.classForFamily(safival);
  78             if (safi == null) {
  79                 LOG.debug("Ignoring GR capability for unknown subsequent address family {}", safival);
  80                 buffer.skipBytes(PER_TABLE_SIZE - 3);
  81                 continue;
  82             }
  83
  84             final byte afiFlags = buffer.readByte();
  85             final int staleTime = buffer.readUnsignedMedium();
  86             final Tables table = new TablesBuilder()
  87                     .setAfi(afi)
  88                     .setSafi(safi)
  89                     .setAfiFlags(new Tables.AfiFlags(Boolean.valueOf(afiFlags == AFI_FLAG_FORWARDING_STATE)))
  90                     .setLongLivedStaleTime(new Uint24(Uint32.valueOf(staleTime)))
  91                     .build();
  92             tables.add(table);
  93         }
  94         return new CParametersBuilder()
  95                 .addAugmentation(new CParameters1Builder()
  96                     .setLlGracefulRestartCapability(new LlGracefulRestartCapabilityBuilder()
  97                         .setTables(tables.build())
  98                         .build())
  99                     .build())
 100                 .build();
 101     }
 102
 103     @Override
 104     public void serializeCapability(final CParameters capability, final ByteBuf byteAggregator) {
 105         final CParameters1 aug = capability.augmentation(CParameters1.class);
 106         if (aug != null) {
 107             final LlGracefulRestartCapability cap = aug.getLlGracefulRestartCapability();
 108             if (cap != null) {
 109                 CapabilityUtil.formatCapability(CODE, serializeCapability(cap), byteAggregator);
 110             }
 111         }
 112     }
 113
 114     private ByteBuf serializeCapability(final LlGracefulRestartCapability cap) {
 115         final Map<TablesKey, Tables> tables = cap.getTables();
 116         if (tables == null || tables.isEmpty()) {
 117             return Unpooled.EMPTY_BUFFER;
 118         }
 119
 120         final ByteBuf buffer = Unpooled.buffer(PER_TABLE_SIZE * tables.size());
 121         for (Tables table : tables.values()) {
 122             final Class<? extends AddressFamily> afi = table.getAfi();
 123             final Class<? extends SubsequentAddressFamily> safi = table.getSafi();
 124             final Integer afival = this.afiReg.numberForClass(afi);
 125             checkArgument(afival != null, "Unhandled address family %s", afi);
 126             buffer.writeShort(afival);
 127             final Integer safival = this.safiReg.numberForClass(safi);
 128             checkArgument(safival != null, "Unhandled subsequent address family %s", safi);
 129             buffer.writeByte(safival);
 130             if (table.getAfiFlags() != null && table.getAfiFlags().isForwardingState()) {
 131                 buffer.writeByte(AFI_FLAG_FORWARDING_STATE);
 132             } else {
 133                 buffer.writeByte(0);
 134             }
 135             final Uint24 staleTime = table.getLongLivedStaleTime();
 136             final int timeval = staleTime != null ? staleTime.getValue().intValue() : 0;
 137             checkArgument(timeval >= 0 && timeval <= MAX_STALE_TIME, "Restart time is %s", staleTime);
 138             buffer.writeMedium(timeval);
 139         }
 140         return buffer;
 141     }
 142 }