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!";
45 private static final double MC_WIDTH_GRAN = 2 * GridConstant.GRANULARITY;
47 private long timer1 = 120000;
48 // openroadm spec value is 120000, functest value is 3000
49 private long timer2 = 20000;
50 // openroadm spec value is 20000, functest value is 2000
52 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
53 CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager) {
55 this.openRoadmInterfaces = openRoadmInterfaces;
56 this.crossConnect = crossConnect;
57 this.deviceTransactionManager = deviceTransactionManager;
60 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
61 CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager,
62 String timer1, String timer2) {
64 this.openRoadmInterfaces = openRoadmInterfaces;
65 this.crossConnect = crossConnect;
66 this.deviceTransactionManager = deviceTransactionManager;
68 this.timer1 = Long.parseLong(timer1);
69 } catch (NumberFormatException e) {
71 LOG.warn("Failed to retrieve Olm timer1 value from configuration - using default value {}",
75 this.timer2 = Long.parseLong(timer2);
76 } catch (NumberFormatException e) {
78 LOG.warn("Failed to retrieve Olm timer2 value from configuration - using default value {}",
84 * This methods measures power requirement for turning up a WL
85 * from the Spanloss at OTS transmit direction and update
86 * roadm-connection target-output-power.
89 * Input parameter from the olm servicePowerSetup rpc
91 * @return true/false based on status of operation.
93 //TODO Need to Case Optical Power mode/NodeType in case of 2.2 devices
94 public Boolean setPower(ServicePowerSetupInput input) {
95 LOG.info("Olm-setPower initiated for input {}", input);
96 String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
97 input.getLowerSpectralSlotNumber().toString(),
98 input.getHigherSpectralSlotNumber().toString());
99 for (int i = 0; i < input.getNodes().size(); i++) {
100 String nodeId = input.getNodes().get(i).getNodeId();
101 String destTpId = input.getNodes().get(i).getDestTp();
102 Optional<Nodes> inputNodeOptional = OlmUtils.getNode(nodeId, this.db);
103 if (inputNodeOptional.isEmpty()
104 || inputNodeOptional.get().getNodeInfo().getNodeType() == null) {
105 LOG.error("OLM-PowerMgmtImpl : Error node type cannot be retrieved for node {}", nodeId);
108 Nodes inputNode = inputNodeOptional.get();
109 OpenroadmNodeVersion openroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion();
111 switch (inputNode.getNodeInfo().getNodeType()) {
113 if (destTpId == null) {
116 LOG.info("Getting data from input node {}", inputNode.getNodeInfo().getNodeType());
117 LOG.info("Getting mapping data for node is {}",
118 inputNode.nonnullMapping().values().stream().filter(o -> o.key()
119 .equals(new MappingKey(destTpId))).findFirst().toString());
120 // If its not A-End transponder
121 if (!destTpId.toUpperCase(Locale.getDefault()).contains("NETWORK")) {
122 LOG.info("{} is a drop node. Net power settings needed", nodeId);
126 BigDecimal powerVal = getXpdrPowerValue(
127 inputNode, destTpId, nodeId, openroadmVersion.getIntValue(),
128 input.getNodes().get(i + 1).getSrcTp(), input.getNodes().get(i + 1).getNodeId());
129 if (powerVal == null) {
133 String interfaceName = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
134 destTpId, spectralSlotName);
135 if (!callSetTransponderPower(nodeId, interfaceName, powerVal, openroadmVersion)) {
136 LOG.info("Transponder OCH connection: {} power update failed ", interfaceName);
139 LOG.info("Transponder OCH connection: {} power updated ", interfaceName);
141 LOG.info("Now going in sleep mode");
142 Thread.sleep(timer1);
143 } catch (InterruptedException e) {
144 LOG.info("Transponder warmup failed for OCH connection: {}", interfaceName, e);
145 // FIXME shouldn't it be LOG.warn or LOG.error?
146 // or maybe this try/catch block can simply be removed
150 LOG.info("This is a roadm {} device", openroadmVersion.getName());
151 String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
152 input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
153 LOG.info("Connection number is {}", connectionNumber);
155 // If Drop node leave node is power mode
156 if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
157 LOG.info("Setting power at drop node");
158 crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), null, connectionNumber);
161 if (!destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
164 // If Degree is transmitting end then set power
165 Optional<Mapping> mappingObjectOptional = inputNode.nonnullMapping()
166 .values().stream().filter(o -> o.key()
167 .equals(new MappingKey(destTpId))).findFirst();
168 if (mappingObjectOptional.isEmpty()) {
171 // TODO can it be return false rather than continue?
172 // in that case, mappingObjectOptional could be moved inside method getSpanLossTx()
173 LOG.info("Dest point is Degree {}", mappingObjectOptional.get());
174 BigDecimal spanLossTx = getSpanLossTx(mappingObjectOptional.get().getSupportingOts(),
175 destTpId, nodeId, openroadmVersion.getIntValue());
177 LOG.info("Spanloss TX is {}", spanLossTx);
178 // TODO: The span-loss limits should be obtained from optical specifications
179 if (spanLossTx == null || spanLossTx.intValue() <= 0 || spanLossTx.intValue() > 27) {
180 LOG.error("Power Value is null: spanLossTx null or out of openROADM range ]0,27] {}",
184 BigDecimal powerValue = getRdmPowerValue(spanLossTx, input);
186 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), powerValue,
188 LOG.info("Set Power failed for Roadm-connection: {} on Node: {}",
189 connectionNumber, nodeId);
190 // FIXME shouldn't it be LOG.error
193 LOG.info("Roadm-connection: {} updated ", connectionNumber);
194 Thread.sleep(timer2);
195 // TODO make this timer value configurable via OSGi blueprint
196 // although the value recommended by the white paper is 20 seconds.
197 // At least one vendor product needs 60 seconds
198 // because it is not supporting GainLoss with target-output-power.
200 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.GainLoss.getName(), powerValue,
202 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}",
204 // FIXME no return false in that case?
206 } catch (InterruptedException e) {
207 LOG.error("Olm-setPower wait failed :", e);
212 LOG.error("OLM-PowerMgmtImpl : Error with node type for node {}", nodeId);
219 private Map<String, Double> getTxPowerRangeMap(Nodes inputNode, String destTpId, String nodeId,
220 Integer openroadmVersion) {
222 Optional<Mapping> mappingObject = inputNode.nonnullMapping().values().stream()
223 .filter(o -> o.key().equals(new MappingKey(destTpId))).findFirst();
224 if (mappingObject.isEmpty()) {
225 LOG.info("Mapping object not found for nodeId: {}", nodeId);
226 // FIXME shouldn't it be LOG.error ?
228 // return null here means return false in setPower()
229 // TODO Align protections with getSRGRxPowerRangeMap
232 String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
233 String portName = mappingObject.get().getSupportingPort();
234 switch (openroadmVersion) {
236 return PowerMgmtVersion121.getXponderPowerRange(circuitPackName, portName,
237 nodeId, deviceTransactionManager);
239 return PowerMgmtVersion221.getXponderPowerRange(circuitPackName, portName,
240 nodeId, deviceTransactionManager);
242 return PowerMgmtVersion710.getXponderPowerRange(circuitPackName, portName,
243 nodeId, deviceTransactionManager);
245 LOG.error("Unrecognized OpenRoadm version");
246 return new HashMap<>();
247 // FIXME shouldn't it lead to a return false in setPower()?
252 private Map<String, Double> getSRGRxPowerRangeMap(String srgId, String nodeId, Integer openroadmVersion) {
254 Optional<Nodes> inputNode = OlmUtils.getNode(nodeId, this.db);
255 int rdmOpenroadmVersion =
256 inputNode.isPresent()
257 ? inputNode.get().getNodeInfo().getOpenroadmVersion().getIntValue()
259 Optional<Mapping> mappingObject = inputNode
260 .flatMap(node -> node.nonnullMapping().values().stream()
261 .filter(o -> o.key().equals(new MappingKey(srgId))).findFirst());
263 if (mappingObject.isEmpty()) {
264 return new HashMap<>();
265 // FIXME shouldn't it lead to a return false in setPower() ?
268 String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
269 String portName = mappingObject.get().getSupportingPort();
270 switch (rdmOpenroadmVersion) {
272 return PowerMgmtVersion121.getSRGRxPowerRange(nodeId, srgId,
273 deviceTransactionManager, circuitPackName, portName);
275 return PowerMgmtVersion221.getSRGRxPowerRange(nodeId, srgId,
276 deviceTransactionManager, circuitPackName, portName);
278 return PowerMgmtVersion710.getSRGRxPowerRange(nodeId, srgId,
279 deviceTransactionManager, circuitPackName, portName);
281 LOG.error("Unrecognized OpenRoadm version");
283 //return null here means return false in setPower()
284 // TODO Align protections with getTxPowerRangeMap
288 private BigDecimal getSpanLossTx(String supportingOts, String destTpId, String nodeId, Integer openroadmVersion) {
290 switch (openroadmVersion) {
292 Optional<Interface> interfaceOpt =
293 this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
294 if (interfaceOpt.isEmpty()) {
295 LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
298 if (interfaceOpt.get().augmentation(Interface1.class).getOts()
299 .getSpanLossTransmit() == null) {
300 LOG.error("interface {} has no spanloss value", interfaceOpt.get().getName());
303 return interfaceOpt.get()
304 .augmentation(Interface1.class)
305 .getOts().getSpanLossTransmit().getValue();
307 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019
308 .interfaces.grp.Interface> interfaceOpt1 =
309 this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
310 if (interfaceOpt1.isEmpty()) {
311 LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
314 if (interfaceOpt1.get().augmentation(org.opendaylight.yang.gen.v1.http.org
315 .openroadm.optical.transport.interfaces.rev181019.Interface1.class).getOts()
316 .getSpanLossTransmit() == null) {
317 LOG.error("interface {} has no spanloss value", interfaceOpt1.get().getName());
320 return interfaceOpt1.get()
321 .augmentation(org.opendaylight.yang.gen.v1.http.org
322 .openroadm.optical.transport.interfaces.rev181019.Interface1.class)
323 .getOts().getSpanLossTransmit().getValue();
328 } catch (OpenRoadmInterfaceException ex) {
329 LOG.error("Failed to get interface {} from node {}!",
330 supportingOts, nodeId, ex);
332 } catch (IllegalArgumentException ex) {
333 LOG.error("Failed to get non existing interface {} from node {}!",
334 supportingOts, nodeId);
339 private BigDecimal getXpdrPowerValue(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion,
340 String srgId, String nextNodeId) {
342 Map<String, Double> txPowerRangeMap = getTxPowerRangeMap(inputNode, destTpId, nodeId, openroadmVersion);
343 if (txPowerRangeMap == null) {
345 // return null here means return false in setPower()
347 BigDecimal powerVal =
348 openroadmVersion == 3 ? DEFAULT_TPDR_PWR_400G : DEFAULT_TPDR_PWR_100G;
349 if (txPowerRangeMap.isEmpty()) {
350 LOG.info("Tranponder range not available setting to default power for nodeId: {}", nodeId);
354 Map<String, Double> rxSRGPowerRangeMap = getSRGRxPowerRangeMap(srgId, nextNodeId, openroadmVersion);
355 if (rxSRGPowerRangeMap == null) {
357 // return null here means return false in setPower()
358 // TODO empty txPowerRangeMap + null rxSRGPowerRangeMap is allowed
359 // => confirm this behavior is OK
361 if (rxSRGPowerRangeMap.isEmpty()) {
362 LOG.info("SRG Power Range not found, setting the Transponder range to default");
366 powerVal = new BigDecimal(txPowerRangeMap.get("MaxTx"))
367 .min(new BigDecimal(rxSRGPowerRangeMap.get("MaxRx")));
368 LOG.info("Calculated Transponder Power value is {}" , powerVal);
373 private BigDecimal getRdmPowerValue(BigDecimal spanLossTx, ServicePowerSetupInput input) {
374 // TODO: These values will be obtained from the specifications
375 // power-value here refers to the Pin[50GHz]
376 BigDecimal powerValue;
377 if (spanLossTx.doubleValue() >= 23.0) {
378 powerValue = BigDecimal.valueOf(2.0);
379 } else if (spanLossTx.doubleValue() >= 8.0) {
380 powerValue = BigDecimal.valueOf(- (8.0 - spanLossTx.doubleValue()) / 3.0 - 3.0);
381 } else if (spanLossTx.doubleValue() >= 6.0) {
382 powerValue = BigDecimal.valueOf(-3.0);
384 powerValue = spanLossTx.subtract(BigDecimal.valueOf(9));
386 // target-output-power yang precision is 2, so we limit here to 2
387 powerValue = powerValue.setScale(2, RoundingMode.CEILING);
388 LOG.info("P1[50GHz]={} dBm for spanloss {} based on OpenROADM-5.0 specs power target mask", powerValue,
390 // we work at constant power spectral density (50 GHz channel width @-20dBm=37.5GHz)
391 // 87.5 GHz channel width @-20dBm=75GHz
392 if (input.getMcWidth() != null) {
393 // Units of MC-wdith are in GHz, meaning it should be 40/50/87.5GHz
394 // TODO: Should we validate this units before proceeding?
395 LOG.debug("Input Grid size is {}",input.getMcWidth().getValue());
397 // We round-off the mc-width to the nearest grid-value based on the granularity of 12.5 GHz
398 double nbrMcSlots = Math.ceil(input.getMcWidth().getValue().doubleValue() / MC_WIDTH_GRAN);
399 LOG.debug("Nearest (ceil) number of slots {}", nbrMcSlots);
400 BigDecimal mcWidth = new BigDecimal(MC_WIDTH_GRAN * nbrMcSlots);
401 LOG.info("Given mc-width={}, Rounded mc-width={}", input.getMcWidth().getValue(), mcWidth);
403 BigDecimal logVal = mcWidth.divide(new BigDecimal(50));
404 double pdsVal = 10 * Math.log10(logVal.doubleValue());
405 // Addition of PSD value will give Pin[87.5 GHz]
406 powerValue = powerValue.add(new BigDecimal(pdsVal, new MathContext(3,
407 RoundingMode.HALF_EVEN)));
408 LOG.info("P1[{}GHz]={} dB will be used for OSNR calculation", mcWidth, powerValue);
410 // FIXME compliancy with OpenROADM MSA and approximations used -- should be addressed with powermask update
411 // cf JIRA ticket https://jira.opendaylight.org/browse/TRNSPRTPCE-494
412 LOG.info("The power value is {} for spanloss {}", powerValue, spanLossTx);
417 * This methods turns down power a WL by performing
421 * 1. Pull interfaces used in service and change
422 * status to outOfService
425 * 2. For each of the ROADM node set target-output-power
426 * to -60dbm, wait for 20 seconds, turn power mode to off
429 * 3. Turn down power in Z to A direction and A to Z
432 * Input parameter from the olm servicePowerTurndown rpc
434 * @return true/false based on status of operation
436 public Boolean powerTurnDown(ServicePowerTurndownInput input) {
437 LOG.info("Olm-powerTurnDown initiated for input {}", input);
438 /*Starting with last element into the list Z -> A for
439 turning down A -> Z */
440 String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
441 input.getLowerSpectralSlotNumber().toString(),
442 input.getHigherSpectralSlotNumber().toString());
443 for (int i = input.getNodes().size() - 1; i >= 0; i--) {
444 String nodeId = input.getNodes().get(i).getNodeId();
445 String destTpId = input.getNodes().get(i).getDestTp();
446 String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
447 input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
449 if (destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
450 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), new BigDecimal(-60),
452 LOG.warn("Power down failed for Roadm-connection: {}", connectionNumber);
455 Thread.sleep(timer2);
456 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
457 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
460 } else if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
461 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
462 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
463 // FIXME a return false would allow sync with DEG case but makes current Unit tests fail
466 } catch (InterruptedException e) {
467 // TODO Auto-generated catch block
468 LOG.error("Olm-powerTurnDown wait failed: ",e);
476 * This method retrieves transponder OCH interface and
480 * Unique identifier for the mounted netconf- node
481 * @param interfaceName
482 * OCH interface name carrying WL
484 * Calculated transmit power
485 * @param openroadmVersion
486 * Version of openRoadm device software
487 * @return true/false based on status of operation
489 private boolean callSetTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
490 OpenroadmNodeVersion openroadmVersion) {
492 boolean powerSetupResult = false;
494 switch (openroadmVersion.getIntValue()) {
496 Optional<Interface> interfaceOptional121 =
497 openRoadmInterfaces.getInterface(nodeId, interfaceName);
498 if (interfaceOptional121.isEmpty()) {
499 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
502 powerSetupResult = PowerMgmtVersion121.setTransponderPower(nodeId, interfaceName,
503 txPower, deviceTransactionManager, interfaceOptional121.get());
506 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp
507 .Interface> interfaceOptional221 =
508 openRoadmInterfaces.getInterface(nodeId, interfaceName);
509 if (interfaceOptional221.isEmpty()) {
510 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
513 powerSetupResult = PowerMgmtVersion221.setTransponderPower(nodeId, interfaceName,
514 txPower, deviceTransactionManager, interfaceOptional221.get());
517 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp
518 .Interface> interfaceOptional710 =
519 openRoadmInterfaces.getInterface(nodeId, interfaceName);
520 if (interfaceOptional710.isEmpty()) {
521 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
524 powerSetupResult = PowerMgmtVersion710.setTransponderPower(nodeId, interfaceName,
525 txPower, deviceTransactionManager, interfaceOptional710.get());
528 LOG.error("Unrecognized OpenRoadm version");
531 } catch (OpenRoadmInterfaceException ex) {
532 LOG.error("Failed to get interface {} from node {}!", interfaceName, nodeId, ex);
535 if (!powerSetupResult) {
536 LOG.debug("Transponder power setup failed for nodeId {} on interface {}",
537 nodeId, interfaceName);
540 LOG.debug("Transponder power set up completed successfully for nodeId {} and interface {}",
541 nodeId,interfaceName);