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