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