pce/src/main/java/org/opendaylight/transportpce/pce/networkanalyzer/PceNode.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.networkanalyzer;
  10
  11 import java.util.ArrayList;
  12 import java.util.HashMap;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Optional;
  16 import java.util.TreeMap;
  17
  18 import org.opendaylight.transportpce.pce.SortPortsByName;
  19 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.TerminationPoint1;
  20 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.Node1;
  21 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.networks.network.node.termination.point.pp.attributes.UsedWavelength;
  22 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmNodeType;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmTpType;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 public class PceNode {
  30     /* Logging. */
  31     private static final Logger LOG = LoggerFactory.getLogger(PceCalculation.class);
  32     ////////////////////////// NODES ///////////////////////////
  33     /*
  34      */
  35
  36     private boolean valid = true;
  37
  38     private final Node node;
  39     private final NodeId nodeId;
  40     private final OpenroadmNodeType nodeType;
  41     private final String supNodeId;
  42     private final String clli;
  43
  44     // wavelength calculation per node type
  45     private List<Long> availableWLindex = new ArrayList<Long>();
  46     private Map<String, OpenroadmTpType> availableSrgPp = new TreeMap<String, OpenroadmTpType>();
  47     private Map<String, OpenroadmTpType> availableSrgCp = new TreeMap<String, OpenroadmTpType>();
  48     private List<String> usedXpndrNWTps = new ArrayList<String>();
  49     private List<PceLink> outgoingLinks = new ArrayList<PceLink>();
  50     private Map<String, String> clientPerNwTp = new HashMap<String, String>();
  51
  52     public PceNode(Node node, OpenroadmNodeType nodeType, NodeId nodeId) {
  53         this.node = node;
  54         this.nodeId = nodeId;
  55         this.nodeType = nodeType;
  56         this.supNodeId = getSupNodeId(node);
  57         this.clli = MapUtils.getCLLI(node);
  58
  59         if ((node == null) || (nodeId == null) || (nodeType == null)) {
  60             LOG.error("PceNode: one of parameters is not populated : nodeId, node type");
  61             this.valid = false;
  62         }
  63     }
  64
  65     public void initSrgTps() {
  66         this.availableSrgPp.clear();
  67         this.availableSrgCp.clear();
  68         if (!isValid()) {
  69             return;
  70         }
  71         LOG.info("initSrgTpList: getting SRG tps from ROADM node {}", this.nodeId);
  72         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 nodeTp =
  73                 this.node.augmentation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology
  74                                 .rev180226.Node1.class);
  75         List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
  76             .node.TerminationPoint> allTps =
  77                 nodeTp.getTerminationPoint();
  78         if (allTps == null) {
  79             LOG.error("initSrgTpList: ROADM TerminationPoint list is empty for node {}", this.toString());
  80             this.valid = false;
  81             return;
  82         }
  83         for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
  84             .node.TerminationPoint tp : allTps) {
  85             TerminationPoint1 cntp1 = tp.augmentation(TerminationPoint1.class);
  86             org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.TerminationPoint1 nttp1 = tp
  87                 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130
  88                 .TerminationPoint1.class);
  89             OpenroadmTpType type = cntp1.getTpType();
  90             LOG.info("type = {} for tp {}", type.getName(), tp.toString());
  91
  92             switch (type) {
  93                 case SRGTXRXCP:
  94                 case SRGRXCP:
  95                 case SRGTXCP:
  96                     LOG.info("initSrgTpList: adding SRG-CP tp = {} ", tp.getTpId().getValue());
  97                     this.availableSrgCp.put(tp.getTpId().getValue(), cntp1.getTpType());
  98                     break;
  99                 case SRGRXPP:
 100                 case SRGTXPP:
 101                 case SRGTXRXPP:
 102                     boolean used = true;
 103                     LOG.info("initSrgTpList: SRG-PP tp = {} found", tp.getTpId().getValue());
 104                     try {
 105                         List<UsedWavelength> usedWavelengths = nttp1.getPpAttributes().getUsedWavelength();
 106                         if (usedWavelengths.isEmpty()) {
 107                             used = false;
 108                         }
 109                     } catch (NullPointerException e) {
 110                         LOG.warn("initSrgTpList: 'usedWavelengths' for tp={} is null !", tp.getTpId().getValue());
 111                         used = false;
 112                     }
 113                     if (!used) {
 114                         LOG.info("initSrgTpList: adding SRG-PP tp '{}'", tp.getTpId().getValue());
 115                         this.availableSrgPp.put(tp.getTpId().getValue(), cntp1.getTpType());
 116                     } else {
 117                         LOG.warn("initSrgTpList: SRG-PP tp = {} found is busy !!");
 118                     }
 119                     break;
 120                 default:
 121                     break;
 122             }
 123         }
 124         if (this.availableSrgPp.isEmpty() && this.availableSrgCp.isEmpty()) {
 125             LOG.error("initSrgTpList: ROADM SRG TerminationPoint list is empty for node {}", this.toString());
 126             this.valid = false;
 127             return;
 128         }
 129         LOG.info("initSrgTpList: availableSrgPp size = {} && availableSrgCp size = {} in {}", this.availableSrgPp
 130                 .size(), this.availableSrgCp.size(), this.toString());
 131         return;
 132     }
 133
 134     public void initWLlist() {
 135         this.availableWLindex.clear();
 136         if (!isValid()) {
 137             return;
 138         }
 139         Node1 node1 = this.node.augmentation(Node1.class);
 140         switch (this.nodeType) {
 141             case SRG :
 142                 List<org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev181130.srg.node.attributes
 143                     .AvailableWavelengths> srgAvailableWL =
 144                         node1.getSrgAttributes().getAvailableWavelengths();
 145                 if (srgAvailableWL == null) {
 146                     this.valid = false;
 147                     LOG.error("initWLlist: SRG AvailableWavelengths is empty for node  {}", this.toString());
 148                     return;
 149                 }
 150                 for (org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev181130.srg.node.attributes
 151                         .AvailableWavelengths awl : srgAvailableWL) {
 152                     this.availableWLindex.add(awl.getIndex());
 153                     LOG.debug("initWLlist: SRG next = {} in {}", awl.getIndex(), this.toString());
 154                 }
 155                 break;
 156             case DEGREE :
 157                 List<org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev181130.degree.node.attributes
 158                     .AvailableWavelengths> degAvailableWL = node1.getDegreeAttributes().getAvailableWavelengths();
 159                 if (degAvailableWL == null) {
 160                     this.valid = false;
 161                     LOG.error("initWLlist: DEG AvailableWavelengths is empty for node  {}", this.toString());
 162                     return;
 163                 }
 164                 for (org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev181130.degree.node.attributes
 165                             .AvailableWavelengths awl : degAvailableWL) {
 166                     this.availableWLindex.add(awl.getIndex());
 167                     LOG.debug("initWLlist: DEGREE next = {} in {}", awl.getIndex(), this.toString());
 168                 }
 169                 break;
 170             case XPONDER :
 171                 // HARD CODED 96
 172                 for (long i = 1; i <= 96; i++) {
 173                     this.availableWLindex.add(i);
 174                 }
 175                 break;
 176             default:
 177                 LOG.error("initWLlist: unsupported node type {} in node {}", this.nodeType, this.toString());
 178                 break;
 179         }
 180         if (this.availableWLindex.size() == 0) {
 181             LOG.debug("initWLlist: There are no available wavelengths in node {}", this.toString());
 182             this.valid = false;
 183         }
 184         LOG.debug("initWLlist: availableWLindex size = {} in {}", this.availableWLindex.size(), this.toString());
 185         return;
 186     }
 187
 188     public void initXndrTps() {
 189         LOG.info("initXndrTps for node : {}", this.nodeId);
 190         if (!isValid()) {
 191             return;
 192         }
 193         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 nodeTp =
 194                 this.node.augmentation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology
 195                         .rev180226.Node1.class);
 196         List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
 197             .node.TerminationPoint> allTps = nodeTp.getTerminationPoint();
 198         if (allTps == null) {
 199             this.valid = false;
 200             LOG.error("initXndrTps: XPONDER TerminationPoint list is empty for node {}", this.toString());
 201             return;
 202         }
 203         this.valid = false;
 204         for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
 205             .node.TerminationPoint tp : allTps) {
 206             TerminationPoint1 cntp1 = tp.augmentation(TerminationPoint1.class);
 207             org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.TerminationPoint1 nttp1 = tp
 208                 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130
 209                 .TerminationPoint1.class);
 210             if (cntp1.getTpType() == OpenroadmTpType.XPONDERNETWORK) {
 211                 if (nttp1.getXpdrNetworkAttributes().getWavelength() != null) {
 212                     this.usedXpndrNWTps.add(tp.getTpId().getValue());
 213                     LOG.debug("initXndrTps: XPONDER tp = {} is used", tp.getTpId().getValue());
 214                 } else {
 215                     this.valid = true;
 216                 }
 217                 // find Client of this network TP
 218                 String client = nttp1.getXpdrNetworkAttributes().getTailEquipmentId();
 219                 if ((client.equals("")) || (client == null)) {
 220                     LOG.error("initXndrTps: XPONDER {} NW TP doesn't have defined Client {}", this.toString(), tp
 221                             .getTpId().getValue());
 222                     this.valid = false;
 223                 }
 224                 this.clientPerNwTp.put(tp.getTpId().getValue(), client);
 225             }
 226         }
 227         if (!isValid()) {
 228             LOG.error("initXndrTps: XPONDER doesn't have available wavelengths for node  {}", this.toString());
 229             return;
 230         }
 231     }
 232
 233     public String getRdmSrgClient(String tp, Boolean aend) {
 234         LOG.info("getRdmSrgClient: Getting PP client for tp '{}' on node : {}", tp, this.nodeId);
 235         OpenroadmTpType srgType = null;
 236         OpenroadmTpType cpType = this.availableSrgCp.get(tp);
 237         if (cpType == null) {
 238             LOG.error("getRdmSrgClient: tp {} not existed in SRG CPterminationPoint list");
 239             return null;
 240         }
 241         switch (cpType) {
 242             case SRGTXRXCP:
 243                 LOG.info("getRdmSrgClient: Getting BI Directional PP port ...");
 244                 srgType = OpenroadmTpType.SRGTXRXPP;
 245                 break;
 246             case SRGTXCP:
 247                 LOG.info("getRdmSrgClient: Getting UNI Rx PP port ...");
 248                 srgType = OpenroadmTpType.SRGRXPP;
 249                 break;
 250             case SRGRXCP:
 251                 LOG.info("getRdmSrgClient: Getting UNI Tx PP port ...");
 252                 srgType = OpenroadmTpType.SRGTXPP;
 253                 break;
 254             default:
 255                 break;
 256         }
 257         LOG.info("getRdmSrgClient:  Getting client PP for CP '{}'", tp);
 258         if (!this.availableSrgPp.isEmpty()) {
 259             Optional<String> client = null;
 260             final OpenroadmTpType openType = srgType;
 261             client = this.availableSrgPp.entrySet()
 262                     .stream().filter(pp -> pp.getValue().getName().equals(openType.getName()))
 263                     .map(Map.Entry::getKey)
 264                     .sorted(new SortPortsByName())
 265                     .findFirst();
 266             if (!client.isPresent()) {
 267                 LOG.error("getRdmSrgClient: ROADM {} doesn't have PP Client for CP {}", this.toString(), tp);
 268                 return null;
 269             }
 270             LOG.info("getRdmSrgClient: client PP {} for CP {} found !", client, tp);
 271             return client.get();
 272         } else {
 273             LOG.error("getRdmSrgClient: SRG TerminationPoint PP list is not available for node {}", this.toString());
 274             return null;
 275         }
 276     }
 277
 278     private String getSupNodeId(Node inputNode) {
 279         String tempSupId = "";
 280         // TODO: supporting IDs exist as a List. this code takes just the
 281         // first element
 282         tempSupId = MapUtils.getSupNode(inputNode);
 283         if (tempSupId.equals("")) {
 284             LOG.error("getSupNodeId: Empty Supporting node for node: [{}]. Node is ignored", inputNode.getNodeId());
 285         }
 286         return tempSupId;
 287     }
 288
 289     public void validateAZxponder(String anodeId, String znodeId) {
 290         if (!isValid()) {
 291             return;
 292         }
 293
 294         if (this.nodeType != OpenroadmNodeType.XPONDER) {
 295             return;
 296         }
 297
 298         // Detect A and Z
 299         if (this.supNodeId.equals(anodeId) || (this.supNodeId.equals(znodeId))) {
 300
 301             LOG.info("validateAZxponder: A or Z node detected == {}", nodeId.getValue());
 302             initXndrTps();
 303             return;
 304         }
 305
 306         LOG.debug("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
 307         valid = false;
 308     }
 309
 310     public String getXpdrClient(String tp) {
 311         return this.clientPerNwTp.get(tp);
 312     }
 313
 314     public boolean checkTP(String tp) {
 315         return !(this.usedXpndrNWTps.contains(tp));
 316     }
 317
 318     public boolean checkWL(long index) {
 319         return (this.availableWLindex.contains(index));
 320     }
 321
 322     public boolean isValid() {
 323         if ((node == null) || (nodeId == null) || (nodeType == null) || (supNodeId == null) || (clli == null)) {
 324             LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
 325             valid = false;
 326         }
 327         return valid;
 328     }
 329
 330     public List<Long> getAvailableWLs() {
 331         return availableWLindex;
 332     }
 333
 334     public void addOutgoingLink(PceLink outLink) {
 335         this.outgoingLinks.add(outLink);
 336     }
 337
 338     public List<PceLink> getOutgoingLinks() {
 339         return outgoingLinks;
 340     }
 341
 342     public String getClient(String tp) {
 343         return clientPerNwTp.get(tp);
 344     }
 345
 346     public NodeId getNodeId() {
 347         return nodeId;
 348     }
 349
 350     public String getSupNodeIdPceNode() {
 351         return supNodeId;
 352     }
 353
 354     public String getCLLI() {
 355         return clli;
 356     }
 357
 358     public String toString() {
 359         return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + clli;
 360     }
 361
 362     public void printLinksOfNode() {
 363         LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks().toString());
 364     }
 365
 366 }