bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/config/BgpPeer.java

   1 /*
   2  * Copyright (c) 2016 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.config;
   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 com.google.common.util.concurrent.FluentFuture;
  15 import io.netty.util.concurrent.Future;
  16 import java.net.InetSocketAddress;
  17 import java.util.ArrayList;
  18 import java.util.Collections;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Objects;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import java.util.stream.Collectors;
  25 import org.apache.commons.lang3.StringUtils;
  26 import org.checkerframework.checker.lock.qual.GuardedBy;
  27 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  28 import org.opendaylight.mdsal.common.api.CommitInfo;
  29 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
  30 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
  31 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
  32 import org.opendaylight.protocol.bgp.parser.spi.RevisedErrorHandlingSupport;
  33 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
  34 import org.opendaylight.protocol.bgp.rib.impl.BgpPeerUtil;
  35 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  36 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
  37 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
  38 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  39 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
  40 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerStateConsumer;
  41 import org.opendaylight.protocol.concepts.KeyMapping;
  42 import org.opendaylight.protocol.util.Ipv4Util;
  43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
  45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Config;
  46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
  47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroup;
  48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.AddPathCapabilityBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamilies;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborPeerGroupConfig;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.slf4j.Logger;
  69 import org.slf4j.LoggerFactory;
  70
  71 public class BgpPeer implements PeerBean, BGPPeerStateConsumer {
  72
  73     private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
  74
  75     private final RpcProviderService rpcRegistry;
  76     @GuardedBy("this")
  77     private Neighbor currentConfiguration;
  78     @GuardedBy("this")
  79     private BgpPeerSingletonService bgpPeerSingletonService;
  80
  81     public BgpPeer(final RpcProviderService rpcRegistry) {
  82         this.rpcRegistry = rpcRegistry;
  83     }
  84
  85     private static List<OptionalCapabilities> getBgpCapabilities(final AfiSafis afiSafis, final RIB rib,
  86                                                           final BGPTableTypeRegistryConsumer tableTypeRegistry) {
  87         final List<OptionalCapabilities> caps = new ArrayList<>();
  88         caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
  89                 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
  90
  91         caps.add(new OptionalCapabilitiesBuilder()
  92                 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
  93         caps.add(new OptionalCapabilitiesBuilder()
  94                 .setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
  95
  96         final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(afiSafis, false);
  97         final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil
  98                 .toAddPathCapability(afiSafi, tableTypeRegistry);
  99         if (!addPathCapability.isEmpty()) {
 100             caps.add(new OptionalCapabilitiesBuilder()
 101                     .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 102                             new CParameters1Builder().setAddPathCapability(
 103                                     new AddPathCapabilityBuilder()
 104                                             .setAddressFamilies(addPathCapability).build()).build()).build()).build());
 105         }
 106
 107         final List<BgpTableType> tableTypes = OpenConfigMappingUtil.toTableTypes(afiSafi, tableTypeRegistry);
 108         for (final BgpTableType tableType : tableTypes) {
 109             if (!rib.getLocalTables().contains(tableType)) {
 110                 LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.",
 111                     tableType);
 112             }
 113
 114             caps.add(new OptionalCapabilitiesBuilder().setCParameters(
 115                     new CParametersBuilder().addAugmentation(CParameters1.class,
 116                             new CParameters1Builder().setMultiprotocolCapability(
 117                                     new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
 118         }
 119         return caps;
 120     }
 121
 122     private static Optional<byte[]> getPassword(final KeyMapping key) {
 123         if (key != null) {
 124             return Optional.of(Iterables.getOnlyElement(key.values()));
 125         }
 126         return Optional.empty();
 127     }
 128
 129     @Override
 130     public synchronized void start(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
 131             final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
 132         Preconditions.checkState(this.bgpPeerSingletonService == null,
 133                 "Previous peer instance was not closed.");
 134
 135         this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, bgpIid, peerGroupLoader,
 136                 tableTypeRegistry);
 137         this.currentConfiguration = neighbor;
 138     }
 139
 140     @Override
 141     public synchronized void restart(final RIB rib, final InstanceIdentifier<Bgp> bgpIid,
 142             final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
 143         Preconditions.checkState(this.currentConfiguration != null);
 144         start(rib, this.currentConfiguration, bgpIid, peerGroupLoader, tableTypeRegistry);
 145     }
 146
 147     @Override
 148     public void close() {
 149         // No-op
 150     }
 151
 152     @Override
 153     public synchronized void instantiateServiceInstance() {
 154         if (this.bgpPeerSingletonService != null) {
 155             this.bgpPeerSingletonService.instantiateServiceInstance();
 156         }
 157     }
 158
 159     @Override
 160     public synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
 161         if (this.bgpPeerSingletonService != null) {
 162             final FluentFuture<? extends CommitInfo> fut = this.bgpPeerSingletonService.closeServiceInstance();
 163             this.bgpPeerSingletonService = null;
 164             return fut;
 165         }
 166         return CommitInfo.emptyFluentFuture();
 167     }
 168
 169     @Override
 170     public synchronized Boolean containsEqualConfiguration(final Neighbor neighbor) {
 171         if (this.currentConfiguration == null) {
 172             return false;
 173         }
 174         final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
 175         final AfiSafis extAfiSafi = neighbor.getAfiSafis();
 176         final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
 177         final List<AfiSafi> extSafi = extAfiSafi != null ? extAfiSafi.getAfiSafi() : Collections.emptyList();
 178         return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
 179                 && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
 180                 && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
 181                 && Objects.equals(this.currentConfiguration.getAddPaths(), neighbor.getAddPaths())
 182                 && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
 183                 && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
 184                 && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
 185                 && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
 186                 && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
 187                 && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
 188                 && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
 189                 && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
 190                 && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
 191                 && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
 192     }
 193
 194     @Override
 195     public synchronized BGPPeerState getPeerState() {
 196         if (this.bgpPeerSingletonService == null) {
 197             return null;
 198         }
 199         return this.bgpPeerSingletonService.getPeerState();
 200     }
 201
 202     synchronized void removePeer(final BGPPeerRegistry bgpPeerRegistry) {
 203         if (BgpPeer.this.currentConfiguration != null) {
 204             bgpPeerRegistry.removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
 205         }
 206     }
 207
 208     private final class BgpPeerSingletonService implements BGPPeerStateConsumer {
 209         private final boolean activeConnection;
 210         private final BGPDispatcher dispatcher;
 211         private final InetSocketAddress inetAddress;
 212         private final int retryTimer;
 213         private final KeyMapping keys;
 214         private final InetSocketAddress localAddress;
 215         private final BGPPeer bgpPeer;
 216         private final IpAddress neighborAddress;
 217         private final BGPSessionPreferences prefs;
 218         private Future<Void> connection;
 219         private boolean isServiceInstantiated;
 220         private final List<OptionalCapabilities> finalCapabilities;
 221         private final int gracefulRestartTimer;
 222         private final RevisedErrorHandlingSupport errorHandling;
 223
 224
 225         private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
 226                 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
 227             this.neighborAddress = neighbor.getNeighborAddress();
 228
 229             PeerGroup peerGroup = null;
 230             String peerGroupName = null;
 231             final Config neighborConfig = neighbor.getConfig();
 232             if (neighborConfig != null) {
 233                 final NeighborPeerGroupConfig pgConfig = neighborConfig.augmentation(NeighborPeerGroupConfig.class);
 234                 if (pgConfig != null) {
 235                     peerGroupName = StringUtils.substringBetween(pgConfig.getPeerGroup(), "=\"", "\"");
 236                     peerGroup = peerGroupLoader.getPeerGroup(bgpIid, peerGroupName);
 237                 }
 238             }
 239             final AfiSafis afisSafis;
 240             if (peerGroup != null && peerGroup.getAfiSafis() != null) {
 241                 afisSafis = peerGroup.getAfiSafis();
 242             } else {
 243                 afisSafis = requireNonNull(neighbor.getAfiSafis(), "Missing mandatory AFIs/SAFIs");
 244             }
 245
 246             final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
 247                     .toTableKey(afisSafis.getAfiSafi(), tableTypeRegistry);
 248             final PeerRole role = OpenConfigMappingUtil.toPeerRole(neighbor, peerGroup);
 249
 250             final ClusterIdentifier clusterId = OpenConfigMappingUtil
 251                     .getNeighborClusterIdentifier(neighbor.getRouteReflector(), peerGroup);
 252             final int hold = OpenConfigMappingUtil.getHoldTimer(neighbor, peerGroup);
 253             this.gracefulRestartTimer = OpenConfigMappingUtil.getGracefulRestartTimer(neighbor,
 254                     peerGroup, hold);
 255             final Set<TablesKey> gracefulTables = GracefulRestartUtil.getGracefulTables(afisSafis.getAfiSafi(),
 256                     tableTypeRegistry);
 257             final Map<TablesKey, Integer> llGracefulTimers = GracefulRestartUtil
 258                     .getLlGracefulTimers(afisSafis.getAfiSafi(), tableTypeRegistry);
 259             this.finalCapabilities = getBgpCapabilities(afisSafis, rib, tableTypeRegistry);
 260             final List<BgpParameters> bgpParameters = getInitialBgpParameters(gracefulTables, llGracefulTimers);
 261             final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
 262             final IpAddress neighborLocalAddress = OpenConfigMappingUtil.getLocalAddress(neighbor.getTransport());
 263             final AsNumber globalAs = rib.getLocalAs();
 264             final AsNumber neighborRemoteAs = OpenConfigMappingUtil
 265                     .getRemotePeerAs(neighbor.getConfig(), peerGroup, globalAs);
 266             final AsNumber neighborLocalAs;
 267             if (role == PeerRole.Ebgp) {
 268                 neighborLocalAs = OpenConfigMappingUtil.getLocalPeerAs(neighbor.getConfig(), globalAs);
 269             } else {
 270                 neighborLocalAs = globalAs;
 271             }
 272
 273             this.errorHandling = OpenConfigMappingUtil.getRevisedErrorHandling(role, peerGroup, neighbor);
 274             this.bgpPeer = new BGPPeer(tableTypeRegistry, this.neighborAddress, peerGroupName, rib, role, clusterId,
 275                     neighborLocalAs, BgpPeer.this.rpcRegistry, afiSafisAdvertized, gracefulTables, llGracefulTimers,
 276                     BgpPeer.this);
 277             this.prefs = new BGPSessionPreferences(neighborLocalAs, hold, rib.getBgpIdentifier(),
 278                     neighborRemoteAs, bgpParameters, getPassword(keyMapping));
 279             this.activeConnection = OpenConfigMappingUtil.isActive(neighbor, peerGroup);
 280             this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor, peerGroup);
 281             this.dispatcher = rib.getDispatcher();
 282
 283             final PortNumber port = OpenConfigMappingUtil.getPort(neighbor, peerGroup);
 284             this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress, port);
 285             if (neighborLocalAddress != null) {
 286                 this.localAddress = Ipv4Util.toInetSocketAddress(neighborLocalAddress, port);
 287             } else {
 288                 this.localAddress = null;
 289             }
 290             this.keys = keyMapping;
 291         }
 292
 293         private List<BgpParameters> getInitialBgpParameters(final Set<TablesKey> gracefulTables,
 294                                                             final Map<TablesKey, Integer> llGracefulTimers) {
 295             final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulRestarts = llGracefulTimers.entrySet().stream()
 296                     .map(entry -> new BgpPeerUtil.LlGracefulRestartDTO(entry.getKey(), entry.getValue(), false))
 297                     .collect(Collectors.toSet());
 298             return Collections.singletonList(
 299                     GracefulRestartUtil.getGracefulBgpParameters(this.finalCapabilities, gracefulTables,
 300                             Collections.emptySet(), gracefulRestartTimer, false, llGracefulRestarts));
 301         }
 302
 303         private synchronized void instantiateServiceInstance() {
 304             this.isServiceInstantiated = true;
 305             LOG.info("Peer instantiated {}", this.neighborAddress);
 306             this.bgpPeer.instantiateServiceInstance();
 307             this.dispatcher.getBGPPeerRegistry().addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
 308             if (this.activeConnection) {
 309                 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.localAddress,
 310                         this.retryTimer, this.keys);
 311             }
 312         }
 313
 314         private synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
 315             if (!this.isServiceInstantiated) {
 316                 LOG.info("Peer {} already closed", this.neighborAddress);
 317                 return CommitInfo.emptyFluentFuture();
 318             }
 319             LOG.info("Close Peer {}", this.neighborAddress);
 320             this.isServiceInstantiated = false;
 321             if (this.connection != null) {
 322                 this.connection.cancel(true);
 323                 this.connection = null;
 324             }
 325             final FluentFuture<? extends CommitInfo> future = this.bgpPeer.close();
 326             removePeer(this.dispatcher.getBGPPeerRegistry());
 327             return future;
 328         }
 329
 330         @Override
 331         public BGPPeerState getPeerState() {
 332             return this.bgpPeer.getPeerState();
 333         }
 334     }
 335
 336     public synchronized List<OptionalCapabilities> getBgpFixedCapabilities() {
 337         return this.bgpPeerSingletonService.finalCapabilities;
 338     }
 339
 340     public synchronized int getGracefulRestartTimer() {
 341         return this.bgpPeerSingletonService.gracefulRestartTimer;
 342     }
 343
 344     public synchronized Optional<RevisedErrorHandlingSupport> getErrorHandling() {
 345         return Optional.ofNullable(this.bgpPeerSingletonService.errorHandling);
 346     }
 347 }