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.networkanalyzer;
11 import java.io.IOException;
12 import java.io.ObjectInputStream;
13 import java.io.ObjectOutputStream;
14 import java.io.Serializable;
15 import java.util.Collection;
16 import java.util.Iterator;
17 import java.util.List;
19 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Link1;
20 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
21 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev200529.span.attributes.LinkConcatenation;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev200529.span.attributes.LinkConcatenation.FiberType;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.link.rev200529.span.attributes.LinkConcatenationKey;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev200529.networks.network.link.oms.attributes.Span;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmLinkType;
27 import org.opendaylight.yang.gen.v1.http.transportpce.topology.rev201019.OtnLinkType;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.LinkId;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
34 @SuppressWarnings("serial")
35 @edu.umd.cs.findbugs.annotations.SuppressFBWarnings(
36 value = "SE_NO_SERIALVERSIONID",
37 justification = "https://github.com/rzwitserloot/lombok/wiki/WHY-NOT:-serialVersionUID")
38 public class PceLink implements Serializable {
41 private static final Logger LOG = LoggerFactory.getLogger(PceLink.class);
42 ///////////////////////// LINKS ////////////////////
44 * extension of Link to include constraints and Graph weight
47 private boolean isValid = true;
49 // this member is for XPONDER INPUT/OUTPUT links.
50 // it keeps name of client corresponding to NETWORK TP
51 private String client = "";
52 private final LinkId linkId;
53 private final OpenroadmLinkType linkType;
54 private final NodeId sourceId;
55 private final NodeId destId;
56 private transient Object sourceTP;
57 private transient Object destTP;
58 private final String sourceNetworkSupNodeId;
59 private final String destNetworkSupNodeId;
60 private final String sourceCLLI;
61 private final String destCLLI;
62 private final LinkId oppositeLink;
63 private final AdminStates adminStates;
64 private final State state;
65 private final Long latency;
66 private final Long availableBandwidth;
67 private final Long usedBandwidth;
68 private final List<Long> srlgList;
69 private final double osnr;
70 private final transient Span omsAttributesSpan;
72 private static final double CELERITY = 2.99792458 * 1e5;
73 private static final double NOISE_MASK_A = 0.571429;
74 private static final double NOISE_MASK_B = 39.285714;
75 private static final double UPPER_BOUND_OSNR = 33;
76 private static final double LOWER_BOUND_OSNR = 0.1;
78 public PceLink(Link link, PceNode source, PceNode dest) {
79 LOG.info("PceLink: : PceLink start ");
81 this.linkId = link.getLinkId();
83 this.sourceId = link.getSource().getSourceNode();
84 this.destId = link.getDestination().getDestNode();
86 this.sourceTP = link.getSource().getSourceTp();
87 this.destTP = link.getDestination().getDestTp();
89 this.sourceNetworkSupNodeId = source.getSupNetworkNodeId();
90 this.destNetworkSupNodeId = dest.getSupNetworkNodeId();
92 this.sourceCLLI = source.getSupClliNodeId();
93 this.destCLLI = dest.getSupClliNodeId();
95 this.linkType = MapUtils.calcType(link);
97 this.oppositeLink = calcOpposite(link);
99 this.adminStates = link.augmentation(Link1.class).getAdministrativeState();
100 this.state = link.augmentation(Link1.class).getOperationalState();
102 if (this.linkType == OpenroadmLinkType.ROADMTOROADM) {
103 this.omsAttributesSpan = MapUtils.getOmsAttributesSpan(link);
104 this.srlgList = MapUtils.getSRLG(link);
105 this.latency = calcLatency(link);
106 this.osnr = calcSpanOSNR();
107 this.availableBandwidth = 0L;
108 this.usedBandwidth = 0L;
109 } else if (this.linkType == OpenroadmLinkType.OTNLINK) {
110 this.availableBandwidth = MapUtils.getAvailableBandwidth(link);
111 this.usedBandwidth = MapUtils.getUsedBandwidth(link);
112 this.srlgList = MapUtils.getSRLGfromLink(link);
115 this.omsAttributesSpan = null;
117 this.omsAttributesSpan = null;
118 this.srlgList = null;
120 //infinite OSNR in DB
122 this.availableBandwidth = 0L;
123 this.usedBandwidth = 0L;
125 LOG.debug("PceLink: created PceLink {}", linkId);
128 //Retrieve the opposite link
129 private LinkId calcOpposite(Link link) {
130 LinkId tmpoppositeLink = MapUtils.extractOppositeLink(link);
131 if (tmpoppositeLink == null) {
132 LOG.error("PceLink: Error calcOpposite. Link is ignored {}", link.getLinkId().getValue());
135 return tmpoppositeLink;
138 //Compute the link latency : if the latency is not defined, the latency is computed from the omsAttributesSpan
139 private Long calcLatency(Link link) {
140 Link1 link1 = link.augmentation(Link1.class);
141 if (link1.getLinkLatency() != null) {
142 return link1.getLinkLatency().toJava();
144 if (this.omsAttributesSpan == null) {
148 Map<LinkConcatenationKey, LinkConcatenation> linkConcatenationMap = this.omsAttributesSpan
149 .nonnullLinkConcatenation();
150 for (Map.Entry<LinkConcatenationKey, LinkConcatenation> entry : linkConcatenationMap.entrySet()) {
151 // Length is expressed in meter and latency is expressed in ms according to OpenROADM MSA
152 if (entry == null || entry.getValue() == null || entry.getValue().getSRLGLength() == null) {
153 LOG.debug("In PceLink: cannot compute the latency for the link {}", link.getLinkId().getValue());
156 tmp += entry.getValue().getSRLGLength().toJava() / CELERITY;
157 LOG.info("In PceLink: The latency of link {} == {}", link.getLinkId(), tmp);
159 return (long) Math.ceil(tmp);
162 //Compute the OSNR of a span
163 public double calcSpanOSNR() {
164 if (this.omsAttributesSpan == null) {
167 Collection<LinkConcatenation> linkConcatenationList =
168 this.omsAttributesSpan.nonnullLinkConcatenation().values();
169 if (linkConcatenationList == null) {
170 LOG.error("in PceLink : Null field in the OmsAttrubtesSpan");
173 Iterator<LinkConcatenation> linkConcatenationiterator = linkConcatenationList.iterator();
174 if (!linkConcatenationiterator.hasNext()) {
177 // power on the output of the previous ROADM (dBm)
178 double pout = retrievePower(linkConcatenationiterator.next().getFiberType());
180 double spanLoss = this.omsAttributesSpan.getSpanlossCurrent().getValue().doubleValue();
181 // power on the input of the current ROADM (dBm)
182 double pin = pout - spanLoss;
183 double spanOsnrDb = NOISE_MASK_A * pin + NOISE_MASK_B;
184 if (spanOsnrDb > UPPER_BOUND_OSNR) {
185 spanOsnrDb = UPPER_BOUND_OSNR;
186 } else if (spanOsnrDb < LOWER_BOUND_OSNR) {
187 spanOsnrDb = LOWER_BOUND_OSNR;
192 private double retrievePower(FiberType fiberType) {
216 public LinkId getOppositeLink() {
220 public AdminStates getAdminStates() {
224 public State getState() {
228 public Object getSourceTP() {
232 public Object getDestTP() {
236 public OpenroadmLinkType getlinkType() {
240 public LinkId getLinkId() {
244 public NodeId getSourceId() {
248 public NodeId getDestId() {
252 public String getClient() {
256 public void setClient(String client) {
257 this.client = client;
260 // Double for transformer of JUNG graph
261 public Double getLatency() {
262 return latency.doubleValue();
265 public Long getAvailableBandwidth() {
266 return availableBandwidth;
269 public Long getUsedBandwidth() {
270 return usedBandwidth;
273 public String getsourceNetworkSupNodeId() {
274 return sourceNetworkSupNodeId;
277 public String getdestNetworkSupNodeId() {
278 return destNetworkSupNodeId;
281 public List<Long> getsrlgList() {
285 public double getosnr() {
289 public String getsourceCLLI() {
293 public String getdestCLLI() {
297 public boolean isValid() {
298 if ((this.linkId == null) || (this.linkType == null) || (this.oppositeLink == null)) {
300 LOG.error("PceLink: No Link type or opposite link is available. Link is ignored {}", linkId);
302 isValid = checkParams();
303 if ((this.omsAttributesSpan == null) && (this.linkType == OpenroadmLinkType.ROADMTOROADM)) {
305 LOG.error("PceLink: Error reading Span for OMS link. Link is ignored {}", linkId);
307 if ((this.srlgList != null) && (this.srlgList.isEmpty())) {
309 LOG.error("PceLink: Empty srlgList for OMS link. Link is ignored {}", linkId);
314 public boolean isOtnValid(Link link, String serviceType) {
316 if (this.linkType != OpenroadmLinkType.OTNLINK) {
317 LOG.error("PceLink: Not an OTN link. Link is ignored {}", linkId);
321 OtnLinkType otnLinkType = link
322 .augmentation(org.opendaylight.yang.gen.v1.http.transportpce.topology.rev201019.Link1.class)
324 if (this.availableBandwidth == 0L) {
325 LOG.error("PceLink: No bandwidth available for OTN Link, link {} is ignored ", linkId);
330 OtnLinkType neededType = null;
331 switch (serviceType) {
334 if (this.usedBandwidth != 0L) {
338 neededType = OtnLinkType.OTU4;
352 neededType = OtnLinkType.ODTU4;
356 neededType = OtnLinkType.ODTU4;
359 LOG.error("PceLink: isOtnValid Link {} unsupported serviceType {} ", linkId, serviceType);
363 if ((this.availableBandwidth >= neededBW)
364 && ((neededType == null) || (neededType.equals(otnLinkType)))) {
365 LOG.info("PceLink: Selected Link {} has available bandwidth and is eligible for {} creation ",
366 linkId, serviceType);
369 return checkParams();
372 private boolean checkParams() {
373 if ((this.linkId == null) || (this.linkType == null) || (this.oppositeLink == null)) {
374 LOG.error("PceLink: No Link type or opposite link is available. Link is ignored {}", linkId);
377 if ((this.adminStates == null) || (this.state == null)) {
378 LOG.error("PceLink: Link is not available. Link is ignored {}", linkId);
381 if ((this.sourceId == null) || (this.destId == null) || (this.sourceTP == null) || (this.destTP == null)) {
382 LOG.error("PceLink: No Link source or destination is available. Link is ignored {}", linkId);
385 if ((this.sourceNetworkSupNodeId.equals("")) || (this.destNetworkSupNodeId.equals(""))) {
386 LOG.error("PceLink: No Link source SuppNodeID or destination SuppNodeID is available. Link is ignored {}",
390 if ((this.sourceCLLI.equals("")) || (this.destCLLI.equals(""))) {
391 LOG.error("PceLink: No Link source CLLI or destination CLLI is available. Link is ignored {}", linkId);
399 public String toString() {
400 return "PceLink type=" + linkType + " ID=" + linkId.getValue() + " latency=" + latency;
403 private void writeObject(ObjectOutputStream out) throws IOException {
404 out.defaultWriteObject();
405 out.writeObject(this.sourceTP);
406 out.writeObject(this.destTP);
409 private void readObject(ObjectInputStream in) throws IOException,ClassNotFoundException {
410 in.defaultReadObject();
411 this.sourceTP = in.readObject();
412 this.destTP = in.readObject();