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
  17 import org.jgrapht.GraphPath;
  18 import org.jgrapht.alg.shortestpath.KShortestSimplePaths;
  19 import org.jgrapht.alg.shortestpath.PathValidator;
  20 import org.jgrapht.graph.DefaultDirectedWeightedGraph;
  21 import org.opendaylight.transportpce.common.ResponseCodes;
  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.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
  28
  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<NodeId, PceNode>();
  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<PceLink>();
  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.toString(), zendNode.toString());
  74         LOG.debug("In GraphCalculator: allPceNodes size {}, nodes {} ", allPceNodes.size(), allPceNodes.toString());
  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<String, PceGraphEdge>(PceGraphEdge.class);
  83         populateWithNodes(weightedGraph);
  84         populateWithLinks(weightedGraph);
  85
  86         if (!runKgraphs(weightedGraph)) {
  87             LOG.info("In calcPath : pceResult {}", pceResult.toString());
  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.toString());
 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             if (("100GE".equals(serviceType)) || ("OTU4".equals(serviceType))) {
 112                 LOG.info("In calcPath Path FOUND path for wl [{}], hops {}, distance per metrics {}, path AtoZ {}",
 113                         pceResult.getResultWavelength(), pathAtoZ.size(), path.getWeight(), pathAtoZ.toString());
 114                 break;
 115             } else {
 116                 // Service is at OTN layer and is relying on a supporting wavelength service
 117                 LOG.info("In calcPath Path FOUND path for hops {}, distance per metrics {}, path AtoZ {}",
 118                         pathAtoZ.size(), path.getWeight(), pathAtoZ.toString());
 119                 break;
 120             }
 121
 122         }
 123
 124         if (shortestPathAtoZ != null) {
 125             LOG.info("In calcPath CHOOSEN PATH for wl [{}], hops {}, path AtoZ {}",
 126                     pceResult.getResultWavelength(), shortestPathAtoZ.size(), shortestPathAtoZ.toString());
 127         }
 128         LOG.info("In calcPath : pceResult {}", pceResult.toString());
 129         return (pceResult.getStatus());
 130     }
 131
 132     private boolean runKgraphs(DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph) {
 133
 134         if (weightedGraph.edgeSet().isEmpty() || weightedGraph.vertexSet().isEmpty()) {
 135             return false;
 136         }
 137         PathValidator<String, PceGraphEdge> wpv = new InAlgoPathValidator();
 138
 139         // KShortestPaths on weightedGraph
 140         KShortestSimplePaths<String, PceGraphEdge> swp =
 141             new KShortestSimplePaths<String, PceGraphEdge>(weightedGraph, mhopsPerPath, wpv);
 142         allWPaths = swp.getPaths(apceNode.getNodeId().getValue(), zpceNode.getNodeId().getValue(), kpathsToBring);
 143
 144         if (allWPaths.isEmpty()) {
 145             LOG.info(" In runKgraphs : algorithm didn't find any path");
 146             pceResult.setLocalCause(LocalCause.NO_PATH_EXISTS);
 147             pceResult.setRC(ResponseCodes.RESPONSE_FAILED);
 148             return false;
 149         }
 150
 151         // debug print
 152         for (GraphPath<String, PceGraphEdge> path : allWPaths) {
 153             LOG.debug("path Weight: {} : {}", path.getWeight(), path.getVertexList().toString());
 154         }
 155
 156         return true;
 157     }
 158
 159     private boolean validateLinkforGraph(PceLink pcelink) {
 160
 161         PceNode source = allPceNodes.get(pcelink.getSourceId());
 162         PceNode dest = allPceNodes.get(pcelink.getDestId());
 163
 164         if (source == null) {
 165             LOG.error("In addLinkToGraph link source node is null : {}", pcelink.toString());
 166             return false;
 167         }
 168         if (dest == null) {
 169             LOG.error("In addLinkToGraph link dest node is null : {}", pcelink.toString());
 170             return false;
 171         }
 172         LOG.debug("In addLinkToGraph link to nodes : {}{} {}", pcelink.toString(), source.toString(), dest.toString());
 173         return true;
 174     }
 175
 176     private void populateWithNodes(DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph) {
 177         Iterator<Map.Entry<NodeId, PceNode>> nodes = allPceNodes.entrySet().iterator();
 178         while (nodes.hasNext()) {
 179             Map.Entry<NodeId, PceNode> node = nodes.next();
 180             weightedGraph.addVertex(node.getValue().getNodeId().getValue());
 181             LOG.debug("In populateWithNodes in node :  {}", node.getValue().toString());
 182         }
 183     }
 184
 185     private boolean populateWithLinks(DefaultDirectedWeightedGraph<String, PceGraphEdge> weightedGraph) {
 186
 187         Iterator<Map.Entry<NodeId, PceNode>> nodes = allPceNodes.entrySet().iterator();
 188         while (nodes.hasNext()) {
 189
 190             Map.Entry<NodeId, PceNode> node = nodes.next();
 191
 192             PceNode pcenode = node.getValue();
 193             List<PceLink> links = pcenode.getOutgoingLinks();
 194
 195             LOG.debug("In populateGraph: use node for graph {}", pcenode.toString());
 196
 197             for (PceLink link : links) {
 198                 LOG.debug("In populateGraph node {} : add edge to graph {}", pcenode.toString(), link.toString());
 199
 200                 if (!validateLinkforGraph(link)) {
 201                     continue;
 202                 }
 203
 204                 PceGraphEdge graphLink = new PceGraphEdge(link);
 205                 weightedGraph.addEdge(link.getSourceId().getValue(), link.getDestId().getValue(), graphLink);
 206
 207                 weightedGraph.setEdgeWeight(graphLink, chooseWeight(link));
 208             }
 209         }
 210         return true;
 211     }
 212
 213     private double chooseWeight(PceLink link) {
 214         // HopCount is default
 215         double weight = 1;
 216         switch (pceHardConstraints.getPceMetrics()) {
 217             case HopCount :
 218                 weight = 1;
 219                 LOG.debug("In PceGraph HopCount is used as a metrics. {}", link.toString());
 220                 break;
 221             case PropagationDelay :
 222                 weight = link.getLatency();
 223                 LOG.debug("In PceGraph PropagationDelay is used as a metrics. {}", link.toString());
 224                 if ((("1GE".equals(serviceType)) || ("10GE".equals(serviceType)) || ("ODU4".equals(serviceType)))
 225                         && (weight == 0)) {
 226                     LOG.warn("PropagationDelay set as metric, but latency is null: is latency set for OTN link {}?",
 227                         link.toString());
 228                 }
 229                 break;
 230             // TODO implement IGPMetric and TEMetric - low priority.
 231             case IGPMetric :
 232             case TEMetric :
 233             default:
 234                 LOG.warn("In PceGraph {} not implemented. HopCount works as a default",
 235                     pceHardConstraints.getPceMetrics());
 236                 break;
 237         }
 238         return weight;
 239     }
 240
 241     public int getKpathsToBring() {
 242         return kpathsToBring;
 243     }
 244
 245     public void setKpathsToBring(int kpathsToBring) {
 246         this.kpathsToBring = kpathsToBring;
 247     }
 248
 249     public void setMhopsPerPath(int mhopsPerPath) {
 250         this.mhopsPerPath = mhopsPerPath;
 251     }
 252
 253     public List<PceLink> getPathAtoZ() {
 254         return shortestPathAtoZ;
 255     }
 256
 257     public PceResult getReturnStructure() {
 258         return pceResult;
 259     }
 260
 261     public void setConstrains(PceConstraints pceHardConstraintsInput, PceConstraints pceSoftConstraintsInput) {
 262         this.pceHardConstraints = pceHardConstraintsInput;
 263         this.pceSoftConstraints = pceSoftConstraintsInput;
 264     }
 265 }