/* * Copyright © 2017 AT&T and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.transportpce.olm.power; import java.math.BigDecimal; import java.util.HashMap; import java.util.Locale; import java.util.Map; import java.util.Optional; import org.opendaylight.mdsal.binding.api.DataBroker; import org.opendaylight.transportpce.common.crossconnect.CrossConnect; import org.opendaylight.transportpce.common.device.DeviceTransactionManager; import org.opendaylight.transportpce.common.fixedflex.GridConstant; import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException; import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces; import org.opendaylight.transportpce.olm.util.OlmUtils; import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerSetupInput; import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerTurndownInput; import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210927.OpenroadmNodeVersion; import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210927.mapping.Mapping; import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210927.mapping.MappingKey; import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210927.network.Nodes; import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.OpticalControlMode; import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface; import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.Interface1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class PowerMgmtImpl implements PowerMgmt { private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtImpl.class); private final DataBroker db; private final OpenRoadmInterfaces openRoadmInterfaces; private final CrossConnect crossConnect; private final DeviceTransactionManager deviceTransactionManager; private static final BigDecimal DEFAULT_TPDR_PWR_100G = new BigDecimal(-5); private static final BigDecimal DEFAULT_TPDR_PWR_400G = new BigDecimal(0); private static final String INTERFACE_NOT_PRESENT = "Interface {} on node {} is not present!"; private long timer1 = 120000; // openroadm spec value is 120000, functest value is 3000 private long timer2 = 20000; // openroadm spec value is 20000, functest value is 2000 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces, CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager) { this.db = db; this.openRoadmInterfaces = openRoadmInterfaces; this.crossConnect = crossConnect; this.deviceTransactionManager = deviceTransactionManager; } public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces, CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager, String timer1, String timer2) { this.db = db; this.openRoadmInterfaces = openRoadmInterfaces; this.crossConnect = crossConnect; this.deviceTransactionManager = deviceTransactionManager; try { this.timer1 = Long.parseLong(timer1); } catch (NumberFormatException e) { this.timer1 = 120000; LOG.warn("Failed to retrieve Olm timer1 value from configuration - using default value {}", this.timer1, e); } try { this.timer2 = Long.parseLong(timer2); } catch (NumberFormatException e) { this.timer2 = 20000; LOG.warn("Failed to retrieve Olm timer2 value from configuration - using default value {}", this.timer2, e); } } /** * This methods measures power requirement for turning up a WL * from the Spanloss at OTS transmit direction and update * roadm-connection target-output-power. * * @param input * Input parameter from the olm servicePowerSetup rpc * * @return true/false based on status of operation. */ //TODO Need to Case Optical Power mode/NodeType in case of 2.2 devices public Boolean setPower(ServicePowerSetupInput input) { LOG.info("Olm-setPower initiated for input {}", input); String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR, input.getLowerSpectralSlotNumber().toString(), input.getHigherSpectralSlotNumber().toString()); for (int i = 0; i < input.getNodes().size(); i++) { String nodeId = input.getNodes().get(i).getNodeId(); String destTpId = input.getNodes().get(i).getDestTp(); Optional inputNodeOptional = OlmUtils.getNode(nodeId, this.db); if (inputNodeOptional.isEmpty() || inputNodeOptional.get().getNodeInfo().getNodeType() == null) { LOG.error("OLM-PowerMgmtImpl : Error node type cannot be retrieved for node {}", nodeId); continue; } Nodes inputNode = inputNodeOptional.get(); OpenroadmNodeVersion openroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion(); switch (inputNode.getNodeInfo().getNodeType()) { case Xpdr: if (destTpId == null) { continue; } LOG.info("Getting data from input node {}", inputNode.getNodeInfo().getNodeType()); LOG.info("Getting mapping data for node is {}", inputNode.nonnullMapping().values().stream().filter(o -> o.key() .equals(new MappingKey(destTpId))).findFirst().toString()); // If its not A-End transponder if (!destTpId.toUpperCase(Locale.getDefault()).contains("NETWORK")) { LOG.info("{} is a drop node. Net power settings needed", nodeId); continue; } BigDecimal powerVal = getXpdrPowerValue( inputNode, destTpId, nodeId, openroadmVersion.getIntValue(), input.getNodes().get(i + 1).getSrcTp(), input.getNodes().get(i + 1).getNodeId()); if (powerVal == null) { return false; } String interfaceName = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR, destTpId, spectralSlotName); if (!callSetTransponderPower(nodeId, interfaceName, powerVal, openroadmVersion)) { LOG.info("Transponder OCH connection: {} power update failed ", interfaceName); continue; } LOG.info("Transponder OCH connection: {} power updated ", interfaceName); try { LOG.info("Now going in sleep mode"); Thread.sleep(timer1); } catch (InterruptedException e) { LOG.info("Transponder warmup failed for OCH connection: {}", interfaceName, e); // FIXME shouldn't it be LOG.warn or LOG.error? // or maybe this try/catch block can simply be removed } break; case Rdm: LOG.info("This is a roadm {} device", openroadmVersion.getName()); String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR, input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName); LOG.info("Connection number is {}", connectionNumber); // If Drop node leave node is power mode if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) { LOG.info("Setting power at drop node"); crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), null, connectionNumber); continue; } if (!destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) { continue; } // If Degree is transmitting end then set power Optional mappingObjectOptional = inputNode.nonnullMapping() .values().stream().filter(o -> o.key() .equals(new MappingKey(destTpId))).findFirst(); if (mappingObjectOptional.isEmpty()) { continue; } // TODO can it be return false rather than continue? // in that case, mappingObjectOptional could be moved inside method getSpanLossTx() LOG.info("Dest point is Degree {}", mappingObjectOptional.get()); BigDecimal spanLossTx = getSpanLossTx(mappingObjectOptional.get().getSupportingOts(), destTpId, nodeId, openroadmVersion.getIntValue()); LOG.info("Spanloss TX is {}", spanLossTx); if (spanLossTx == null || spanLossTx.intValue() <= 0 || spanLossTx.intValue() > 28) { LOG.error("Power Value is null: spanLossTx null or out of openROADM range ]0,28] {}", spanLossTx); return false; } BigDecimal powerValue = getRdmPowerValue(spanLossTx, input); try { if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), powerValue, connectionNumber)) { LOG.info("Set Power failed for Roadm-connection: {} on Node: {}", connectionNumber, nodeId); // FIXME shouldn't it be LOG.error return false; } LOG.info("Roadm-connection: {} updated ", connectionNumber); Thread.sleep(timer2); // TODO make this timer value configurable via OSGi blueprint // although the value recommended by the white paper is 20 seconds. // At least one vendor product needs 60 seconds // because it is not supporting GainLoss with target-output-power. if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.GainLoss.getName(), powerValue, connectionNumber)) { LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber); // FIXME no return false in that case? } } catch (InterruptedException e) { LOG.error("Olm-setPower wait failed :", e); return false; } break; default : LOG.error("OLM-PowerMgmtImpl : Error with node type for node {}", nodeId); break; } } return true; } private Map getTxPowerRangeMap(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion) { Optional mappingObject = inputNode.nonnullMapping().values().stream() .filter(o -> o.key().equals(new MappingKey(destTpId))).findFirst(); if (mappingObject.isEmpty()) { LOG.info("Mapping object not found for nodeId: {}", nodeId); // FIXME shouldn't it be LOG.error ? return null; // return null here means return false in setPower() // TODO Align protections with getSRGRxPowerRangeMap } String circuitPackName = mappingObject.get().getSupportingCircuitPackName(); String portName = mappingObject.get().getSupportingPort(); switch (openroadmVersion) { case 1: return PowerMgmtVersion121.getXponderPowerRange(circuitPackName, portName, nodeId, deviceTransactionManager); case 2: return PowerMgmtVersion221.getXponderPowerRange(circuitPackName, portName, nodeId, deviceTransactionManager); case 3: return PowerMgmtVersion710.getXponderPowerRange(circuitPackName, portName, nodeId, deviceTransactionManager); default: LOG.error("Unrecognized OpenRoadm version"); return new HashMap<>(); // FIXME shouldn't it lead to a return false in setPower()? } } private Map getSRGRxPowerRangeMap(String srgId, String nodeId, Integer openroadmVersion) { Optional inputNode = OlmUtils.getNode(nodeId, this.db); int rdmOpenroadmVersion = inputNode.isPresent() ? inputNode.get().getNodeInfo().getOpenroadmVersion().getIntValue() : openroadmVersion; Optional mappingObject = inputNode .flatMap(node -> node.nonnullMapping().values().stream() .filter(o -> o.key().equals(new MappingKey(srgId))).findFirst()); if (mappingObject.isEmpty()) { return new HashMap<>(); // FIXME shouldn't it lead to a return false in setPower() ? } String circuitPackName = mappingObject.get().getSupportingCircuitPackName(); String portName = mappingObject.get().getSupportingPort(); switch (rdmOpenroadmVersion) { case 1: return PowerMgmtVersion121.getSRGRxPowerRange(nodeId, srgId, deviceTransactionManager, circuitPackName, portName); case 2: return PowerMgmtVersion221.getSRGRxPowerRange(nodeId, srgId, deviceTransactionManager, circuitPackName, portName); case 3: return PowerMgmtVersion710.getSRGRxPowerRange(nodeId, srgId, deviceTransactionManager, circuitPackName, portName); default: LOG.error("Unrecognized OpenRoadm version"); return null; //return null here means return false in setPower() // TODO Align protections with getTxPowerRangeMap } } private BigDecimal getSpanLossTx(String supportingOts, String destTpId, String nodeId, Integer openroadmVersion) { try { switch (openroadmVersion) { case 1: Optional interfaceOpt = this.openRoadmInterfaces.getInterface(nodeId, supportingOts); if (interfaceOpt.isEmpty()) { LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId); return null; } if (interfaceOpt.get().augmentation(Interface1.class).getOts() .getSpanLossTransmit() == null) { LOG.error("interface {} has no spanloss value", interfaceOpt.get().getName()); return null; } return interfaceOpt.get() .augmentation(Interface1.class) .getOts().getSpanLossTransmit().getValue(); case 2: Optional interfaceOpt1 = this.openRoadmInterfaces.getInterface(nodeId, supportingOts); if (interfaceOpt1.isEmpty()) { LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId); return null; } if (interfaceOpt1.get().augmentation(org.opendaylight.yang.gen.v1.http.org .openroadm.optical.transport.interfaces.rev181019.Interface1.class).getOts() .getSpanLossTransmit() == null) { LOG.error("interface {} has no spanloss value", interfaceOpt1.get().getName()); return null; } return interfaceOpt1.get() .augmentation(org.opendaylight.yang.gen.v1.http.org .openroadm.optical.transport.interfaces.rev181019.Interface1.class) .getOts().getSpanLossTransmit().getValue(); // TODO no case 3 ? default: return null; } } catch (OpenRoadmInterfaceException ex) { LOG.error("Failed to get interface {} from node {}!", supportingOts, nodeId, ex); return null; } catch (IllegalArgumentException ex) { LOG.error("Failed to get non existing interface {} from node {}!", supportingOts, nodeId); return null; } } private BigDecimal getXpdrPowerValue(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion, String srgId, String nextNodeId) { Map txPowerRangeMap = getTxPowerRangeMap(inputNode, destTpId, nodeId, openroadmVersion); if (txPowerRangeMap == null) { return null; // return null here means return false in setPower() } BigDecimal powerVal = openroadmVersion == 3 ? DEFAULT_TPDR_PWR_400G : DEFAULT_TPDR_PWR_100G; if (txPowerRangeMap.isEmpty()) { LOG.info("Tranponder range not available setting to default power for nodeId: {}", nodeId); return powerVal; } Map rxSRGPowerRangeMap = getSRGRxPowerRangeMap(srgId, nextNodeId, openroadmVersion); if (rxSRGPowerRangeMap == null) { return null; // return null here means return false in setPower() // TODO empty txPowerRangeMap + null rxSRGPowerRangeMap is allowed // => confirm this behavior is OK } if (rxSRGPowerRangeMap.isEmpty()) { LOG.info("SRG Power Range not found, setting the Transponder range to default"); return powerVal; } powerVal = new BigDecimal(txPowerRangeMap.get("MaxTx")) .min(new BigDecimal(rxSRGPowerRangeMap.get("MaxRx"))); LOG.info("Calculated Transponder Power value is {}" , powerVal); return powerVal; } private BigDecimal getRdmPowerValue(BigDecimal spanLossTx, ServicePowerSetupInput input) { BigDecimal powerValue = spanLossTx.subtract(BigDecimal.valueOf(9)).min(BigDecimal.valueOf(2)); // we work at constant power spectral density (50 GHz channel width @-20dBm=37.5GHz) // 87.5 GHz channel width @-20dBm=75GHz if (input.getWidth() != null) { BigDecimal gridSize = input.getWidth().getValue(); LOG.debug("Input Gridsize is {}",gridSize); if (gridSize.equals(GridConstant.WIDTH_80)) { powerValue = powerValue.add(BigDecimal.valueOf(3)); } // TODO no default or warning for unsupported grid sizes ? } // FIXME compliancy with OpenROADM MSA and approximations used // cf JIRA ticket https://jira.opendaylight.org/browse/TRNSPRTPCE-494 LOG.info("Power Value is {}", powerValue); return powerValue; } /** * This methods turns down power a WL by performing * following steps: * *

* 1. Pull interfaces used in service and change * status to outOfService * *

* 2. For each of the ROADM node set target-output-power * to -60dbm, wait for 20 seconds, turn power mode to off * *

* 3. Turn down power in Z to A direction and A to Z * * @param input * Input parameter from the olm servicePowerTurndown rpc * * @return true/false based on status of operation */ public Boolean powerTurnDown(ServicePowerTurndownInput input) { LOG.info("Olm-powerTurnDown initiated for input {}", input); /*Starting with last element into the list Z -> A for turning down A -> Z */ String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR, input.getLowerSpectralSlotNumber().toString(), input.getHigherSpectralSlotNumber().toString()); for (int i = input.getNodes().size() - 1; i >= 0; i--) { String nodeId = input.getNodes().get(i).getNodeId(); String destTpId = input.getNodes().get(i).getDestTp(); String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR, input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName); try { if (destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) { if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), new BigDecimal(-60), connectionNumber)) { LOG.warn("Power down failed for Roadm-connection: {}", connectionNumber); return false; } Thread.sleep(timer2); if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) { LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber); return false; } } else if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) { if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) { LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber); // FIXME a return false would allow sync with DEG case but makes current Unit tests fail } } } catch (InterruptedException e) { // TODO Auto-generated catch block LOG.error("Olm-powerTurnDown wait failed: ",e); return false; } } return true; } /** * This method retrieves transponder OCH interface and * sets power. * * @param nodeId * Unique identifier for the mounted netconf- node * @param interfaceName * OCH interface name carrying WL * @param txPower * Calculated transmit power * @param openroadmVersion * Version of openRoadm device software * @return true/false based on status of operation */ private boolean callSetTransponderPower(String nodeId, String interfaceName, BigDecimal txPower, OpenroadmNodeVersion openroadmVersion) { boolean powerSetupResult = false; try { switch (openroadmVersion.getIntValue()) { case 1: Optional interfaceOptional121 = openRoadmInterfaces.getInterface(nodeId, interfaceName); if (interfaceOptional121.isEmpty()) { LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId); return false; } powerSetupResult = PowerMgmtVersion121.setTransponderPower(nodeId, interfaceName, txPower, deviceTransactionManager, interfaceOptional121.get()); break; case 2: Optional interfaceOptional221 = openRoadmInterfaces.getInterface(nodeId, interfaceName); if (interfaceOptional221.isEmpty()) { LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId); return false; } powerSetupResult = PowerMgmtVersion221.setTransponderPower(nodeId, interfaceName, txPower, deviceTransactionManager, interfaceOptional221.get()); break; case 3: Optional interfaceOptional710 = openRoadmInterfaces.getInterface(nodeId, interfaceName); if (interfaceOptional710.isEmpty()) { LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId); return false; } powerSetupResult = PowerMgmtVersion710.setTransponderPower(nodeId, interfaceName, txPower, deviceTransactionManager, interfaceOptional710.get()); break; default: LOG.error("Unrecognized OpenRoadm version"); return false; } } catch (OpenRoadmInterfaceException ex) { LOG.error("Failed to get interface {} from node {}!", interfaceName, nodeId, ex); return false; } if (!powerSetupResult) { LOG.debug("Transponder power setup failed for nodeId {} on interface {}", nodeId, interfaceName); return false; } LOG.debug("Transponder power set up completed successfully for nodeId {} and interface {}", nodeId,interfaceName); return true; } }