2 * Copyright © 2017 AT&T and others. All rights reserved.
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
9 package org.opendaylight.transportpce.olm.power;
10 import java.math.BigDecimal;
11 import java.math.MathContext;
12 import java.math.RoundingMode;
13 import java.util.HashMap;
14 import java.util.Locale;
16 import java.util.Optional;
17 import org.opendaylight.mdsal.binding.api.DataBroker;
18 import org.opendaylight.transportpce.common.crossconnect.CrossConnect;
19 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
20 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
21 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
22 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
23 import org.opendaylight.transportpce.olm.util.OlmUtils;
24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerSetupInput;
25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerTurndownInput;
26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220114.OpenroadmNodeVersion;
27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220114.mapping.Mapping;
28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220114.mapping.MappingKey;
29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220114.network.Nodes;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.OpticalControlMode;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.Interface1;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
36 public class PowerMgmtImpl implements PowerMgmt {
37 private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtImpl.class);
38 private final DataBroker db;
39 private final OpenRoadmInterfaces openRoadmInterfaces;
40 private final CrossConnect crossConnect;
41 private final DeviceTransactionManager deviceTransactionManager;
42 private static final BigDecimal DEFAULT_TPDR_PWR_100G = new BigDecimal(-5);
43 private static final BigDecimal DEFAULT_TPDR_PWR_400G = new BigDecimal(0);
44 private static final String INTERFACE_NOT_PRESENT = "Interface {} on node {} is not present!";
46 private long timer1 = 120000;
47 // openroadm spec value is 120000, functest value is 3000
48 private long timer2 = 20000;
49 // openroadm spec value is 20000, functest value is 2000
51 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
52 CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager) {
54 this.openRoadmInterfaces = openRoadmInterfaces;
55 this.crossConnect = crossConnect;
56 this.deviceTransactionManager = deviceTransactionManager;
59 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
60 CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager,
61 String timer1, String timer2) {
63 this.openRoadmInterfaces = openRoadmInterfaces;
64 this.crossConnect = crossConnect;
65 this.deviceTransactionManager = deviceTransactionManager;
67 this.timer1 = Long.parseLong(timer1);
68 } catch (NumberFormatException e) {
70 LOG.warn("Failed to retrieve Olm timer1 value from configuration - using default value {}",
74 this.timer2 = Long.parseLong(timer2);
75 } catch (NumberFormatException e) {
77 LOG.warn("Failed to retrieve Olm timer2 value from configuration - using default value {}",
83 * This methods measures power requirement for turning up a WL
84 * from the Spanloss at OTS transmit direction and update
85 * roadm-connection target-output-power.
88 * Input parameter from the olm servicePowerSetup rpc
90 * @return true/false based on status of operation.
92 //TODO Need to Case Optical Power mode/NodeType in case of 2.2 devices
93 public Boolean setPower(ServicePowerSetupInput input) {
94 LOG.info("Olm-setPower initiated for input {}", input);
95 String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
96 input.getLowerSpectralSlotNumber().toString(),
97 input.getHigherSpectralSlotNumber().toString());
98 for (int i = 0; i < input.getNodes().size(); i++) {
99 String nodeId = input.getNodes().get(i).getNodeId();
100 String destTpId = input.getNodes().get(i).getDestTp();
101 Optional<Nodes> inputNodeOptional = OlmUtils.getNode(nodeId, this.db);
102 if (inputNodeOptional.isEmpty()
103 || inputNodeOptional.get().getNodeInfo().getNodeType() == null) {
104 LOG.error("OLM-PowerMgmtImpl : Error node type cannot be retrieved for node {}", nodeId);
107 Nodes inputNode = inputNodeOptional.get();
108 OpenroadmNodeVersion openroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion();
110 switch (inputNode.getNodeInfo().getNodeType()) {
112 if (destTpId == null) {
115 LOG.info("Getting data from input node {}", inputNode.getNodeInfo().getNodeType());
116 LOG.info("Getting mapping data for node is {}",
117 inputNode.nonnullMapping().values().stream().filter(o -> o.key()
118 .equals(new MappingKey(destTpId))).findFirst().toString());
119 // If its not A-End transponder
120 if (!destTpId.toUpperCase(Locale.getDefault()).contains("NETWORK")) {
121 LOG.info("{} is a drop node. Net power settings needed", nodeId);
125 BigDecimal powerVal = getXpdrPowerValue(
126 inputNode, destTpId, nodeId, openroadmVersion.getIntValue(),
127 input.getNodes().get(i + 1).getSrcTp(), input.getNodes().get(i + 1).getNodeId());
128 if (powerVal == null) {
132 String interfaceName = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
133 destTpId, spectralSlotName);
134 if (!callSetTransponderPower(nodeId, interfaceName, powerVal, openroadmVersion)) {
135 LOG.info("Transponder OCH connection: {} power update failed ", interfaceName);
138 LOG.info("Transponder OCH connection: {} power updated ", interfaceName);
140 LOG.info("Now going in sleep mode");
141 Thread.sleep(timer1);
142 } catch (InterruptedException e) {
143 LOG.info("Transponder warmup failed for OCH connection: {}", interfaceName, e);
144 // FIXME shouldn't it be LOG.warn or LOG.error?
145 // or maybe this try/catch block can simply be removed
149 LOG.info("This is a roadm {} device", openroadmVersion.getName());
150 String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
151 input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
152 LOG.info("Connection number is {}", connectionNumber);
154 // If Drop node leave node is power mode
155 if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
156 LOG.info("Setting power at drop node");
157 crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), null, connectionNumber);
160 if (!destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
163 // If Degree is transmitting end then set power
164 Optional<Mapping> mappingObjectOptional = inputNode.nonnullMapping()
165 .values().stream().filter(o -> o.key()
166 .equals(new MappingKey(destTpId))).findFirst();
167 if (mappingObjectOptional.isEmpty()) {
170 // TODO can it be return false rather than continue?
171 // in that case, mappingObjectOptional could be moved inside method getSpanLossTx()
172 LOG.info("Dest point is Degree {}", mappingObjectOptional.get());
173 BigDecimal spanLossTx = getSpanLossTx(mappingObjectOptional.get().getSupportingOts(),
174 destTpId, nodeId, openroadmVersion.getIntValue());
176 LOG.info("Spanloss TX is {}", spanLossTx);
177 if (spanLossTx == null || spanLossTx.intValue() <= 0 || spanLossTx.intValue() > 28) {
178 LOG.error("Power Value is null: spanLossTx null or out of openROADM range ]0,28] {}",
182 BigDecimal powerValue = getRdmPowerValue(spanLossTx, input);
184 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), powerValue,
186 LOG.info("Set Power failed for Roadm-connection: {} on Node: {}",
187 connectionNumber, nodeId);
188 // FIXME shouldn't it be LOG.error
191 LOG.info("Roadm-connection: {} updated ", connectionNumber);
192 Thread.sleep(timer2);
193 // TODO make this timer value configurable via OSGi blueprint
194 // although the value recommended by the white paper is 20 seconds.
195 // At least one vendor product needs 60 seconds
196 // because it is not supporting GainLoss with target-output-power.
198 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.GainLoss.getName(), powerValue,
200 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}",
202 // FIXME no return false in that case?
204 } catch (InterruptedException e) {
205 LOG.error("Olm-setPower wait failed :", e);
210 LOG.error("OLM-PowerMgmtImpl : Error with node type for node {}", nodeId);
217 private Map<String, Double> getTxPowerRangeMap(Nodes inputNode, String destTpId, String nodeId,
218 Integer openroadmVersion) {
220 Optional<Mapping> mappingObject = inputNode.nonnullMapping().values().stream()
221 .filter(o -> o.key().equals(new MappingKey(destTpId))).findFirst();
222 if (mappingObject.isEmpty()) {
223 LOG.info("Mapping object not found for nodeId: {}", nodeId);
224 // FIXME shouldn't it be LOG.error ?
226 // return null here means return false in setPower()
227 // TODO Align protections with getSRGRxPowerRangeMap
230 String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
231 String portName = mappingObject.get().getSupportingPort();
232 switch (openroadmVersion) {
234 return PowerMgmtVersion121.getXponderPowerRange(circuitPackName, portName,
235 nodeId, deviceTransactionManager);
237 return PowerMgmtVersion221.getXponderPowerRange(circuitPackName, portName,
238 nodeId, deviceTransactionManager);
240 return PowerMgmtVersion710.getXponderPowerRange(circuitPackName, portName,
241 nodeId, deviceTransactionManager);
243 LOG.error("Unrecognized OpenRoadm version");
244 return new HashMap<>();
245 // FIXME shouldn't it lead to a return false in setPower()?
250 private Map<String, Double> getSRGRxPowerRangeMap(String srgId, String nodeId, Integer openroadmVersion) {
252 Optional<Nodes> inputNode = OlmUtils.getNode(nodeId, this.db);
253 int rdmOpenroadmVersion =
254 inputNode.isPresent()
255 ? inputNode.get().getNodeInfo().getOpenroadmVersion().getIntValue()
257 Optional<Mapping> mappingObject = inputNode
258 .flatMap(node -> node.nonnullMapping().values().stream()
259 .filter(o -> o.key().equals(new MappingKey(srgId))).findFirst());
261 if (mappingObject.isEmpty()) {
262 return new HashMap<>();
263 // FIXME shouldn't it lead to a return false in setPower() ?
266 String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
267 String portName = mappingObject.get().getSupportingPort();
268 switch (rdmOpenroadmVersion) {
270 return PowerMgmtVersion121.getSRGRxPowerRange(nodeId, srgId,
271 deviceTransactionManager, circuitPackName, portName);
273 return PowerMgmtVersion221.getSRGRxPowerRange(nodeId, srgId,
274 deviceTransactionManager, circuitPackName, portName);
276 return PowerMgmtVersion710.getSRGRxPowerRange(nodeId, srgId,
277 deviceTransactionManager, circuitPackName, portName);
279 LOG.error("Unrecognized OpenRoadm version");
281 //return null here means return false in setPower()
282 // TODO Align protections with getTxPowerRangeMap
286 private BigDecimal getSpanLossTx(String supportingOts, String destTpId, String nodeId, Integer openroadmVersion) {
288 switch (openroadmVersion) {
290 Optional<Interface> interfaceOpt =
291 this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
292 if (interfaceOpt.isEmpty()) {
293 LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
296 if (interfaceOpt.get().augmentation(Interface1.class).getOts()
297 .getSpanLossTransmit() == null) {
298 LOG.error("interface {} has no spanloss value", interfaceOpt.get().getName());
301 return interfaceOpt.get()
302 .augmentation(Interface1.class)
303 .getOts().getSpanLossTransmit().getValue();
305 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019
306 .interfaces.grp.Interface> interfaceOpt1 =
307 this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
308 if (interfaceOpt1.isEmpty()) {
309 LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
312 if (interfaceOpt1.get().augmentation(org.opendaylight.yang.gen.v1.http.org
313 .openroadm.optical.transport.interfaces.rev181019.Interface1.class).getOts()
314 .getSpanLossTransmit() == null) {
315 LOG.error("interface {} has no spanloss value", interfaceOpt1.get().getName());
318 return interfaceOpt1.get()
319 .augmentation(org.opendaylight.yang.gen.v1.http.org
320 .openroadm.optical.transport.interfaces.rev181019.Interface1.class)
321 .getOts().getSpanLossTransmit().getValue();
326 } catch (OpenRoadmInterfaceException ex) {
327 LOG.error("Failed to get interface {} from node {}!",
328 supportingOts, nodeId, ex);
330 } catch (IllegalArgumentException ex) {
331 LOG.error("Failed to get non existing interface {} from node {}!",
332 supportingOts, nodeId);
337 private BigDecimal getXpdrPowerValue(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion,
338 String srgId, String nextNodeId) {
340 Map<String, Double> txPowerRangeMap = getTxPowerRangeMap(inputNode, destTpId, nodeId, openroadmVersion);
341 if (txPowerRangeMap == null) {
343 // return null here means return false in setPower()
345 BigDecimal powerVal =
346 openroadmVersion == 3 ? DEFAULT_TPDR_PWR_400G : DEFAULT_TPDR_PWR_100G;
347 if (txPowerRangeMap.isEmpty()) {
348 LOG.info("Tranponder range not available setting to default power for nodeId: {}", nodeId);
352 Map<String, Double> rxSRGPowerRangeMap = getSRGRxPowerRangeMap(srgId, nextNodeId, openroadmVersion);
353 if (rxSRGPowerRangeMap == null) {
355 // return null here means return false in setPower()
356 // TODO empty txPowerRangeMap + null rxSRGPowerRangeMap is allowed
357 // => confirm this behavior is OK
359 if (rxSRGPowerRangeMap.isEmpty()) {
360 LOG.info("SRG Power Range not found, setting the Transponder range to default");
364 powerVal = new BigDecimal(txPowerRangeMap.get("MaxTx"))
365 .min(new BigDecimal(rxSRGPowerRangeMap.get("MaxRx")));
366 LOG.info("Calculated Transponder Power value is {}" , powerVal);
371 private BigDecimal getRdmPowerValue(BigDecimal spanLossTx, ServicePowerSetupInput input) {
372 BigDecimal powerValue = spanLossTx.subtract(BigDecimal.valueOf(9)).min(BigDecimal.valueOf(2));
373 // we work at constant power spectral density (50 GHz channel width @-20dBm=37.5GHz)
374 // 87.5 GHz channel width @-20dBm=75GHz
375 if (input.getMcWidth() != null) {
376 LOG.debug("Input Gridsize is {}",input.getMcWidth().getValue());
377 if (input.getMcWidth().getValue().equals(GridConstant.WIDTH_80)) {
378 powerValue = powerValue.add(BigDecimal.valueOf(3));
379 } else if (input.getMcWidth().getValue().equals(GridConstant.SLOT_WIDTH_87_5)) {
380 BigDecimal logVal = GridConstant.SLOT_WIDTH_87_5.divide(new BigDecimal(50));
381 double pdsVal = 10 * Math.log10(logVal.doubleValue());
382 powerValue = powerValue.add(new BigDecimal(pdsVal, new MathContext(3, RoundingMode.HALF_EVEN)));
385 // FIXME compliancy with OpenROADM MSA and approximations used -- should be addressed with powermask update
386 // cf JIRA ticket https://jira.opendaylight.org/browse/TRNSPRTPCE-494
387 LOG.info("Power Value is {}", powerValue);
392 * This methods turns down power a WL by performing
396 * 1. Pull interfaces used in service and change
397 * status to outOfService
400 * 2. For each of the ROADM node set target-output-power
401 * to -60dbm, wait for 20 seconds, turn power mode to off
404 * 3. Turn down power in Z to A direction and A to Z
407 * Input parameter from the olm servicePowerTurndown rpc
409 * @return true/false based on status of operation
411 public Boolean powerTurnDown(ServicePowerTurndownInput input) {
412 LOG.info("Olm-powerTurnDown initiated for input {}", input);
413 /*Starting with last element into the list Z -> A for
414 turning down A -> Z */
415 String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
416 input.getLowerSpectralSlotNumber().toString(),
417 input.getHigherSpectralSlotNumber().toString());
418 for (int i = input.getNodes().size() - 1; i >= 0; i--) {
419 String nodeId = input.getNodes().get(i).getNodeId();
420 String destTpId = input.getNodes().get(i).getDestTp();
421 String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
422 input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
424 if (destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
425 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), new BigDecimal(-60),
427 LOG.warn("Power down failed for Roadm-connection: {}", connectionNumber);
430 Thread.sleep(timer2);
431 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
432 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
435 } else if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
436 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
437 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
438 // FIXME a return false would allow sync with DEG case but makes current Unit tests fail
441 } catch (InterruptedException e) {
442 // TODO Auto-generated catch block
443 LOG.error("Olm-powerTurnDown wait failed: ",e);
451 * This method retrieves transponder OCH interface and
455 * Unique identifier for the mounted netconf- node
456 * @param interfaceName
457 * OCH interface name carrying WL
459 * Calculated transmit power
460 * @param openroadmVersion
461 * Version of openRoadm device software
462 * @return true/false based on status of operation
464 private boolean callSetTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
465 OpenroadmNodeVersion openroadmVersion) {
467 boolean powerSetupResult = false;
469 switch (openroadmVersion.getIntValue()) {
471 Optional<Interface> interfaceOptional121 =
472 openRoadmInterfaces.getInterface(nodeId, interfaceName);
473 if (interfaceOptional121.isEmpty()) {
474 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
477 powerSetupResult = PowerMgmtVersion121.setTransponderPower(nodeId, interfaceName,
478 txPower, deviceTransactionManager, interfaceOptional121.get());
481 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp
482 .Interface> interfaceOptional221 =
483 openRoadmInterfaces.getInterface(nodeId, interfaceName);
484 if (interfaceOptional221.isEmpty()) {
485 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
488 powerSetupResult = PowerMgmtVersion221.setTransponderPower(nodeId, interfaceName,
489 txPower, deviceTransactionManager, interfaceOptional221.get());
492 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp
493 .Interface> interfaceOptional710 =
494 openRoadmInterfaces.getInterface(nodeId, interfaceName);
495 if (interfaceOptional710.isEmpty()) {
496 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
499 powerSetupResult = PowerMgmtVersion710.setTransponderPower(nodeId, interfaceName,
500 txPower, deviceTransactionManager, interfaceOptional710.get());
503 LOG.error("Unrecognized OpenRoadm version");
506 } catch (OpenRoadmInterfaceException ex) {
507 LOG.error("Failed to get interface {} from node {}!", interfaceName, nodeId, ex);
510 if (!powerSetupResult) {
511 LOG.debug("Transponder power setup failed for nodeId {} on interface {}",
512 nodeId, interfaceName);
515 LOG.debug("Transponder power set up completed successfully for nodeId {} and interface {}",
516 nodeId,interfaceName);