bgp/parser-spi/src/main/java/org/opendaylight/protocol/bgp/parser/spi/pojo/SimpleNlriRegistry.java

   1 /*
   2  * Copyright (c) 2013 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.parser.spi.pojo;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.Iterables;
  14 import io.netty.buffer.ByteBuf;
  15 import io.netty.buffer.Unpooled;
  16 import java.util.AbstractMap.SimpleEntry;
  17 import java.util.Map.Entry;
  18 import java.util.concurrent.ConcurrentHashMap;
  19 import java.util.concurrent.ConcurrentMap;
  20 import org.opendaylight.bgp.concepts.NextHopUtil;
  21 import org.opendaylight.protocol.bgp.parser.BGPParsingException;
  22 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  23 import org.opendaylight.protocol.bgp.parser.spi.AddressFamilyRegistry;
  24 import org.opendaylight.protocol.bgp.parser.spi.NextHopParserSerializer;
  25 import org.opendaylight.protocol.bgp.parser.spi.NlriParser;
  26 import org.opendaylight.protocol.bgp.parser.spi.NlriRegistry;
  27 import org.opendaylight.protocol.bgp.parser.spi.NlriSerializer;
  28 import org.opendaylight.protocol.bgp.parser.spi.PeerSpecificParserConstraint;
  29 import org.opendaylight.protocol.bgp.parser.spi.SubsequentAddressFamilyRegistry;
  30 import org.opendaylight.protocol.concepts.AbstractRegistration;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlri;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpReachNlriBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlri;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.update.attributes.MpUnreachNlriBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.CNextHop;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 final class SimpleNlriRegistry implements NlriRegistry {
  44
  45     private static final int RESERVED = 1;
  46     private static final int NEXT_HOP_LENGHT = 1;
  47     private static final String PARSER_NOT_FOUND = "Nlri parser not found for table type {}";
  48     private static final Logger LOG = LoggerFactory.getLogger(SimpleNlriRegistry.class);
  49
  50     private final ConcurrentMap<BgpTableType, NlriParser> handlers = new ConcurrentHashMap<>();
  51     private final ConcurrentMap<Class<? extends DataObject>, NlriSerializer> serializers = new ConcurrentHashMap<>();
  52     private final ConcurrentMap<BgpTableType, NextHopParserSerializer> nextHopParsers = new ConcurrentHashMap<>();
  53     private final ConcurrentMap<Entry<Class<? extends CNextHop>, BgpTableType>,
  54             NextHopParserSerializer> nextHopSerializers = new ConcurrentHashMap<>();
  55     private final SubsequentAddressFamilyRegistry safiReg;
  56     private final AddressFamilyRegistry afiReg;
  57
  58     SimpleNlriRegistry(final AddressFamilyRegistry afiReg, final SubsequentAddressFamilyRegistry safiReg) {
  59         this.afiReg = requireNonNull(afiReg);
  60         this.safiReg = requireNonNull(safiReg);
  61     }
  62
  63     private static BgpTableType createKey(final Class<? extends AddressFamily> afi,
  64         final Class<? extends SubsequentAddressFamily> safi) {
  65         requireNonNull(afi);
  66         requireNonNull(safi);
  67         return new BgpTableTypeImpl(afi, safi);
  68     }
  69
  70     synchronized AutoCloseable registerNlriSerializer(final Class<? extends DataObject> nlriClass,
  71             final NlriSerializer serializer) {
  72         final NlriSerializer prev = this.serializers.get(nlriClass);
  73         Preconditions.checkState(prev == null, "Serializer already bound to class " + prev);
  74
  75         this.serializers.put(nlriClass, serializer);
  76
  77         final Object lock = this;
  78         return new AbstractRegistration() {
  79             @Override
  80             protected void removeRegistration() {
  81                 synchronized (lock) {
  82                     SimpleNlriRegistry.this.serializers.remove(nlriClass);
  83                 }
  84             }
  85         };
  86     }
  87
  88     synchronized AutoCloseable registerNlriParser(final Class<? extends AddressFamily> afi,
  89         final Class<? extends SubsequentAddressFamily> safi, final NlriParser parser,
  90         final NextHopParserSerializer nextHopSerializer, final Class<? extends CNextHop> cnextHopClass,
  91         final Class<? extends CNextHop>... cnextHopClassList) {
  92         final BgpTableType key = createKey(afi, safi);
  93         final NlriParser prev = this.handlers.get(key);
  94         Preconditions.checkState(prev == null, "AFI/SAFI is already bound to parser " + prev);
  95
  96         this.handlers.put(key, parser);
  97         this.nextHopParsers.put(key,nextHopSerializer);
  98
  99         if (cnextHopClass != null) {
 100             final Entry<Class<? extends CNextHop>, BgpTableType> nhKey = new SimpleEntry<>(cnextHopClass, key);
 101             this.nextHopSerializers.put(nhKey, nextHopSerializer);
 102             for (final Class<? extends CNextHop> cnextHop : cnextHopClassList) {
 103                 final Entry<Class<? extends CNextHop>, BgpTableType> nhKeys = new SimpleEntry<>(cnextHop, key);
 104                 this.nextHopSerializers.put(nhKeys, nextHopSerializer);
 105             }
 106         }
 107
 108         final Object lock = this;
 109         return new AbstractRegistration() {
 110             @Override
 111             protected void removeRegistration() {
 112                 synchronized (lock) {
 113                     SimpleNlriRegistry.this.handlers.remove(key);
 114                     SimpleNlriRegistry.this.nextHopParsers.remove(key);
 115                     if (cnextHopClass != null) {
 116                         final Entry<Class<? extends CNextHop>, BgpTableType> nhKey
 117                                 = new SimpleEntry<>(cnextHopClass, key);
 118                         SimpleNlriRegistry.this.nextHopSerializers.remove(nhKey);
 119                         for (final Class<? extends CNextHop> cnextHop : cnextHopClassList) {
 120                             final Entry<Class<? extends CNextHop>, BgpTableType> nhKeys
 121                                     = new SimpleEntry<>(cnextHop, key);
 122                             SimpleNlriRegistry.this.nextHopSerializers.remove(nhKeys);
 123                         }
 124                     }
 125                 }
 126             }
 127         };
 128     }
 129
 130     private Class<? extends AddressFamily> getAfi(final ByteBuf buffer) throws BGPParsingException {
 131         final int afiVal = buffer.readUnsignedShort();
 132         final Class<? extends AddressFamily> afi = this.afiReg.classForFamily(afiVal);
 133         if (afi == null) {
 134             throw new BGPParsingException("Address Family Identifier: '" + afiVal + "' not supported.");
 135         }
 136         return afi;
 137     }
 138
 139     private Class<? extends SubsequentAddressFamily> getSafi(final ByteBuf buffer) throws BGPParsingException {
 140         final int safiVal = buffer.readUnsignedByte();
 141         final Class<? extends SubsequentAddressFamily> safi = this.safiReg.classForFamily(safiVal);
 142         if (safi == null) {
 143             throw new BGPParsingException("Subsequent Address Family Identifier: '" + safiVal + "' not supported.");
 144         }
 145         return safi;
 146     }
 147
 148     @Override
 149     public MpUnreachNlri parseMpUnreach(final ByteBuf buffer, final PeerSpecificParserConstraint constraint)
 150             throws BGPParsingException {
 151         final MpUnreachNlriBuilder builder = new MpUnreachNlriBuilder();
 152         builder.setAfi(getAfi(buffer));
 153         builder.setSafi(getSafi(buffer));
 154
 155         if (buffer.isReadable()) {
 156             final ByteBuf nlri = buffer.slice();
 157             final BgpTableType key = createKey(builder.getAfi(), builder.getSafi());
 158             final NlriParser parser = this.handlers.get(key);
 159             if (parser == null) {
 160                 LOG.warn(PARSER_NOT_FOUND, key);
 161             } else {
 162                 parser.parseNlri(nlri, builder, constraint);
 163             }
 164         }
 165         return builder.build();
 166     }
 167
 168     @Override
 169     public void serializeMpReach(final MpReachNlri mpReachNlri, final ByteBuf byteAggregator) {
 170         final Class<? extends AddressFamily> afi = mpReachNlri.getAfi();
 171         final Class<? extends SubsequentAddressFamily> safi = mpReachNlri.getSafi();
 172         byteAggregator.writeShort(this.afiReg.numberForClass(afi));
 173         byteAggregator.writeByte(this.safiReg.numberForClass(safi));
 174
 175         final CNextHop cNextHop = mpReachNlri.getCNextHop();
 176         if (cNextHop != null) {
 177             final Entry<Class<? extends CNextHop>, BgpTableType> key = new SimpleEntry(
 178                     cNextHop.getImplementedInterface(), new BgpTableTypeImpl(afi, safi));
 179             final NextHopParserSerializer nextHopSerializer = this.nextHopSerializers.get(key);
 180             final ByteBuf nextHopBuffer = Unpooled.buffer();
 181             nextHopSerializer.serializeNextHop(cNextHop, nextHopBuffer);
 182             byteAggregator.writeByte(nextHopBuffer.writerIndex());
 183             byteAggregator.writeBytes(nextHopBuffer);
 184
 185         } else {
 186             byteAggregator.writeZero(NEXT_HOP_LENGHT);
 187         }
 188         byteAggregator.writeZero(RESERVED);
 189     }
 190
 191     @Override
 192     public void serializeMpUnReach(final MpUnreachNlri mpUnreachNlri, final ByteBuf byteAggregator) {
 193         byteAggregator.writeShort(this.afiReg.numberForClass(mpUnreachNlri.getAfi()));
 194         byteAggregator.writeByte(this.safiReg.numberForClass(mpUnreachNlri.getSafi()));
 195     }
 196
 197     @Override
 198     public Iterable<NlriSerializer> getSerializers() {
 199         return Iterables.unmodifiableIterable(this.serializers.values());
 200     }
 201
 202     @Override
 203     public MpReachNlri parseMpReach(final ByteBuf buffer, final PeerSpecificParserConstraint constraint)
 204             throws BGPParsingException {
 205         final MpReachNlriBuilder builder = new MpReachNlriBuilder();
 206         final Class<? extends AddressFamily> afi = getAfi(buffer);
 207         final Class<? extends SubsequentAddressFamily> safi = getSafi(buffer);
 208         builder.setAfi(afi);
 209         builder.setSafi(safi);
 210
 211         final BgpTableType key = createKey(builder.getAfi(), builder.getSafi());
 212
 213         final int nextHopLength = buffer.readUnsignedByte();
 214         if (nextHopLength != 0) {
 215             final NextHopParserSerializer nextHopParser = this.nextHopParsers.get(key);
 216             if (nextHopParser != null) {
 217                 builder.setCNextHop(nextHopParser.parseNextHop(buffer.readSlice(nextHopLength)));
 218             } else {
 219                 builder.setCNextHop(NextHopUtil.parseNextHop(buffer.readSlice(nextHopLength)));
 220                 LOG.warn("NexHop Parser/Serializer for AFI/SAFI ({},{}) not bound",afi,safi);
 221             }
 222         }
 223         buffer.skipBytes(RESERVED);
 224
 225         final ByteBuf nlri = buffer.slice();
 226         final NlriParser parser = this.handlers.get(key);
 227         if (parser == null) {
 228             LOG.warn(PARSER_NOT_FOUND, key);
 229         } else {
 230             parser.parseNlri(nlri, builder, constraint);
 231         }
 232         return builder.build();
 233     }
 234 }