v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/InterfacesWriterFactory.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.translate.v3po;
  18
  19 import static io.fd.honeycomb.translate.v3po.VppClassifierHoneycombWriterFactory.CLASSIFY_SESSION_ID;
  20 import static io.fd.honeycomb.translate.v3po.VppClassifierHoneycombWriterFactory.CLASSIFY_TABLE_ID;
  21
  22 import com.google.common.collect.Sets;
  23 import com.google.inject.Inject;
  24 import com.google.inject.name.Named;
  25 import io.fd.honeycomb.translate.impl.write.GenericListWriter;
  26 import io.fd.honeycomb.translate.impl.write.GenericWriter;
  27 import io.fd.honeycomb.translate.v3po.interfaces.AclCustomizer;
  28 import io.fd.honeycomb.translate.v3po.interfaces.EthernetCustomizer;
  29 import io.fd.honeycomb.translate.v3po.interfaces.GreCustomizer;
  30 import io.fd.honeycomb.translate.v3po.interfaces.InterfaceCustomizer;
  31 import io.fd.honeycomb.translate.v3po.interfaces.L2Customizer;
  32 import io.fd.honeycomb.translate.v3po.interfaces.ProxyArpCustomizer;
  33 import io.fd.honeycomb.translate.v3po.interfaces.RoutingCustomizer;
  34 import io.fd.honeycomb.translate.v3po.interfaces.TapCustomizer;
  35 import io.fd.honeycomb.translate.v3po.interfaces.VhostUserCustomizer;
  36 import io.fd.honeycomb.translate.v3po.interfaces.VxlanCustomizer;
  37 import io.fd.honeycomb.translate.v3po.interfaces.VxlanGpeCustomizer;
  38 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv4AddressCustomizer;
  39 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv4Customizer;
  40 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv4NeighbourCustomizer;
  41 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv6Customizer;
  42 import io.fd.honeycomb.translate.v3po.util.NamingContext;
  43 import io.fd.honeycomb.translate.write.WriterFactory;
  44 import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
  45 import java.util.Set;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv6;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Neighbor;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppInterfaceAugmentation;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.acl.base.attributes.Ip4Acl;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.acl.base.attributes.Ip6Acl;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.acl.base.attributes.L2Acl;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Acl;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Ethernet;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Gre;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.L2;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.ProxyArp;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Routing;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Tap;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VhostUser;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Vxlan;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VxlanGpe;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68 import org.openvpp.jvpp.future.FutureJVpp;
  69
  70 public final class InterfacesWriterFactory implements WriterFactory, AutoCloseable {
  71
  72     public static final InstanceIdentifier<Interface> IFC_ID =
  73         InstanceIdentifier.create(Interfaces.class).child(Interface.class);
  74     public static final InstanceIdentifier<VppInterfaceAugmentation> VPP_IFC_AUG_ID =
  75         IFC_ID.augmentation(VppInterfaceAugmentation.class);
  76     public static final InstanceIdentifier<Acl> ACL_ID = VPP_IFC_AUG_ID.child(Acl.class);
  77     public static final InstanceIdentifier<L2> L2_ID = VPP_IFC_AUG_ID.child(L2.class);
  78
  79     private final FutureJVpp jvpp;
  80     private final NamingContext bdContext;
  81     private final NamingContext ifcContext;
  82     private final NamingContext classifyTableContext;
  83
  84     @Inject
  85     public InterfacesWriterFactory(final FutureJVpp vppJvppIfcDependency,
  86                                    @Named("bridge-domain-context") final NamingContext bridgeDomainContextDependency,
  87                                    @Named("interface-context") final NamingContext interfaceContextDependency,
  88                                    @Named("classify-table-context") final NamingContext classifyTableContextDependency) {
  89         this.jvpp = vppJvppIfcDependency;
  90         this.bdContext = bridgeDomainContextDependency;
  91         this.ifcContext = interfaceContextDependency;
  92         this.classifyTableContext = classifyTableContextDependency;
  93     }
  94
  95     @Override
  96     public void init(final ModifiableWriterRegistryBuilder registry) {
  97         // Interfaces
  98         //  Interface =
  99         registry.add(new GenericListWriter<>(IFC_ID, new InterfaceCustomizer(jvpp, ifcContext)));
 100         //   VppInterfaceAugmentation
 101         addVppInterfaceAgmentationWriters(IFC_ID, registry);
 102         //   Interface1 (ietf-ip augmentation)
 103         addInterface1AugmentationWriters(IFC_ID, registry);
 104         //   SubinterfaceAugmentation TODO make dedicated module for subIfc writer factory
 105         new SubinterfaceAugmentationWriterFactory(jvpp, ifcContext, bdContext, classifyTableContext).init(registry);
 106     }
 107
 108     private void addInterface1AugmentationWriters(final InstanceIdentifier<Interface> ifcId,
 109                                                   final ModifiableWriterRegistryBuilder registry) {
 110         final InstanceIdentifier<Interface1> ifc1AugId = ifcId.augmentation(Interface1.class);
 111         // Ipv6(after interface) TODO unfinished customizer =
 112         registry.addAfter(new GenericWriter<>(ifc1AugId.child(Ipv6.class), new Ipv6Customizer(jvpp)),
 113                 ifcId);
 114         // Ipv4(after interface)
 115         final InstanceIdentifier<Ipv4> ipv4Id = ifc1AugId.child(Ipv4.class);
 116         registry.addAfter(new GenericWriter<>(ipv4Id, new Ipv4Customizer(jvpp, ifcContext)),
 117                 ifcId);
 118         //  Address(after Ipv4) =
 119         final InstanceIdentifier<Address> ipv4AddressId = ipv4Id.child(Address.class);
 120         registry.addAfter(new GenericListWriter<>(ipv4AddressId, new Ipv4AddressCustomizer(jvpp, ifcContext)),
 121                 ipv4Id);
 122         //  Neighbor(after ipv4Address)
 123         registry.addAfter(new GenericListWriter<>(ipv4Id.child(Neighbor.class), new Ipv4NeighbourCustomizer(jvpp, ifcContext)),
 124                 ipv4AddressId);
 125     }
 126
 127     private void addVppInterfaceAgmentationWriters(final InstanceIdentifier<Interface> ifcId,
 128                                                    final ModifiableWriterRegistryBuilder registry) {
 129         // VhostUser(Needs to be executed before Interface customizer) =
 130         final InstanceIdentifier<VhostUser> vhostId = VPP_IFC_AUG_ID.child(VhostUser.class);
 131         registry.addBefore(new GenericWriter<>(vhostId, new VhostUserCustomizer(jvpp, ifcContext)),
 132                 ifcId);
 133         // Vxlan(Needs to be executed before Interface customizer) =
 134         final InstanceIdentifier<Vxlan> vxlanId = VPP_IFC_AUG_ID.child(Vxlan.class);
 135         registry.addBefore(new GenericWriter<>(vxlanId, new VxlanCustomizer(jvpp, ifcContext)),
 136                 ifcId);
 137         // VxlanGpe(Needs to be executed before Interface customizer) =
 138         final InstanceIdentifier<VxlanGpe> vxlanGpeId = VPP_IFC_AUG_ID.child(VxlanGpe.class);
 139         registry.addBefore(new GenericWriter<>(vxlanGpeId, new VxlanGpeCustomizer(jvpp, ifcContext)),
 140                 ifcId);
 141         // Tap(Needs to be executed before Interface customizer) =
 142         final InstanceIdentifier<Tap> tapId = VPP_IFC_AUG_ID.child(Tap.class);
 143         registry.addBefore(new GenericWriter<>(tapId, new TapCustomizer(jvpp, ifcContext)),
 144                 ifcId);
 145
 146         // Gre(Needs to be executed before Interface customizer) =
 147         final InstanceIdentifier<Gre> greId = VPP_IFC_AUG_ID.child(Gre.class);
 148         registry.addBefore(new GenericWriter<>(greId, new GreCustomizer(jvpp, ifcContext)),
 149                 ifcId);
 150
 151
 152         final Set<InstanceIdentifier<?>> specificIfcTypes = Sets.newHashSet(vhostId, vxlanGpeId, vxlanGpeId, tapId);
 153
 154         // Ethernet(No dependency, customizer not finished TODO) =
 155         registry.add(new GenericWriter<>(VPP_IFC_AUG_ID.child(Ethernet.class), new EthernetCustomizer(jvpp)));
 156         // Routing(Execute only after specific interface customizers) =
 157         registry.addAfter(
 158                 new GenericWriter<>(VPP_IFC_AUG_ID.child(Routing.class), new RoutingCustomizer(jvpp, ifcContext)),
 159                 specificIfcTypes);
 160         // Routing(Execute only after specific interface customizers) =
 161         registry.addAfter(new GenericWriter<>(L2_ID, new L2Customizer(jvpp, ifcContext, bdContext)),
 162                 specificIfcTypes);
 163         // Proxy Arp (execute after specific interface customizers)
 164         registry.addAfter(
 165                 new GenericWriter<>(VPP_IFC_AUG_ID.child(ProxyArp.class), new ProxyArpCustomizer(jvpp, ifcContext)),
 166                 specificIfcTypes);
 167         // ACL (execute after classify table and session writers)
 168         // also handles L2Acl, Ip4Acl and Ip6Acl:
 169         final InstanceIdentifier<Acl> aclId = InstanceIdentifier.create(Acl.class);
 170         registry
 171                 .subtreeAddAfter(
 172                         Sets.newHashSet(aclId.child(L2Acl.class), aclId.child(Ip4Acl.class), aclId.child(Ip6Acl.class)),
 173                         new GenericWriter<>(ACL_ID, new AclCustomizer(jvpp, ifcContext, classifyTableContext)),
 174                         Sets.newHashSet(CLASSIFY_TABLE_ID, CLASSIFY_SESSION_ID));
 175     }
 176
 177
 178 }