bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/BGPPeer.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.rib.impl;
   9
  10 import com.google.common.base.MoreObjects;
  11 import com.google.common.base.MoreObjects.ToStringHelper;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.Lists;
  14 import com.google.common.net.InetAddresses;
  15 import java.util.ArrayList;
  16 import java.util.Arrays;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Set;
  22 import javax.annotation.concurrent.GuardedBy;
  23 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeMXBean;
  24 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeRegistration;
  25 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeRegistrator;
  26 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpPeerState;
  27 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
  28 import org.opendaylight.controller.config.yang.bgp.rib.impl.RouteTable;
  29 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  32 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  33 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionStatistics;
  34 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  35 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext;
  36 import org.opendaylight.protocol.bgp.rib.spi.BGPSession;
  37 import org.opendaylight.protocol.bgp.rib.spi.BGPSessionListener;
  38 import org.opendaylight.protocol.bgp.rib.spi.BGPTerminationReason;
  39 import org.opendaylight.protocol.bgp.rib.spi.Peer;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationIpv4CaseBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes1;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.Attributes2;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.RouteRefresh;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  65 import org.opendaylight.yangtools.yang.binding.Notification;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68
  69 /**
  70  * Class representing a peer. We have a single instance for each peer, which provides translation from BGP events into
  71  * RIB actions.
  72  */
  73 public class BGPPeer implements BGPSessionListener, Peer, AutoCloseable, BGPPeerRuntimeMXBean, TransactionChainListener {
  74
  75     private static final Logger LOG = LoggerFactory.getLogger(BGPPeer.class);
  76
  77     @GuardedBy("this")
  78     private final Set<TablesKey> tables = new HashSet<>();
  79     @GuardedBy("this")
  80     private BGPSession session;
  81     @GuardedBy("this")
  82     private byte[] rawIdentifier;
  83     @GuardedBy("this")
  84     private DOMTransactionChain chain;
  85     @GuardedBy("this")
  86     private AdjRibInWriter ribWriter;
  87
  88     private final RIB rib;
  89     private final String name;
  90     private BGPPeerRuntimeRegistrator registrator;
  91     private BGPPeerRuntimeRegistration runtimeReg;
  92     private long sessionEstablishedCounter = 0L;
  93     private final Map<TablesKey, AdjRibOutListener> adjRibOutListenerSet = new HashMap();
  94
  95     public BGPPeer(final String name, final RIB rib) {
  96         this(name, rib, PeerRole.Ibgp);
  97     }
  98
  99     public BGPPeer(final String name, final RIB rib, final PeerRole role) {
 100         this.rib = Preconditions.checkNotNull(rib);
 101         this.name = name;
 102         this.chain = rib.createPeerChain(this);
 103         this.ribWriter = AdjRibInWriter.create(rib.getYangRibId(), role, this.chain);
 104     }
 105
 106     @Override
 107     public synchronized void close() {
 108         releaseConnection();
 109         this.chain.close();
 110     }
 111
 112     @Override
 113     public void onMessage(final BGPSession session, final Notification msg) {
 114         if (!(msg instanceof Update) && !(msg instanceof RouteRefresh)) {
 115             LOG.info("Ignoring unhandled message class {}", msg.getClass());
 116             return;
 117         }
 118         if (msg instanceof Update) {
 119             onUpdateMessage((Update) msg);
 120         } else {
 121             onRouteRefreshMessage((RouteRefresh) msg, session);
 122         }
 123     }
 124
 125     private void onRouteRefreshMessage(final RouteRefresh message, final BGPSession session) {
 126         final Class<? extends AddressFamily> rrAfi = message.getAfi();
 127         final Class<? extends SubsequentAddressFamily> rrSafi = message.getSafi();
 128
 129         final TablesKey key = new TablesKey(rrAfi, rrSafi);
 130         final AdjRibOutListener listener = this.adjRibOutListenerSet.get(key);
 131         if (listener != null) {
 132             listener.close();
 133             this.adjRibOutListenerSet.remove(listener);
 134             createAdjRibOutListener(RouterIds.createPeerId(session.getBgpId()), key, true);
 135         } else {
 136             LOG.info("Ignoring RouteRefresh message. Afi/Safi is not supported: {}, {}.", rrAfi, rrSafi);
 137         }
 138     }
 139
 140     private void onUpdateMessage(final Update message) {
 141         // update AdjRibs
 142         final Attributes attrs = message.getAttributes();
 143         MpReachNlri mpReach = null;
 144         final boolean isAnyNlriAnnounced = message.getNlri() != null;
 145         if (isAnyNlriAnnounced) {
 146             mpReach = prefixesToMpReach(message);
 147         } else if (attrs != null && attrs.getAugmentation(Attributes1.class) != null) {
 148             mpReach = attrs.getAugmentation(Attributes1.class).getMpReachNlri();
 149         }
 150         if (mpReach != null) {
 151             this.ribWriter.updateRoutes(mpReach, nextHopToAttribute(attrs, mpReach));
 152         }
 153         MpUnreachNlri mpUnreach = null;
 154         if (message.getWithdrawnRoutes() != null) {
 155             mpUnreach = prefixesToMpUnreach(message, isAnyNlriAnnounced);
 156         } else if (attrs != null && attrs.getAugmentation(Attributes2.class) != null) {
 157             mpUnreach = attrs.getAugmentation(Attributes2.class).getMpUnreachNlri();
 158         }
 159         if (mpUnreach != null) {
 160             this.ribWriter.removeRoutes(mpUnreach);
 161         }
 162     }
 163
 164     private static Attributes nextHopToAttribute(final Attributes attrs, final MpReachNlri mpReach) {
 165         if (attrs.getCNextHop() == null && mpReach.getCNextHop() != null) {
 166             final AttributesBuilder attributesBuilder = new AttributesBuilder(attrs);
 167             attributesBuilder.setCNextHop(mpReach.getCNextHop());
 168             return attributesBuilder.build();
 169         }
 170         return attrs;
 171     }
 172
 173     /**
 174      * Creates MPReach for the prefixes to be handled in the same way as linkstate routes
 175      *
 176      * @param message Update message containing prefixes in NLRI
 177      * @return MpReachNlri with prefixes from the nlri field
 178      */
 179     private static MpReachNlri prefixesToMpReach(final Update message) {
 180         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 181         for (final Ipv4Prefix p : message.getNlri().getNlri()) {
 182             prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
 183         }
 184         final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(
 185             UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
 186                 new AdvertizedRoutesBuilder().setDestinationType(
 187                     new DestinationIpv4CaseBuilder().setDestinationIpv4(
 188                         new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build());
 189         if (message.getAttributes() != null) {
 190             b.setCNextHop(message.getAttributes().getCNextHop());
 191         }
 192         return b.build();
 193     }
 194
 195     /**
 196      * Create MPUnreach for the prefixes to be handled in the same way as linkstate routes
 197      *
 198      * @param message Update message containing withdrawn routes
 199      * @param isAnyNlriAnnounced
 200      * @return MpUnreachNlri with prefixes from the withdrawn routes field
 201      */
 202     private static MpUnreachNlri prefixesToMpUnreach(final Update message, final boolean isAnyNlriAnnounced) {
 203         final List<Ipv4Prefixes> prefixes = new ArrayList<>();
 204         for (final Ipv4Prefix p : message.getWithdrawnRoutes().getWithdrawnRoutes()) {
 205             boolean nlriAnounced = false;
 206             if(isAnyNlriAnnounced) {
 207                 nlriAnounced = message.getNlri().getNlri().contains(p);
 208             }
 209
 210             if(!nlriAnounced) {
 211                 prefixes.add(new Ipv4PrefixesBuilder().setPrefix(p).build());
 212             }
 213         }
 214         return new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
 215                 new WithdrawnRoutesBuilder().setDestinationType(
 216                     new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
 217                         new DestinationIpv4Builder().setIpv4Prefixes(prefixes).build()).build()).build()).build();
 218     }
 219
 220     @Override
 221     public synchronized void onSessionUp(final BGPSession session) {
 222         LOG.info("Session with peer {} went up with tables: {}", this.name, session.getAdvertisedTableTypes());
 223         this.session = session;
 224         this.rawIdentifier = InetAddresses.forString(session.getBgpId().getValue()).getAddress();
 225         final PeerId peerId = RouterIds.createPeerId(session.getBgpId());
 226         createAdjRibOutListener(peerId);
 227
 228         this.ribWriter = this.ribWriter.transform(peerId, this.rib.getRibSupportContext(), this.tables, false);
 229         this.sessionEstablishedCounter++;
 230         if (this.registrator != null) {
 231             this.runtimeReg = this.registrator.register(this);
 232         }
 233     }
 234
 235     private void createAdjRibOutListener(final PeerId peerId) {
 236         for (final BgpTableType t : this.session.getAdvertisedTableTypes()) {
 237             final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
 238             if (this.tables.add(key)) {
 239                 createAdjRibOutListener(peerId, key, true);
 240             }
 241         }
 242
 243         addBgp4Support(peerId);
 244     }
 245
 246     //try to add a support for old-school BGP-4, if peer did not advertise IPv4-Unicast MP capability
 247     private void addBgp4Support(final PeerId peerId) {
 248         final TablesKey key = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
 249         if (this.tables.add(key)) {
 250             createAdjRibOutListener(peerId, key, false);
 251         }
 252     }
 253
 254     private void createAdjRibOutListener(final PeerId peerId, final TablesKey key, final boolean mpSupport) {
 255         final RIBSupportContext context = this.rib.getRibSupportContext().getRIBSupportContext(key);
 256
 257         // not particularly nice
 258         if (context != null && this.session instanceof BGPSessionImpl) {
 259             this.adjRibOutListenerSet.put(key, AdjRibOutListener.create(peerId, key, this.rib.getYangRibId(), this.rib.getCodecsRegistry(),
 260                 context.getRibSupport(), ((RIBImpl) this.rib).getService(), ((BGPSessionImpl) this.session).getLimiter(), mpSupport));
 261         }
 262     }
 263
 264     private synchronized void cleanup() {
 265         // FIXME: BUG-196: support graceful
 266         for (final AdjRibOutListener adjRibOutListener : this.adjRibOutListenerSet.values()) {
 267             adjRibOutListener.close();
 268         }
 269         this.adjRibOutListenerSet.clear();
 270         this.ribWriter.removePeer();
 271         this.tables.clear();
 272     }
 273
 274     @Override
 275     public void onSessionDown(final BGPSession session, final Exception e) {
 276         if(e.getMessage().equals(BGPSessionImpl.END_OF_INPUT)) {
 277             LOG.info("Session with peer {} went down", this.name);
 278         } else {
 279             LOG.info("Session with peer {} went down", this.name, e);
 280         }
 281         releaseConnection();
 282     }
 283
 284     @Override
 285     public void onSessionTerminated(final BGPSession session, final BGPTerminationReason cause) {
 286         LOG.info("Session with peer {} terminated: {}", this.name, cause);
 287         releaseConnection();
 288     }
 289
 290     @Override
 291     public String toString() {
 292         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
 293     }
 294
 295     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 296         toStringHelper.add("name", this.name);
 297         toStringHelper.add("tables", this.tables);
 298         return toStringHelper;
 299     }
 300
 301     @Override
 302     public String getName() {
 303         return this.name;
 304     }
 305
 306     @Override
 307     public void releaseConnection() {
 308         addPeerToDisconnectedSharedList();
 309         cleanup();
 310         dropConnection();
 311     }
 312
 313     private void addPeerToDisconnectedSharedList() {
 314         if(this.session != null) {
 315             this.rib.getCacheDisconnectedPeers().insertDesconectedPeer(this.session.getBgpId());
 316         }
 317     }
 318
 319     @GuardedBy("this")
 320     private void dropConnection() {
 321         if (this.runtimeReg != null) {
 322             this.runtimeReg.close();
 323             this.runtimeReg = null;
 324         }
 325         if (this.session != null) {
 326             try {
 327                 this.session.close();
 328             } catch (final Exception e) {
 329                 LOG.warn("Error closing session with peer", e);
 330             }
 331             this.session = null;
 332         }
 333     }
 334
 335     @Override
 336     public boolean isSessionActive() {
 337         return this.session != null;
 338     }
 339
 340     @Override
 341     public synchronized byte[] getRawIdentifier() {
 342         return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
 343     }
 344
 345     @Override
 346     public void resetSession() {
 347         releaseConnection();
 348     }
 349
 350     @Override
 351     public void resetStats() {
 352         if (this.session instanceof BGPSessionStatistics) {
 353             ((BGPSessionStatistics) this.session).resetSessionStats();
 354         }
 355     }
 356
 357     public synchronized void registerRootRuntimeBean(final BGPPeerRuntimeRegistrator registrator) {
 358         this.registrator = registrator;
 359     }
 360
 361     @Override
 362     public BgpSessionState getBgpSessionState() {
 363         if (this.session instanceof BGPSessionStatistics) {
 364             return ((BGPSessionStatistics) this.session).getBgpSesionState();
 365         }
 366         return new BgpSessionState();
 367     }
 368
 369     @Override
 370     public synchronized BgpPeerState getBgpPeerState() {
 371         final BgpPeerState peerState = new BgpPeerState();
 372         final List<RouteTable> routes = Lists.newArrayList();
 373         for (final TablesKey tablesKey : this.tables) {
 374             final RouteTable routeTable = new RouteTable();
 375             routeTable.setTableType("afi=" + tablesKey.getAfi().getSimpleName() + ",safi=" + tablesKey.getSafi().getSimpleName());
 376             routeTable.setRoutesCount(this.rib.getRoutesCount(tablesKey));
 377             routes.add(routeTable);
 378         }
 379         peerState.setRouteTable(routes);
 380         peerState.setSessionEstablishedCount(this.sessionEstablishedCounter);
 381         return peerState;
 382     }
 383
 384     @Override
 385     public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 386         LOG.error("Transaction chain failed.", cause);
 387         releaseConnection();
 388         this.chain.close();
 389         this.chain = this.rib.createPeerChain(this);
 390     }
 391
 392     @Override
 393     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 394         LOG.debug("Transaction chain {} successfull.", chain);
 395     }
 396
 397     @Override
 398     public void markUptodate(final TablesKey tablesKey) {
 399         this.ribWriter.markTableUptodate(tablesKey);
 400     }
 401 }