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