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