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