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