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