v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/initializers/InterfacesInitializer.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.initializers;
  18
  19 import com.google.common.base.Preconditions;
  20 import com.google.common.collect.Lists;
  21 import io.fd.honeycomb.data.init.AbstractDataTreeConverter;
  22 import java.util.List;
  23 import java.util.stream.Collectors;
  24 import javax.annotation.Nonnull;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.AdminStatus;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1Builder;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface2;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4Builder;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Neighbor;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.NeighborBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.Subnet;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.address.subnet.PrefixLengthBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppInterfaceAugmentation;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppInterfaceAugmentationBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppInterfaceStateAugmentation;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VxlanGpeVni;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VxlanVni;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.AclBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.EthernetBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.L2Builder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.TapBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VhostUserBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VxlanBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.VxlanGpeBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces._interface.GreBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.Acl;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.Ethernet;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.L2;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.Tap;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.VhostUser;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.Vxlan;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.VxlanGpe;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.interfaces.state._interface.Gre;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.Interconnection;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.interconnection.BridgeBased;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.interconnection.BridgeBasedBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.interconnection.XconnectBased;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.base.attributes.interconnection.XconnectBasedBuilder;
  69 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  70 import org.slf4j.Logger;
  71 import org.slf4j.LoggerFactory;
  72
  73 /**
  74  * Initializes ietf-interfaces config data based on operational state
  75  */
  76 public class InterfacesInitializer extends AbstractDataTreeConverter<InterfacesState, Interfaces> {
  77     private static final Logger LOG = LoggerFactory.getLogger(InterfacesInitializer.class);
  78
  79     public InterfacesInitializer(@Nonnull final DataBroker bindingDataBroker) {
  80         super(bindingDataBroker, InstanceIdentifier.create(InterfacesState.class),
  81             InstanceIdentifier.create(Interfaces.class));
  82     }
  83
  84     @Override
  85     protected Interfaces convert(final InterfacesState operationalData) {
  86         LOG.debug("InterfacesInitializer.convert()");
  87         InterfacesBuilder interfacesBuilder = new InterfacesBuilder();
  88         interfacesBuilder
  89             .setInterface(Lists.transform(operationalData.getInterface(), InterfacesInitializer::initialize));
  90         return interfacesBuilder.build();
  91     }
  92
  93     // FIXME https://jira.fd.io/browse/HONEYCOMB-73 this kind of initialization/transformation is bad
  94     // There is no relation to readers, it cannot be extended (readers can) and its hard to keep in sync with readers
  95
  96     // TODO add IP v4/ v6 initializer
  97
  98     private static Interface initialize(
  99         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input) {
 100         InterfaceBuilder builder = new InterfaceBuilder();
 101         builder.setKey(new InterfaceKey(input.getKey().getName()));
 102         builder.setName(input.getName());
 103         builder.setType(input.getType());
 104         builder.setEnabled(AdminStatus.Up.equals(input.getAdminStatus()));
 105         // builder.setLinkUpDownTrapEnable(); TODO not present in interfaces-state
 106
 107         initializeVppInterfaceStateAugmentation(input, builder);
 108         SubInterfaceInitializationUtils.initializeSubinterfaceStateAugmentation(input, builder);
 109         initializeIetfIpAugmentation(input, builder);
 110
 111         return builder.build();
 112     }
 113
 114     private static void initializeVppInterfaceStateAugmentation(
 115         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input,
 116         final InterfaceBuilder builder) {
 117         final VppInterfaceStateAugmentation vppIfcAugmentation =
 118             input.getAugmentation(VppInterfaceStateAugmentation.class);
 119         if (vppIfcAugmentation != null) {
 120             final VppInterfaceAugmentationBuilder augmentBuilder = new VppInterfaceAugmentationBuilder();
 121             builder.setDescription(vppIfcAugmentation.getDescription());
 122
 123             final Vxlan vxlan = vppIfcAugmentation.getVxlan();
 124             if (vxlan != null) {
 125                 setVxlan(augmentBuilder, vxlan);
 126             }
 127
 128             final VxlanGpe vxlanGpe = vppIfcAugmentation.getVxlanGpe();
 129             if (vxlanGpe != null) {
 130                 setVxlanGpe(augmentBuilder, vxlanGpe);
 131             }
 132
 133             final Gre gre = vppIfcAugmentation.getGre();
 134             if (gre != null) {
 135                 setGre(augmentBuilder, gre);
 136             }
 137
 138             final Tap tap = vppIfcAugmentation.getTap();
 139             if (tap != null) {
 140                 setTap(input, augmentBuilder, tap);
 141             }
 142
 143             final VhostUser vhostUser = vppIfcAugmentation.getVhostUser();
 144             if (vhostUser != null) {
 145                 setVhostUser(augmentBuilder, vhostUser);
 146             }
 147
 148             final L2 l2 = vppIfcAugmentation.getL2();
 149             if (l2 != null) {
 150                 setL2(augmentBuilder, l2);
 151             }
 152
 153             final Ethernet ethernet = vppIfcAugmentation.getEthernet();
 154             if (ethernet != null) {
 155                 setEthernet(augmentBuilder, ethernet);
 156             }
 157
 158             final Acl acl = vppIfcAugmentation.getAcl();
 159             if (acl != null) {
 160                 setAcl(augmentBuilder, acl);
 161             }
 162
 163             // TODO set routing, not present in interface-state
 164
 165             builder.addAugmentation(VppInterfaceAugmentation.class, augmentBuilder.build());
 166         }
 167     }
 168
 169     private static void initializeIetfIpAugmentation(
 170         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input,
 171         final InterfaceBuilder builder) {
 172         final Interface2 ietfIpAugmentation = input.getAugmentation(Interface2.class);
 173         if (ietfIpAugmentation != null) {
 174             final Interface1Builder augmentBuilder = new Interface1Builder();
 175
 176             final Ipv4 ipv4 = ietfIpAugmentation.getIpv4();
 177             if (ipv4 != null) {
 178                 final List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address>
 179                     collect =
 180                     ipv4.getAddress().stream()
 181                         .map(
 182                             address -> new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.AddressBuilder()
 183                                 .setIp(address.getIp())
 184                                 .setSubnet(getSubnet(address))
 185                                 .build())
 186                         .collect(Collectors.toList());
 187
 188                 final List<Neighbor> neighbors = ipv4.getNeighbor().stream()
 189                     .map(neighbor -> new NeighborBuilder().setIp(neighbor.getIp())
 190                         .setLinkLayerAddress(neighbor.getLinkLayerAddress()).build())
 191                     .collect(Collectors.toList());
 192
 193                 augmentBuilder.setIpv4(new Ipv4Builder().setAddress(collect).setNeighbor(neighbors).build());
 194             }
 195
 196             // TODO ipv6
 197
 198             builder.addAugmentation(Interface1.class, augmentBuilder.build());
 199         }
 200     }
 201
 202     private static Subnet getSubnet(final Address address) {
 203         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.Subnet
 204             subnet = address.getSubnet();
 205
 206         // TODO only prefix length supported
 207         Preconditions.checkArgument(
 208             subnet instanceof org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength);
 209
 210         return new PrefixLengthBuilder().setPrefixLength(
 211             ((org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength) subnet)
 212                 .getPrefixLength()).build();
 213     }
 214
 215     private static void setEthernet(final VppInterfaceAugmentationBuilder augmentBuilder, final Ethernet ethernet) {
 216         final EthernetBuilder ethernetBuilder = new EthernetBuilder();
 217         ethernetBuilder.setMtu(ethernet.getMtu());
 218         augmentBuilder.setEthernet(ethernetBuilder.build());
 219     }
 220
 221     private static void setAcl(final VppInterfaceAugmentationBuilder augmentBuilder, final Acl acl) {
 222         final AclBuilder aclBuilder = new AclBuilder();
 223         aclBuilder.setL2Acl(acl.getL2Acl());
 224         aclBuilder.setIp4Acl(acl.getIp4Acl());
 225         aclBuilder.setIp6Acl(acl.getIp6Acl());
 226         augmentBuilder.setAcl(aclBuilder.build());
 227     }
 228
 229     private static void setL2(final VppInterfaceAugmentationBuilder augmentBuilder, final L2 l2) {
 230         final L2Builder l2Builder = new L2Builder();
 231
 232         final Interconnection interconnection = l2.getInterconnection();
 233         if (interconnection != null) {
 234             if (interconnection instanceof XconnectBased) {
 235                 final XconnectBasedBuilder xconnectBasedBuilder = new XconnectBasedBuilder();
 236                 xconnectBasedBuilder.setXconnectOutgoingInterface(
 237                     ((XconnectBased) interconnection).getXconnectOutgoingInterface());
 238                 l2Builder.setInterconnection(xconnectBasedBuilder.build());
 239             } else if (interconnection instanceof BridgeBased) {
 240                 final BridgeBasedBuilder bridgeBasedBuilder = new BridgeBasedBuilder();
 241                 bridgeBasedBuilder.setBridgeDomain(((BridgeBased) interconnection).getBridgeDomain());
 242                 bridgeBasedBuilder
 243                     .setBridgedVirtualInterface(((BridgeBased) interconnection).isBridgedVirtualInterface());
 244                 bridgeBasedBuilder.setSplitHorizonGroup(((BridgeBased) interconnection).getSplitHorizonGroup());
 245                 l2Builder.setInterconnection(bridgeBasedBuilder.build());
 246             }
 247         }
 248
 249         augmentBuilder.setL2(l2Builder.build());
 250     }
 251
 252     private static void setVhostUser(final VppInterfaceAugmentationBuilder augmentBuilder, final VhostUser vhostUser) {
 253         final VhostUserBuilder vhostUserBuilder = new VhostUserBuilder();
 254         vhostUserBuilder.setRole(vhostUser.getRole());
 255         vhostUserBuilder.setSocket(vhostUser.getSocket());
 256         augmentBuilder.setVhostUser(vhostUserBuilder.build());
 257     }
 258
 259     private static void setTap(
 260         final @Nonnull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface input,
 261         final VppInterfaceAugmentationBuilder augmentBuilder,
 262         final Tap tap) {
 263         final TapBuilder tapBuilder = new TapBuilder();
 264         tapBuilder.setMac(input.getPhysAddress());
 265         tapBuilder.setTapName(tap.getTapName());
 266 //                            tapBuilder.setDeviceInstance();
 267         augmentBuilder.setTap(tapBuilder.build());
 268     }
 269
 270     private static void setVxlan(final VppInterfaceAugmentationBuilder augmentBuilder, final Vxlan vxlan) {
 271         final VxlanBuilder vxlanBuilder = new VxlanBuilder();
 272         vxlanBuilder.setDst(vxlan.getDst());
 273         vxlanBuilder.setSrc(vxlan.getSrc());
 274         vxlanBuilder.setEncapVrfId(vxlan.getEncapVrfId());
 275         vxlanBuilder.setVni(new VxlanVni(vxlan.getVni()));
 276         augmentBuilder.setVxlan(vxlanBuilder.build());
 277     }
 278
 279     private static void setVxlanGpe(final VppInterfaceAugmentationBuilder augmentBuilder, final VxlanGpe vxlanGpe) {
 280         final VxlanGpeBuilder vxlanGpeBuilder = new VxlanGpeBuilder();
 281         vxlanGpeBuilder.setLocal(vxlanGpe.getLocal());
 282         vxlanGpeBuilder.setRemote(vxlanGpe.getRemote());
 283         vxlanGpeBuilder.setVni(new VxlanGpeVni(vxlanGpe.getVni()));
 284         vxlanGpeBuilder.setNextProtocol(vxlanGpe.getNextProtocol());
 285         vxlanGpeBuilder.setEncapVrfId(vxlanGpe.getEncapVrfId());
 286         vxlanGpeBuilder.setDecapVrfId(vxlanGpe.getDecapVrfId());
 287         augmentBuilder.setVxlanGpe(vxlanGpeBuilder.build());
 288     }
 289
 290     private static void setGre(final VppInterfaceAugmentationBuilder augmentBuilder, final Gre gre) {
 291         final GreBuilder greBuilder = new GreBuilder();
 292         greBuilder.setDst(gre.getDst());
 293         greBuilder.setSrc(gre.getSrc());
 294         greBuilder.setOuterFibId(gre.getOuterFibId());
 295         augmentBuilder.setGre(greBuilder.build());
 296     }
 297 }