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