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