Refactor OLM PowerMgmtImpl class
[transportpce.git] / olm / src / main / java / org / opendaylight / transportpce / olm / power / PowerMgmtImpl.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.olm.power;
10 import java.math.BigDecimal;
11 import java.util.HashMap;
12 import java.util.Locale;
13 import java.util.Map;
14 import java.util.Optional;
15 import org.opendaylight.mdsal.binding.api.DataBroker;
16 import org.opendaylight.transportpce.common.crossconnect.CrossConnect;
17 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
18 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
19 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
20 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaces;
21 import org.opendaylight.transportpce.olm.util.OlmUtils;
22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerSetupInput;
23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerTurndownInput;
24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.OpenroadmNodeVersion;
25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.mapping.Mapping;
26 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.mapping.MappingKey;
27 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.network.Nodes;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.OpticalControlMode;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.transport.interfaces.rev161014.Interface1;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
33
34 public class PowerMgmtImpl implements PowerMgmt {
35     private static final Logger LOG = LoggerFactory.getLogger(PowerMgmtImpl.class);
36     private final DataBroker db;
37     private final OpenRoadmInterfaces openRoadmInterfaces;
38     private final CrossConnect crossConnect;
39     private final DeviceTransactionManager deviceTransactionManager;
40     private static final BigDecimal DEFAULT_TPDR_PWR_100G = new BigDecimal(-5);
41     private static final BigDecimal DEFAULT_TPDR_PWR_400G = new BigDecimal(0);
42     private static final String INTERFACE_NOT_PRESENT = "Interface {} on node {} is not present!";
43
44     public PowerMgmtImpl(DataBroker db, OpenRoadmInterfaces openRoadmInterfaces,
45                          CrossConnect crossConnect, DeviceTransactionManager deviceTransactionManager) {
46         this.db = db;
47         this.openRoadmInterfaces = openRoadmInterfaces;
48         this.crossConnect = crossConnect;
49         this.deviceTransactionManager = deviceTransactionManager;
50     }
51
52     /**
53      * This methods measures power requirement for turning up a WL
54      * from the Spanloss at OTS transmit direction and update
55      * roadm-connection target-output-power.
56      *
57      * @param input
58      *            Input parameter from the olm servicePowerSetup rpc
59      *
60      * @return true/false based on status of operation.
61      */
62     //TODO Need to Case Optical Power mode/NodeType in case of 2.2 devices
63     public Boolean setPower(ServicePowerSetupInput input) {
64         LOG.info("Olm-setPower initiated for input {}", input);
65         String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
66                 input.getLowerSpectralSlotNumber().toString(),
67                 input.getHigherSpectralSlotNumber().toString());
68         for (int i = 0; i < input.getNodes().size(); i++) {
69             String nodeId = input.getNodes().get(i).getNodeId();
70             String destTpId = input.getNodes().get(i).getDestTp();
71             Optional<Nodes> inputNodeOptional = OlmUtils.getNode(nodeId, this.db);
72             if (inputNodeOptional.isEmpty()
73                     || inputNodeOptional.get().getNodeInfo().getNodeType() == null) {
74                 LOG.error("OLM-PowerMgmtImpl : Error node type cannot be retrieved for node {}", nodeId);
75                 continue;
76             }
77             Nodes inputNode = inputNodeOptional.get();
78             OpenroadmNodeVersion openroadmVersion = inputNode.getNodeInfo().getOpenroadmVersion();
79
80             switch (inputNode.getNodeInfo().getNodeType()) {
81                 case Xpdr:
82                     if (destTpId == null) {
83                         continue;
84                     }
85                     LOG.info("Getting data from input node {}", inputNode.getNodeInfo().getNodeType());
86                     LOG.info("Getting mapping data for node is {}",
87                         inputNode.nonnullMapping().values().stream().filter(o -> o.key()
88                          .equals(new MappingKey(destTpId))).findFirst().toString());
89                     // If its not A-End transponder
90                     if (!destTpId.toUpperCase(Locale.getDefault()).contains("NETWORK")) {
91                         LOG.info("{} is a drop node. Net power settings needed", nodeId);
92                         continue;
93                     }
94
95                     BigDecimal powerVal = getXpdrPowerValue(
96                             inputNode, destTpId, nodeId, openroadmVersion.getIntValue(),
97                             input.getNodes().get(i + 1).getSrcTp(), input.getNodes().get(i + 1).getNodeId());
98                     if (powerVal == null) {
99                         return false;
100                     }
101
102                     String interfaceName = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
103                         destTpId, spectralSlotName);
104                     if (!callSetTransponderPower(nodeId, interfaceName, powerVal, openroadmVersion)) {
105                         LOG.info("Transponder OCH connection: {} power update failed ", interfaceName);
106                         continue;
107                     }
108                     LOG.info("Transponder OCH connection: {} power updated ", interfaceName);
109                     try {
110                         LOG.info("Now going in sleep mode");
111                         Thread.sleep(OlmUtils.OLM_TIMER_1);
112                     } catch (InterruptedException e) {
113                         LOG.info("Transponder warmup failed for OCH connection: {}", interfaceName, e);
114                         // FIXME shouldn't it be LOG.warn  or LOG.error?
115                         // or maybe this try/catch block can simply be removed
116                     }
117                     break;
118                 case Rdm:
119                     LOG.info("This is a roadm {} device", openroadmVersion.getName());
120                     String connectionNumber = String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
121                             input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
122                     LOG.info("Connection number is {}", connectionNumber);
123
124                     // If Drop node leave node is power mode
125                     if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
126                         LOG.info("Setting power at drop node");
127                         crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), null, connectionNumber);
128                         continue;
129                     }
130                     if (!destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
131                         continue;
132                     }
133                     // If Degree is transmitting end then set power
134                     Optional<Mapping> mappingObjectOptional = inputNode.nonnullMapping()
135                             .values().stream().filter(o -> o.key()
136                             .equals(new MappingKey(destTpId))).findFirst();
137                     if (mappingObjectOptional.isEmpty()) {
138                         continue;
139                     }
140                     // TODO can it be return false rather than continue?
141                     // in that case, mappingObjectOptional could be moved inside method getSpanLossTx()
142                     LOG.info("Dest point is Degree {}", mappingObjectOptional.get());
143                     BigDecimal spanLossTx = getSpanLossTx(mappingObjectOptional.get().getSupportingOts(),
144                         destTpId, nodeId, openroadmVersion.getIntValue());
145
146                     LOG.info("Spanloss TX is {}", spanLossTx);
147                     if (spanLossTx == null || spanLossTx.intValue() <= 0 || spanLossTx.intValue() > 28) {
148                         LOG.error("Power Value is null: spanLossTx null or out of openROADM range ]0,28] {}",
149                                 spanLossTx);
150                         return false;
151                     }
152                     BigDecimal powerValue = getRdmPowerValue(spanLossTx, input);
153                     try {
154                         if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), powerValue,
155                                 connectionNumber)) {
156                             LOG.info("Set Power failed for Roadm-connection: {} on Node: {}",
157                                     connectionNumber, nodeId);
158                             // FIXME shouldn't it be LOG.error
159                             return false;
160                         }
161                         LOG.info("Roadm-connection: {} updated ", connectionNumber);
162                         Thread.sleep(OlmUtils.OLM_TIMER_2);
163                         // TODO make this timer value configurable via OSGi blueprint
164                         // although the value recommended by the white paper is 20 seconds.
165                         // At least one vendor product needs 60 seconds
166                         // because it is not supporting GainLoss with target-output-power.
167
168                         if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.GainLoss.getName(), powerValue,
169                                 connectionNumber)) {
170                             LOG.warn("Setting power-control mode off failed for Roadm-connection: {}",
171                                 connectionNumber);
172                             // FIXME no return false in that case?
173                         }
174                     } catch (InterruptedException e) {
175                         LOG.error("Olm-setPower wait failed :", e);
176                         return false;
177                     }
178                     break;
179                 default :
180                     LOG.error("OLM-PowerMgmtImpl : Error with node type for node {}", nodeId);
181                     break;
182             }
183         }
184         return true;
185     }
186
187     private Map<String, Double> getTxPowerRangeMap(Nodes inputNode, String destTpId, String nodeId,
188             Integer openroadmVersion) {
189
190         Optional<Mapping> mappingObject = inputNode.nonnullMapping().values().stream()
191                 .filter(o -> o.key().equals(new MappingKey(destTpId))).findFirst();
192         if (mappingObject.isEmpty()) {
193             LOG.info("Mapping object not found for nodeId: {}", nodeId);
194             // FIXME shouldn't it be LOG.error ?
195             return null;
196             // return null here means return false in setPower()
197             // TODO Align protections with getSRGRxPowerRangeMap
198         }
199
200         String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
201         String portName = mappingObject.get().getSupportingPort();
202         switch (openroadmVersion) {
203             case 1:
204                 return PowerMgmtVersion121.getXponderPowerRange(circuitPackName, portName,
205                     nodeId, deviceTransactionManager);
206             case 2:
207                 return PowerMgmtVersion221.getXponderPowerRange(circuitPackName, portName,
208                     nodeId, deviceTransactionManager);
209             case 3:
210                 return PowerMgmtVersion710.getXponderPowerRange(circuitPackName, portName,
211                     nodeId, deviceTransactionManager);
212             default:
213                 LOG.error("Unrecognized OpenRoadm version");
214                 return new HashMap<>();
215                 // FIXME shouldn't it lead to a return false in setPower()?
216         }
217     }
218
219
220     private Map<String, Double> getSRGRxPowerRangeMap(String srgId, String nodeId, Integer openroadmVersion) {
221
222         Optional<Nodes> inputNode = OlmUtils.getNode(nodeId, this.db);
223         int rdmOpenroadmVersion =
224                 inputNode.isPresent()
225                     ? inputNode.get().getNodeInfo().getOpenroadmVersion().getIntValue()
226                     : openroadmVersion;
227         Optional<Mapping> mappingObject = inputNode
228                 .flatMap(node -> node.nonnullMapping().values().stream()
229                     .filter(o -> o.key().equals(new MappingKey(srgId))).findFirst());
230
231         if (mappingObject.isEmpty()) {
232             return new HashMap<>();
233             // FIXME shouldn't it lead to a return false in setPower() ?
234         }
235
236         String circuitPackName = mappingObject.get().getSupportingCircuitPackName();
237         String portName = mappingObject.get().getSupportingPort();
238         switch (rdmOpenroadmVersion) {
239             case 1:
240                 return PowerMgmtVersion121.getSRGRxPowerRange(nodeId, srgId,
241                         deviceTransactionManager, circuitPackName, portName);
242             case 2:
243                 return PowerMgmtVersion221.getSRGRxPowerRange(nodeId, srgId,
244                         deviceTransactionManager, circuitPackName, portName);
245             case 3:
246                 return PowerMgmtVersion710.getSRGRxPowerRange(nodeId, srgId,
247                         deviceTransactionManager, circuitPackName, portName);
248             default:
249                 LOG.error("Unrecognized OpenRoadm version");
250                 return null;
251                 //return null here means return false in setPower()
252                 // TODO Align protections with getTxPowerRangeMap
253         }
254     }
255
256     private BigDecimal getSpanLossTx(String supportingOts, String destTpId, String nodeId, Integer openroadmVersion) {
257         try {
258             switch (openroadmVersion) {
259                 case 1:
260                     Optional<Interface> interfaceOpt =
261                         this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
262                     if (interfaceOpt.isEmpty()) {
263                         LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
264                         return null;
265                     }
266                     if (interfaceOpt.get().augmentation(Interface1.class).getOts()
267                             .getSpanLossTransmit() == null) {
268                         LOG.error("interface {} has no spanloss value", interfaceOpt.get().getName());
269                         return null;
270                     }
271                     return interfaceOpt.get()
272                             .augmentation(Interface1.class)
273                             .getOts().getSpanLossTransmit().getValue();
274                 case 2:
275                     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019
276                             .interfaces.grp.Interface> interfaceOpt1 =
277                         this.openRoadmInterfaces.getInterface(nodeId, supportingOts);
278                     if (interfaceOpt1.isEmpty()) {
279                         LOG.error(INTERFACE_NOT_PRESENT, supportingOts, nodeId);
280                         return null;
281                     }
282                     if (interfaceOpt1.get().augmentation(org.opendaylight.yang.gen.v1.http.org
283                             .openroadm.optical.transport.interfaces.rev181019.Interface1.class).getOts()
284                                 .getSpanLossTransmit() == null) {
285                         LOG.error("interface {} has no spanloss value", interfaceOpt1.get().getName());
286                         return null;
287                     }
288                     return interfaceOpt1.get()
289                             .augmentation(org.opendaylight.yang.gen.v1.http.org
290                                 .openroadm.optical.transport.interfaces.rev181019.Interface1.class)
291                             .getOts().getSpanLossTransmit().getValue();
292                 // TODO no case 3 ?
293                 default:
294                     return null;
295             }
296         } catch (OpenRoadmInterfaceException ex) {
297             LOG.error("Failed to get interface {} from node {}!",
298                 supportingOts, nodeId, ex);
299             return null;
300         } catch (IllegalArgumentException ex) {
301             LOG.error("Failed to get non existing interface {} from node {}!",
302                 supportingOts, nodeId);
303             return null;
304         }
305     }
306
307     private BigDecimal getXpdrPowerValue(Nodes inputNode, String destTpId, String nodeId, Integer openroadmVersion,
308             String srgId, String nextNodeId) {
309
310         Map<String, Double> txPowerRangeMap = getTxPowerRangeMap(inputNode, destTpId, nodeId, openroadmVersion);
311         if (txPowerRangeMap == null) {
312             return null;
313             // return null here means return false in setPower()
314         }
315         BigDecimal powerVal =
316             openroadmVersion == 3 ? DEFAULT_TPDR_PWR_400G : DEFAULT_TPDR_PWR_100G;
317         if (txPowerRangeMap.isEmpty()) {
318             LOG.info("Tranponder range not available setting to default power for nodeId: {}", nodeId);
319             return powerVal;
320         }
321
322         Map<String, Double> rxSRGPowerRangeMap = getSRGRxPowerRangeMap(srgId, nextNodeId, openroadmVersion);
323         if (rxSRGPowerRangeMap == null) {
324             return null;
325             // return null here means return false in setPower()
326             // TODO empty txPowerRangeMap + null rxSRGPowerRangeMap is allowed
327             // => confirm this behavior is OK
328         }
329         if (rxSRGPowerRangeMap.isEmpty()) {
330             LOG.info("SRG Power Range not found, setting the Transponder range to default");
331             return powerVal;
332         }
333
334         powerVal = new BigDecimal(txPowerRangeMap.get("MaxTx"))
335             .min(new BigDecimal(rxSRGPowerRangeMap.get("MaxRx")));
336         LOG.info("Calculated Transponder Power value is {}" , powerVal);
337         return powerVal;
338     }
339
340
341     private BigDecimal getRdmPowerValue(BigDecimal spanLossTx, ServicePowerSetupInput input) {
342         BigDecimal powerValue = spanLossTx.subtract(BigDecimal.valueOf(9)).min(BigDecimal.valueOf(2));
343         // we work at constant power spectral density (50 GHz channel width @-20dBm=37.5GHz)
344         // 87.5 GHz channel width @-20dBm=75GHz
345         if (input.getWidth() != null) {
346             BigDecimal gridSize = input.getWidth().getValue();
347             LOG.debug("Input Gridsize is {}",gridSize);
348             if (gridSize.equals(GridConstant.WIDTH_80)) {
349                 powerValue = powerValue.add(BigDecimal.valueOf(3));
350             }
351             // TODO no default or warning for unsupported grid sizes ?
352         }
353         // FIXME compliancy with OpenROADM MSA and approximations used
354         // cf JIRA ticket https://jira.opendaylight.org/browse/TRNSPRTPCE-494
355         LOG.info("Power Value is {}", powerValue);
356         return powerValue;
357     }
358
359     /**
360      * This methods turns down power a WL by performing
361      * following steps:
362      *
363      * <p>
364      * 1. Pull interfaces used in service and change
365      * status to outOfService
366      *
367      * <p>
368      * 2. For each of the ROADM node set target-output-power
369      * to -60dbm, wait for 20 seconds, turn power mode to off
370      *
371      * <p>
372      * 3. Turn down power in Z to A direction and A to Z
373      *
374      * @param input
375      *            Input parameter from the olm servicePowerTurndown rpc
376      *
377      * @return true/false based on status of operation
378      */
379     public Boolean powerTurnDown(ServicePowerTurndownInput input) {
380         LOG.info("Olm-powerTurnDown initiated for input {}", input);
381         /*Starting with last element into the list Z -> A for
382           turning down A -> Z */
383         String spectralSlotName = String.join(GridConstant.SPECTRAL_SLOT_SEPARATOR,
384                 input.getLowerSpectralSlotNumber().toString(),
385                 input.getHigherSpectralSlotNumber().toString());
386         for (int i = input.getNodes().size() - 1; i >= 0; i--) {
387             String nodeId = input.getNodes().get(i).getNodeId();
388             String destTpId = input.getNodes().get(i).getDestTp();
389             String connectionNumber =  String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,
390                     input.getNodes().get(i).getSrcTp(), destTpId, spectralSlotName);
391             try {
392                 if (destTpId.toUpperCase(Locale.getDefault()).contains("DEG")) {
393                     if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Power.getName(), new BigDecimal(-60),
394                             connectionNumber)) {
395                         LOG.warn("Power down failed for Roadm-connection: {}", connectionNumber);
396                         return false;
397                     }
398                     Thread.sleep(OlmUtils.OLM_TIMER_2);
399                     if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
400                         LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
401                         return false;
402                     }
403                 } else if (destTpId.toUpperCase(Locale.getDefault()).contains("SRG")) {
404                     if (!crossConnect.setPowerLevel(nodeId, OpticalControlMode.Off.getName(), null, connectionNumber)) {
405                         LOG.warn("Setting power-control mode off failed for Roadm-connection: {}", connectionNumber);
406                         // FIXME a return false would allow sync with DEG case but makes current Unit tests fail
407                     }
408                 }
409             } catch (InterruptedException e) {
410                 // TODO Auto-generated catch block
411                 LOG.error("Olm-powerTurnDown wait failed: ",e);
412                 return false;
413             }
414         }
415         return true;
416     }
417
418     /**
419      * This method retrieves transponder OCH interface and
420      * sets power.
421      *
422      * @param nodeId
423      *            Unique identifier for the mounted netconf- node
424      * @param interfaceName
425      *            OCH interface name carrying WL
426      * @param txPower
427      *            Calculated transmit power
428      * @param openroadmVersion
429      *            Version of openRoadm device software
430      * @return true/false based on status of operation
431      */
432     private boolean callSetTransponderPower(String nodeId, String interfaceName, BigDecimal txPower,
433                                             OpenroadmNodeVersion openroadmVersion) {
434
435         boolean powerSetupResult = false;
436         try {
437             switch (openroadmVersion.getIntValue()) {
438                 case 1:
439                     Optional<Interface> interfaceOptional121 =
440                         openRoadmInterfaces.getInterface(nodeId, interfaceName);
441                     if (interfaceOptional121.isEmpty()) {
442                         LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
443                         return false;
444                     }
445                     powerSetupResult = PowerMgmtVersion121.setTransponderPower(nodeId, interfaceName,
446                             txPower, deviceTransactionManager, interfaceOptional121.get());
447                     break;
448                 case 2:
449                     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp
450                             .Interface> interfaceOptional221 =
451                         openRoadmInterfaces.getInterface(nodeId, interfaceName);
452                     if (interfaceOptional221.isEmpty()) {
453                         LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
454                         return false;
455                     }
456                     powerSetupResult = PowerMgmtVersion221.setTransponderPower(nodeId, interfaceName,
457                             txPower, deviceTransactionManager, interfaceOptional221.get());
458                     break;
459                 case 3:
460                     Optional<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.interfaces.grp
461                             .Interface> interfaceOptional710 =
462                         openRoadmInterfaces.getInterface(nodeId, interfaceName);
463                     if (interfaceOptional710.isEmpty()) {
464                         LOG.error(INTERFACE_NOT_PRESENT, interfaceName, nodeId);
465                         return false;
466                     }
467                     powerSetupResult = PowerMgmtVersion710.setTransponderPower(nodeId, interfaceName,
468                             txPower, deviceTransactionManager, interfaceOptional710.get());
469                     break;
470                 default:
471                     LOG.error("Unrecognized OpenRoadm version");
472                     return false;
473             }
474         } catch (OpenRoadmInterfaceException ex) {
475             LOG.error("Failed to get interface {} from node {}!", interfaceName, nodeId, ex);
476             return false;
477         }
478         if (!powerSetupResult) {
479             LOG.debug("Transponder power setup failed for nodeId {} on interface {}",
480                     nodeId, interfaceName);
481             return false;
482         }
483         LOG.debug("Transponder power set up completed successfully for nodeId {} and interface {}",
484                 nodeId,interfaceName);
485         return true;
486     }
487
488 }