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