From 2bca3b4a54e1b0a5206c7be14262e35753700d13 Mon Sep 17 00:00:00 2001 From: Jan Srnicek Date: Mon, 9 Oct 2017 10:39:17 +0200 Subject: HONEYCOMB-363 - Bgp extension modules Provides maven modules per bgp extension. Defines common configuration that can be used to define new extensions(AbstractBgpExtensionModule). Change-Id: I1c8ff65b6f9aa5474026f4bdf42476bd0559208e Signed-off-by: Jan Srnicek --- .../extension-common/asciidoc/Readme.adoc | 5 + .../bgp-extensions/extension-common/pom.xml | 79 +++++++++++++ .../bgp/extension/AbstractBgpExtensionModule.java | 130 +++++++++++++++++++++ .../BGPExtensionConsumerContextProvider.java | 52 +++++++++ .../BGPTableTypeRegistryConsumerProvider.java | 40 +++++++ .../bgp/extension/BgpExtensionModule.java | 63 ++++++++++ .../bgp/extension/CommonBgpExtensionsModule.java | 45 +++++++ .../RIBExtensionConsumerContextProvider.java | 46 ++++++++ 8 files changed, 460 insertions(+) create mode 100644 infra/northbound/bgp-extensions/extension-common/asciidoc/Readme.adoc create mode 100644 infra/northbound/bgp-extensions/extension-common/pom.xml create mode 100644 infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/AbstractBgpExtensionModule.java create mode 100644 infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPExtensionConsumerContextProvider.java create mode 100644 infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPTableTypeRegistryConsumerProvider.java create mode 100644 infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BgpExtensionModule.java create mode 100644 infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/CommonBgpExtensionsModule.java create mode 100644 infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/RIBExtensionConsumerContextProvider.java (limited to 'infra/northbound/bgp-extensions/extension-common') diff --git a/infra/northbound/bgp-extensions/extension-common/asciidoc/Readme.adoc b/infra/northbound/bgp-extensions/extension-common/asciidoc/Readme.adoc new file mode 100644 index 000000000..2969ad353 --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/asciidoc/Readme.adoc @@ -0,0 +1,5 @@ += extension-common + +Contains common features used by BGP extension modules. + +To create new BGP extension module, use parent class *AbstractBgpExtensionModule* \ No newline at end of file diff --git a/infra/northbound/bgp-extensions/extension-common/pom.xml b/infra/northbound/bgp-extensions/extension-common/pom.xml new file mode 100644 index 000000000..b6ea4cc72 --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/pom.xml @@ -0,0 +1,79 @@ + + + + + + impl-parent + io.fd.honeycomb.common + 1.18.01-SNAPSHOT + ../../../../common/impl-parent + + 4.0.0 + + io.fd.honeycomb.northbound.bgp + extension-common + 1.18.01-SNAPSHOT + + + + + com.google.inject + guice + + + org.opendaylight.bgpcep + bgp-rib-spi + ${bgpcep.version} + + + org.opendaylight.bgpcep + bgp-openconfig-api + ${bgpcep.version} + + + org.opendaylight.bgpcep + bgp-openconfig-spi + ${bgpcep.version} + + + com.google.code.findbugs + jsr305 + + + io.fd.honeycomb + binding-init + ${project.version} + + + com.google.inject.extensions + guice-multibindings + + + io.fd.honeycomb + cfg-init + ${project.version} + + + org.opendaylight.bgpcep + bgp-parser-impl + ${bgpcep.version} + + + + \ No newline at end of file diff --git a/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/AbstractBgpExtensionModule.java b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/AbstractBgpExtensionModule.java new file mode 100644 index 000000000..caab1a83f --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/AbstractBgpExtensionModule.java @@ -0,0 +1,130 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.northbound.bgp.extension; + +import com.google.inject.AbstractModule; +import com.google.inject.Singleton; +import com.google.inject.multibindings.Multibinder; +import io.fd.honeycomb.translate.write.WriterFactory; +import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionProviderActivator; +import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderActivator; +import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi; +import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRib; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; +import org.slf4j.Logger; + +import javax.annotation.Nonnull; + +/** + * General blueprint for any module that wants to bind new BGP extension + */ +public abstract class AbstractBgpExtensionModule extends AbstractModule implements BgpExtensionModule { + + public static final InstanceIdentifier TABLES_IID = InstanceIdentifier.create(ApplicationRib.class).child(Tables.class); + + @Override + protected void configure() { + bindRibActivators(); + bindExtensionActivators(); + bindTableTypes(); + bindAfiSafis(); + bindApplicationRibWriters(); + bind(BGPTableTypeRegistryConsumer.class).toProvider(BGPTableTypeRegistryConsumerProvider.class) + .in(Singleton.class); + + configureAlso(); + + // TODO(HONEYCOMB-395): should all afi-safis use the same send-max value? + } + + protected abstract Logger getLogger(); + + private void bindAfiSafis() { + final Multibinder afiSafiBinder = Multibinder.newSetBinder(binder(), AfiSafi.class); + getAfiSafiTypeProviders().stream() + .peek(aClass -> getLogger().debug("Binding afi {}", aClass)) + .forEach(providerClass -> afiSafiBinder.addBinding().toProvider(providerClass)); + } + + private void bindRibActivators() { + final Multibinder ribBinder = Multibinder.newSetBinder(binder(), + RIBExtensionProviderActivator.class); + getRibActivators().stream() + .peek(aClass -> getLogger().debug("Binding RIB activator {}", aClass)) + .forEach(activator -> ribBinder.addBinding().to(activator)); + } + + private void bindExtensionActivators() { + final Multibinder extensionsBinder = Multibinder.newSetBinder(binder(), + BGPExtensionProviderActivator.class); + getExtensionActivators().stream() + .peek(aClass -> getLogger().debug("Binding Extension activator {}", aClass)) + .forEach(activator -> extensionsBinder.addBinding().to(activator)); + } + + private void bindTableTypes() { + final Multibinder tableTypeBinder = + Multibinder.newSetBinder(binder(), BGPTableTypeRegistryConsumerProvider.BGPTableType.class); + getTableTypes().stream() + .peek(tableTypeRegistration -> getLogger().debug("Binding table type {}", tableTypeRegistration)) + .forEach(registration -> tableTypeBinder.addBinding() + .toInstance(provider -> provider.registerBGPTableType(registration.addressFamily, registration.subsequentAddressFamily, registration.afiSafiType))); + } + + private void bindApplicationRibWriters() { + final Multibinder applicationRibWritersBinder = Multibinder.newSetBinder(binder(), WriterFactory.class); + + getApplicationRibWriters().stream() + .peek(aClass -> getLogger().debug("Binding writer factory {}", aClass)) + .forEach(aClass -> applicationRibWritersBinder.addBinding().to(aClass)); + } + + static final class TableTypeRegistration { + private final Class addressFamily; + private final Class subsequentAddressFamily; + private final Class afiSafiType; + + private TableTypeRegistration(final Class addressFamily, + final Class subsequentAddressFamily, + final Class afiSafiType) { + this.addressFamily = addressFamily; + this.subsequentAddressFamily = subsequentAddressFamily; + this.afiSafiType = afiSafiType; + } + + static TableTypeRegistration tableType(@Nonnull final Class addressFamily, + @Nonnull final Class subsequentAddressFamily, + @Nonnull final Class afiSafiType) { + return new TableTypeRegistration(addressFamily, subsequentAddressFamily, afiSafiType); + } + + @Override + public String toString() { + return "TableTypeRegistration{" + + "addressFamily=" + addressFamily + + ", subsequentAddressFamily=" + subsequentAddressFamily + + ", afiSafiType=" + afiSafiType + + '}'; + } + } + +} diff --git a/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPExtensionConsumerContextProvider.java b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPExtensionConsumerContextProvider.java new file mode 100644 index 000000000..14c3e9e1b --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPExtensionConsumerContextProvider.java @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.northbound.bgp.extension; + +import com.google.inject.Inject; +import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionConsumerContext; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionProviderActivator; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionProviderContext; +import org.opendaylight.protocol.bgp.parser.spi.pojo.SimpleBGPExtensionProviderContext; +import org.opendaylight.protocol.bgp.parser.spi.pojo.SimpleBGPExtensionProviderContextActivator; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.ArrayList; +import java.util.Set; + +final class BGPExtensionConsumerContextProvider extends ProviderTrait { + private static final Logger LOG = LoggerFactory.getLogger(BGPExtensionConsumerContextProvider.class); + + @Inject + private Set activators; + + @Inject + private ShutdownHandler shutdownHandler; + + @Override + protected BGPExtensionConsumerContext create() { + final BGPExtensionProviderContext ctx = new SimpleBGPExtensionProviderContext(); + final SimpleBGPExtensionProviderContextActivator activator = + new SimpleBGPExtensionProviderContextActivator(ctx, new ArrayList<>(activators)); + LOG.debug("Starting BGPExtensionConsumerContext with activators: {}", activators); + activator.start(); + shutdownHandler.register("bgp-extension-context-activator", activator); + return ctx; + } +} diff --git a/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPTableTypeRegistryConsumerProvider.java b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPTableTypeRegistryConsumerProvider.java new file mode 100644 index 000000000..24e592a27 --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BGPTableTypeRegistryConsumerProvider.java @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.northbound.bgp.extension; + +import com.google.inject.Inject; +import io.fd.honeycomb.binding.init.ProviderTrait; +import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer; +import org.opendaylight.protocol.bgp.openconfig.spi.SimpleBGPTableTypeRegistryProvider; + +import java.util.Set; + +final class BGPTableTypeRegistryConsumerProvider extends ProviderTrait { + @Inject + private Set tableTypes; + + @Override + protected BGPTableTypeRegistryConsumer create() { + final SimpleBGPTableTypeRegistryProvider registry = new SimpleBGPTableTypeRegistryProvider(); + tableTypes.stream().forEach(tableType -> tableType.register(registry)); + return registry; + } + + interface BGPTableType { + void register(SimpleBGPTableTypeRegistryProvider registry); + } +} diff --git a/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BgpExtensionModule.java b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BgpExtensionModule.java new file mode 100644 index 000000000..10d4398ed --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/BgpExtensionModule.java @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.northbound.bgp.extension; + +import com.google.inject.Provider; +import io.fd.honeycomb.translate.write.WriterFactory; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionProviderActivator; +import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderActivator; +import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi; + +import java.util.Set; + +/** + * Interface to define all bindings that BGP extension module should expose + */ +public interface BgpExtensionModule { + + /** + * RIB activator/s for module + */ + Set> getRibActivators(); + + /** + * Extension activator/s for module + */ + Set> getExtensionActivators(); + + /** + * Supported table types + */ + Set getTableTypes(); + + /** + * Supported afi's + */ + Set>> getAfiSafiTypeProviders(); + + /** + * Returns {@code WriterFactory} that binds all nodes that extension is handling + */ + Set> getApplicationRibWriters(); + + /** + * Any additional bindings that are needed + */ + default void configureAlso() { + //NOOP - override to add additional configuration + } +} diff --git a/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/CommonBgpExtensionsModule.java b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/CommonBgpExtensionsModule.java new file mode 100644 index 000000000..e5406dd44 --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/CommonBgpExtensionsModule.java @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.northbound.bgp.extension; + +import com.google.inject.AbstractModule; +import com.google.inject.Singleton; +import com.google.inject.multibindings.Multibinder; +import org.opendaylight.protocol.bgp.parser.impl.BGPActivator; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionConsumerContext; +import org.opendaylight.protocol.bgp.parser.spi.BGPExtensionProviderActivator; +import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Registers BGP extensions provided by ODL implementation. + * TODO(HONEYCOMB-378): add support for flowspec (requires some special initialization) + */ +public final class CommonBgpExtensionsModule extends AbstractModule { + private static final Logger LOG = LoggerFactory.getLogger(CommonBgpExtensionsModule.class); + + protected void configure() { + LOG.debug("Initializing CommonBgpExtensionsModule"); + // This should be part of BgpModule, but that one is Private and Multibinders + private BASE_MODULES + // do not work together, that's why there's a dedicated module here + // https://github.com/google/guice/issues/906 + bind(RIBExtensionConsumerContext.class).toProvider(RIBExtensionConsumerContextProvider.class).in(Singleton.class); + bind(BGPExtensionConsumerContext.class).toProvider(BGPExtensionConsumerContextProvider.class).in(Singleton.class); + Multibinder.newSetBinder(binder(), BGPExtensionProviderActivator.class).addBinding().to(BGPActivator.class); + } +} diff --git a/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/RIBExtensionConsumerContextProvider.java b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/RIBExtensionConsumerContextProvider.java new file mode 100644 index 000000000..a8374ea67 --- /dev/null +++ b/infra/northbound/bgp-extensions/extension-common/src/main/java/io/fd/honeycomb/northbound/bgp/extension/RIBExtensionConsumerContextProvider.java @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2017 Cisco and/or its affiliates. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.fd.honeycomb.northbound.bgp.extension; + +import com.google.inject.Inject; +import io.fd.honeycomb.binding.init.ProviderTrait; +import io.fd.honeycomb.data.init.ShutdownHandler; +import org.opendaylight.protocol.bgp.rib.spi.*; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.util.ArrayList; +import java.util.Set; + +public class RIBExtensionConsumerContextProvider extends ProviderTrait { + private static final Logger LOG = LoggerFactory.getLogger(RIBExtensionConsumerContextProvider.class); + @Inject + private Set activators; + @Inject + private ShutdownHandler shutdownHandler; + + @Override + protected RIBExtensionConsumerContext create() { + final RIBExtensionProviderContext ctx = new SimpleRIBExtensionProviderContext(); + final SimpleRIBExtensionProviderContextActivator activator = + new SimpleRIBExtensionProviderContextActivator(ctx, new ArrayList<>(activators)); + LOG.debug("Starting RIBExtensionConsumerContext with activators: {}", activators); + activator.start(); + shutdownHandler.register("rib-extension-consumer-context-activator", activator); + return ctx; + } +} -- cgit 1.2.3-korg