bgp/rib-impl/src/main/java/org/opendaylight/controller/config/yang/bgp/rib/impl/BGPPeerModule.java

   1 /*
   2  * Copyright (c) 2013 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  * Generated file
  10
  11  * Generated from: yang module name: bgp-rib-impl  yang module local name: bgp-peer
  12  * Generated by: org.opendaylight.controller.config.yangjmxgenerator.plugin.JMXGenerator
  13  * Generated at: Sat Jan 25 11:00:14 CET 2014
  14  *
  15  * Do not modify this file unless it is present under src/main directory
  16  */
  17 package org.opendaylight.controller.config.yang.bgp.rib.impl;
  18
  19 import com.google.common.base.Optional;
  20 import com.google.common.base.Preconditions;
  21 import com.google.common.net.InetAddresses;
  22 import io.netty.channel.epoll.Epoll;
  23 import io.netty.util.concurrent.Future;
  24 import java.net.InetSocketAddress;
  25 import java.util.ArrayList;
  26 import java.util.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import org.opendaylight.controller.config.api.JmxAttributeValidationException;
  30 import org.opendaylight.protocol.bgp.openconfig.spi.BGPConfigModuleTracker;
  31 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigProvider;
  32 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenconfigMapper;
  33 import org.opendaylight.protocol.bgp.openconfig.spi.InstanceConfigurationIdentifier;
  34 import org.opendaylight.protocol.bgp.openconfig.spi.pojo.BGPPeerInstanceConfiguration;
  35 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
  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.StrictBGPPeerRegistry;
  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.RIB;
  42 import org.opendaylight.protocol.concepts.KeyMapping;
  43 import org.opendaylight.protocol.util.Ipv6Util;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.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.GracefulRestartCapabilityBuilder;
  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.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.rfc2385.cfg.rev160324.Rfc2385Key;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64 /**
  65  *
  66  */
  67 public final class BGPPeerModule extends org.opendaylight.controller.config.yang.bgp.rib.impl.AbstractBGPPeerModule {
  68     private static final Logger LOG = LoggerFactory.getLogger(BGPPeerModule.class);
  69
  70     public BGPPeerModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
  71         final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
  72         super(identifier, dependencyResolver);
  73     }
  74
  75     public BGPPeerModule(final org.opendaylight.controller.config.api.ModuleIdentifier identifier,
  76         final org.opendaylight.controller.config.api.DependencyResolver dependencyResolver, final BGPPeerModule oldModule,
  77         final java.lang.AutoCloseable oldInstance) {
  78
  79         super(identifier, dependencyResolver, oldModule, oldInstance);
  80     }
  81
  82     @Override
  83     protected void customValidation() {
  84         final IpAddress host = getHost();
  85         JmxAttributeValidationException.checkNotNull(host, "value is not set.", hostJmxAttribute);
  86         JmxAttributeValidationException.checkCondition(host.getIpv4Address() != null || host.getIpv6Address() != null,
  87             "Unexpected host", hostJmxAttribute);
  88
  89         JmxAttributeValidationException.checkNotNull(getPort(), "value is not set.", portJmxAttribute);
  90
  91         if (getPeerRole() != null) {
  92             final boolean isNotPeerRoleInternal= getPeerRole() != PeerRole.Internal;
  93             JmxAttributeValidationException.checkCondition(isNotPeerRoleInternal,
  94                 "Internal Peer Role is reserved for Application Peer use.", peerRoleJmxAttribute);
  95         }
  96
  97         if (getOptionalPassword(getPassword()).isPresent()) {
  98             JmxAttributeValidationException.checkCondition(Epoll.isAvailable(),
  99                     "BGP Peer is configured with password but native transport is not available", passwordJmxAttribute);
 100         }
 101
 102     }
 103
 104     private InetSocketAddress createAddress() {
 105         final IpAddress ip = getHost();
 106         Preconditions.checkArgument(ip.getIpv4Address() != null || ip.getIpv6Address() != null, "Failed to handle host %s", ip);
 107         if (ip.getIpv4Address() != null) {
 108             return new InetSocketAddress(InetAddresses.forString(ip.getIpv4Address().getValue()), getPort().getValue());
 109         }
 110         return new InetSocketAddress(InetAddresses.forString(ip.getIpv6Address().getValue()), getPort().getValue());
 111     }
 112
 113     @Override
 114     public java.lang.AutoCloseable createInstance() {
 115         final RIB r = getRibDependency();
 116
 117         final List<BgpParameters> tlvs = getTlvs(r);
 118         final AsNumber remoteAs = getAsOrDefault(r);
 119         final BGPSessionPreferences prefs = new BGPSessionPreferences(r.getLocalAs(), getHoldtimer(), r.getBgpIdentifier(), remoteAs, tlvs);
 120         final BGPPeer bgpClientPeer;
 121         final IpAddress host = getNormalizedHost();
 122         if (getPeerRole() != null) {
 123             bgpClientPeer = new BGPPeer(peerName(host), r, getPeerRole(), getSimpleRoutingPolicy(), getRpcRegistryDependency());
 124         } else {
 125             bgpClientPeer = new BGPPeer(peerName(host), r, PeerRole.Ibgp, getSimpleRoutingPolicy(), getRpcRegistryDependency());
 126         }
 127
 128         bgpClientPeer.registerRootRuntimeBean(getRootRuntimeBeanRegistratorWrapper());
 129
 130         getPeerRegistryBackwards().addPeer(host, bgpClientPeer, prefs);
 131
 132         final BGPPeerModuleTracker moduleTracker = new BGPPeerModuleTracker(r.getOpenConfigProvider());
 133         moduleTracker.onInstanceCreate();
 134
 135         final CloseableNoEx peerCloseable = new CloseableNoEx() {
 136             @Override
 137             public void close() {
 138                 bgpClientPeer.close();
 139                 getPeerRegistryBackwards().removePeer(host);
 140                 moduleTracker.onInstanceClose();
 141             }
 142         };
 143
 144         // Initiate connection
 145         if(getInitiateConnection()) {
 146             final Future<Void> cf = initiateConnection(createAddress(), getOptionalPassword(getPassword()), getPeerRegistryBackwards());
 147             return new CloseableNoEx() {
 148                 @Override
 149                 public void close() {
 150                     cf.cancel(true);
 151                     peerCloseable.close();
 152                 }
 153             };
 154         } else {
 155             return peerCloseable;
 156         }
 157     }
 158
 159     private interface CloseableNoEx extends AutoCloseable {
 160         @Override
 161         void close();
 162     }
 163
 164     private AsNumber getAsOrDefault(final RIB r) {
 165         // Remote AS number defaults to our local AS
 166         final AsNumber remoteAs;
 167         if (getRemoteAs() != null) {
 168             remoteAs = new AsNumber(getRemoteAs());
 169         } else {
 170             remoteAs = r.getLocalAs();
 171         }
 172         return remoteAs;
 173     }
 174
 175     private List<BgpParameters> getTlvs(final RIB r) {
 176         final List<BgpParameters> tlvs = new ArrayList<>();
 177         final List<OptionalCapabilities> caps = new ArrayList<>();
 178         caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
 179             new As4BytesCapabilityBuilder().setAsNumber(r.getLocalAs()).build()).build()).build());
 180         caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 181             new CParameters1Builder().setGracefulRestartCapability(new GracefulRestartCapabilityBuilder().build()).build()).build()).build());
 182
 183         if (getRouteRefresh()) {
 184             caps.add(new OptionalCapabilitiesBuilder().setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
 185         }
 186
 187         if (!getAddPathDependency().isEmpty()) {
 188             final List<AddressFamilies> addPathFamilies = filterAddPathDependency(getAddPathDependency());
 189             caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 190                 new CParameters1Builder().setAddPathCapability(new AddPathCapabilityBuilder().setAddressFamilies(addPathFamilies).build()).build()).build()).build());
 191         }
 192
 193         for (final BgpTableType t : getAdvertizedTableDependency()) {
 194             if (!r.getLocalTables().contains(t)) {
 195                 LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.", t);
 196             }
 197
 198             caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
 199                 new CParameters1Builder().setMultiprotocolCapability(new MultiprotocolCapabilityBuilder(t).build()).build()).build()).build());
 200         }
 201         tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
 202         return tlvs;
 203     }
 204
 205     private List<AddressFamilies> filterAddPathDependency(final List<AddressFamilies> addPathDependency) {
 206         final Map<BgpTableType, AddressFamilies> filteredFamilies = new HashMap<BgpTableType, AddressFamilies>();
 207         for (final AddressFamilies family : addPathDependency) {
 208             final BgpTableType key = new BgpTableTypeImpl(family.getAfi(), family.getSafi());
 209             if (!filteredFamilies.containsKey(key)) {
 210                 filteredFamilies.put(key, family);
 211             } else {
 212                 LOG.info("Ignoring Add-path dependency {}", family);
 213             }
 214         }
 215         return new ArrayList<AddressFamilies>(filteredFamilies.values());
 216     }
 217
 218     public IpAddress getNormalizedHost() {
 219         final IpAddress host = getHost();
 220         if(host.getIpv6Address() != null){
 221             return new IpAddress(Ipv6Util.getFullForm(host.getIpv6Address()));
 222         }
 223         return host;
 224     }
 225
 226     private io.netty.util.concurrent.Future<Void> initiateConnection(final InetSocketAddress address, final Optional<Rfc2385Key> password, final BGPPeerRegistry registry) {
 227         KeyMapping keys = KeyMapping.getKeyMapping(address.getAddress(), password);
 228         final RIB rib = getRibDependency();
 229         final Optional<KeyMapping> optionalKey = Optional.fromNullable(keys);
 230         return rib.getDispatcher().createReconnectingClient(address, registry, getRetrytimer(), optionalKey);
 231     }
 232
 233     private BGPPeerRegistry getPeerRegistryBackwards() {
 234         return getPeerRegistry() == null ? StrictBGPPeerRegistry.GLOBAL : getPeerRegistryDependency();
 235     }
 236
 237     private static String peerName(final IpAddress host) {
 238         if (host.getIpv4Address() != null) {
 239             return host.getIpv4Address().getValue();
 240         }
 241         if (host.getIpv6Address() != null) {
 242             return host.getIpv6Address().getValue();
 243         }
 244
 245         return null;
 246     }
 247
 248     private final class BGPPeerModuleTracker implements BGPConfigModuleTracker {
 249
 250         private final BGPOpenconfigMapper<BGPPeerInstanceConfiguration> neighborProvider;
 251         private final BGPPeerInstanceConfiguration bgpPeerInstanceConfiguration;
 252
 253         public BGPPeerModuleTracker(final Optional<BGPOpenConfigProvider> openconfigProvider) {
 254             if (openconfigProvider.isPresent()) {
 255                 this.neighborProvider = openconfigProvider.get().getOpenConfigMapper(BGPPeerInstanceConfiguration.class);
 256             } else {
 257                 this.neighborProvider = null;
 258             }
 259             final InstanceConfigurationIdentifier identifier = new InstanceConfigurationIdentifier(getIdentifier().getInstanceName());
 260             this.bgpPeerInstanceConfiguration = new BGPPeerInstanceConfiguration(identifier, Rev130715Util.getIpvAddress(getNormalizedHost()),
 261                     Rev130715Util.getPort(getPort().getValue()), getHoldtimer(), getPeerRole(), getInitiateConnection(),
 262                         getAdvertizedTableDependency(), Rev130715Util.getASNumber(getAsOrDefault(getRibDependency()).getValue()),
 263                         getOptionalPassword(getPassword()), getAddPathDependency());
 264         }
 265
 266         @Override
 267         public void onInstanceCreate() {
 268             if (this.neighborProvider != null) {
 269                 this.neighborProvider.writeConfiguration(this.bgpPeerInstanceConfiguration);
 270             }
 271         }
 272
 273         @Override
 274         public void onInstanceClose() {
 275             if (this.neighborProvider != null) {
 276                 this.neighborProvider.removeConfiguration(this.bgpPeerInstanceConfiguration);
 277             }
 278         }
 279
 280     }
 281
 282     private Optional<Rfc2385Key> getOptionalPassword(final Rfc2385Key password) {
 283         return password != null && ! password.getValue().isEmpty() ? Optional.of(password) : Optional.<Rfc2385Key>absent();
 284     }
 285
 286 }