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.rev220316.OpenroadmNodeVersion;
27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.Mapping;
28 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.MappingKey;
29 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.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.opendaylight.yangtools.yang.common.Decimal64;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
37 public class PowerMgmtImpl implements PowerMgmt {
38 private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtImpl.class);
39 private final DataBroker db;
40 private final OpenRoadmInterfaces openRoadmInterfaces;
41 private final CrossConnect crossConnect;
42 private final DeviceTransactionManager deviceTransactionManager;
43 private static final BigDecimal DEFAULT_TPDR_PWR_100G = new BigDecimal(-5);
44 private static final BigDecimal DEFAULT_TPDR_PWR_400G = new BigDecimal(0);
45 private static final String INTERFACE_NOT_PRESENT = "Interface {} on node {} is not present!";
46 private static final double MC_WIDTH_GRAN = 2 * GridConstant.GRANULARITY;
48 private long timer1 = 120000;
49 // openroadm spec value is 120000, functest value is 3000
50 private long timer2 = 20000;
51 // openroadm spec value is 20000, functest value is 2000
53 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
54 CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager) {
56 this.openRoadmInterfaces = openRoadmInterfaces;
57 this.crossConnect = crossConnect;
58 this.deviceTransactionManager = deviceTransactionManager;
61 public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
62 CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager,
63 String timer1, String timer2) {
65 this.openRoadmInterfaces = openRoadmInterfaces;
66 this.crossConnect = crossConnect;
67 this.deviceTransactionManager = deviceTransactionManager;
69 this.timer1 = Long.parseLong(timer1);
70 } catch (NumberFormatException e) {
72 LOG.warn("Failed to retrieve Olm timer1 value from configuration - using default value {}",
76 this.timer2 = Long.parseLong(timer2);
77 } catch (NumberFormatException e) {
79 LOG.warn("Failed to retrieve Olm timer2 value from configuration - using default value {}",
85 * This methods measures power requirement for turning up a WL
86 * from the Spanloss at OTS transmit direction and update
87 * roadm-connection target-output-power.
90 * Input parameter from the olm servicePowerSetup rpc
92 * @return true/false based on status of operation.
94 //TODO Need to Case Optical Power mode/NodeType in case of 2.2 devices
95 public Boolean setPower(ServicePowerSetupInput input) {
96 LOG.info("Olm-setPower initiated for input {}", input);
97 String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
98 input.getLowerSpectralSlotNumber().toString(),
99 input.getHigherSpectralSlotNumber().toString());
100 for (int i = 0; i < input.getNodes().size(); i++) {
101 String nodeId = input.getNodes().get(i).getNodeId();
102 String destTpId = input.getNodes().get(i).getDestTp();
103 Optional<Nodes> inputNodeOptional = OlmUtils.getNode(nodeId, this.db);
104 if (inputNodeOptional.isEmpty()
105 || inputNodeOptional.get().getNodeInfo().getNodeType() == null) {
106 LOG.error("OLM-PowerMgmtImpl : Error node type cannot be retrieved for node {}", nodeId);
109 Nodes inputNode = inputNodeOptional.get();
110 OpenroadmNodeVersion openroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion();
112 switch (inputNode.getNodeInfo().getNodeType()) {
114 if (destTpId == null) {
117 LOG.info("Getting data from input node {}", inputNode.getNodeInfo().getNodeType());
118 LOG.info("Getting mapping data for node is {}",
119 inputNode.nonnullMapping().values().stream().filter(o -> o.key()
120 .equals(new MappingKey(destTpId))).findFirst().toString());
121 // If its not A-End transponder
122 if (!destTpId.toUpperCase(Locale.getDefault()).contains("NETWORK")) {
123 LOG.info("{} is a drop node. Net power settings needed", nodeId);
127 BigDecimal powerVal = getXpdrPowerValue(
128 inputNode, destTpId, nodeId, openroadmVersion.getIntValue(),
129 input.getNodes().get(i + 1).getSrcTp(), input.getNodes().get(i + 1).getNodeId());
130 if (powerVal == null) {
134 String interfaceName = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
135 destTpId, spectralSlotName);
136 if (!callSetTransponderPower(nodeId, interfaceName, powerVal, openroadmVersion)) {
137 LOG.info("Transponder OCH connection: {} power update failed ", interfaceName);
140 LOG.info("Transponder OCH connection: {} power updated ", interfaceName);
142 LOG.info("Now going in sleep mode");
143 Thread.sleep(timer1);
144 } catch (InterruptedException e) {
145 LOG.info("Transponder warmup failed for OCH connection: {}", interfaceName, e);
146 // FIXME shouldn't it be LOG.warn or LOG.error?
147 // or maybe this try/catch block can simply be removed
151 LOG.info("This is a roadm {} device", openroadmVersion.getName());
152 String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
153 input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
154 LOG.info("Connection number is {}", connectionNumber);
156 // If Drop node leave node is power mode
157 if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
158 LOG.info("Setting power at drop node");
159 crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), null, connectionNumber);
162 if (!destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
165 // If Degree is transmitting end then set power
166 Optional<Mapping> mappingObjectOptional = inputNode.nonnullMapping()
167 .values().stream().filter(o -> o.key()
168 .equals(new MappingKey(destTpId))).findFirst();
169 if (mappingObjectOptional.isEmpty()) {
172 // TODO can it be return false rather than continue?
173 // in that case, mappingObjectOptional could be moved inside method getSpanLossTx()
174 LOG.info("Dest point is Degree {}", mappingObjectOptional.get());
175 BigDecimal spanLossTx = getSpanLossTx(mappingObjectOptional.get().getSupportingOts(),
176 destTpId, nodeId, openroadmVersion.getIntValue());
178 LOG.info("Spanloss TX is {}", spanLossTx);
179 // TODO: The span-loss limits should be obtained from optical specifications
180 if (spanLossTx == null || spanLossTx.intValue() <= 0 || spanLossTx.intValue() > 27) {
181 LOG.error("Power Value is null: spanLossTx null or out of openROADM range ]0,27] {}",
185 Decimal64 powerValue = Decimal64.valueOf(getRdmPowerValue(spanLossTx, input));
187 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), powerValue,
189 LOG.info("Set Power failed for Roadm-connection: {} on Node: {}",
190 connectionNumber, nodeId);
191 // FIXME shouldn't it be LOG.error
194 LOG.info("Roadm-connection: {} updated ", connectionNumber);
195 Thread.sleep(timer2);
196 // TODO make this timer value configurable via OSGi blueprint
197 // although the value recommended by the white paper is 20 seconds.
198 // At least one vendor product needs 60 seconds
199 // because it is not supporting GainLoss with target-output-power.
201 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.GainLoss.getName(), powerValue,
203 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}",
205 // FIXME no return false in that case?
207 } catch (InterruptedException e) {
208 LOG.error("Olm-setPower wait failed :", e);
213 LOG.error("OLM-PowerMgmtImpl : Error with node type for node {}", nodeId);
220 private Map<String, Double> getTxPowerRangeMap(Nodes inputNode, String destTpId, String nodeId,
221 Integer openroadmVersion) {
223 Optional<Mapping> mappingObject = inputNode.nonnullMapping().values().stream()
224 .filter(o -> o.key().equals(new MappingKey(destTpId))).findFirst();
225 if (mappingObject.isEmpty()) {
226 LOG.info("Mapping object not found for nodeId: {}", nodeId);
227 // FIXME shouldn't it be LOG.error ?
229 // return null here means return false in setPower()
230 // TODO Align protections with getSRGRxPowerRangeMap
233 String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
234 String portName = mappingObject.get().getSupportingPort();
235 switch (openroadmVersion) {
237 return PowerMgmtVersion121.getXponderPowerRange(circuitPackName, portName,
238 nodeId, deviceTransactionManager);
240 return PowerMgmtVersion221.getXponderPowerRange(circuitPackName, portName,
241 nodeId, deviceTransactionManager);
243 return PowerMgmtVersion710.getXponderPowerRange(circuitPackName, portName,
244 nodeId, deviceTransactionManager);
246 LOG.error("Unrecognized OpenRoadm version");
247 return new HashMap<>();
248 // FIXME shouldn't it lead to a return false in setPower()?
253 private Map<String, Double> getSRGRxPowerRangeMap(String srgId, String nodeId, Integer openroadmVersion) {
255 Optional<Nodes> inputNode = OlmUtils.getNode(nodeId, this.db);
256 int rdmOpenroadmVersion =
257 inputNode.isPresent()
258 ? inputNode.get().getNodeInfo().getOpenroadmVersion().getIntValue()
260 Optional<Mapping> mappingObject = inputNode
261 .flatMap(node -> node.nonnullMapping().values().stream()
262 .filter(o -> o.key().equals(new MappingKey(srgId))).findFirst());
264 if (mappingObject.isEmpty()) {
265 return new HashMap<>();
266 // FIXME shouldn't it lead to a return false in setPower() ?
269 String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
270 String portName = mappingObject.get().getSupportingPort();
271 switch (rdmOpenroadmVersion) {
273 return PowerMgmtVersion121.getSRGRxPowerRange(nodeId, srgId,
274 deviceTransactionManager, circuitPackName, portName);
276 return PowerMgmtVersion221.getSRGRxPowerRange(nodeId, srgId,
277 deviceTransactionManager, circuitPackName, portName);
279 return PowerMgmtVersion710.getSRGRxPowerRange(nodeId, srgId,
280 deviceTransactionManager, circuitPackName, portName);
282 LOG.error("Unrecognized OpenRoadm version");
284 //return null here means return false in setPower()
285 // TODO Align protections with getTxPowerRangeMap
289 private BigDecimal getSpanLossTx(String supportingOts, String destTpId, String nodeId, Integer openroadmVersion) {
291 switch (openroadmVersion) {
293 Optional<Interface> interfaceOpt =
294 this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
295 if (interfaceOpt.isEmpty()) {
296 LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
299 if (interfaceOpt.get().augmentation(Interface1.class).getOts()
300 .getSpanLossTransmit() == null) {
301 LOG.error("interface {} has no spanloss value", interfaceOpt.get().getName());
304 return interfaceOpt.get()
305 .augmentation(Interface1.class)
306 .getOts().getSpanLossTransmit().getValue().decimalValue();
308 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019
309 .interfaces.grp.Interface> interfaceOpt1 =
310 this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
311 if (interfaceOpt1.isEmpty()) {
312 LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
315 if (interfaceOpt1.get().augmentation(org.opendaylight.yang.gen.v1.http.org
316 .openroadm.optical.transport.interfaces.rev181019.Interface1.class).getOts()
317 .getSpanLossTransmit() == null) {
318 LOG.error("interface {} has no spanloss value", interfaceOpt1.get().getName());
321 return interfaceOpt1.get()
322 .augmentation(org.opendaylight.yang.gen.v1.http.org
323 .openroadm.optical.transport.interfaces.rev181019.Interface1.class)
324 .getOts().getSpanLossTransmit().getValue().decimalValue();
329 } catch (OpenRoadmInterfaceException ex) {
330 LOG.error("Failed to get interface {} from node {}!",
331 supportingOts, nodeId, ex);
333 } catch (IllegalArgumentException ex) {
334 LOG.error("Failed to get non existing interface {} from node {}!",
335 supportingOts, nodeId);
340 private BigDecimal getXpdrPowerValue(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion,
341 String srgId, String nextNodeId) {
343 Map<String, Double> txPowerRangeMap = getTxPowerRangeMap(inputNode, destTpId, nodeId, openroadmVersion);
344 if (txPowerRangeMap == null) {
346 // return null here means return false in setPower()
348 BigDecimal powerVal =
349 openroadmVersion == 3 ? DEFAULT_TPDR_PWR_400G : DEFAULT_TPDR_PWR_100G;
350 if (txPowerRangeMap.isEmpty()) {
351 LOG.info("Tranponder range not available setting to default power for nodeId: {}", nodeId);
355 Map<String, Double> rxSRGPowerRangeMap = getSRGRxPowerRangeMap(srgId, nextNodeId, openroadmVersion);
356 if (rxSRGPowerRangeMap == null) {
358 // return null here means return false in setPower()
359 // TODO empty txPowerRangeMap + null rxSRGPowerRangeMap is allowed
360 // => confirm this behavior is OK
362 if (rxSRGPowerRangeMap.isEmpty()) {
363 LOG.info("SRG Power Range not found, setting the Transponder range to default");
367 powerVal = new BigDecimal(txPowerRangeMap.get("MaxTx"))
368 .min(new BigDecimal(rxSRGPowerRangeMap.get("MaxRx")));
369 LOG.info("Calculated Transponder Power value is {}" , powerVal);
374 private BigDecimal getRdmPowerValue(BigDecimal spanLossTx, ServicePowerSetupInput input) {
375 // TODO: These values will be obtained from the specifications
376 // power-value here refers to the Pin[50GHz]
377 BigDecimal powerValue;
378 if (spanLossTx.doubleValue() >= 23.0) {
379 powerValue = BigDecimal.valueOf(2.0);
380 } else if (spanLossTx.doubleValue() >= 8.0) {
381 powerValue = BigDecimal.valueOf(- (8.0 - spanLossTx.doubleValue()) / 3.0 - 3.0);
382 } else if (spanLossTx.doubleValue() >= 6.0) {
383 powerValue = BigDecimal.valueOf(-3.0);
385 powerValue = spanLossTx.subtract(BigDecimal.valueOf(9));
387 BigDecimal mcWidth = new BigDecimal(50);
388 // we work at constant power spectral density (50 GHz channel width @-20dBm=37.5GHz)
389 // 87.5 GHz channel width @-20dBm=75GHz
390 if (input.getMcWidth() != null) {
391 // Units of MC-width are in GHz, meaning it should be 40/50/87.5GHz
392 // TODO: Should we validate this units before proceeding?
393 LOG.debug("Input Grid size is {}", input.getMcWidth().getValue());
395 // We round-off the mc-width to the nearest grid-value based on the granularity of 12.5 GHz
396 double nbrMcSlots = Math.ceil(input.getMcWidth().getValue().doubleValue() / MC_WIDTH_GRAN);
397 LOG.debug("Nearest (ceil) number of slots {}", nbrMcSlots);
398 mcWidth = new BigDecimal(MC_WIDTH_GRAN * nbrMcSlots);
399 LOG.debug("Given mc-width={}, Rounded mc-width={}", input.getMcWidth().getValue(), mcWidth);
401 BigDecimal logVal = mcWidth.divide(new BigDecimal(50));
402 double pdsVal = 10 * Math.log10(logVal.doubleValue());
403 // Addition of PSD value will give Pin[87.5 GHz]
404 powerValue = powerValue.add(new BigDecimal(pdsVal, new MathContext(3, RoundingMode.HALF_EVEN)));
406 // FIXME compliancy with OpenROADM MSA and approximations used -- should be addressed with powermask update
407 // cf JIRA ticket https://jira.opendaylight.org/browse/TRNSPRTPCE-494
408 powerValue = powerValue.setScale(2, RoundingMode.CEILING);
409 // target-output-power yang precision is 2, so we limit here to 2
410 LOG.info("The power value is P1[{}GHz]={} dB for spanloss {}", mcWidth, powerValue, spanLossTx);
415 * This methods turns down power a WL by performing
419 * 1. Pull interfaces used in service and change
420 * status to outOfService
423 * 2. For each of the ROADM node set target-output-power
424 * to -60dbm, wait for 20 seconds, turn power mode to off
427 * 3. Turn down power in Z to A direction and A to Z
430 * Input parameter from the olm servicePowerTurndown rpc
432 * @return true/false based on status of operation
434 public Boolean powerTurnDown(ServicePowerTurndownInput input) {
435 LOG.info("Olm-powerTurnDown initiated for input {}", input);
436 /*Starting with last element into the list Z -> A for
437 turning down A -> Z */
438 String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
439 input.getLowerSpectralSlotNumber().toString(),
440 input.getHigherSpectralSlotNumber().toString());
441 for (int i = input.getNodes().size() - 1; i >= 0; i--) {
442 String nodeId = input.getNodes().get(i).getNodeId();
443 String destTpId = input.getNodes().get(i).getDestTp();
444 String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
445 input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
447 if (destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
448 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(),
449 Decimal64.valueOf("-60"), connectionNumber)) {
450 LOG.warn("Power down failed for Roadm-connection: {}", connectionNumber);
453 Thread.sleep(timer2);
454 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
455 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
458 } else if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
459 if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
460 LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
461 // FIXME a return false would allow sync with DEG case but makes current Unit tests fail
464 } catch (InterruptedException e) {
465 // TODO Auto-generated catch block
466 LOG.error("Olm-powerTurnDown wait failed: ",e);
474 * This method retrieves transponder OCH interface and
478 * Unique identifier for the mounted netconf- node
479 * @param interfaceName
480 * OCH interface name carrying WL
482 * Calculated transmit power
483 * @param openroadmVersion
484 * Version of openRoadm device software
485 * @return true/false based on status of operation
487 private boolean callSetTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
488 OpenroadmNodeVersion openroadmVersion) {
490 boolean powerSetupResult = false;
492 switch (openroadmVersion.getIntValue()) {
494 Optional<Interface> interfaceOptional121 =
495 openRoadmInterfaces.getInterface(nodeId, interfaceName);
496 if (interfaceOptional121.isEmpty()) {
497 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
500 powerSetupResult = PowerMgmtVersion121.setTransponderPower(nodeId, interfaceName,
501 txPower, deviceTransactionManager, interfaceOptional121.get());
504 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp
505 .Interface> interfaceOptional221 =
506 openRoadmInterfaces.getInterface(nodeId, interfaceName);
507 if (interfaceOptional221.isEmpty()) {
508 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
511 powerSetupResult = PowerMgmtVersion221.setTransponderPower(nodeId, interfaceName,
512 txPower, deviceTransactionManager, interfaceOptional221.get());
515 Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp
516 .Interface> interfaceOptional710 =
517 openRoadmInterfaces.getInterface(nodeId, interfaceName);
518 if (interfaceOptional710.isEmpty()) {
519 LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
522 powerSetupResult = PowerMgmtVersion710.setTransponderPower(nodeId, interfaceName,
523 txPower, deviceTransactionManager, interfaceOptional710.get());
526 LOG.error("Unrecognized OpenRoadm version");
529 } catch (OpenRoadmInterfaceException ex) {
530 LOG.error("Failed to get interface {} from node {}!", interfaceName, nodeId, ex);
533 if (!powerSetupResult) {
534 LOG.debug("Transponder power setup failed for nodeId {} on interface {}",
535 nodeId, interfaceName);
538 LOG.debug("Transponder power set up completed successfully for nodeId {} and interface {}",
539 nodeId,interfaceName);