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