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