renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterface121.java

   1 /*
   2  * Copyright © 2017 AT&T and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.transportpce.renderer.openroadminterface;
  10
  11 import java.math.BigDecimal;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.Optional;
  15 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  16 import org.opendaylight.transportpce.common.StringConstants;
  17 import org.opendaylight.transportpce.common.Timeouts;
  18 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  19 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
  20 import org.opendaylight.transportpce.common.fixedflex.SpectrumInformation;
  21 import org.opendaylight.transportpce.common.mapping.PortMapping;
  22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
  23 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
  24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.mapping.Mapping;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.PowerDBm;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceKey;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.OrgOpenroadmDevice;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev161014.AdminStates;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.EthAttributes;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.Interface1Builder;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.ethernet.interfaces.rev161014.ethernet.container.EthernetBuilder;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.EthernetCsmacd;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.InterfaceType;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpenROADMOpticalMultiplex;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalChannel;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OpticalTransport;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOdu;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.interfaces.rev161014.OtnOtu;
  42 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
  43 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.R100G;
  44 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.och.container.OchBuilder;
  45 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.OtsAttributes;
  46 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.ots.container.OtsBuilder;
  47 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.ODU4;
  48 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.OduAttributes;
  49 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.odu.container.OduBuilder;
  50 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.opu.OpuBuilder;
  51 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OTU4;
  52 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.OtuAttributes;
  53 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.otu.container.OtuBuilder;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  55 import org.opendaylight.yangtools.yang.common.Uint32;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59
  60 public class OpenRoadmInterface121 {
  61     private static final String MAPPING_MSG_ERROR =
  62             "Unable to get mapping from PortMapping for node % and logical connection port %s";
  63     private final PortMapping portMapping;
  64     private final OpenRoadmInterfaces openRoadmInterfaces;
  65     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterface121.class);
  66
  67     public  OpenRoadmInterface121(PortMapping portMapping, OpenRoadmInterfaces openRoadmInterfaces) {
  68         this.portMapping = portMapping;
  69         this.openRoadmInterfaces = openRoadmInterfaces;
  70     }
  71
  72     public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
  73             throws OpenRoadmInterfaceException {
  74         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
  75         if (portMap == null) {
  76             throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
  77         }
  78
  79         // Ethernet interface specific data
  80         EthernetBuilder ethIfBuilder = new EthernetBuilder()
  81                 .setAutoNegotiation(EthAttributes.AutoNegotiation.Enabled)
  82                 .setDuplex(EthAttributes.Duplex.Full)
  83                 .setFec(EthAttributes.Fec.Off)
  84                 .setSpeed(Uint32.valueOf(100000))
  85                 .setMtu(Uint32.valueOf(9000));
  86
  87         InterfaceBuilder ethInterfaceBldr = createGenericInterfaceBuilder(portMap, EthernetCsmacd.class,
  88                                                                           logicalConnPoint + "-ETHERNET");
  89
  90         // Create Interface1 type object required for adding as augmentation
  91         Interface1Builder ethIf1Builder = new Interface1Builder();
  92         ethInterfaceBldr.addAugmentation(ethIf1Builder.setEthernet(ethIfBuilder.build()).build());
  93
  94         // Post interface on the device
  95         this.openRoadmInterfaces.postInterface(nodeId, ethInterfaceBldr);
  96
  97         // Post the equipment-state change on the device circuit-pack
  98         this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
  99
 100         return ethInterfaceBldr.getName();
 101     }
 102
 103     private InterfaceBuilder createGenericInterfaceBuilder(Mapping portMap, Class<? extends InterfaceType> type,
 104                                                            String key) {
 105         return new InterfaceBuilder()
 106                 .setDescription("  TBD   ")
 107                 .setCircuitId("   TBD    ")
 108                 .setSupportingCircuitPackName(portMap.getSupportingCircuitPackName())
 109                 .setSupportingPort(portMap.getSupportingPort())
 110                 .setAdministrativeState(AdminStates.InService)
 111                 .setType(type)
 112                 .setName(key)
 113                 .withKey(new InterfaceKey(key));
 114     }
 115     /**
 116      * This methods creates an OTU interface on the given termination point.
 117      *
 118      * @param nodeId node ID
 119      * @param logicalConnPoint logical Connection Point
 120      * @param supportOchInterface support OCH Interface
 121      *
 122      * @return Name of the interface if successful, otherwise return null.
 123      * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
 124      */
 125
 126     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
 127             throws OpenRoadmInterfaceException {
 128         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 129         if (portMap == null) {
 130             throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
 131         }
 132         // Create generic interface
 133         InterfaceBuilder otuInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOtu.class, logicalConnPoint
 134                 + "-OTU");
 135         otuInterfaceBldr.setSupportingInterface(supportOchInterface);
 136
 137         // OTU interface specific data
 138         OtuBuilder otuIfBuilder = new OtuBuilder()
 139                 .setFec(OtuAttributes.Fec.Scfec)
 140                 .setRate(OTU4.class);
 141
 142         // Create Interface1 type object required for adding as augmentation
 143         // TODO look at imports of different versions of class
 144         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder otuIf1Builder =
 145                 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.otu.interfaces.rev161014.Interface1Builder();
 146         otuInterfaceBldr.addAugmentation(otuIf1Builder.setOtu(otuIfBuilder.build()).build());
 147
 148         // Post interface on the device
 149         this.openRoadmInterfaces.postInterface(nodeId, otuInterfaceBldr);
 150         return otuInterfaceBldr.getName();
 151     }
 152
 153     /**
 154      * This methods creates an ODU interface on the given termination point.
 155      *
 156      * @param nodeId node ID
 157      * @param logicalConnPoint logical Connection Point
 158      * @param supportingOtuInterface supporting OTU Interface
 159      *
 160      * @return Name of the interface if successful, otherwise return null.
 161      * @throws OpenRoadmInterfaceException OpenRoadmInterfaceException
 162      */
 163
 164     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 165             throws OpenRoadmInterfaceException {
 166         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 167         if (portMap == null) {
 168             throw new OpenRoadmInterfaceException(String.format(MAPPING_MSG_ERROR, nodeId, logicalConnPoint));
 169         }
 170         InterfaceBuilder oduInterfaceBldr = createGenericInterfaceBuilder(portMap, OtnOdu.class, logicalConnPoint
 171                 + "-ODU");
 172         oduInterfaceBldr.setSupportingInterface(supportingOtuInterface);
 173
 174         // ODU interface specific data
 175         // Set Opu attributes
 176         OpuBuilder opuBldr = new OpuBuilder()
 177                 .setPayloadType("07")
 178                 .setExpPayloadType("07");
 179         OduBuilder oduIfBuilder = new OduBuilder()
 180                 .setRate(ODU4.class)
 181                 .setMonitoringMode(OduAttributes.MonitoringMode.Terminated)
 182                 .setOpu(opuBldr.build());
 183
 184         // Create Interface1 type object required for adding as augmentation
 185         // TODO look at imports of different versions of class
 186         org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder oduIf1Builder =
 187                 new org.opendaylight.yang.gen.v1.http.org.openroadm.otn.odu.interfaces.rev161014.Interface1Builder();
 188         oduInterfaceBldr.addAugmentation(oduIf1Builder.setOdu(oduIfBuilder.build()).build());
 189
 190         // Post interface on the device
 191         this.openRoadmInterfaces.postInterface(nodeId, oduInterfaceBldr);
 192         return oduInterfaceBldr.getName();
 193     }
 194     /**
 195      * This methods creates a list of OCH interface on the given termination point on
 196      * Roadm.
 197      *
 198      * @param nodeId node ID
 199      * @param logicalConnPoint logical connection point
 200      * @param spectrumInformation SpectrumInformation
 201      * @return List containing name of the interface if successful, otherwise return empty list.
 202      *
 203      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 204      */
 205
 206     public List<String> createOpenRoadmOchInterfaces(String nodeId, String logicalConnPoint,
 207             SpectrumInformation spectrumInformation)
 208         throws OpenRoadmInterfaceException {
 209         Mapping portMap = portMapping.getMapping(nodeId, logicalConnPoint);
 210         if (portMap == null) {
 211             throw new OpenRoadmInterfaceException(String.format(
 212                 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
 213                     nodeId, logicalConnPoint));
 214         }
 215         // Create generic interface
 216         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 217                 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
 218
 219         // OCH interface specific data
 220         OchBuilder ocIfBuilder = new OchBuilder().setWavelengthNumber(spectrumInformation.getWaveLength());
 221
 222         // Add supporting OMS interface
 223         if (portMap.getSupportingOms() != null) {
 224             ochInterfaceBldr.setSupportingInterface(portMap.getSupportingOms());
 225         }
 226         // Create Interface1 type object required for adding as augmentation
 227         // TODO look at imports of different versions of class
 228         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.Interface1Builder
 229                 ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces
 230                 .rev161014.Interface1Builder();
 231         ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
 232
 233         List<String> interfacesCreated = new ArrayList<>();
 234         // Post interface on the device
 235         openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 236         interfacesCreated.add(ochInterfaceBldr.getName());
 237         return interfacesCreated;
 238     }
 239
 240     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint,
 241             SpectrumInformation spectrumInformation) throws OpenRoadmInterfaceException {
 242         Mapping portMap = this.portMapping.getMapping(nodeId, logicalConnPoint);
 243         if (portMap == null) {
 244             throw new OpenRoadmInterfaceException(String.format(
 245                 "Unable to get mapping from PortMapping for node %s and logical connection port %s",
 246                     nodeId, logicalConnPoint));
 247         }
 248         OchAttributes.ModulationFormat modulationFormat = OchAttributes.ModulationFormat.DpQpsk;
 249         Optional<OchAttributes.ModulationFormat> optionalModulationFormat = OchAttributes.ModulationFormat
 250                 .forName(spectrumInformation.getModulationFormat());
 251         if (optionalModulationFormat.isPresent()) {
 252             modulationFormat =  optionalModulationFormat.get();
 253         }
 254         // OCH interface specific data
 255         OchBuilder ocIfBuilder = new OchBuilder()
 256                 .setWavelengthNumber(spectrumInformation.getWaveLength())
 257                 .setModulationFormat(modulationFormat)
 258                 .setRate(R100G.class)
 259                 .setTransmitPower(new PowerDBm(new BigDecimal("-5")));
 260
 261         // Create Interface1 type object required for adding as augmentation
 262         // TODO look at imports of different versions of class
 263         org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014
 264                 .Interface1Builder ochIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel
 265                 .interfaces.rev161014.Interface1Builder();
 266         // Create generic interface
 267         InterfaceBuilder ochInterfaceBldr = createGenericInterfaceBuilder(portMap, OpticalChannel.class,
 268                 spectrumInformation.getIdentifierFromParams(logicalConnPoint));
 269         ochInterfaceBldr.addAugmentation(ochIf1Builder.setOch(ocIfBuilder.build()).build());
 270
 271         // Post interface on the device
 272         this.openRoadmInterfaces.postInterface(nodeId, ochInterfaceBldr);
 273
 274         // Post the equipment-state change on the device circuit-pack if xpdr node
 275         if (portMap.getLogicalConnectionPoint().contains(StringConstants.NETWORK_TOKEN)) {
 276             this.openRoadmInterfaces.postEquipmentState(nodeId, portMap.getSupportingCircuitPackName(), true);
 277         }
 278         return ochInterfaceBldr.getName();
 279     }
 280
 281     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, String spectralSlotName) {
 282         return String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,logicalConnectionPoint, spectralSlotName);
 283     }
 284
 285     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 286         if (mapping.getSupportingOms() == null) {
 287             // Create generic interface
 288             InterfaceBuilder omsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpenROADMOpticalMultiplex.class,
 289                 "OMS-" + mapping.getLogicalConnectionPoint());
 290             if (mapping.getSupportingOts() != null) {
 291                 omsInterfaceBldr.setSupportingInterface(mapping.getSupportingOts());
 292             } else {
 293                 LOG.error("Unable to get ots interface from mapping {} - {}", nodeId,
 294                           mapping.getLogicalConnectionPoint());
 295                 return null;
 296             }
 297             this.openRoadmInterfaces.postInterface(nodeId, omsInterfaceBldr);
 298             this.portMapping.updateMapping(nodeId, mapping);
 299             return omsInterfaceBldr.build().getName();
 300         } else {
 301             return mapping.getSupportingOms();
 302         }
 303     }
 304
 305     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 306         if (mapping.getSupportingOts() == null) {
 307             // Create generic interface
 308             InterfaceBuilder otsInterfaceBldr = createGenericInterfaceBuilder(mapping, OpticalTransport.class, "OTS-"
 309                     + mapping.getLogicalConnectionPoint());
 310             // OTS interface augmentation specific data
 311             OtsBuilder otsIfBuilder = new OtsBuilder();
 312             otsIfBuilder.setFiberType(OtsAttributes.FiberType.Smf);
 313
 314             // Create Interface1 type object required for adding as
 315             // augmentation
 316             org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014
 317                     .Interface1Builder otsIf1Builder = new org.opendaylight.yang.gen.v1.http.org.openroadm
 318                     .optical.transport.interfaces.rev161014.Interface1Builder();
 319             otsInterfaceBldr.addAugmentation(otsIf1Builder.setOts(otsIfBuilder.build()).build());
 320             this.openRoadmInterfaces.postInterface(nodeId, otsInterfaceBldr);
 321             this.portMapping.updateMapping(nodeId, mapping);
 322             return otsInterfaceBldr.build().getName();
 323         } else {
 324             return mapping.getSupportingOts();
 325         }
 326     }
 327
 328     public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
 329         DeviceTransactionManager deviceTransactionManager) {
 330         InstanceIdentifier<RoadmConnections> xciid = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 331             .child(RoadmConnections.class, new RoadmConnectionsKey(xc));
 332         LOG.info("reading xc {} in node {}", xc, nodeId);
 333         Optional<RoadmConnections> crossconnection = deviceTransactionManager.getDataFromDevice(nodeId,
 334             LogicalDatastoreType.CONFIGURATION, xciid, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 335         if (crossconnection.isPresent()) {
 336             RoadmConnections rc = crossconnection.get();
 337             LOG.info("xd {} found", xc);
 338             if (rc.getSource().getSrcIf().equals(interfaceName)
 339                 || rc.getDestination().getDstIf().equals(interfaceName)) {
 340                 return true;
 341             }
 342         } else {
 343             LOG.info("xd {} not found !", xc);
 344         }
 345         return false;
 346     }
 347
 348 }