HC2VPP-174: add support for BGP IPv4/IPv6 unicast

Tranlates BGP IPv4/IPv6 routes to VPP FIB.

Not supported:
 - multiple paths (https://tools.ietf.org/html/rfc7911)
 - IPv6 SR

Change-Id: I06f0e81dd44df6a2eb7a3fe95445041e8f4f7af9
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

5 files changed, 336 insertions, 0 deletions

diff --git a/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/BgpInetModule.java b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/BgpInetModule.java
new file mode 100644
index 000000000..58f2e84d8
--- /dev/null
+++ b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/BgpInetModule.java
@@ -0,0 +1,43 @@
+/*
+ * 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.hc2vpp.bgp.inet;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.multibindings.Multibinder;
+import io.fd.honeycomb.translate.bgp.RouteWriterFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * BgpInetModule class instantiating BGP IPv4 and IPv6 route writers.
+ */
+public final class BgpInetModule extends AbstractModule {
+
+    private static final Logger LOG = LoggerFactory.getLogger(BgpInetModule.class);
+
+    @Override
+    protected void configure() {
+        LOG.info("Installing BGP inet module");
+
+        LOG.info("Injecting route writers");
+        final Multibinder<RouteWriterFactory> writerFactoryBinder =
+            Multibinder.newSetBinder(binder(), RouteWriterFactory.class);
+        writerFactoryBinder.addBinding().to(InetRouteWriterFactory.class);
+
+        LOG.info("BgpInetModule successfully configured");
+    }
+}
diff --git a/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/InetRouteWriterFactory.java b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/InetRouteWriterFactory.java
new file mode 100644
index 000000000..821d4364d
--- /dev/null
+++ b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/InetRouteWriterFactory.java
@@ -0,0 +1,34 @@
+/*
+ * 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.hc2vpp.bgp.inet;
+
+import com.google.inject.Inject;
+import io.fd.honeycomb.translate.bgp.RibWriter;
+import io.fd.honeycomb.translate.bgp.RouteWriterFactory;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import javax.annotation.Nonnull;
+
+final class InetRouteWriterFactory implements RouteWriterFactory {
+    @Inject
+    private FutureJVppCore vppApi;
+
+    @Override
+    public void init(@Nonnull final RibWriter registry) {
+        registry.register(new Ipv4Writer(vppApi));
+        registry.register(new Ipv6Writer(vppApi));
+    }
+}
diff --git a/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/Ipv4Writer.java b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/Ipv4Writer.java
new file mode 100644
index 000000000..ef1853ce8
--- /dev/null
+++ b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/Ipv4Writer.java
@@ -0,0 +1,111 @@
+/*
+ * 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.hc2vpp.bgp.inet;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.sun.istack.internal.Nullable;
+import io.fd.hc2vpp.common.translate.util.Ipv4Translator;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+import io.fd.honeycomb.translate.bgp.RouteWriter;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import io.fd.vpp.jvpp.core.dto.IpAddDelRoute;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
+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.next.hop.CNextHop;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCase;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+final class Ipv4Writer implements RouteWriter<Ipv4Route>, Ipv4Translator, JvppReplyConsumer, RouteRequestProducer {
+
+    private static final Logger LOG = LoggerFactory.getLogger(Ipv4Writer.class);
+
+    @SuppressWarnings("unchecked")
+    private static final InstanceIdentifier<Ipv4Route> ID = InstanceIdentifier.create(BgpRib.class).child(Rib.class)
+        .child(LocRib.class).child(Tables.class).child((Class) Ipv4Routes.class)
+        .child(Ipv4Route.class);
+
+    private final FutureJVppCore vppApi;
+
+    Ipv4Writer(@Nonnull final FutureJVppCore vppApi) {
+        this.vppApi = checkNotNull(vppApi, "vppApi should not be null");
+    }
+
+    @Override
+    public void create(@Nonnull final InstanceIdentifier<Ipv4Route> id,
+                       @Nullable final Ipv4Route route)
+        throws WriteFailedException.CreateFailedException {
+        final IpAddDelRoute request = request(route, true);
+        LOG.debug("Translating id={}, route={} to {}", id, route, request);
+        getReplyForCreate(vppApi.ipAddDelRoute(request).toCompletableFuture(), id, route);
+        LOG.debug("VPP FIB updated successfully (added id={}).", id);
+    }
+
+    @Override
+    public void delete(@Nonnull final InstanceIdentifier<Ipv4Route> id,
+                       @Nullable final Ipv4Route route)
+        throws WriteFailedException.DeleteFailedException {
+        LOG.debug("Removing id={}, route={}", id, route);
+        getReplyForDelete(vppApi.ipAddDelRoute(request(route, false)).toCompletableFuture(), id);
+        LOG.debug("VPP FIB updated successfully (removed id={}).", id);
+    }
+
+    @Override
+    public void update(@Nonnull final InstanceIdentifier<Ipv4Route> id,
+                       @Nullable final Ipv4Route routeBefore,
+                       @Nullable final Ipv4Route routeAfter)
+        throws WriteFailedException.UpdateFailedException {
+        throw new WriteFailedException.UpdateFailedException(id, routeBefore, routeAfter,
+            new UnsupportedOperationException("Operation not supported"));
+    }
+
+    private IpAddDelRoute request(final Ipv4Route route, boolean isAdd) {
+        // TODO(HC2VPP-177): add support for request.nextHopWeight for multiple path case
+
+        final CNextHop cNextHop = route.getAttributes().getCNextHop();
+        checkArgument(cNextHop instanceof Ipv4NextHopCase, "only ipv4 next hop is supported, but was %s (route = %s)",
+            cNextHop, route);
+
+        final IpAddDelRoute request = ipAddDelRoute(isAdd);
+
+        final Ipv4Address nextHop = ((Ipv4NextHopCase) cNextHop).getIpv4NextHop().getGlobal();
+        request.nextHopAddress = ipv4AddressNoZoneToArray(nextHop.getValue());
+
+        final Ipv4Prefix destinationAddress = route.getPrefix();
+        request.dstAddress = ipv4AddressPrefixToArray(destinationAddress);
+        request.dstAddressLength = extractPrefix(destinationAddress);
+
+        return request;
+    }
+
+    @Nonnull
+    @Override
+    public InstanceIdentifier<Ipv4Route> getManagedDataObjectType() {
+        return ID;
+    }
+}
diff --git a/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/Ipv6Writer.java b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/Ipv6Writer.java
new file mode 100644
index 000000000..0e7e31de4
--- /dev/null
+++ b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/Ipv6Writer.java
@@ -0,0 +1,115 @@
+/*
+ * 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.hc2vpp.bgp.inet;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import com.sun.istack.internal.Nullable;
+import io.fd.hc2vpp.common.translate.util.Ipv6Translator;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+import io.fd.honeycomb.translate.bgp.RouteWriter;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import io.fd.vpp.jvpp.core.dto.IpAddDelRoute;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv6.routes.Ipv6Routes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv6.routes.ipv6.routes.Ipv6Route;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
+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.next.hop.CNextHop;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv6NextHopCase;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+final class Ipv6Writer implements RouteWriter<Ipv6Route>, Ipv6Translator, JvppReplyConsumer, RouteRequestProducer {
+
+    private static final Logger LOG = LoggerFactory.getLogger(Ipv6Writer.class);
+
+    @SuppressWarnings("unchecked")
+    private static final  InstanceIdentifier<Ipv6Route> ID = InstanceIdentifier.create(BgpRib.class).child(Rib.class)
+        .child(LocRib.class).child(Tables.class).child((Class) Ipv6Routes.class)
+        .child(Ipv6Route.class);
+
+    private final FutureJVppCore vppApi;
+
+    Ipv6Writer(@Nonnull final FutureJVppCore vppApi) {
+        this.vppApi = checkNotNull(vppApi, "vppApi should not be null");
+    }
+
+    @Override
+    public void create(@Nonnull final InstanceIdentifier<Ipv6Route> id,
+                       @Nullable final Ipv6Route route)
+        throws WriteFailedException.CreateFailedException {
+        final IpAddDelRoute request = request(route, true);
+        LOG.debug("Translating id={}, route={} to {}", id, route, request);
+        getReplyForCreate(vppApi.ipAddDelRoute(request).toCompletableFuture(), id, route);
+        LOG.debug("VPP FIB updated successfully (added id={}).", id);
+    }
+
+    @Override
+    public void delete(@Nonnull final InstanceIdentifier<Ipv6Route> id,
+                       @Nullable final Ipv6Route route)
+        throws WriteFailedException.DeleteFailedException {
+        LOG.debug("Removing id={}, route={}", id, route);
+        getReplyForDelete(vppApi.ipAddDelRoute(request(route, false)).toCompletableFuture(), id);
+        LOG.debug("VPP FIB updated successfully (removed id={}).", id);
+    }
+
+    @Override
+    public void update(@Nonnull final InstanceIdentifier<Ipv6Route> id,
+                       @Nullable final Ipv6Route routeBefore,
+                       @Nullable final Ipv6Route routeAfter)
+        throws WriteFailedException.UpdateFailedException {
+        throw new WriteFailedException.UpdateFailedException(id, routeBefore, routeAfter,
+            new UnsupportedOperationException("Operation not supported"));
+    }
+
+    private IpAddDelRoute request(final Ipv6Route dataAfter, boolean isAdd) {
+        // TODO(HC2VPP-178): support of bgp-prefix-sid SR for IPv6
+        // dataAfter.getAttributes().getBgpPrefixSid()
+
+        // TODO(HC2VPP-177): add support for request.nextHopWeight for multiple path case
+
+        final CNextHop cNextHop = dataAfter.getAttributes().getCNextHop();
+        checkArgument(cNextHop instanceof Ipv6NextHopCase, "only ipv6 next hop is supported, but was %s (route = %s)",
+            cNextHop, dataAfter);
+
+        final IpAddDelRoute request = ipAddDelRoute(isAdd);
+        request.isIpv6 = 1;
+
+        final Ipv6Address nextHop = ((Ipv6NextHopCase) cNextHop).getIpv6NextHop().getGlobal();
+        request.nextHopAddress = ipv6AddressNoZoneToArray(nextHop);
+
+        final Ipv6Prefix destinationAddress = dataAfter.getPrefix();
+        request.dstAddress = ipv6AddressPrefixToArray(destinationAddress);
+        request.dstAddressLength = extractPrefix(destinationAddress);
+
+        return request;
+    }
+
+    @Nonnull
+    @Override
+    public InstanceIdentifier<Ipv6Route> getManagedDataObjectType() {
+        return ID;
+    }
+}
diff --git a/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/RouteRequestProducer.java b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/RouteRequestProducer.java
new file mode 100644
index 000000000..2684ba5ec
--- /dev/null
+++ b/bgp/inet/src/main/java/io/fd/hc2vpp/bgp/inet/RouteRequestProducer.java
@@ -0,0 +1,33 @@
+/*
+ * 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.hc2vpp.bgp.inet;
+
+import io.fd.hc2vpp.common.translate.util.ByteDataTranslator;
+import io.fd.vpp.jvpp.core.dto.IpAddDelRoute;
+
+interface RouteRequestProducer extends ByteDataTranslator {
+    int MPLS_LABEL_INVALID = 0x100000;
+
+    default IpAddDelRoute ipAddDelRoute(boolean isAdd) {
+        final IpAddDelRoute request = new IpAddDelRoute();
+        request.isAdd = booleanToByte(isAdd);
+        // we create recursive route and expect hc2vpp user to add route for next hop with interface specified
+        request.nextHopSwIfIndex = -1;
+        request.nextHopViaLabel = MPLS_LABEL_INVALID;
+        return request;
+    }
+}