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.graph;
11 import java.util.ArrayList;
12 import java.util.BitSet;
13 import java.util.HashMap;
14 import java.util.Iterator;
15 import java.util.List;
17 import java.util.Map.Entry;
18 import java.util.function.Function;
19 import java.util.stream.Collectors;
20 import java.util.stream.IntStream;
21 import org.jgrapht.Graph;
22 import org.jgrapht.GraphPath;
23 import org.jgrapht.alg.shortestpath.PathValidator;
24 import org.jgrapht.alg.shortestpath.YenKShortestPath;
25 import org.jgrapht.graph.DefaultDirectedWeightedGraph;
26 import org.opendaylight.transportpce.common.ResponseCodes;
27 import org.opendaylight.transportpce.common.StringConstants;
28 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
29 import org.opendaylight.transportpce.pce.constraints.PceConstraints;
30 import org.opendaylight.transportpce.pce.networkanalyzer.PceLink;
31 import org.opendaylight.transportpce.pce.networkanalyzer.PceNode;
32 import org.opendaylight.transportpce.pce.networkanalyzer.PceResult;
33 import org.opendaylight.transportpce.pce.networkanalyzer.PceResult.LocalCause;
34 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.pce.rev240205.PceConstraintMode;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
41 public class PceGraph {
43 private static final Logger LOG = LoggerFactory.getLogger(PceGraph.class);
45 ////////////////////////// for Graph ///////////////////////////
46 // how many paths to bring
47 private int kpathsToBring = 15;
50 private Map<NodeId, PceNode> allPceNodes = new HashMap<>();
51 private Map<LinkId, PceLink> allPceLinks = new HashMap<>();
52 private PceNode apceNode = null;
53 private PceNode zpceNode = null;
54 private String serviceType = "";
55 private Double margin = null;
56 PceConstraints pceHardConstraints;
57 private PceConstraintMode pceConstraintMode;
58 private BitSet spectrumConstraint;
61 private PceResult pceResult = null;
62 private List<PceLink> shortestPathAtoZ = null;
64 // for path calculation
65 Map<Integer, GraphPath<String, PceGraphEdge>> allWPaths = null;
67 private List<PceLink> pathAtoZ = new ArrayList<>();
69 private final NetworkTransactionService networkTransactionService;
71 public PceGraph(PceNode aendNode, PceNode zendNode, Map<NodeId, PceNode> allPceNodes,
72 Map<LinkId, PceLink> allPceLinks, PceConstraints pceHardConstraints,PceResult pceResult, String serviceType,
73 NetworkTransactionService networkTransactionService, PceConstraintMode mode, BitSet spectrumConstraint) {
75 this.apceNode = aendNode;
76 this.zpceNode = zendNode;
77 this.allPceNodes = allPceNodes;
78 this.allPceLinks = allPceLinks;
79 this.pceResult = pceResult;
80 this.pceHardConstraints = pceHardConstraints;
81 this.serviceType = serviceType;
82 this.networkTransactionService = networkTransactionService;
83 this.pceConstraintMode = mode;
84 this.spectrumConstraint = spectrumConstraint;
86 LOG.info("In GraphCalculator: A and Z = {} / {} ", aendNode, zendNode);
87 LOG.debug("In GraphCalculator: allPceNodes size {}, nodes {} ", allPceNodes.size(), allPceNodes);
90 public boolean calcPath() {
92 LOG.info(" In PCE GRAPH calcPath : K SHORT PATHS algorithm ");
94 Graph<String, PceGraphEdge> weightedGraph =
95 new DefaultDirectedWeightedGraph<>(PceGraphEdge.class);
96 populateWithNodes(weightedGraph);
97 populateWithLinks(weightedGraph);
99 if (!runKgraphs(weightedGraph)) {
100 LOG.error("In calcPath : pceResult {}", pceResult);
103 // validate found paths
104 pceResult.setRC(ResponseCodes.RESPONSE_FAILED);
105 for (Entry<Integer, GraphPath<String, PceGraphEdge>> entry : allWPaths.entrySet()) {
106 GraphPath<String, PceGraphEdge> path = entry.getValue();
107 LOG.info("validating path n° {} - {}", entry.getKey(), path.getVertexList());
108 PostAlgoPathValidator papv = new PostAlgoPathValidator(networkTransactionService, spectrumConstraint);
109 pceResult = papv.checkPath(
110 path, allPceNodes, allPceLinks, pceResult, pceHardConstraints, serviceType, pceConstraintMode);
111 this.margin = papv.getTpceCalculatedMargin();
112 if (ResponseCodes.RESPONSE_OK.equals(pceResult.getResponseCode())) {
113 LOG.info("Path is validated");
115 LOG.warn("In calcPath: post algo validations DROPPED the path {}; for following cause: {}",
116 path, pceResult.getLocalCause());
122 for (PceGraphEdge edge : path.getEdgeList()) {
123 pathAtoZ.add(edge.link());
126 shortestPathAtoZ = new ArrayList<>(pathAtoZ);
127 switch (serviceType) {
129 case StringConstants.SERVICE_TYPE_100GE_T:
130 case StringConstants.SERVICE_TYPE_OTUC2:
131 case StringConstants.SERVICE_TYPE_OTUC3:
132 case StringConstants.SERVICE_TYPE_OTUC4:
133 case StringConstants.SERVICE_TYPE_400GE:
134 case StringConstants.SERVICE_TYPE_OTU4:
136 "In calcPath Path FOUND path for wl [{}], min Freq assignment {}, max Freq assignment {},"
137 + " hops {}, distance per metrics {}, path AtoZ {}",
138 pceResult.getResultWavelength(), pceResult.getMinFreq(), pceResult.getMaxFreq(),
139 pathAtoZ.size(), path.getWeight(), pathAtoZ);
144 "In calcPath Path FOUND path for hops {}, distance per metrics {}, path AtoZ {}",
145 pathAtoZ.size(), path.getWeight(), pathAtoZ);
152 if (shortestPathAtoZ != null) {
153 LOG.info("In calcPath CHOOSEN PATH for wl [{}], min freq {}, max freq {}, hops {}, path AtoZ {}",
154 pceResult.getResultWavelength(), pceResult.getMinFreq(), pceResult.getMaxFreq(),
155 shortestPathAtoZ.size(), shortestPathAtoZ);
157 LOG.info("In calcPath : pceResult {}", pceResult);
158 return (pceResult.getStatus());
161 private boolean runKgraphs(Graph<String, PceGraphEdge> weightedGraph) {
163 if (weightedGraph.edgeSet().isEmpty() || weightedGraph.vertexSet().isEmpty()) {
166 PathValidator<String, PceGraphEdge> wpv = new InAlgoPathValidator();
168 // YenShortestPath on weightedGraph
169 YenKShortestPath<String, PceGraphEdge> swp = new YenKShortestPath<>(weightedGraph, wpv);
170 List<GraphPath<String, PceGraphEdge>> weightedPathList = swp
171 .getPaths(apceNode.getNodeId().getValue(), zpceNode.getNodeId().getValue(), kpathsToBring);
172 allWPaths = IntStream
173 .range(0, weightedPathList.size())
175 .collect(Collectors.toMap(Function.identity(), weightedPathList::get));
177 if (allWPaths.isEmpty()) {
178 LOG.info(" In runKgraphs : algorithm didn't find any path");
179 pceResult.setLocalCause(LocalCause.NO_PATH_EXISTS);
180 pceResult.setRC(ResponseCodes.RESPONSE_FAILED);
186 .forEach((k, v) -> LOG.info("path n° {} - weight: {} - path: {}", k, v.getWeight(), v.getVertexList()));
190 private boolean validateLinkforGraph(PceLink pcelink) {
192 PceNode source = allPceNodes.get(pcelink.getSourceId());
193 PceNode dest = allPceNodes.get(pcelink.getDestId());
195 if (source == null) {
196 LOG.error("In addLinkToGraph link source node is null : {}", pcelink);
200 LOG.error("In addLinkToGraph link dest node is null : {}", pcelink);
203 LOG.debug("In addLinkToGraph link to nodes : {}{} {}", pcelink, source, dest);
207 private void populateWithNodes(Graph<String, PceGraphEdge> weightedGraph) {
208 Iterator<Map.Entry<NodeId, PceNode>> nodes = allPceNodes.entrySet().iterator();
209 while (nodes.hasNext()) {
210 Map.Entry<NodeId, PceNode> node = nodes.next();
211 if (State.InService.equals(node.getValue().getState())) {
212 weightedGraph.addVertex(node.getValue().getNodeId().getValue());
213 LOG.debug("In populateWithNodes in node : {}", node.getValue());
218 private boolean populateWithLinks(Graph<String, PceGraphEdge> weightedGraph) {
220 Iterator<Map.Entry<NodeId, PceNode>> nodes = allPceNodes.entrySet().iterator();
221 while (nodes.hasNext()) {
223 Map.Entry<NodeId, PceNode> node = nodes.next();
225 PceNode pcenode = node.getValue();
226 List<PceLink> links = pcenode.getOutgoingLinks();
228 LOG.debug("In populateGraph: use node for graph {}", pcenode);
230 for (PceLink link : links) {
231 LOG.debug("In populateGraph node {} : add edge to graph {}", pcenode, link);
233 if (!validateLinkforGraph(link)) {
236 if (State.InService.equals(link.getState())) {
237 PceGraphEdge graphLink = new PceGraphEdge(link);
238 weightedGraph.addEdge(link.getSourceId().getValue(), link.getDestId().getValue(), graphLink);
240 weightedGraph.setEdgeWeight(graphLink, chooseWeight(link));
247 private double chooseWeight(PceLink link) {
248 // HopCount is default
250 switch (pceHardConstraints.getPceMetrics()) {
253 LOG.debug("In PceGraph HopCount is used as a metrics. {}", link);
255 case PropagationDelay :
256 weight = link.getLatency();
257 LOG.debug("In PceGraph PropagationDelay is used as a metrics. {}", link);
259 && ("1GE".equals(serviceType) || "10GE".equals(serviceType) || "ODU4".equals(serviceType))) {
260 LOG.warn("PropagationDelay set as metric, but latency is null: is latency set for OTN link {}?",
264 // TODO implement IGPMetric and TEMetric - low priority.
268 LOG.warn("In PceGraph {} not implemented. HopCount works as a default",
269 pceHardConstraints.getPceMetrics());
275 public int getKpathsToBring() {
276 return kpathsToBring;
279 public void setKpathsToBring(int kpathsToBring) {
280 this.kpathsToBring = kpathsToBring;
283 public List<PceLink> getPathAtoZ() {
284 return shortestPathAtoZ;
287 public PceResult getReturnStructure() {
291 public Double getmargin() {
295 public void setConstrains(PceConstraints pceHardConstraintsInput) {
296 this.pceHardConstraints = pceHardConstraintsInput;