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 ServiceRegistration<?> serviceRegistration;
  75     private Neighbor currentConfiguration;
  76     private BgpPeerSingletonService bgpPeerSingletonService;
  77
  78     public BgpPeer(final RpcProviderRegistry rpcRegistry) {
  79         this.rpcRegistry = rpcRegistry;
  80     }
  81
  82     @Override
  83     public void start(final RIB rib, final Neighbor neighbor, final BGPTableTypeRegistryConsumer tableTypeRegistry,
  84         final WriteConfiguration configurationWriter) {
  85         Preconditions.checkState(this.bgpPeerSingletonService == null, "Previous peer instance was not closed.");
  86         this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, tableTypeRegistry, configurationWriter);
  87         this.currentConfiguration = neighbor;
  88     }
  89
  90     @Override
  91     public void restart(final RIB rib, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
  92         Preconditions.checkState(this.currentConfiguration != null);
  93         start(rib, this.currentConfiguration, tableTypeRegistry, null);
  94     }
  95
  96     @Override
  97     public void close() {
  98         closeSingletonService();
  99         if (this.serviceRegistration != null) {
 100             this.serviceRegistration.unregister();
 101             this.serviceRegistration = null;
 102         }
 103     }
 104
 105     private void closeSingletonService() {
 106         try {
 107             this.bgpPeerSingletonService.close();
 108             this.bgpPeerSingletonService = null;
 109         } catch (final Exception e) {
 110             LOG.warn("Failed to close peer instance", e);
 111         }
 112     }
 113
 114     @Override
 115     public Boolean containsEqualConfiguration(final Neighbor neighbor) {
 116         final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
 117         final AfiSafis extAfiSafi = neighbor.getAfiSafis();
 118         final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
 119         final List<AfiSafi> extSafi = extAfiSafi != null ? extAfiSafi.getAfiSafi() : Collections.emptyList();
 120         return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
 121         && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
 122         && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
 123         && Objects.equals(this.currentConfiguration.getAddPaths(),neighbor.getAddPaths())
 124         && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
 125         && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
 126         && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
 127         && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
 128         && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
 129         && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
 130         && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
 131         && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
 132         && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
 133         && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
 134     }
 135
 136     private static List<BgpParameters> getBgpParameters(final Neighbor neighbor, final RIB rib,
 137             final BGPTableTypeRegistryConsumer tableTypeRegistry) {
 138         final List<BgpParameters> tlvs = new ArrayList<>();
 139         final List<OptionalCapabilities> caps = new ArrayList<>();
 140         caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
 141                 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
 142
 143         caps.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
 144         caps.add(new OptionalCapabilitiesBuilder().setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
 145
 146         final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(neighbor.getAfiSafis(), false);
 147         final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil.toAddPathCapability(afiSafi, tableTypeRegistry);
 148         if (!addPathCapability.isEmpty()) {
 149             caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 150                     new CParameters1Builder().setAddPathCapability(
 151                             new AddPathCapabilityBuilder().setAddressFamilies(addPathCapability).build()).build()).build()).build());
 152         }
 153
 154         final List<BgpTableType> tableTypes = OpenConfigMappingUtil.toTableTypes(afiSafi, tableTypeRegistry);
 155         for (final BgpTableType tableType : tableTypes) {
 156             if (!rib.getLocalTables().contains(tableType)) {
 157                 LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.", tableType);
 158             }
 159
 160             caps.add(new OptionalCapabilitiesBuilder().setCParameters(
 161                     new CParametersBuilder().addAugmentation(CParameters1.class,
 162                             new CParameters1Builder().setMultiprotocolCapability(
 163                                     new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
 164         }
 165         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
 166         return tlvs;
 167     }
 168
 169     private static Optional<byte[]> getPassword(final KeyMapping key) {
 170         if (key != null) {
 171             return Optional.of(Iterables.getOnlyElement(key.values()));
 172         }
 173         return Optional.absent();
 174     }
 175
 176     @Override
 177     public BgpPeerState getBgpPeerState() {
 178         return this.bgpPeerSingletonService.getPeer().getBgpPeerState();
 179     }
 180
 181     @Override
 182     public BgpSessionState getBgpSessionState() {
 183         return this.bgpPeerSingletonService.getPeer().getBgpSessionState();
 184     }
 185
 186     @Override
 187     public void resetSession() {
 188         this.bgpPeerSingletonService.getPeer().resetSession();
 189     }
 190
 191     @Override
 192     public void resetStats() {
 193         this.bgpPeerSingletonService.getPeer().resetStats();
 194     }
 195
 196     @Override
 197     public BGPPeerState getPeerState() {
 198         if (this.bgpPeerSingletonService == null) {
 199             return null;
 200         }
 201         return this.bgpPeerSingletonService.getPeerState();
 202     }
 203
 204     void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
 205         this.serviceRegistration = serviceRegistration;
 206     }
 207
 208     private final class BgpPeerSingletonService implements BGPPeerStateConsumer, ClusterSingletonService,
 209         AutoCloseable {
 210         private final ServiceGroupIdentifier serviceGroupIdentifier;
 211         private final boolean activeConnection;
 212         private final BGPDispatcher dispatcher;
 213         private final InetSocketAddress inetAddress;
 214         private final int retryTimer;
 215         private final Optional<KeyMapping> key;
 216         private final WriteConfiguration configurationWriter;
 217         private ClusterSingletonServiceRegistration registration;
 218         private final BGPPeer bgpPeer;
 219         private final IpAddress neighborAddress;
 220         private final BGPSessionPreferences prefs;
 221         private Future<Void> connection;
 222
 223         private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor,
 224             final BGPTableTypeRegistryConsumer tableTypeRegistry, final WriteConfiguration configurationWriter) {
 225             this.neighborAddress = neighbor.getNeighborAddress();
 226             final AfiSafis afisSAfis = Preconditions.checkNotNull(neighbor.getAfiSafis());
 227             final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
 228                 .toTableKey(afisSAfis.getAfiSafi(), tableTypeRegistry);
 229             this.bgpPeer = new BGPPeer(Ipv4Util.toStringIP(this.neighborAddress), rib,
 230                 OpenConfigMappingUtil.toPeerRole(neighbor), getSimpleRoutingPolicy(neighbor), BgpPeer.this.rpcRegistry,
 231                 afiSafisAdvertized, Collections.emptySet());
 232             final List<BgpParameters> bgpParameters = getBgpParameters(neighbor, rib, tableTypeRegistry);
 233             final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
 234             this.prefs = new BGPSessionPreferences(rib.getLocalAs(), getHoldTimer(neighbor), rib.getBgpIdentifier(),
 235                 getPeerAs(neighbor, rib), bgpParameters, getPassword(keyMapping));
 236             this.activeConnection = OpenConfigMappingUtil.isActive(neighbor);
 237             this.dispatcher = rib.getDispatcher();
 238             this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress, OpenConfigMappingUtil.getPort(neighbor));
 239             this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor);
 240             this.key = Optional.fromNullable(keyMapping);
 241             this.configurationWriter = configurationWriter;
 242             this.serviceGroupIdentifier = rib.getRibIServiceGroupIdentifier();
 243             LOG.info("Peer Singleton Service {} registered", this.serviceGroupIdentifier.getValue());
 244             //this need to be always the last step
 245             this.registration = rib.registerClusterSingletonService(this);
 246         }
 247
 248         @Override
 249         public void close() throws Exception {
 250             if (this.registration != null) {
 251                 this.registration.close();
 252                 this.registration = null;
 253             }
 254         }
 255
 256         @Override
 257         public void instantiateServiceInstance() {
 258             if(this.configurationWriter != null) {
 259                 this.configurationWriter.apply();
 260             }
 261             LOG.info("Peer Singleton Service {} instantiated", getIdentifier().getValue());
 262             this.bgpPeer.instantiateServiceInstance();
 263             this.dispatcher.getBGPPeerRegistry().addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
 264             if (this.activeConnection) {
 265                 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.retryTimer, this.key);
 266             }
 267         }
 268
 269         @Override
 270         public ListenableFuture<Void> closeServiceInstance() {
 271             LOG.info("Close Peer Singleton Service {}", getIdentifier().getValue());
 272             if (this.connection != null) {
 273                 this.connection.cancel(true);
 274                 this.connection = null;
 275             }
 276             this.bgpPeer.close();
 277             if(BgpPeer.this.currentConfiguration != null) {
 278                 this.dispatcher.getBGPPeerRegistry().removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
 279             }
 280             return Futures.immediateFuture(null);
 281         }
 282
 283         @Override
 284         public ServiceGroupIdentifier getIdentifier() {
 285             return this.serviceGroupIdentifier;
 286         }
 287
 288         BGPPeerRuntimeMXBean getPeer() {
 289             return this.bgpPeer;
 290         }
 291
 292         @Override
 293         public BGPPeerState getPeerState() {
 294             return this.bgpPeer.getPeerState();
 295         }
 296     }
 297 }