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