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.initializers;
19 import com.google.common.base.Preconditions;
20 import com.google.common.collect.Lists;
21 import com.google.inject.Inject;
22 import com.google.inject.name.Named;
23 import io.fd.honeycomb.data.init.AbstractDataTreeConverter;
24 import java.util.List;
25 import java.util.stream.Collectors;
26 import javax.annotation.Nonnull;
27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesBuilder;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.AdminStatus;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1Builder;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface2;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4Builder;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Neighbor;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.NeighborBuilder;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.Subnet;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.subnet.PrefixLengthBuilder;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentationBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceStateAugmentation;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanGpeVni;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanVni;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.AclBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.EthernetBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.GreBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.L2Builder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.TapBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VhostUserBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.VxlanGpeBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.acl.EgressBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.acl.IngressBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Acl;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Ethernet;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Gre;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.L2;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Tap;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.VhostUser;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.Vxlan;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.VxlanGpe;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.acl.Egress;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces.state._interface.acl.Ingress;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.base.attributes.Interconnection;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.base.attributes.interconnection.BridgeBased;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.base.attributes.interconnection.BridgeBasedBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.base.attributes.interconnection.XconnectBased;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.base.attributes.interconnection.XconnectBasedBuilder;
75 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
76 import org.slf4j.Logger;
77 import org.slf4j.LoggerFactory;
80 * Initializes ietf-interfaces config data based on operational state
82 public class InterfacesInitializer extends AbstractDataTreeConverter<InterfacesState, Interfaces> {
83 private static final Logger LOG = LoggerFactory.getLogger(InterfacesInitializer.class);
86 public InterfacesInitializer(@Named("honeycomb-initializer") @Nonnull final DataBroker bindingDataBroker) {
87 super(bindingDataBroker, InstanceIdentifier.create(InterfacesState.class),
88 InstanceIdentifier.create(Interfaces.class));
92 protected Interfaces convert(final InterfacesState operationalData) {
93 LOG.debug("InterfacesInitializer.convert()");
94 InterfacesBuilder interfacesBuilder = new InterfacesBuilder();
96 .setInterface(Lists.transform(operationalData.getInterface(), InterfacesInitializer::initialize));
97 return interfacesBuilder.build();
100 // TODO https://jira.fd.io/browse/HONEYCOMB-73 this kind of initialization/transformation is bad
101 // There is no relation to readers, it cannot be extended (readers can) and its hard to keep in sync with readers
103 private static Interface initialize(
104 final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input) {
105 InterfaceBuilder builder = new InterfaceBuilder();
106 builder.setKey(new InterfaceKey(input.getKey().getName()));
107 builder.setName(input.getName());
108 builder.setType(input.getType());
109 builder.setEnabled(AdminStatus.Up.equals(input.getAdminStatus()));
110 // Not present in interfaces-state
111 // builder.setLinkUpDownTrapEnable();
113 initializeVppInterfaceStateAugmentation(input, builder);
114 SubInterfaceInitializationUtils.initializeSubinterfaceStateAugmentation(input, builder);
115 initializeIetfIpAugmentation(input, builder);
117 return builder.build();
120 private static void initializeVppInterfaceStateAugmentation(
121 final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input,
122 final InterfaceBuilder builder) {
123 final VppInterfaceStateAugmentation vppIfcAugmentation =
124 input.getAugmentation(VppInterfaceStateAugmentation.class);
125 if (vppIfcAugmentation != null) {
126 final VppInterfaceAugmentationBuilder augmentBuilder = new VppInterfaceAugmentationBuilder();
127 builder.setDescription(vppIfcAugmentation.getDescription());
129 final Vxlan vxlan = vppIfcAugmentation.getVxlan();
131 setVxlan(augmentBuilder, vxlan);
134 final VxlanGpe vxlanGpe = vppIfcAugmentation.getVxlanGpe();
135 if (vxlanGpe != null) {
136 setVxlanGpe(augmentBuilder, vxlanGpe);
139 final Gre gre = vppIfcAugmentation.getGre();
141 setGre(augmentBuilder, gre);
144 final Tap tap = vppIfcAugmentation.getTap();
146 setTap(input, augmentBuilder, tap);
149 final VhostUser vhostUser = vppIfcAugmentation.getVhostUser();
150 if (vhostUser != null) {
151 setVhostUser(augmentBuilder, vhostUser);
154 final L2 l2 = vppIfcAugmentation.getL2();
156 setL2(augmentBuilder, l2);
159 final Ethernet ethernet = vppIfcAugmentation.getEthernet();
160 if (ethernet != null) {
161 setEthernet(augmentBuilder, ethernet);
164 final Acl acl = vppIfcAugmentation.getAcl();
166 setAcl(augmentBuilder, acl);
169 // Routing is not present in interface-state. Doing nothing for it
171 builder.addAugmentation(VppInterfaceAugmentation.class, augmentBuilder.build());
175 private static void initializeIetfIpAugmentation(
176 final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input,
177 final InterfaceBuilder builder) {
178 final Interface2 ietfIpAugmentation = input.getAugmentation(Interface2.class);
179 if (ietfIpAugmentation != null) {
180 final Interface1Builder augmentBuilder = new Interface1Builder();
182 final Ipv4 ipv4 = ietfIpAugmentation.getIpv4();
184 final List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address>
186 ipv4.getAddress().stream()
188 address -> new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressBuilder()
189 .setIp(address.getIp())
190 .setSubnet(getSubnet(address))
192 .collect(Collectors.toList());
194 final List<Neighbor> neighbors = ipv4.getNeighbor().stream()
195 .map(neighbor -> new NeighborBuilder().setIp(neighbor.getIp())
196 .setLinkLayerAddress(neighbor.getLinkLayerAddress()).build())
197 .collect(Collectors.toList());
199 augmentBuilder.setIpv4(new Ipv4Builder().setAddress(collect).setNeighbor(neighbors).build());
202 builder.addAugmentation(Interface1.class, augmentBuilder.build());
206 private static Subnet getSubnet(final Address address) {
207 final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.Subnet
208 subnet = address.getSubnet();
210 // Only prefix length supported
211 Preconditions.checkArgument(
212 subnet instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength);
214 return new PrefixLengthBuilder().setPrefixLength(
215 ((org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength) subnet)
216 .getPrefixLength()).build();
219 private static void setEthernet(final VppInterfaceAugmentationBuilder augmentBuilder, final Ethernet ethernet) {
220 final EthernetBuilder ethernetBuilder = new EthernetBuilder();
221 ethernetBuilder.setMtu(ethernet.getMtu());
222 augmentBuilder.setEthernet(ethernetBuilder.build());
225 private static void setAcl(final VppInterfaceAugmentationBuilder augmentBuilder, final Acl acl) {
226 final AclBuilder aclBuilder = new AclBuilder();
228 final Ingress ingress = acl.getIngress();
229 if (ingress != null) {
230 final IngressBuilder builder = new IngressBuilder();
231 builder.setL2Acl(ingress.getL2Acl());
232 builder.setIp4Acl(ingress.getIp4Acl());
233 builder.setIp6Acl(ingress.getIp6Acl());
234 aclBuilder.setIngress(builder.build());
237 final Egress egress = acl.getEgress();
238 if (egress != null) {
239 final EgressBuilder builder = new EgressBuilder();
240 builder.setL2Acl(egress.getL2Acl());
241 builder.setIp4Acl(egress.getIp4Acl());
242 builder.setIp6Acl(egress.getIp6Acl());
243 aclBuilder.setEgress(builder.build());
245 augmentBuilder.setAcl(aclBuilder.build());
248 private static void setL2(final VppInterfaceAugmentationBuilder augmentBuilder, final L2 l2) {
249 final L2Builder l2Builder = new L2Builder();
251 final Interconnection interconnection = l2.getInterconnection();
252 if (interconnection != null) {
253 if (interconnection instanceof XconnectBased) {
254 final XconnectBasedBuilder xconnectBasedBuilder = new XconnectBasedBuilder();
255 xconnectBasedBuilder.setXconnectOutgoingInterface(
256 ((XconnectBased) interconnection).getXconnectOutgoingInterface());
257 l2Builder.setInterconnection(xconnectBasedBuilder.build());
258 } else if (interconnection instanceof BridgeBased) {
259 final BridgeBasedBuilder bridgeBasedBuilder = new BridgeBasedBuilder();
260 bridgeBasedBuilder.setBridgeDomain(((BridgeBased) interconnection).getBridgeDomain());
262 .setBridgedVirtualInterface(((BridgeBased) interconnection).isBridgedVirtualInterface());
263 bridgeBasedBuilder.setSplitHorizonGroup(((BridgeBased) interconnection).getSplitHorizonGroup());
264 l2Builder.setInterconnection(bridgeBasedBuilder.build());
268 augmentBuilder.setL2(l2Builder.build());
271 private static void setVhostUser(final VppInterfaceAugmentationBuilder augmentBuilder, final VhostUser vhostUser) {
272 final VhostUserBuilder vhostUserBuilder = new VhostUserBuilder();
273 vhostUserBuilder.setRole(vhostUser.getRole());
274 vhostUserBuilder.setSocket(vhostUser.getSocket());
275 augmentBuilder.setVhostUser(vhostUserBuilder.build());
278 private static void setTap(
279 final @Nonnull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input,
280 final VppInterfaceAugmentationBuilder augmentBuilder,
282 final TapBuilder tapBuilder = new TapBuilder();
283 tapBuilder.setMac(input.getPhysAddress());
284 tapBuilder.setTapName(tap.getTapName());
285 // tapBuilder.setDeviceInstance();
286 augmentBuilder.setTap(tapBuilder.build());
289 private static void setVxlan(final VppInterfaceAugmentationBuilder augmentBuilder, final Vxlan vxlan) {
290 final VxlanBuilder vxlanBuilder = new VxlanBuilder();
291 vxlanBuilder.setDst(vxlan.getDst());
292 vxlanBuilder.setSrc(vxlan.getSrc());
293 vxlanBuilder.setEncapVrfId(vxlan.getEncapVrfId());
294 vxlanBuilder.setVni(new VxlanVni(vxlan.getVni()));
295 augmentBuilder.setVxlan(vxlanBuilder.build());
298 private static void setVxlanGpe(final VppInterfaceAugmentationBuilder augmentBuilder, final VxlanGpe vxlanGpe) {
299 final VxlanGpeBuilder vxlanGpeBuilder = new VxlanGpeBuilder();
300 vxlanGpeBuilder.setLocal(vxlanGpe.getLocal());
301 vxlanGpeBuilder.setRemote(vxlanGpe.getRemote());
302 vxlanGpeBuilder.setVni(new VxlanGpeVni(vxlanGpe.getVni()));
303 vxlanGpeBuilder.setNextProtocol(vxlanGpe.getNextProtocol());
304 vxlanGpeBuilder.setEncapVrfId(vxlanGpe.getEncapVrfId());
305 vxlanGpeBuilder.setDecapVrfId(vxlanGpe.getDecapVrfId());
306 augmentBuilder.setVxlanGpe(vxlanGpeBuilder.build());
309 private static void setGre(final VppInterfaceAugmentationBuilder augmentBuilder, final Gre gre) {
310 final GreBuilder greBuilder = new GreBuilder();
311 greBuilder.setDst(gre.getDst());
312 greBuilder.setSrc(gre.getSrc());
313 greBuilder.setOuterFibId(gre.getOuterFibId());
314 augmentBuilder.setGre(greBuilder.build());