Handle missing spanloss in PCE without crashing
[transportpce.git] / pce / src / main / java / org / opendaylight / transportpce / pce / networkanalyzer / PceLink.java
index cf303055bb2d6e0ebec098a88f9f3154787a51be..2d05a3e0989691eb4d65f8fd5cd54443c1fd3703 100644 (file)
@@ -8,28 +8,29 @@
 
 package org.opendaylight.transportpce.pce.networkanalyzer;
 
-import java.io.IOException;
-import java.io.ObjectInputStream;
-import java.io.ObjectOutputStream;
 import java.io.Serializable;
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
-import org.eclipse.jdt.annotation.NonNull;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.Link1;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev181130.span.attributes.LinkConcatenation;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev181130.span.attributes.LinkConcatenation.FiberType;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev181130.span.attributes.LinkConcatenationKey;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev181130.networks.network.link.oms.attributes.Span;
-import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmLinkType;
-import org.opendaylight.yang.gen.v1.http.transportpce.topology.rev200129.OtnLinkType;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.networkutils.rev220630.OtnLinkType;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev211210.Link1;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.span.attributes.LinkConcatenation1;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev211210.span.attributes.LinkConcatenation1.FiberType;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev211210.networks.network.link.oms.attributes.Span;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.OpenroadmLinkType;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenation;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev211210.link.concatenation.LinkConcatenationKey;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@SuppressWarnings("serial")
 @edu.umd.cs.findbugs.annotations.SuppressFBWarnings(
     value = "SE_NO_SERIALVERSIONID",
     justification = "https://github.com/rzwitserloot/lombok/wiki/WHY-NOT:-serialVersionUID")
@@ -43,7 +44,6 @@ public class PceLink implements Serializable {
      */
     double weight = 0;
     private boolean isValid = true;
-    private boolean isOtnValid = true;
 
     // this member is for XPONDER INPUT/OUTPUT links.
     // it keeps name of client corresponding to NETWORK TP
@@ -52,27 +52,30 @@ public class PceLink implements Serializable {
     private final OpenroadmLinkType linkType;
     private final NodeId sourceId;
     private final NodeId destId;
-    private transient Object sourceTP;
-    private transient Object destTP;
+    private final TpId sourceTP;
+    private final TpId destTP;
     private final String sourceNetworkSupNodeId;
     private final String destNetworkSupNodeId;
     private final String sourceCLLI;
     private final String destCLLI;
     private final LinkId oppositeLink;
+    private final AdminStates adminStates;
+    private final State state;
     private final Long latency;
     private final Long availableBandwidth;
     private final Long usedBandwidth;
     private final List<Long> srlgList;
     private final double osnr;
     private final transient Span omsAttributesSpan;
-    private static final double CELERITY = 2.99792458 * 1e5; //meter per ms
+    //meter per ms
+    private static final double CELERITY = 2.99792458 * 1e5;
     private static final double NOISE_MASK_A = 0.571429;
     private static final double NOISE_MASK_B = 39.285714;
     private static final double UPPER_BOUND_OSNR = 33;
     private static final double LOWER_BOUND_OSNR = 0.1;
 
     public PceLink(Link link, PceNode source, PceNode dest) {
-        LOG.info("PceLink: : PceLink start ");
+        LOG.debug("PceLink: : PceLink start ");
 
         this.linkId = link.getLinkId();
 
@@ -92,6 +95,9 @@ public class PceLink implements Serializable {
 
         this.oppositeLink = calcOpposite(link);
 
+        this.adminStates = link.augmentation(Link1.class).getAdministrativeState();
+        this.state = link.augmentation(Link1.class).getOperationalState();
+
         if (this.linkType == OpenroadmLinkType.ROADMTOROADM) {
             this.omsAttributesSpan = MapUtils.getOmsAttributesSpan(link);
             this.srlgList = MapUtils.getSRLG(link);
@@ -110,7 +116,8 @@ public class PceLink implements Serializable {
             this.omsAttributesSpan = null;
             this.srlgList = null;
             this.latency = 0L;
-            this.osnr = 100L; //infinite OSNR in DB
+            //infinite OSNR in DB
+            this.osnr = 100L;
             this.availableBandwidth = 0L;
             this.usedBandwidth = 0L;
         }
@@ -129,34 +136,30 @@ public class PceLink implements Serializable {
 
     //Compute the link latency : if the latency is not defined, the latency is computed from the omsAttributesSpan
     private Long calcLatency(Link link) {
-        Link1 link1 = null;
-        Long tmplatency;
-        link1 = link.augmentation(Link1.class);
+        Link1 link1 = link.augmentation(Link1.class);
         if (link1.getLinkLatency() != null) {
-            tmplatency = link1.getLinkLatency().toJava();
-            return tmplatency;
+            return link1.getLinkLatency().toJava();
         }
-
-        try {
-            double tmp = 0;
-            @NonNull
-            Map<LinkConcatenationKey, LinkConcatenation> linkConcatenationMap =
-                this.omsAttributesSpan.nonnullLinkConcatenation();
-            for (Map.Entry<LinkConcatenationKey, LinkConcatenation> entry : linkConcatenationMap.entrySet()) {
-                //Length is expressed in meter and latency is expressed in ms according to OpenROADM MSA
-                tmp += entry.getValue().getSRLGLength().toJava() / CELERITY;
-                LOG.info("In PceLink: The latency of link {} == {}",link.getLinkId(),tmp);
+        if (this.omsAttributesSpan == null) {
+            return 1L;
+        }
+        double tmp = 0;
+        Map<LinkConcatenationKey, LinkConcatenation> linkConcatenationMap = this.omsAttributesSpan
+                .nonnullLinkConcatenation();
+        for (Map.Entry<LinkConcatenationKey, LinkConcatenation> entry : linkConcatenationMap.entrySet()) {
+            // Length is expressed in meter and latency is expressed in ms according to OpenROADM MSA
+            if (entry == null || entry.getValue() == null || entry.getValue().getSRLGLength() == null) {
+                LOG.debug("In PceLink: cannot compute the latency for the link {}", link.getLinkId().getValue());
+                return 1L;
             }
-            tmplatency = (long) Math.ceil(tmp);
-        } catch (NullPointerException e) {
-            LOG.debug("In PceLink: cannot compute the latency for the link {}",link.getLinkId().getValue());
-            tmplatency = 1L;
+            tmp += entry.getValue().getSRLGLength().doubleValue() / CELERITY;
+            LOG.debug("In PceLink: The latency of link {} == {}", link.getLinkId(), tmp);
         }
-        return tmplatency;
+        return (long) Math.ceil(tmp);
     }
 
     //Compute the OSNR of a span
-    public double calcSpanOSNR() {
+    private double calcSpanOSNR() {
         if (this.omsAttributesSpan == null) {
             return 0L;
         }
@@ -170,11 +173,17 @@ public class PceLink implements Serializable {
         if (!linkConcatenationiterator.hasNext()) {
             return 0L;
         }
+        if (this.omsAttributesSpan.getSpanlossCurrent() == null) {
+            LOG.error("in PceLink : Spanloss is null");
+            return 0L;
+        }
         // power on the output of the previous ROADM (dBm)
-        double pout = retrievePower(linkConcatenationiterator.next().getFiberType());
+        double pout = retrievePower(linkConcatenationiterator.next().augmentation(LinkConcatenation1.class)
+            .getFiberType());
         // span loss (dB)
         double spanLoss = this.omsAttributesSpan.getSpanlossCurrent().getValue().doubleValue();
-        double pin = pout - spanLoss; // power on the input of the current ROADM (dBm)
+        // power on the input of the current ROADM (dBm)
+        double pin = pout - spanLoss;
         double spanOsnrDb = NOISE_MASK_A * pin + NOISE_MASK_B;
         if (spanOsnrDb > UPPER_BOUND_OSNR) {
             spanOsnrDb = UPPER_BOUND_OSNR;
@@ -212,11 +221,19 @@ public class PceLink implements Serializable {
         return oppositeLink;
     }
 
-    public Object getSourceTP() {
+    public AdminStates getAdminStates() {
+        return adminStates;
+    }
+
+    public State getState() {
+        return state;
+    }
+
+    public TpId getSourceTP() {
         return sourceTP;
     }
 
-    public Object getDestTP() {
+    public TpId getDestTP() {
         return destTP;
     }
 
@@ -286,22 +303,15 @@ public class PceLink implements Serializable {
             isValid = false;
             LOG.error("PceLink: No Link type or opposite link is available. Link is ignored {}", linkId);
         }
-        if ((this.sourceId == null) || (this.destId == null) || (this.sourceTP == null) || (this.destTP == null)) {
-            isValid = false;
-            LOG.error("PceLink: No Link source or destination is available. Link is ignored {}", linkId);
-        }
-        if ((this.sourceNetworkSupNodeId.equals("")) || (this.destNetworkSupNodeId.equals(""))) {
-            isValid = false;
-            LOG.error("PceLink: No Link source SuppNodeID or destination SuppNodeID is available. Link is ignored {}",
-                linkId);
-        }
-        if ((this.sourceCLLI.equals("")) || (this.destCLLI.equals(""))) {
-            isValid = false;
-            LOG.error("PceLink: No Link source CLLI or destination CLLI is available. Link is ignored {}", linkId);
-        }
-        if ((this.omsAttributesSpan == null) && (this.linkType == OpenroadmLinkType.ROADMTOROADM)) {
-            isValid = false;
-            LOG.error("PceLink: Error reading Span for OMS link. Link is ignored {}", linkId);
+        isValid = checkParams();
+        if (this.linkType == OpenroadmLinkType.ROADMTOROADM) {
+            if (this.omsAttributesSpan == null) {
+                isValid = false;
+                LOG.error("PceLink: Error reading Span for OMS link. Link is ignored {}", linkId);
+            } else if (this.omsAttributesSpan.getSpanlossCurrent() == null) {
+                isValid = false;
+                LOG.error("PceLink: Error reading Spanloss for OMS link. Link is ignored {}", linkId);
+            }
         }
         if ((this.srlgList != null) && (this.srlgList.isEmpty())) {
             isValid = false;
@@ -318,7 +328,8 @@ public class PceLink implements Serializable {
         }
 
         OtnLinkType otnLinkType = link
-            .augmentation(org.opendaylight.yang.gen.v1.http.transportpce.topology.rev200129.Link1.class)
+            .augmentation(org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.networkutils
+                    .rev220630.Link1.class)
             .getOtnLinkType();
         if (this.availableBandwidth == 0L) {
             LOG.error("PceLink: No bandwidth available for OTN Link, link {}  is ignored ", linkId);
@@ -328,8 +339,31 @@ public class PceLink implements Serializable {
         long neededBW;
         OtnLinkType neededType = null;
         switch (serviceType) {
-
+            case "ODUC2":
+                if (this.usedBandwidth != 0L) {
+                    return false;
+                }
+                neededBW = 200000L;
+                // Add intermediate rate otn-link-type
+                neededType = OtnLinkType.OTUC2;
+                break;
+            case "ODUC3":
+                if (this.usedBandwidth != 0L) {
+                    return false;
+                }
+                neededBW = 300000L;
+                // hange otn-link-type
+                neededType = OtnLinkType.OTUC3;
+                break;
+            case "ODUC4":
+                if (this.usedBandwidth != 0L) {
+                    return false;
+                }
+                neededBW = 400000L;
+                neededType = OtnLinkType.OTUC4;
+                break;
             case "ODU4":
+            case "100GEs":
                 if (this.usedBandwidth != 0L) {
                     return false;
                 }
@@ -346,6 +380,11 @@ public class PceLink implements Serializable {
             case "ODU1":
                 neededBW = 2500L;
                 break;
+            case "100GEm":
+                neededBW = 100000L;
+                // TODO: Here link type needs to be changed, based on the line-rate
+                neededType = OtnLinkType.ODUC4;
+                break;
             case "10GE":
                 neededBW = 10000L;
                 neededType = OtnLinkType.ODTU4;
@@ -361,14 +400,22 @@ public class PceLink implements Serializable {
 
         if ((this.availableBandwidth >= neededBW)
             && ((neededType == null) || (neededType.equals(otnLinkType)))) {
-            LOG.info("PceLink: Selected Link {} has available bandwidth and is eligible for {} creation ",
+            LOG.debug("PceLink: Selected Link {} has available bandwidth and is eligible for {} creation ",
                 linkId, serviceType);
         }
 
+        return checkParams();
+    }
+
+    private boolean checkParams() {
         if ((this.linkId == null) || (this.linkType == null) || (this.oppositeLink == null)) {
             LOG.error("PceLink: No Link type or opposite link is available. Link is ignored {}", linkId);
             return false;
         }
+        if ((this.adminStates == null) || (this.state == null)) {
+            LOG.error("PceLink: Link is not available. Link is ignored {}", linkId);
+            return false;
+        }
         if ((this.sourceId == null) || (this.destId == null) || (this.sourceTP == null) || (this.destTP == null)) {
             LOG.error("PceLink: No Link source or destination is available. Link is ignored {}", linkId);
             return false;
@@ -390,16 +437,4 @@ public class PceLink implements Serializable {
     public String toString() {
         return "PceLink type=" + linkType + " ID=" + linkId.getValue() + " latency=" + latency;
     }
-
-    private void writeObject(ObjectOutputStream out) throws IOException {
-        out.defaultWriteObject();
-        out.writeObject(this.sourceTP);
-        out.writeObject(this.destTP);
-    }
-
-    private void readObject(ObjectInputStream in) throws IOException,ClassNotFoundException {
-        in.defaultReadObject();
-        this.sourceTP = in.readObject();
-        this.destTP = in.readObject();
-    }
 }