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.acl.IetfAClWriter;
  39 import io.fd.honeycomb.translate.v3po.interfaces.acl.IetfAclCustomizer;
  40 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv4AddressCustomizer;
  41 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv4Customizer;
  42 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv4NeighbourCustomizer;
  43 import io.fd.honeycomb.translate.v3po.interfaces.ip.Ipv6Customizer;
  44 import io.fd.honeycomb.translate.v3po.util.NamingContext;
  45 import io.fd.honeycomb.translate.write.WriterFactory;
  46 import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
  47 import java.util.Set;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv6;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Neighbor;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppInterfaceAugmentation;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.acl.base.attributes.Ip4Acl;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.acl.base.attributes.Ip6Acl;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.acl.base.attributes.L2Acl;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.ietf.acl.base.attributes.AccessLists;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Acl;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Ethernet;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Gre;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.IetfAcl;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.L2;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.ProxyArp;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Routing;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Tap;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VhostUser;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.Vxlan;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VxlanGpe;
  71 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  72 import org.openvpp.jvpp.core.future.FutureJVppCore;
  73
  74 public final class InterfacesWriterFactory implements WriterFactory {
  75
  76     public static final InstanceIdentifier<Interface> IFC_ID =
  77         InstanceIdentifier.create(Interfaces.class).child(Interface.class);
  78     public static final InstanceIdentifier<VppInterfaceAugmentation> VPP_IFC_AUG_ID =
  79         IFC_ID.augmentation(VppInterfaceAugmentation.class);
  80     public static final InstanceIdentifier<Acl> ACL_ID = VPP_IFC_AUG_ID.child(Acl.class);
  81     public static final InstanceIdentifier<L2> L2_ID = VPP_IFC_AUG_ID.child(L2.class);
  82     public static final InstanceIdentifier<IetfAcl> IETF_ACL_ID = VPP_IFC_AUG_ID.child(IetfAcl.class);
  83
  84     private final FutureJVppCore jvpp;
  85     private final IetfAClWriter aclWriter;
  86     private final NamingContext bdNamingContext;
  87     private final NamingContext ifcNamingContext;
  88     private final NamingContext classifyTableNamingContext;
  89     private final DisabledInterfacesManager ifcDisableContext;
  90
  91     @Inject
  92     public InterfacesWriterFactory(final FutureJVppCore vppJvppIfcDependency,
  93                                    final IetfAClWriter aclWriter,
  94                                    @Named("bridge-domain-context") final NamingContext bridgeDomainContextDependency,
  95                                    @Named("interface-context") final NamingContext interfaceContextDependency,
  96                                    @Named("classify-table-context") final NamingContext classifyTableContextDependency,
  97                                    final DisabledInterfacesManager ifcDisableContext) {
  98         this.jvpp = vppJvppIfcDependency;
  99         this.aclWriter = aclWriter;
 100         this.bdNamingContext = bridgeDomainContextDependency;
 101         this.ifcNamingContext = interfaceContextDependency;
 102         this.ifcDisableContext = ifcDisableContext;
 103         this.classifyTableNamingContext = classifyTableContextDependency;
 104     }
 105
 106     @Override
 107     public void init(final ModifiableWriterRegistryBuilder registry) {
 108         // Interfaces
 109         //  Interface =
 110         registry.add(new GenericListWriter<>(IFC_ID, new InterfaceCustomizer(jvpp, ifcNamingContext)));
 111         //   VppInterfaceAugmentation
 112         addVppInterfaceAgmentationWriters(IFC_ID, registry);
 113         //   Interface1 (ietf-ip augmentation)
 114         addInterface1AugmentationWriters(IFC_ID, registry);
 115         //   SubinterfaceAugmentation
 116         new SubinterfaceAugmentationWriterFactory(jvpp, aclWriter, ifcNamingContext, bdNamingContext,
 117                 classifyTableNamingContext).init(registry);
 118     }
 119
 120     private void addInterface1AugmentationWriters(final InstanceIdentifier<Interface> ifcId,
 121                                                   final ModifiableWriterRegistryBuilder registry) {
 122         final InstanceIdentifier<Interface1> ifc1AugId = ifcId.augmentation(Interface1.class);
 123         // Ipv6(after interface) =
 124         registry.addAfter(new GenericWriter<>(ifc1AugId.child(Ipv6.class), new Ipv6Customizer(jvpp)),
 125                 ifcId);
 126         // Ipv4(after interface)
 127         final InstanceIdentifier<Ipv4> ipv4Id = ifc1AugId.child(Ipv4.class);
 128         registry.addAfter(new GenericWriter<>(ipv4Id, new Ipv4Customizer(jvpp, ifcNamingContext)),
 129                 ifcId);
 130         //  Address(after Ipv4) =
 131         final InstanceIdentifier<Address> ipv4AddressId = ipv4Id.child(Address.class);
 132         registry.addAfter(new GenericListWriter<>(ipv4AddressId, new Ipv4AddressCustomizer(jvpp, ifcNamingContext)),
 133                 ipv4Id);
 134         //  Neighbor(after ipv4Address)
 135         registry.addAfter(new GenericListWriter<>(ipv4Id.child(Neighbor.class), new Ipv4NeighbourCustomizer(jvpp,
 136                         ifcNamingContext)),
 137                 ipv4AddressId);
 138     }
 139
 140     private void addVppInterfaceAgmentationWriters(final InstanceIdentifier<Interface> ifcId,
 141                                                    final ModifiableWriterRegistryBuilder registry) {
 142         // VhostUser(Needs to be executed before Interface customizer) =
 143         final InstanceIdentifier<VhostUser> vhostId = VPP_IFC_AUG_ID.child(VhostUser.class);
 144         registry.addBefore(new GenericWriter<>(vhostId, new VhostUserCustomizer(jvpp, ifcNamingContext)),
 145                 ifcId);
 146         // Vxlan(Needs to be executed before Interface customizer) =
 147         final InstanceIdentifier<Vxlan> vxlanId = VPP_IFC_AUG_ID.child(Vxlan.class);
 148         registry.addBefore(new GenericWriter<>(vxlanId, new VxlanCustomizer(jvpp, ifcNamingContext, ifcDisableContext)),
 149                 ifcId);
 150         // VxlanGpe(Needs to be executed before Interface customizer) =
 151         final InstanceIdentifier<VxlanGpe> vxlanGpeId = VPP_IFC_AUG_ID.child(VxlanGpe.class);
 152         registry.addBefore(new GenericWriter<>(vxlanGpeId,
 153                         new VxlanGpeCustomizer(jvpp, ifcNamingContext, ifcDisableContext)), ifcId);
 154         // Tap(Needs to be executed before Interface customizer) =
 155         final InstanceIdentifier<Tap> tapId = VPP_IFC_AUG_ID.child(Tap.class);
 156         registry.addBefore(new GenericWriter<>(tapId, new TapCustomizer(jvpp, ifcNamingContext)),
 157                 ifcId);
 158
 159         // Gre(Needs to be executed before Interface customizer) =
 160         final InstanceIdentifier<Gre> greId = VPP_IFC_AUG_ID.child(Gre.class);
 161         registry.addBefore(new GenericWriter<>(greId, new GreCustomizer(jvpp, ifcNamingContext)),
 162                 ifcId);
 163
 164
 165         final Set<InstanceIdentifier<?>> specificIfcTypes = Sets.newHashSet(vhostId, vxlanGpeId, vxlanGpeId, tapId);
 166
 167         // Ethernet =
 168         registry.add(new GenericWriter<>(VPP_IFC_AUG_ID.child(Ethernet.class), new EthernetCustomizer(jvpp)));
 169         // Routing(Execute only after specific interface customizers) =
 170         registry.addAfter(
 171                 new GenericWriter<>(VPP_IFC_AUG_ID.child(Routing.class), new RoutingCustomizer(jvpp, ifcNamingContext)),
 172                 specificIfcTypes);
 173         // Routing(Execute only after specific interface customizers) =
 174         registry.addAfter(new GenericWriter<>(L2_ID, new L2Customizer(jvpp, ifcNamingContext, bdNamingContext)),
 175                 specificIfcTypes);
 176         // Proxy Arp (execute after specific interface customizers)
 177         registry.addAfter(
 178                 new GenericWriter<>(VPP_IFC_AUG_ID.child(ProxyArp.class), new ProxyArpCustomizer(jvpp, ifcNamingContext)),
 179                 specificIfcTypes);
 180         // ACL (execute after classify table and session writers)
 181         // also handles L2Acl, Ip4Acl and Ip6Acl:
 182         final InstanceIdentifier<Acl> aclId = InstanceIdentifier.create(Acl.class);
 183         registry
 184             .subtreeAddAfter(
 185                 Sets.newHashSet(aclId.child(L2Acl.class), aclId.child(Ip4Acl.class), aclId.child(Ip6Acl.class)),
 186                 new GenericWriter<>(ACL_ID, new AclCustomizer(jvpp, ifcNamingContext, classifyTableNamingContext)),
 187                 Sets.newHashSet(CLASSIFY_TABLE_ID, CLASSIFY_SESSION_ID));
 188
 189         // IETF-ACL, also handles IetfAcl, AccessLists and Acl:
 190         final InstanceIdentifier<AccessLists> accessListsID = InstanceIdentifier.create(IetfAcl.class)
 191             .child(AccessLists.class);
 192         final InstanceIdentifier<?> aclListId = accessListsID.child(
 193             org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.ietf.acl.base.attributes.access.lists.Acl.class);
 194         registry.subtreeAdd(
 195             Sets.newHashSet(accessListsID, aclListId),
 196             new GenericWriter<>(IETF_ACL_ID, new IetfAclCustomizer(aclWriter, ifcNamingContext)));
 197     }
 198
 199
 200 }