pce/src/main/java/org/opendaylight/transportpce/pce/graph/PceGraph.java

   1 /*
   2  * Copyright © 2017 AT&T, Inc. 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.pce.graph;
  10
  11 import java.util.ArrayList;
  12 import java.util.HashMap;
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import java.util.Map;
  16 import org.jgrapht.GraphPath;
  17 import org.jgrapht.alg.shortestpath.KShortestSimplePaths;
  18 import org.jgrapht.alg.shortestpath.PathValidator;
  19 import org.jgrapht.graph.DefaultDirectedWeightedGraph;
  20 import org.opendaylight.transportpce.common.ResponseCodes;
  21 import org.opendaylight.transportpce.common.StringConstants;
  22 import org.opendaylight.transportpce.pce.constraints.PceConstraints;
  23 import org.opendaylight.transportpce.pce.networkanalyzer.PceLink;
  24 import org.opendaylight.transportpce.pce.networkanalyzer.PceNode;
  25 import org.opendaylight.transportpce.pce.networkanalyzer.PceResult;
  26 import org.opendaylight.transportpce.pce.networkanalyzer.PceResult.LocalCause;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 public class PceGraph {
  33     /* Logging. */
  34     private static final Logger LOG = LoggerFactory.getLogger(PceGraph.class);
  35
  36     ////////////////////////// for Graph ///////////////////////////
  37     // how many paths to bring
  38     private int kpathsToBring = 10;
  39
  40     // max #hops
  41     private int mhopsPerPath = 50;
  42
  43     // input
  44     private Map<NodeId, PceNode> allPceNodes = new HashMap<>();
  45     private PceNode apceNode = null;
  46     private PceNode zpceNode = null;
  47     private String serviceType = "";
  48
  49     PceConstraints pceHardConstraints;
  50     PceConstraints pceSoftConstraints;
  51
  52     // results
  53     private PceResult pceResult = null;
  54     private List<PceLink> shortestPathAtoZ = null;
  55
  56     // for path calculation
  57     List<GraphPath<String, PceGraphEdge>> allWPaths = null;
  58
  59     private List<PceLink> pathAtoZ = new ArrayList<>();
  60
  61     public PceGraph(PceNode aendNode, PceNode zendNode, Map<NodeId, PceNode> allPceNodes,
  62             PceConstraints pceHardConstraints, PceConstraints pceSoftConstraints, PceResult pceResult,
  63             String serviceType) {
  64         super();
  65         this.apceNode = aendNode;
  66         this.zpceNode = zendNode;
  67         this.allPceNodes = allPceNodes;
  68         this.pceResult = pceResult;
  69         this.pceHardConstraints = pceHardConstraints;
  70         this.pceSoftConstraints = pceSoftConstraints;
  71         this.serviceType = serviceType;
  72
  73         LOG.info("In GraphCalculator: A and Z = {} / {} ", aendNode, zendNode);
  74         LOG.debug("In GraphCalculator: allPceNodes size {}, nodes {} ", allPceNodes.size(), allPceNodes);
  75     }
  76
  77     public boolean calcPath() {
  78
  79         LOG.info(" In PCE GRAPH calcPath : K SHORT PATHS algorithm ");
  80
  81         DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph =
  82                 new DefaultDirectedWeightedGraph<>(PceGraphEdge.class);
  83         populateWithNodes(weightedGraph);
  84         populateWithLinks(weightedGraph);
  85
  86         if (!runKgraphs(weightedGraph)) {
  87             LOG.info("In calcPath : pceResult {}", pceResult);
  88             return false;
  89         }
  90
  91         // validate found paths
  92         pceResult.setRC(ResponseCodes.RESPONSE_FAILED);
  93         for (GraphPath<String, PceGraphEdge> path : allWPaths) {
  94             PostAlgoPathValidator papv = new PostAlgoPathValidator();
  95             pceResult = papv.checkPath(path, allPceNodes, pceResult, pceHardConstraints, serviceType);
  96             LOG.info("In calcPath after PostAlgoPathValidator {} {}",
  97                     pceResult.getResponseCode(), ResponseCodes.RESPONSE_OK);
  98
  99             if (!pceResult.getResponseCode().equals(ResponseCodes.RESPONSE_OK)) {
 100                 LOG.info("In calcPath: post algo validations DROPPED the path {}", path);
 101                 continue;
 102             }
 103
 104             // build pathAtoZ
 105             pathAtoZ.clear();
 106             for (PceGraphEdge edge : path.getEdgeList()) {
 107                 pathAtoZ.add(edge.link());
 108             }
 109
 110             shortestPathAtoZ = new ArrayList<>(pathAtoZ);
 111             switch (serviceType) {
 112
 113                 case StringConstants.SERVICE_TYPE_100GE:
 114                 case StringConstants.SERVICE_TYPE_OTU4:
 115                     LOG.info(
 116                         "In calcPath Path FOUND path for wl [{}], min Freq assignment {}, max Freq assignment {},"
 117                         + " hops {}, distance per metrics {}, path AtoZ {}",
 118                         pceResult.getResultWavelength(), pceResult.getMinFreq(), pceResult.getMaxFreq(),
 119                         pathAtoZ.size(), path.getWeight(), pathAtoZ);
 120                     break;
 121
 122                 default:
 123                     LOG.info(
 124                         "In calcPath Path FOUND path for hops {}, distance per metrics {}, path AtoZ {}",
 125                         pathAtoZ.size(), path.getWeight(), pathAtoZ);
 126                     break;
 127             }
 128             break;
 129
 130         }
 131
 132         if (shortestPathAtoZ != null) {
 133             LOG.info("In calcPath CHOOSEN PATH for wl [{}], min freq {}, max freq {}, hops {}, path AtoZ {}",
 134                     pceResult.getResultWavelength(), pceResult.getMinFreq(), pceResult.getMaxFreq(),
 135                     shortestPathAtoZ.size(), shortestPathAtoZ);
 136         }
 137         LOG.info("In calcPath : pceResult {}", pceResult);
 138         return (pceResult.getStatus());
 139     }
 140
 141     private boolean runKgraphs(DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph) {
 142
 143         if (weightedGraph.edgeSet().isEmpty() || weightedGraph.vertexSet().isEmpty()) {
 144             return false;
 145         }
 146         PathValidator<String, PceGraphEdge> wpv = new InAlgoPathValidator();
 147
 148         // KShortestPaths on weightedGraph
 149         KShortestSimplePaths<String, PceGraphEdge> swp =
 150             new KShortestSimplePaths<>(weightedGraph, mhopsPerPath, wpv);
 151         allWPaths = swp.getPaths(apceNode.getNodeId().getValue(), zpceNode.getNodeId().getValue(), kpathsToBring);
 152
 153         if (allWPaths.isEmpty()) {
 154             LOG.info(" In runKgraphs : algorithm didn't find any path");
 155             pceResult.setLocalCause(LocalCause.NO_PATH_EXISTS);
 156             pceResult.setRC(ResponseCodes.RESPONSE_FAILED);
 157             return false;
 158         }
 159
 160         // debug print
 161         for (GraphPath<String, PceGraphEdge> path : allWPaths) {
 162             LOG.debug("path Weight: {} : {}", path.getWeight(), path.getVertexList());
 163         }
 164
 165         return true;
 166     }
 167
 168     private boolean validateLinkforGraph(PceLink pcelink) {
 169
 170         PceNode source = allPceNodes.get(pcelink.getSourceId());
 171         PceNode dest = allPceNodes.get(pcelink.getDestId());
 172
 173         if (source == null) {
 174             LOG.error("In addLinkToGraph link source node is null : {}", pcelink);
 175             return false;
 176         }
 177         if (dest == null) {
 178             LOG.error("In addLinkToGraph link dest node is null : {}", pcelink);
 179             return false;
 180         }
 181         LOG.debug("In addLinkToGraph link to nodes : {}{} {}", pcelink, source, dest);
 182         return true;
 183     }
 184
 185     private void populateWithNodes(DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph) {
 186         Iterator<Map.Entry<NodeId, PceNode>> nodes = allPceNodes.entrySet().iterator();
 187         while (nodes.hasNext()) {
 188             Map.Entry<NodeId, PceNode> node = nodes.next();
 189             if (State.InService.equals(node.getValue().getState())) {
 190                 weightedGraph.addVertex(node.getValue().getNodeId().getValue());
 191                 LOG.debug("In populateWithNodes in node :  {}", node.getValue());
 192             }
 193         }
 194     }
 195
 196     private boolean populateWithLinks(DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph) {
 197
 198         Iterator<Map.Entry<NodeId, PceNode>> nodes = allPceNodes.entrySet().iterator();
 199         while (nodes.hasNext()) {
 200
 201             Map.Entry<NodeId, PceNode> node = nodes.next();
 202
 203             PceNode pcenode = node.getValue();
 204             List<PceLink> links = pcenode.getOutgoingLinks();
 205
 206             LOG.debug("In populateGraph: use node for graph {}", pcenode);
 207
 208             for (PceLink link : links) {
 209                 LOG.debug("In populateGraph node {} : add edge to graph {}", pcenode, link);
 210
 211                 if (!validateLinkforGraph(link)) {
 212                     continue;
 213                 }
 214                 if (State.InService.equals(link.getState())) {
 215                     PceGraphEdge graphLink = new PceGraphEdge(link);
 216                     weightedGraph.addEdge(link.getSourceId().getValue(), link.getDestId().getValue(), graphLink);
 217
 218                     weightedGraph.setEdgeWeight(graphLink, chooseWeight(link));
 219                 }
 220             }
 221         }
 222         return true;
 223     }
 224
 225     private double chooseWeight(PceLink link) {
 226         // HopCount is default
 227         double weight = 1;
 228         switch (pceHardConstraints.getPceMetrics()) {
 229             case HopCount :
 230                 weight = 1;
 231                 LOG.debug("In PceGraph HopCount is used as a metrics. {}", link);
 232                 break;
 233             case PropagationDelay :
 234                 weight = link.getLatency();
 235                 LOG.debug("In PceGraph PropagationDelay is used as a metrics. {}", link);
 236                 if ((weight == 0)
 237                         && ("1GE".equals(serviceType) || "10GE".equals(serviceType) || "ODU4".equals(serviceType))) {
 238                     LOG.warn("PropagationDelay set as metric, but latency is null: is latency set for OTN link {}?",
 239                         link);
 240                 }
 241                 break;
 242             // TODO implement IGPMetric and TEMetric - low priority.
 243             case IGPMetric :
 244             case TEMetric :
 245             default:
 246                 LOG.warn("In PceGraph {} not implemented. HopCount works as a default",
 247                     pceHardConstraints.getPceMetrics());
 248                 break;
 249         }
 250         return weight;
 251     }
 252
 253     public int getKpathsToBring() {
 254         return kpathsToBring;
 255     }
 256
 257     public void setKpathsToBring(int kpathsToBring) {
 258         this.kpathsToBring = kpathsToBring;
 259     }
 260
 261     public void setMhopsPerPath(int mhopsPerPath) {
 262         this.mhopsPerPath = mhopsPerPath;
 263     }
 264
 265     public List<PceLink> getPathAtoZ() {
 266         return shortestPathAtoZ;
 267     }
 268
 269     public PceResult getReturnStructure() {
 270         return pceResult;
 271     }
 272
 273     public void setConstrains(PceConstraints pceHardConstraintsInput, PceConstraints pceSoftConstraintsInput) {
 274         this.pceHardConstraints = pceHardConstraintsInput;
 275         this.pceSoftConstraints = pceSoftConstraintsInput;
 276     }
 277 }