2 * Copyright © 2017 AT&T, Inc. 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.pce.networkanalyzer;
11 import java.util.ArrayList;
12 import java.util.HashMap;
13 import java.util.HashSet;
14 import java.util.List;
16 import java.util.Optional;
18 import java.util.concurrent.ExecutionException;
19 import java.util.stream.Collectors;
20 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
21 import org.opendaylight.transportpce.common.NetworkUtils;
22 import org.opendaylight.transportpce.common.ResponseCodes;
23 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
24 import org.opendaylight.transportpce.pce.constraints.PceConstraints;
25 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.pce.rev200128.PathComputationRequestInput;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Node1;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmLinkType;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmNodeType;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.Networks;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.NetworkKey;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
39 //import org.opendaylight.yangtools.yang.common.Decimal64;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
43 public class PceCalculation {
45 private static final Logger LOG = LoggerFactory.getLogger(PceCalculation.class);
46 private NetworkTransactionService networkTransactionService = null;
48 ///////////// data parsed from Input/////////////////
49 private PathComputationRequestInput input;
50 private String anodeId = "";
51 private String znodeId = "";
52 private String serviceFormatA = "";
53 private String serviceFormatZ = "";
54 private String serviceType = "";
55 private Long serviceRate = 0L;
57 private PceConstraints pceHardConstraints;
59 ///////////// Intermediate data/////////////////
60 private List<PceLink> addLinks = new ArrayList<>();
61 private List<PceLink> dropLinks = new ArrayList<>();
62 private HashSet<NodeId> azSrgs = new HashSet<>();
64 private PceNode aendPceNode = null;
65 private PceNode zendPceNode = null;
67 private List<Link> allLinks = null;
68 private List<Node> allNodes = null;
70 // this List serves graph calculation
71 private Map<NodeId, PceNode> allPceNodes = new HashMap<>();
72 // this List serves calculation of ZtoA path description
73 // TODO maybe better solution is possible
74 private Map<LinkId, PceLink> allPceLinks = new HashMap<>();
75 private Set<LinkId> linksToExclude = new HashSet<>();
76 private PceResult returnStructure;
78 private enum ConstraintTypes {
79 NONE, HARD_EXCLUDE, HARD_INCLUDE, HARD_DIVERSITY, SOFT_EXCLUDE, SOFT_INCLUDE, SOFT_DIVERSITY;
82 public PceCalculation(PathComputationRequestInput input, NetworkTransactionService networkTransactionService,
83 PceConstraints pceHardConstraints, PceConstraints pceSoftConstraints, PceResult rc) {
85 this.networkTransactionService = networkTransactionService;
86 this.returnStructure = rc;
88 this.pceHardConstraints = pceHardConstraints;
92 public void retrievePceNetwork() {
94 LOG.info("In PceCalculation retrieveNetwork: ");
97 returnStructure.setRC(ResponseCodes.RESPONSE_FAILED);
100 MapUtils.mapDiversityConstraints(allNodes, allLinks, pceHardConstraints);
103 returnStructure.setRC(ResponseCodes.RESPONSE_FAILED);
106 printNodesInfo(allPceNodes);
108 returnStructure.setRC(ResponseCodes.RESPONSE_OK);
112 private boolean parseInput() {
113 anodeId = input.getServiceAEnd().getNodeId();
114 znodeId = input.getServiceZEnd().getNodeId();
115 if (input.getServiceAEnd().getServiceFormat() == null || input.getServiceZEnd().getServiceFormat() == null
116 || input.getServiceAEnd().getServiceRate() == null) {
117 LOG.error("Service Format and Service Rate are required for a path calculation");
120 serviceFormatA = input.getServiceAEnd().getServiceFormat().getName();
121 serviceFormatZ = input.getServiceZEnd().getServiceFormat().getName();
122 serviceRate = input.getServiceAEnd().getServiceRate().toJava();
124 LOG.info("parseInput: A and Z :[{}] and [{}]", anodeId, znodeId);
125 if (!(serviceFormatA.equals(serviceFormatZ))) {
126 LOG.info("parseInput: different service format for A and Z not handled, will use service format from Aend");
127 } else if (serviceRate == 100L) {
128 switch (serviceFormatA) {
131 serviceType = "100GE";
134 serviceType = "OTU4";
137 serviceType = "ODU4";
140 LOG.debug("parseInput: unsupported service type: Format {} Rate 100L", serviceFormatA);
143 //switch(serviceRate) may seem a better option at first glance.
144 //But switching on Long or long is not directly possible in Java.
145 //And casting to int bumps the limit here.
146 //Passing by ENUM or String are possible alternatives.
147 //Maybe HashMap and similar options should also be considered here.
148 } else if ("Ethernet".equals(serviceFormatA)) {
149 //only rate 100L is currently supported except in Ethernet
150 if (serviceRate == 10L) {
151 serviceType = "10GE";
152 } else if (serviceRate == 1L) {
155 LOG.debug("parseInput: unsupported service type: Format Ethernet Rate {}", serviceRate);
158 LOG.debug("parseInput: unsupported service type: Format {} Rate {}",
159 serviceFormatA, serviceRate);
162 returnStructure.setRate(input.getServiceAEnd().getServiceRate().toJava());
163 returnStructure.setServiceFormat(input.getServiceAEnd().getServiceFormat());
167 private boolean readMdSal() {
168 InstanceIdentifier<Network> nwInstanceIdentifier = null;
170 if (("OC".equals(serviceFormatA)) || ("OTU".equals(serviceFormatA)) || (("Ethernet".equals(serviceFormatA))
171 && (serviceRate == 100L))) {
173 LOG.info("readMdSal: network {}", NetworkUtils.OVERLAY_NETWORK_ID);
174 nwInstanceIdentifier = InstanceIdentifier.builder(Networks.class)
175 .child(Network.class, new NetworkKey(new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID))).build();
176 } else if ("ODU".equals(serviceFormatA) || ("Ethernet".equals(serviceFormatA) && serviceRate == 10L)
177 || ("Ethernet".equals(serviceFormatA) && serviceRate == 1L)) {
178 LOG.info("readMdSal: network {}", NetworkUtils.OTN_NETWORK_ID);
179 nwInstanceIdentifier = InstanceIdentifier.builder(Networks.class)
180 .child(Network.class, new NetworkKey(new NetworkId(NetworkUtils.OTN_NETWORK_ID))).build();
182 LOG.info("readMdSal: service-rate {} / service-format not handled {}", serviceRate, serviceFormatA);
187 Optional<Network> nwOptional =
188 networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, nwInstanceIdentifier).get();
189 if (nwOptional.isPresent()) {
190 nw = nwOptional.get();
191 LOG.debug("readMdSal: network nodes: nwOptional.isPresent = true {}", nw);
193 } catch (InterruptedException | ExecutionException e) {
194 LOG.error("readMdSal: Error reading topology {}", nwInstanceIdentifier);
195 networkTransactionService.close();
196 returnStructure.setRC(ResponseCodes.RESPONSE_FAILED);
197 throw new RuntimeException(
198 "readMdSal: Error reading from operational store, topology : " + nwInstanceIdentifier + " :" + e);
200 networkTransactionService.close();
203 LOG.error("readMdSal: network is null: {}", nwInstanceIdentifier);
206 allNodes = nw.getNode().stream().sorted((n1, n2) -> n1.getNodeId().getValue().compareTo(n2.getNodeId()
207 .getValue())).collect(Collectors.toList());
208 Network1 nw1 = nw.augmentation(Network1.class);
210 allLinks = nw1.getLink().stream().sorted((l1, l2) -> l1.getSource().getSourceTp().toString().compareTo(l2
211 .getSource().getSourceTp().toString())).collect(Collectors.toList());
213 LOG.warn("no otn links in otn-topology");
215 if (allNodes == null || allNodes.isEmpty()) {
216 LOG.error("readMdSal: no nodes ");
219 LOG.info("readMdSal: network nodes: {} nodes added", allNodes.size());
220 LOG.debug("readMdSal: network nodes: {} nodes added", allNodes);
222 if (allLinks == null || allLinks.isEmpty()) {
223 LOG.error("readMdSal: no links ");
226 LOG.info("readMdSal: network links: {} links added", allLinks.size());
227 LOG.debug("readMdSal: network links: {} links added", allLinks);
232 private boolean analyzeNw() {
234 LOG.debug("analyzeNw: allNodes size {}, allLinks size {}", allNodes.size(), allLinks.size());
236 if (("100GE".equals(serviceType)) || ("OTU4".equals(serviceType))) {
237 // 100GE service and OTU4 service are handled at the openroadm-topology layer
238 for (Node node : allNodes) {
242 LOG.debug("analyzeNw: allPceNodes size {}", allPceNodes.size());
244 if (aendPceNode == null || zendPceNode == null) {
245 LOG.error("analyzeNw: Error in reading nodes: A or Z do not present in the network");
248 for (Link link : allLinks) {
252 LOG.debug("analyzeNw: addLinks size {}, dropLinks size {}", addLinks.size(), dropLinks.size());
254 LOG.debug("analyzeNw: azSrgs size = {}", azSrgs.size());
255 for (NodeId srg : azSrgs) {
256 LOG.debug("analyzeNw: A/Z Srgs SRG = {}", srg.getValue());
259 for (PceLink link : addLinks) {
260 filteraddLinks(link);
262 for (PceLink link : dropLinks) {
263 filterdropLinks(link);
267 // ODU4, 10GE/ODU2e or 1GE/ODU0 services are handled at openroadm-otn layer
269 for (Node node : allNodes) {
270 validateOtnNode(node);
273 LOG.info("analyzeNw: allPceNodes {}", allPceNodes);
275 if (aendPceNode == null || zendPceNode == null) {
276 LOG.error("analyzeNw: Error in reading nodes: A or Z do not present in the network");
279 for (Link link : allLinks) {
284 LOG.info("analyzeNw: allPceNodes size {}, allPceLinks size {}", allPceNodes.size(), allPceLinks.size());
286 if ((allPceNodes.size() == 0) || (allPceLinks.size() == 0)) {
290 LOG.debug("analyzeNw: allPceNodes {}", allPceNodes);
291 LOG.debug("analyzeNw: allPceLinks {}", allPceLinks);
296 private boolean filteraddLinks(PceLink pcelink) {
298 NodeId nodeId = pcelink.getSourceId();
300 if (azSrgs.contains(nodeId)) {
301 allPceLinks.put(pcelink.getLinkId(), pcelink);
302 allPceNodes.get(nodeId).addOutgoingLink(pcelink);
303 LOG.debug("analyzeNw: Add_LINK added to source and to allPceLinks {}", pcelink.getLinkId());
307 // remove the SRG from PceNodes, as it is not directly connected to A/Z
308 allPceNodes.remove(nodeId);
309 LOG.debug("analyzeNw: SRG removed {}", nodeId.getValue());
314 private boolean filterdropLinks(PceLink pcelink) {
316 NodeId nodeId = pcelink.getDestId();
318 if (azSrgs.contains(nodeId)) {
319 allPceLinks.put(pcelink.getLinkId(), pcelink);
320 allPceNodes.get(nodeId).addOutgoingLink(pcelink);
321 LOG.debug("analyzeNw: Drop_LINK added to dest and to allPceLinks {}", pcelink.getLinkId());
325 // remove the SRG from PceNodes, as it is not directly connected to A/Z
326 allPceNodes.remove(pcelink.getDestId());
327 LOG.debug("analyzeNw: SRG removed {}", nodeId.getValue());
332 private boolean validateLink(Link link) {
333 LOG.info("validateLink: link {} ", link);
335 NodeId sourceId = link.getSource().getSourceNode();
336 NodeId destId = link.getDestination().getDestNode();
337 PceNode source = allPceNodes.get(sourceId);
338 PceNode dest = allPceNodes.get(destId);
340 if (source == null) {
341 LOG.debug("validateLink: Link is ignored due source node is rejected by node validation - {}",
342 link.getSource().getSourceNode().getValue());
346 LOG.debug("validateLink: Link is ignored due dest node is rejected by node validation - {}",
347 link.getDestination().getDestNode().getValue());
351 if (("100GE".equals(serviceType)) || ("OTU4".equals(serviceType))) {
352 // 100GE or OTU4 services are handled at WDM Layer
353 PceLink pcelink = new PceLink(link, source, dest);
354 if (!pcelink.isValid()) {
355 dropOppositeLink(link);
356 LOG.error(" validateLink: Link is ignored due errors in network data or in opposite link");
359 LinkId linkId = pcelink.getLinkId();
360 if (validateLinkConstraints(pcelink).equals(ConstraintTypes.HARD_EXCLUDE)) {
361 dropOppositeLink(link);
362 LOG.debug("validateLink: constraints : link is ignored == {}", linkId.getValue());
365 switch (pcelink.getlinkType()) {
368 allPceLinks.put(linkId, pcelink);
369 source.addOutgoingLink(pcelink);
370 LOG.debug("validateLink: {}-LINK added to allPceLinks {}",
371 pcelink.getlinkType(), pcelink);
374 pcelink.setClient(source.getRdmSrgClient(pcelink.getSourceTP().toString()));
375 addLinks.add(pcelink);
376 LOG.debug("validateLink: ADD-LINK saved {}", pcelink);
379 pcelink.setClient(dest.getRdmSrgClient(pcelink.getDestTP().toString()));
380 dropLinks.add(pcelink);
381 LOG.debug("validateLink: DROP-LINK saved {}", pcelink);
384 // store separately all SRG links directly
385 azSrgs.add(sourceId);
387 if (!dest.checkTP(pcelink.getDestTP().toString())) {
389 "validateLink: XPONDER-INPUT is rejected as NW port is busy - {} ", pcelink);
392 if (dest.getXpdrClient(pcelink.getDestTP().toString()) != null) {
393 pcelink.setClient(dest.getXpdrClient(pcelink.getDestTP().toString()));
395 allPceLinks.put(linkId, pcelink);
396 source.addOutgoingLink(pcelink);
397 LOG.debug("validateLink: XPONDER-INPUT link added to allPceLinks {}", pcelink);
399 // does it mean XPONDER==>>SRG ?
401 // store separately all SRG links directly
404 if (!source.checkTP(pcelink.getSourceTP().toString())) {
406 "validateLink: XPONDER-OUTPUT is rejected as NW port is busy - {} ", pcelink);
409 if (source.getXpdrClient(pcelink.getSourceTP().toString()) != null) {
410 pcelink.setClient(source.getXpdrClient(pcelink.getSourceTP().toString()));
412 allPceLinks.put(linkId, pcelink);
413 source.addOutgoingLink(pcelink);
414 LOG.debug("validateLink: XPONDER-OUTPUT link added to allPceLinks {}", pcelink);
417 LOG.warn("validateLink: link type is not supported {}", pcelink);
421 } else if (("ODU4".equals(serviceType)) || ("10GE".equals(serviceType)) || ("1GE".equals(serviceType))) {
422 // ODU4, 1GE and 10GE services relying on ODU2, ODU2e or ODU0 services are handled at OTN layer
423 PceLink pceOtnLink = new PceLink(link, source, dest);
425 if (!pceOtnLink.isOtnValid(link, serviceType)) {
426 dropOppositeLink(link);
427 LOG.error(" validateLink: Link is ignored due errors in network data or in opposite link");
431 LinkId linkId = pceOtnLink.getLinkId();
432 if (validateLinkConstraints(pceOtnLink).equals(ConstraintTypes.HARD_EXCLUDE)) {
433 dropOppositeLink(link);
434 LOG.debug("validateLink: constraints : link is ignored == {}", linkId.getValue());
438 switch (pceOtnLink.getlinkType()) {
440 if (dest.getXpdrClient(pceOtnLink.getDestTP().toString()) != null) {
441 pceOtnLink.setClient(dest.getXpdrClient(pceOtnLink.getDestTP().toString()));
444 allPceLinks.put(linkId, pceOtnLink);
445 source.addOutgoingLink(pceOtnLink);
446 LOG.info("validateLink: OTN-LINK added to allPceLinks {}", pceOtnLink);
449 LOG.warn("validateLink: link type is not supported {}", pceOtnLink);
454 LOG.error(" validateLink: Unmanaged service type {}", serviceType);
460 private boolean validateNode(Node node) {
461 LOG.debug("validateNode: node {} ", node);
463 // PceNode will be used in Graph algorithm
464 Node1 node1 = node.augmentation(Node1.class);
466 LOG.error("getNodeType: no Node1 (type) Augmentation for node: [{}]. Node is ignored", node.getNodeId());
469 OpenroadmNodeType nodeType = node1.getNodeType();
471 PceOpticalNode pceNode = new PceOpticalNode(node, nodeType, node.getNodeId(),
472 input.getServiceAEnd().getServiceFormat(), "optical");
473 pceNode.validateAZxponder(anodeId, znodeId);
474 pceNode.initWLlist();
476 if (!pceNode.isValid()) {
477 LOG.warn(" validateNode: Node is ignored");
481 if (validateNodeConstraints(pceNode).equals(ConstraintTypes.HARD_EXCLUDE)) {
484 if ((pceNode.getSupNetworkNodeId().equals(anodeId) && (this.aendPceNode == null))
485 && (Boolean.TRUE.equals(endPceNode(nodeType, pceNode.getNodeId(), pceNode)))) {
486 this.aendPceNode = pceNode;
488 if ((pceNode.getSupNetworkNodeId().equals(znodeId) && (this.zendPceNode == null))
489 && (Boolean.TRUE.equals(endPceNode(nodeType, pceNode.getNodeId(), pceNode)))) {
490 this.zendPceNode = pceNode;
493 allPceNodes.put(pceNode.getNodeId(), pceNode);
494 LOG.debug("validateNode: node is saved {}", pceNode.getNodeId().getValue());
498 private boolean validateOtnNode(Node node) {
500 LOG.info("validateOtnNode: {} ", node.getNodeId().getValue());
501 // PceOtnNode will be used in Graph algorithm
502 if (node.augmentation(Node1.class) != null) {
503 OpenroadmNodeType nodeType = node.augmentation(Node1.class).getNodeType();
505 PceOtnNode pceOtnNode = new PceOtnNode(node, nodeType, node.getNodeId(), "otn", serviceType);
506 pceOtnNode.validateXponder(anodeId, znodeId);
508 if (!pceOtnNode.isValid()) {
509 LOG.warn(" validateOtnNode: Node {} is ignored", node.getNodeId().getValue());
512 if (validateNodeConstraints(pceOtnNode).equals(ConstraintTypes.HARD_EXCLUDE)) {
515 if (pceOtnNode.getNodeId().getValue().equals(anodeId) && this.aendPceNode == null) {
516 this.aendPceNode = pceOtnNode;
518 if (pceOtnNode.getNodeId().getValue().equals(znodeId) && this.zendPceNode == null) {
519 this.zendPceNode = pceOtnNode;
521 allPceNodes.put(pceOtnNode.getNodeId(), pceOtnNode);
522 LOG.info("validateOtnNode: node {} is saved", node.getNodeId().getValue());
525 LOG.error("ValidateOtnNode: no node-type augmentation. Node {} is ignored", node.getNodeId().getValue());
529 // if (mode == "AZ") {
530 // pceOtnNode.validateAZxponder(anodeId, znodeId);
531 // } else if (mode == "intermediate") {
532 // pceOtnNode.validateIntermediateSwitch();
534 // LOG.error("validateOtnNode: unproper mode passed to the method : {} not supported", mode);
539 private ConstraintTypes validateNodeConstraints(PceNode pcenode) {
540 if (pceHardConstraints.getExcludeSupNodes().isEmpty() && pceHardConstraints.getExcludeCLLI().isEmpty()) {
541 return ConstraintTypes.NONE;
543 if (pceHardConstraints.getExcludeSupNodes().contains(pcenode.getSupNetworkNodeId())) {
544 LOG.info("validateNodeConstraints: {}", pcenode.getNodeId().getValue());
545 return ConstraintTypes.HARD_EXCLUDE;
547 if (pceHardConstraints.getExcludeCLLI().contains(pcenode.getSupClliNodeId())) {
548 LOG.info("validateNodeConstraints: {}", pcenode.getNodeId().getValue());
549 return ConstraintTypes.HARD_EXCLUDE;
551 return ConstraintTypes.NONE;
554 private ConstraintTypes validateLinkConstraints(PceLink link) {
555 if (pceHardConstraints.getExcludeSRLG().isEmpty()) {
556 return ConstraintTypes.NONE;
559 // for now SRLG is the only constraint for link
560 if (link.getlinkType() != OpenroadmLinkType.ROADMTOROADM) {
561 return ConstraintTypes.NONE;
564 List<Long> constraints = new ArrayList<>(pceHardConstraints.getExcludeSRLG());
565 constraints.retainAll(link.getsrlgList());
566 if (!constraints.isEmpty()) {
567 LOG.info("validateLinkConstraints: {}", link.getLinkId().getValue());
568 return ConstraintTypes.HARD_EXCLUDE;
571 return ConstraintTypes.NONE;
574 private void dropOppositeLink(Link link) {
575 LinkId opplink = MapUtils.extractOppositeLink(link);
577 if (allPceLinks.containsKey(opplink)) {
578 allPceLinks.remove(opplink);
580 linksToExclude.add(opplink);
584 private Boolean endPceNode(OpenroadmNodeType openroadmNodeType, NodeId nodeId, PceOpticalNode pceNode) {
585 switch (openroadmNodeType) {
587 pceNode.initSrgTps();
588 this.azSrgs.add(nodeId);
591 pceNode.initXndrTps();
594 LOG.warn("endPceNode: Node {} is not SRG or XPONDER !", nodeId);
598 if (!pceNode.isValid()) {
599 LOG.error("validateNode : there are no availaible wavelengths in node {}", pceNode.getNodeId().getValue());
605 public PceNode getaendPceNode() {
609 public PceNode getzendPceNode() {
613 public Map<NodeId, PceNode> getAllPceNodes() {
614 return this.allPceNodes;
617 public Map<LinkId, PceLink> getAllPceLinks() {
618 return this.allPceLinks;
621 public String getServiceType() {
625 public PceResult getReturnStructure() {
626 return returnStructure;
629 private static void printNodesInfo(Map<NodeId, PceNode> allPceNodes) {
630 allPceNodes.forEach(((nodeId, pceNode) -> {
631 LOG.info("In printNodes in node {} : outgoing links {} ", pceNode.getNodeId().getValue(),
632 pceNode.getOutgoingLinks());