2 * Copyright (c) 2016 Cisco and/or its affiliates.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package io.fd.honeycomb.translate.v3po;
19 import static io.fd.honeycomb.translate.v3po.VppClassifierHoneycombWriterFactory.CLASSIFY_SESSION_ID;
20 import static io.fd.honeycomb.translate.v3po.VppClassifierHoneycombWriterFactory.CLASSIFY_TABLE_ID;
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.EthernetCustomizer;
28 import io.fd.honeycomb.translate.v3po.interfaces.GreCustomizer;
29 import io.fd.honeycomb.translate.v3po.interfaces.InterfaceCustomizer;
30 import io.fd.honeycomb.translate.v3po.interfaces.L2Customizer;
31 import io.fd.honeycomb.translate.v3po.interfaces.ProxyArpCustomizer;
32 import io.fd.honeycomb.translate.v3po.interfaces.RoutingCustomizer;
33 import io.fd.honeycomb.translate.v3po.interfaces.TapCustomizer;
34 import io.fd.honeycomb.translate.v3po.interfaces.VhostUserCustomizer;
35 import io.fd.honeycomb.translate.v3po.interfaces.VxlanCustomizer;
36 import io.fd.honeycomb.translate.v3po.interfaces.VxlanGpeCustomizer;
37 import io.fd.honeycomb.translate.v3po.interfaces.acl.ingress.AclCustomizer;
38 import io.fd.honeycomb.translate.v3po.interfaces.acl.ingress.IetfAClWriter;
39 import io.fd.honeycomb.translate.v3po.interfaces.acl.ingress.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.interfaces.pbb.PbbRewriteCustomizer;
45 import io.fd.honeycomb.translate.v3po.vppclassifier.VppClassifierContextManager;
46 import io.fd.honeycomb.translate.vpp.util.NamingContext;
47 import io.fd.honeycomb.translate.write.WriterFactory;
48 import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
49 import io.fd.vpp.jvpp.core.future.FutureJVppCore;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv6;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Neighbor;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.acl.base.attributes.Ip4Acl;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.acl.base.attributes.Ip6Acl;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.acl.base.attributes.L2Acl;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.AccessLists;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Acl;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Ethernet;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Gre;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.IetfAcl;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.L2;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ProxyArp;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Routing;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Tap;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VhostUser;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.Vxlan;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanGpe;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.acl.Ingress;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.pbb.rev161214.PbbRewriteInterfaceAugmentation;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.pbb.rev161214.interfaces._interface.PbbRewrite;
77 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
79 public final class InterfacesWriterFactory implements WriterFactory {
81 public static final InstanceIdentifier<Interface> IFC_ID =
82 InstanceIdentifier.create(Interfaces.class).child(Interface.class);
83 public static final InstanceIdentifier<VppInterfaceAugmentation> VPP_IFC_AUG_ID =
84 IFC_ID.augmentation(VppInterfaceAugmentation.class);
85 public static final InstanceIdentifier<Acl> ACL_ID = VPP_IFC_AUG_ID.child(Acl.class);
86 public static final InstanceIdentifier<Ingress> INGRESS_ACL_ID = ACL_ID.child(Ingress.class);
87 public static final InstanceIdentifier<L2> L2_ID = VPP_IFC_AUG_ID.child(L2.class);
88 public static final InstanceIdentifier<IetfAcl> IETF_ACL_ID = VPP_IFC_AUG_ID.child(IetfAcl.class);
89 public static final InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Ingress>
90 INGRESS_IETF_ACL_ID = IETF_ACL_ID.child(
91 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Ingress.class);
92 public static final InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Egress>
93 EGRESS_IETF_ACL_ID = IETF_ACL_ID.child(
94 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Egress.class);
96 private final FutureJVppCore jvpp;
97 private final IetfAClWriter aclWriter;
98 private final NamingContext bdNamingContext;
99 private final NamingContext ifcNamingContext;
100 private final VppClassifierContextManager classifyTableContext;
101 private final DisabledInterfacesManager ifcDisableContext;
104 public InterfacesWriterFactory(final FutureJVppCore vppJvppIfcDependency,
105 final IetfAClWriter aclWriter,
106 @Named("bridge-domain-context") final NamingContext bridgeDomainContextDependency,
107 @Named("interface-context") final NamingContext interfaceContextDependency,
108 @Named("classify-table-context") final VppClassifierContextManager classifyTableContext,
109 final DisabledInterfacesManager ifcDisableContext) {
110 this.jvpp = vppJvppIfcDependency;
111 this.aclWriter = aclWriter;
112 this.bdNamingContext = bridgeDomainContextDependency;
113 this.ifcNamingContext = interfaceContextDependency;
114 this.ifcDisableContext = ifcDisableContext;
115 this.classifyTableContext = classifyTableContext;
119 public void init(final ModifiableWriterRegistryBuilder registry) {
122 registry.add(new GenericListWriter<>(IFC_ID, new InterfaceCustomizer(jvpp, ifcNamingContext)));
123 // VppInterfaceAugmentation
124 addVppInterfaceAgmentationWriters(IFC_ID, registry);
125 // Interface1 (ietf-ip augmentation)
126 addInterface1AugmentationWriters(IFC_ID, registry);
127 // SubinterfaceAugmentation
128 new SubinterfaceAugmentationWriterFactory(jvpp, aclWriter, ifcNamingContext, bdNamingContext,
129 classifyTableContext).init(registry);
131 addPbbAugmentationWriters(IFC_ID, registry);
134 private void addInterface1AugmentationWriters(final InstanceIdentifier<Interface> ifcId,
135 final ModifiableWriterRegistryBuilder registry) {
136 final InstanceIdentifier<Interface1> ifc1AugId = ifcId.augmentation(Interface1.class);
137 // Ipv6(after interface) =
138 registry.addAfter(new GenericWriter<>(ifc1AugId.child(Ipv6.class), new Ipv6Customizer(jvpp)),
140 // Ipv4(after interface)
141 final InstanceIdentifier<Ipv4> ipv4Id = ifc1AugId.child(Ipv4.class);
142 registry.addAfter(new GenericWriter<>(ipv4Id, new Ipv4Customizer(jvpp)),
144 // Address(after Ipv4) =
145 final InstanceIdentifier<Address> ipv4AddressId = ipv4Id.child(Address.class);
146 registry.addAfter(new GenericListWriter<>(ipv4AddressId, new Ipv4AddressCustomizer(jvpp, ifcNamingContext)),
148 // Neighbor(after ipv4Address)
149 registry.addAfter(new GenericListWriter<>(ipv4Id.child(Neighbor.class), new Ipv4NeighbourCustomizer(jvpp,
154 private void addVppInterfaceAgmentationWriters(final InstanceIdentifier<Interface> ifcId,
155 final ModifiableWriterRegistryBuilder registry) {
156 // VhostUser(Needs to be executed before Interface customizer) =
157 final InstanceIdentifier<VhostUser> vhostId = VPP_IFC_AUG_ID.child(VhostUser.class);
158 registry.addBefore(new GenericWriter<>(vhostId, new VhostUserCustomizer(jvpp, ifcNamingContext)),
160 // Vxlan(Needs to be executed before Interface customizer) =
161 final InstanceIdentifier<Vxlan> vxlanId = VPP_IFC_AUG_ID.child(Vxlan.class);
162 registry.addBefore(new GenericWriter<>(vxlanId, new VxlanCustomizer(jvpp, ifcNamingContext, ifcDisableContext)),
164 // VxlanGpe(Needs to be executed before Interface customizer) =
165 final InstanceIdentifier<VxlanGpe> vxlanGpeId = VPP_IFC_AUG_ID.child(VxlanGpe.class);
166 registry.addBefore(new GenericWriter<>(vxlanGpeId,
167 new VxlanGpeCustomizer(jvpp, ifcNamingContext, ifcDisableContext)), ifcId);
168 // Tap(Needs to be executed before Interface customizer) =
169 final InstanceIdentifier<Tap> tapId = VPP_IFC_AUG_ID.child(Tap.class);
170 registry.addBefore(new GenericWriter<>(tapId, new TapCustomizer(jvpp, ifcNamingContext)),
173 // Gre(Needs to be executed before Interface customizer) =
174 final InstanceIdentifier<Gre> greId = VPP_IFC_AUG_ID.child(Gre.class);
175 registry.addBefore(new GenericWriter<>(greId, new GreCustomizer(jvpp, ifcNamingContext)),
179 final Set<InstanceIdentifier<?>> specificIfcTypes = Sets.newHashSet(vhostId, vxlanGpeId, vxlanGpeId, tapId);
182 registry.add(new GenericWriter<>(VPP_IFC_AUG_ID.child(Ethernet.class), new EthernetCustomizer(jvpp)));
183 // Routing(Execute only after specific interface customizers) =
185 new GenericWriter<>(VPP_IFC_AUG_ID.child(Routing.class), new RoutingCustomizer(jvpp, ifcNamingContext)),
187 // L2(Execute only after subinterface (and all other ifc types) =
188 registry.addAfter(new GenericWriter<>(L2_ID, new L2Customizer(jvpp, ifcNamingContext, bdNamingContext)),
189 SubinterfaceAugmentationWriterFactory.SUB_IFC_ID);
190 // Proxy Arp (execute after specific interface customizers)
192 new GenericWriter<>(VPP_IFC_AUG_ID.child(ProxyArp.class), new ProxyArpCustomizer(jvpp)),
194 // Ingress (execute after classify table and session writers)
195 // also handles L2Acl, Ip4Acl and Ip6Acl:
196 final InstanceIdentifier<Ingress> ingressId = InstanceIdentifier.create(Ingress.class);
199 Sets.newHashSet(ingressId.child(L2Acl.class), ingressId.child(Ip4Acl.class),
200 ingressId.child(Ip6Acl.class)),
201 new GenericWriter<>(INGRESS_ACL_ID,
202 new AclCustomizer(jvpp, ifcNamingContext, classifyTableContext)),
203 Sets.newHashSet(CLASSIFY_TABLE_ID, CLASSIFY_SESSION_ID));
205 // Ingress IETF-ACL, also handles AccessLists and Acl:
206 final InstanceIdentifier<AccessLists> accessListsIdIngress = InstanceIdentifier.create(
207 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Ingress.class)
208 .child(AccessLists.class);
209 final InstanceIdentifier<?> aclIdIngress = accessListsIdIngress.child(
210 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.access.lists.Acl.class);
212 Sets.newHashSet(accessListsIdIngress, aclIdIngress),
213 new GenericWriter<>(INGRESS_IETF_ACL_ID, new IetfAclCustomizer(aclWriter, ifcNamingContext)));
215 // Ingress IETF-ACL, also handles AccessLists and Acl:
216 final InstanceIdentifier<AccessLists> accessListsIdEgress = InstanceIdentifier.create(
217 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Egress.class)
218 .child(AccessLists.class);
219 final InstanceIdentifier<?> aclIdEgress = accessListsIdEgress.child(
220 org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.access.lists.Acl.class);
222 Sets.newHashSet(accessListsIdEgress, aclIdEgress),
223 new GenericWriter<>(EGRESS_IETF_ACL_ID,
224 new io.fd.honeycomb.translate.v3po.interfaces.acl.egress.IetfAclCustomizer(aclWriter,
228 private void addPbbAugmentationWriters(final InstanceIdentifier<Interface> ifcId,
229 final ModifiableWriterRegistryBuilder registry) {
230 final InstanceIdentifier<PbbRewrite> pbbRewriteId =
231 ifcId.augmentation(PbbRewriteInterfaceAugmentation.class).child(PbbRewrite.class);
233 registry.add(new GenericWriter<>(pbbRewriteId, new PbbRewriteCustomizer(jvpp, ifcNamingContext)));