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