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