HONEYCOMB-58 - Routing Plugin Structure

Read/Write support for ipv4/6 static routes.
Restriction due to vpp implementation described
in readme.

Change-Id: I328f406a9b7cb8781f8becf98eca293cebe66859
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>

3 files changed, 348 insertions, 0 deletions

diff --git a/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/Ipv4RoutePathParser.java b/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/Ipv4RoutePathParser.java
new file mode 100644
index 000000000..58dee232b
--- /dev/null
+++ b/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/Ipv4RoutePathParser.java
@@ -0,0 +1,120 @@
+/*
+ * Copyright (c) 2016 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.routing.trait;
+
+import static io.fd.hc2vpp.routing.trait.RouteMapper.isDefaultInterfaceIndex;
+
+import io.fd.hc2vpp.common.translate.util.AddressTranslator;
+import io.fd.hc2vpp.common.translate.util.MultiNamingContext;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.hc2vpp.routing.naming.Ipv4RouteNamesFactory;
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.vpp.jvpp.core.types.FibPath;
+import java.util.List;
+import java.util.stream.Collectors;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.NextHopOptions;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.SimpleNextHop;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.SimpleNextHopBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.SpecialNextHop;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.SpecialNextHopBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.next.hop.list.NextHopListBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.next.hop.list.next.hop.list.NextHopBuilder;
+
+public interface Ipv4RoutePathParser extends RouteMapper {
+
+    static NextHopOptions resolveOption(final String routeName,
+                                        final List<FibPath> parsedHops,
+                                        final NamingContext interfaceContext,
+                                        final MultiNamingContext routeHopContext,
+                                        final MappingContext mappingContext,
+                                        final Ipv4RouteNamesFactory namesFactory) {
+        return parsedHops.size() == 1
+                ? RouteMapper.INSTANCE.isSpecialHop(parsedHops.get(0))
+                ? specialHop(parsedHops.get(0))
+                : simpleHop(parsedHops.get(0), interfaceContext, mappingContext)
+                : hopList(routeName, parsedHops, interfaceContext, routeHopContext, mappingContext, namesFactory);
+    }
+
+    static SpecialNextHop specialHop(final FibPath singlePath) {
+        return new SpecialNextHopBuilder()
+                .setSpecialNextHop(RouteMapper.INSTANCE.specialHopType(singlePath))
+                .build();
+    }
+
+    static SimpleNextHop simpleHop(final FibPath path, final NamingContext interfaceContext,
+                                   final MappingContext mappingContext) {
+        return resolveInterfaceIfSpecified(new SimpleNextHopBuilder(), path.swIfIndex, interfaceContext, mappingContext)
+                .setNextHop(AddressTranslator.INSTANCE.arrayToIpv4AddressNoZone(path.nextHop))
+                .build();
+    }
+
+    static SimpleNextHopBuilder resolveInterfaceIfSpecified(final SimpleNextHopBuilder builder, final int index,
+                                                            final NamingContext interfaceContext,
+                                                            final MappingContext mappingContext) {
+        if (!isDefaultInterfaceIndex(index)) {
+            builder.setOutgoingInterface(interfaceContext.getName(index, mappingContext));
+        }
+        return builder;
+    }
+
+    static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.NextHopList hopList(
+            final String routeName,
+            final List<FibPath> parsedHops,
+            final NamingContext interfaceContext,
+            final MultiNamingContext routeHopContext,
+            final MappingContext mappingContext,
+            final Ipv4RouteNamesFactory namesFactory) {
+        return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.NextHopListBuilder()
+                .setNextHopList(
+                        new NextHopListBuilder().setNextHop(parsedHops.stream()
+                                .map(fibPath -> resolveInterfaceIfSpecified(new NextHopBuilder(), fibPath.swIfIndex,
+                                        interfaceContext, mappingContext)
+                                        .setId((long) (routeHopContext.getChildIndex(routeName,
+                                                namesFactory.uniqueRouteHopName(fibPath, mappingContext),
+                                                mappingContext)))
+                                        .setWeight(((short) fibPath.weight))
+                                        .setAddress(
+                                                AddressTranslator.INSTANCE
+                                                        .arrayToIpv4AddressNoZone(fibPath.nextHop))
+                                        .build())
+                                .collect(Collectors.toList()))
+                                .build())
+                .build();
+    }
+
+    static NextHopBuilder resolveInterfaceIfSpecified(final NextHopBuilder builder, final int index,
+                                                      final NamingContext interfaceContext,
+                                                      final MappingContext mappingContext) {
+        if (!isDefaultInterfaceIndex(index)) {
+            builder.setOutgoingInterface(interfaceContext.getName(index, mappingContext));
+        }
+        return builder;
+    }
+
+    default NextHopOptions resolveHopType(@Nonnull final String routeName,
+                                          final List<FibPath> parsedHops,
+                                          @Nonnull final NamingContext interfaceContext,
+                                          @Nonnull final MultiNamingContext routeHopContext,
+                                          @Nonnull final MappingContext mappingContext,
+                                          @Nonnull final Ipv4RouteNamesFactory namesFactory) {
+
+        return parsedHops == null || parsedHops.isEmpty()
+                ? null
+                : resolveOption(routeName, parsedHops, interfaceContext, routeHopContext, mappingContext, namesFactory);
+    }
+}
diff --git a/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/Ipv6RoutePathParser.java b/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/Ipv6RoutePathParser.java
new file mode 100644
index 000000000..908472931
--- /dev/null
+++ b/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/Ipv6RoutePathParser.java
@@ -0,0 +1,136 @@
+/*
+ * Copyright (c) 2016 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.routing.trait;
+
+import static io.fd.hc2vpp.routing.trait.RouteMapper.isDefaultInterfaceIndex;
+
+import io.fd.hc2vpp.common.translate.util.AddressTranslator;
+import io.fd.hc2vpp.common.translate.util.MultiNamingContext;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.hc2vpp.routing.naming.Ipv6RouteNamesFactory;
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.vpp.jvpp.core.types.FibPath;
+import java.util.List;
+import java.util.stream.Collectors;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.NextHopOptions;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.SimpleNextHop;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.SimpleNextHopBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.SpecialNextHop;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.SpecialNextHopBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.next.hop.list.NextHopList;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.next.hop.list.NextHopListBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.next.hop.list.next.hop.list.NextHopBuilder;
+
+public interface Ipv6RoutePathParser extends RouteMapper {
+
+    static NextHopOptions resolveOption(final String routeName,
+                                        final List<FibPath> parsedHops,
+                                        final NamingContext interfaceContext,
+                                        final MultiNamingContext routeHopContext,
+                                        final MappingContext mappingContext,
+                                        final Ipv6RouteNamesFactory namesFactory) {
+        return parsedHops.size() == 1
+                ? INSTANCE.isSpecialHop(parsedHops.get(0))
+                ? specialHop(parsedHops.get(0))
+                : simpleHop(parsedHops.get(0), interfaceContext, mappingContext)
+                : hopList(routeName, parsedHops, interfaceContext, routeHopContext, mappingContext, namesFactory);
+    }
+
+    static SpecialNextHop specialHop(final FibPath fibPath) {
+        return new SpecialNextHopBuilder()
+                .setSpecialNextHop(INSTANCE.specialHopType(fibPath))
+                .build();
+    }
+
+    static SimpleNextHop simpleHop(final FibPath path, final NamingContext interfaceContext,
+                                   final MappingContext mappingContext) {
+        return resolveInterfaceIfSpecified(new SimpleNextHopBuilder(), path.swIfIndex, interfaceContext, mappingContext)
+                .setNextHop(AddressTranslator.INSTANCE.arrayToIpv6AddressNoZone(path.nextHop))
+                .build();
+    }
+
+    static SimpleNextHopBuilder resolveInterfaceIfSpecified(SimpleNextHopBuilder builder, final int index,
+                                                            final NamingContext interfaceContext,
+                                                            final MappingContext mappingContext) {
+        if (!isDefaultInterfaceIndex(index)) {
+            builder.setOutgoingInterface(interfaceContext.getName(index, mappingContext));
+        }
+
+        return builder;
+    }
+
+    static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.NextHopList hopList(
+            final String routeName,
+            final List<FibPath> parsedHops,
+            final NamingContext interfaceContext,
+            final MultiNamingContext routeHopContext,
+            final MappingContext mappingContext,
+            final Ipv6RouteNamesFactory namesFactory) {
+        return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing.rev140525.routing.state.routing.instance.routing.protocols.routing.protocol._static.routes.ipv6.route.next.hop.options.NextHopListBuilder()
+                .setNextHopList(
+                        buildNextHopList(routeName, parsedHops, interfaceContext, routeHopContext, mappingContext,
+                                namesFactory))
+                .build();
+    }
+
+    static NextHopList buildNextHopList(final String routeName, final List<FibPath> parsedHops,
+                                        final NamingContext interfaceContext,
+                                        final MultiNamingContext routeHopContext,
+                                        final MappingContext mappingContext,
+                                        final Ipv6RouteNamesFactory namesFactory) {
+        return new NextHopListBuilder().setNextHop(parsedHops.stream()
+                .map(fibPath -> resolveInterfaceIfSpecified(new NextHopBuilder(), fibPath.swIfIndex, interfaceContext,
+                        mappingContext)
+                        .setId(findIdWithinRouteContext(routeName, routeHopContext, mappingContext, fibPath,
+                                namesFactory))
+                        .setWeight((short) fibPath.weight)
+                        .setAddress(AddressTranslator.INSTANCE.arrayToIpv6AddressNoZone(fibPath.nextHop))
+                        .build())
+                .collect(Collectors.toList()))
+                .build();
+    }
+
+    static NextHopBuilder resolveInterfaceIfSpecified(NextHopBuilder builder, final int index,
+                                                      final NamingContext interfaceContext,
+                                                      final MappingContext mappingContext) {
+        if (!isDefaultInterfaceIndex(index)) {
+            builder.setOutgoingInterface(interfaceContext.getName(index, mappingContext));
+        }
+
+        return builder;
+    }
+
+    static long findIdWithinRouteContext(final String routeName, final MultiNamingContext routeHopContext,
+                                         final MappingContext mappingContext, final FibPath fibPath,
+                                         final Ipv6RouteNamesFactory namesFactory) {
+        return (long) (routeHopContext
+                .getChildIndex(routeName, namesFactory.uniqueRouteHopName(fibPath, mappingContext), mappingContext));
+    }
+
+    default NextHopOptions resolveHopType(@Nonnull final String routeName,
+                                          final List<FibPath> parsedHops,
+                                          @Nonnull final NamingContext interfaceContext,
+                                          @Nonnull final MultiNamingContext routeHopContext,
+                                          @Nonnull final MappingContext mappingContext,
+                                          @Nonnull final Ipv6RouteNamesFactory namesFactory) {
+
+        return parsedHops == null || parsedHops.isEmpty()
+                ? null
+                : resolveOption(routeName, parsedHops, interfaceContext, routeHopContext, mappingContext, namesFactory);
+    }
+}
diff --git a/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/RouteMapper.java b/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/RouteMapper.java
new file mode 100644
index 000000000..deabdacee
--- /dev/null
+++ b/routing/routing-impl/src/main/java/io/fd/hc2vpp/routing/trait/RouteMapper.java
@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2016 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.routing.trait;
+
+import io.fd.hc2vpp.common.translate.util.AddressTranslator;
+import io.fd.hc2vpp.common.translate.util.ByteDataTranslator;
+import io.fd.vpp.jvpp.core.types.FibPath;
+import javax.annotation.Nonnull;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.SpecialNextHopGrouping;
+
+public interface RouteMapper extends AddressTranslator, ByteDataTranslator {
+
+    int DEFAULT_INTERFACE_INDEX = -1;
+    RouteMapper INSTANCE = new RouteMapper() {
+    };
+
+    static boolean isDefaultInterfaceIndex(final int index) {
+        return DEFAULT_INTERFACE_INDEX == index;
+    }
+
+    static boolean flagEnabled(final byte flag) {
+        return ByteDataTranslator.INSTANCE.byteToBoolean(flag);
+    }
+
+    /**
+     * Verifies whether provided table id is for provided protocol name
+     */
+    default boolean isWithinProtocol(@Nonnull final String protocolName,
+                                     @Nonnull final String routingProtocolNamePrefix,
+                                     @Nonnull final Integer tableId) {
+        return protocolName.equals(fullRoutingProtocolName(routingProtocolNamePrefix, tableId));
+    }
+
+    /**
+     * Return full protocol name in form routing_protocol_name_prefix + table
+     */
+    default String fullRoutingProtocolName(@Nonnull final String routingProtocolNamePrefix,
+                                           @Nonnull final Integer tableId) {
+        return nameWithPrefix(routingProtocolNamePrefix, String.valueOf(tableId));
+    }
+
+    default String bindName(@Nonnull final String first, @Nonnull final String second, @Nonnull final String third) {
+        return String.format("%s_%s_%s", first, second, third);
+    }
+
+    default String nameWithPrefix(@Nonnull final String prefix, @Nonnull final String name) {
+        return String.format("%s_%s", prefix, name);
+    }
+
+    default boolean equalsWithConfigOrLearned(@Nonnull final String learnedPrefix, @Nonnull final String searched,
+                                              @Nonnull final String name) {
+        return searched.equals(name) || searched.equals(nameWithPrefix(learnedPrefix, name));
+    }
+
+    /**
+     * Resolve if provided {@link FibPath} should be considered as special hop.
+     * Special hop is hop that has any of special flags turned on(drop,local,prohibit,unreachable)
+     */
+    default boolean isSpecialHop(@Nonnull final FibPath path) {
+        return byteToBoolean(path.isDrop) || byteToBoolean(path.isLocal) || byteToBoolean(path.isProhibit) ||
+                byteToBoolean(path.isUnreach);
+    }
+
+    default SpecialNextHopGrouping.SpecialNextHop specialHopType(final FibPath singlePath) {
+        if (flagEnabled(singlePath.isDrop)) {
+            return SpecialNextHopGrouping.SpecialNextHop.Blackhole;
+        } else if (flagEnabled(singlePath.isLocal)) {
+            return SpecialNextHopGrouping.SpecialNextHop.Receive;
+        } else if (flagEnabled(singlePath.isProhibit)) {
+            return SpecialNextHopGrouping.SpecialNextHop.Prohibit;
+        } else if (flagEnabled(singlePath.isUnreach)) {
+            return SpecialNextHopGrouping.SpecialNextHop.Unreachable;
+        } else {
+            throw new IllegalArgumentException(
+                    String.format("An attempt to resolve illegal path %s detected ", singlePath.toString()));
+        }
+    }
+}