2 * Copyright © 2019 Orange, 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.util.ArrayList;
12 import java.util.Comparator;
13 import java.util.HashMap;
14 import java.util.List;
16 import java.util.TreeMap;
17 import java.util.stream.Collectors;
18 import org.eclipse.jdt.annotation.Nullable;
19 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.types.rev181130.xpdr.odu.switching.pools.OduSwitchingPools;
20 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.types.rev181130.xpdr.odu.switching.pools.odu.switching.pools.NonBlockingList;
21 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmNodeType;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.OpenroadmTpType;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev181130.xpdr.tp.supported.interfaces.SupportedInterfaceCapability;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev181130.ODTU4TsAllocated;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev181130.Node1;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev181130.TerminationPoint1;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev181130.networks.network.node.SwitchingPools;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev181130.If100GEODU4;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev181130.If10GEODU2e;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev181130.If1GEODU0;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev181130.IfOCHOTU4ODU4;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
36 import org.opendaylight.yangtools.yang.common.Uint16;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
40 public class PceOtnNode implements PceNode {
42 private static final Logger LOG = LoggerFactory.getLogger(PceOtnNode.class);
43 ////////////////////////// OTN NODES ///////////////////////////
45 * For This Class the node passed shall be at the otn-openroadm Layer
48 private boolean valid = true;
50 private final Node node;
51 private final NodeId nodeId;
52 private final OpenroadmNodeType nodeType;
53 private final String pceNodeType;
54 private final String otnServiceType;
55 private String modeType;
57 private Map<String, List<Uint16>> tpAvailableTribPort = new TreeMap<>();
58 private Map<String, List<Uint16>> tpAvailableTribSlot = new TreeMap<>();
59 private Map<String, OpenroadmTpType> availableXponderTp = new TreeMap<>();
60 private List<String> usedXpdrNWTps = new ArrayList<>();
61 private List<TpId> availableXpdrNWTps;
62 private List<TpId> usableXpdrNWTps;
63 private List<String> usedXpdrClientTps = new ArrayList<>();
64 private List<TpId> availableXpdrClientTps;
65 private List<TpId> usableXpdrClientTps;
67 private List<PceLink> outgoingLinks = new ArrayList<>();
68 private Map<String, String> clientPerNwTp = new HashMap<>();
70 public PceOtnNode(Node node, OpenroadmNodeType nodeType, NodeId nodeId, String pceNodeType, String serviceType) {
73 this.nodeType = nodeType;
74 this.pceNodeType = pceNodeType;
75 this.otnServiceType = serviceType;
76 this.tpAvailableTribSlot.clear();
77 this.usedXpdrNWTps.clear();
78 this.availableXpdrNWTps = new ArrayList<>();
79 this.usableXpdrNWTps = new ArrayList<>();
80 this.usedXpdrClientTps.clear();
81 this.availableXpdrClientTps = new ArrayList<>();
82 this.usableXpdrClientTps = new ArrayList<>();
83 this.tpAvailableTribPort.clear();
84 checkAvailableTribPort();
85 this.tpAvailableTribSlot.clear();
86 checkAvailableTribSlot();
87 if ((node == null) || (nodeId == null) || (nodeType != OpenroadmNodeType.MUXPDR)
88 && (nodeType != OpenroadmNodeType.SWITCH) && (nodeType != OpenroadmNodeType.TPDR)) {
89 LOG.error("PceOtnNode: one of parameters is not populated : nodeId, node type");
94 public void initXndrTps(String mode) {
95 LOG.info("PceOtnNode: initXndrTps for node {}", this.nodeId.getValue());
96 this.availableXponderTp.clear();
100 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 nodeTp
101 = this.node.augmentation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
102 .ietf.network.topology.rev180226.Node1.class);
103 List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
104 .node.TerminationPoint> allTps = nodeTp.getTerminationPoint();
106 if (allTps == null) {
107 LOG.error("PceOtnNode: initXndrTps: XPONDER TerminationPoint list is empty for node {}", this);
111 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
112 .node.TerminationPoint tp : allTps) {
113 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.@Nullable TerminationPoint1 ocnTp1
114 = tp.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130
115 .TerminationPoint1.class);
116 //TODO many nested if-structures below, this needs to be reworked
117 if (OpenroadmTpType.XPONDERNETWORK.equals(ocnTp1.getTpType()) && this.otnServiceType.equals("ODU4")) {
118 TerminationPoint1 ontTp1;
119 if (tp.augmentation(TerminationPoint1.class) != null) {
120 ontTp1 = tp.augmentation(TerminationPoint1.class);
124 if (checkTpForOdtuTermination(ontTp1)) {
125 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
126 this.availableXpdrNWTps.add(tp.getTpId());
128 LOG.error("TP {} of {} does not allow ODU4 termination creation", tp.getTpId().getValue(),
129 node.getNodeId().getValue());
131 } else if (OpenroadmTpType.XPONDERNETWORK.equals(ocnTp1.getTpType())
132 && (this.otnServiceType.equals("10GE") || this.otnServiceType.equals("1GE"))) {
133 TerminationPoint1 ontTp1;
134 if (tp.augmentation(TerminationPoint1.class) != null) {
135 ontTp1 = tp.augmentation(TerminationPoint1.class);
139 if ("10GE".equals(otnServiceType) && checkOdtuTTPforLoOduCreation(ontTp1, 10)
140 || "1GE".equals(otnServiceType) && checkOdtuTTPforLoOduCreation(ontTp1, 1)) {
141 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
142 this.availableXpdrNWTps.add(tp.getTpId());
144 if ("10GE".equals(otnServiceType)) {
145 LOG.error("TP {} of {} does not allow OD2e termination creation", tp.getTpId().getValue(),
146 node.getNodeId().getValue());
147 } else if ("1GE".equals(otnServiceType)) {
148 LOG.error("TP {} of {} does not allow ODU0 termination creation", tp.getTpId().getValue(),
149 node.getNodeId().getValue());
151 LOG.error("TP {} of {} does not allow any termination creation", tp.getTpId().getValue(),
152 node.getNodeId().getValue());
155 } else if (OpenroadmTpType.XPONDERCLIENT.equals(ocnTp1.getTpType())
156 && (this.otnServiceType.equals("10GE") || this.otnServiceType.equals("1GE"))) {
157 TerminationPoint1 ontTp1;
158 if (tp.augmentation(TerminationPoint1.class) != null) {
159 ontTp1 = tp.augmentation(TerminationPoint1.class);
163 if (checkClientTp(ontTp1)) {
164 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
165 this.availableXpdrClientTps.add(tp.getTpId());
167 LOG.error("TP {} of {} does not allow lo-ODU (ODU2e or ODU0) termination creation",
168 tp.getTpId().getValue(), node.getNodeId().getValue());
173 if ((this.otnServiceType.equals("ODU4") && mode.equals("AZ"))
174 || ((this.otnServiceType.equals("10GE") || this.otnServiceType.equals("1GE"))
175 && ((mode.equals("AZ") && checkSwPool(availableXpdrClientTps, availableXpdrNWTps, 1, 1))
176 || (mode.equals("intermediate") && checkSwPool(null, availableXpdrNWTps, 0, 2)))
184 private boolean checkSwPool(List<TpId> clientTps, List<TpId> netwTps, int nbClient, int nbNetw) {
185 if (clientTps != null && netwTps != null && nbClient == 1 && nbNetw == 1) {
186 clientTps.sort(Comparator.comparing(TpId::getValue));
187 netwTps.sort(Comparator.comparing(TpId::getValue));
188 for (TpId nwTp : netwTps) {
189 for (TpId clTp : clientTps) {
191 List<NonBlockingList> nblList = node.augmentation(Node1.class).getSwitchingPools()
192 .getOduSwitchingPools().get(0).getNonBlockingList();
193 for (NonBlockingList nbl : nblList) {
194 if (nbl.getTpList().contains(clTp) && nbl.getTpList().contains(nwTp)) {
195 usableXpdrClientTps.add(clTp);
196 usableXpdrNWTps.add(nwTp);
198 if (usableXpdrClientTps.size() >= nbClient && usableXpdrNWTps.size() >= nbNetw) {
199 clientPerNwTp.put(nwTp.getValue(), clTp.getValue());
207 if (clientTps == null && netwTps != null && nbClient == 0 && nbNetw == 2) {
208 netwTps.sort(Comparator.comparing(TpId::getValue));
210 List<NonBlockingList> nblList = node.augmentation(Node1.class).getSwitchingPools().getOduSwitchingPools()
211 .get(0).getNonBlockingList();
212 for (NonBlockingList nbl : nblList) {
213 for (TpId nwTp : netwTps) {
214 if (nbl.getTpList().contains(nwTp)) {
215 usableXpdrNWTps.add(nwTp);
217 if (usableXpdrNWTps.size() >= nbNetw) {
226 private boolean checkTpForOdtuTermination(TerminationPoint1 ontTp1) {
227 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()) {
228 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
229 if (sic.getIfCapType().equals(IfOCHOTU4ODU4.class)
230 && ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() == null) {
237 private boolean checkOdtuTTPforLoOduCreation(TerminationPoint1 ontTp1, int tsNb) {
238 if (ontTp1.getXpdrTpPortConnectionAttributes() != null
239 && ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() != null
240 && ontTp1.getXpdrTpPortConnectionAttributes().getOdtuTpnPool() != null
241 && ontTp1.getXpdrTpPortConnectionAttributes().getOdtuTpnPool().get(0).getOdtuType()
242 .equals(ODTU4TsAllocated.class)
243 && !ontTp1.getXpdrTpPortConnectionAttributes().getOdtuTpnPool().get(0).getTpnPool().isEmpty()
244 && (ontTp1.getXpdrTpPortConnectionAttributes().getTsPool().size() >= tsNb)) {
250 private boolean checkClientTp(TerminationPoint1 ontTp1) {
251 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()) {
252 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
253 switch (otnServiceType) {
255 // we could also check the administrative status of the tp
256 if (sic.getIfCapType().equals(If1GEODU0.class)) {
261 if (sic.getIfCapType().equals(If10GEODU2e.class)) {
266 if (sic.getIfCapType().equals(If100GEODU4.class)) {
277 public void validateXponder(String anodeId, String znodeId) {
281 if (OpenroadmNodeType.SWITCH.equals(this.nodeType)) {
282 initXndrTps("intermediate");
284 if (this.nodeId.getValue().equals(anodeId) || (this.nodeId.getValue().equals(znodeId))) {
287 LOG.info("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
292 public boolean validateSwitchingPoolBandwidth(
293 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
294 .ietf.network.topology.rev180226.networks.network.node.TerminationPoint tp1,
295 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
296 .ietf.network.topology.rev180226.networks.network.node.TerminationPoint tp2,
298 if (this.nodeType != OpenroadmNodeType.TPDR) {
301 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev181130.Node1 node1 =
303 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev181130.Node1.class);
304 SwitchingPools sp = node1.getSwitchingPools();
305 List<OduSwitchingPools> osp = sp.getOduSwitchingPools();
306 for (OduSwitchingPools ospx : osp) {
307 List<NonBlockingList> nbl = ospx.getNonBlockingList();
308 for (NonBlockingList nbll : nbl) {
309 if (nbll.getAvailableInterconnectBandwidth().toJava() >= neededBW && nbll.getTpList() != null
310 && nbll.getTpList().contains(tp1.getTpId()) && nbll.getTpList().contains(tp2.getTpId())) {
311 LOG.debug("validateSwitchingPoolBandwidth: couple of tp {} x {} valid for crossconnection",
312 tp1.getTpId(), tp2.getTpId());
318 LOG.debug("validateSwitchingPoolBandwidth: No valid Switching pool for crossconnecting tp {} and {}",
319 tp1.getTpId(), tp2.getTpId());
324 public void validateIntermediateSwitch() {
328 if (this.nodeType != OpenroadmNodeType.SWITCH) {
331 // Validate switch for use as an intermediate XPONDER on the path
332 initXndrTps("intermediate");
334 LOG.debug("validateIntermediateSwitch: Switch unusable for transit == {}", nodeId.getValue());
336 LOG.info("validateIntermediateSwitch: Switch usable for transit == {}", nodeId.getValue());
340 public void checkAvailableTribPort() {
341 List<TerminationPoint> networkTpList = node.augmentation(
342 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1.class)
343 .getTerminationPoint().stream()
346 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.TerminationPoint1.class)
347 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
348 .collect(Collectors.toList());
350 for (TerminationPoint tp : networkTpList) {
351 if (tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes().getOdtuTpnPool() != null
352 && tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes().getOdtuTpnPool().get(0)
353 .getOdtuType().equals(ODTU4TsAllocated.class)) {
355 List<Uint16> tpnPool = tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes()
356 .getOdtuTpnPool().get(0).getTpnPool();
357 if (tpnPool != null) {
358 tpAvailableTribPort.put(tp.getTpId().getValue(), tpnPool);
364 public void checkAvailableTribSlot() {
365 List<TerminationPoint> networkTpList = node.augmentation(
366 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1.class)
367 .getTerminationPoint().stream()
370 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev181130.TerminationPoint1.class)
371 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
372 .collect(Collectors.toList());
374 for (TerminationPoint tp : networkTpList) {
375 if (tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes().getTsPool() != null) {
377 List<Uint16> tsPool = tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes()
379 tpAvailableTribSlot.put(tp.getTpId().getValue(), tsPool);
384 public boolean isValid() {
385 if ((node == null) || (nodeId == null) || (nodeType == null) || (this.getSupNetworkNodeId() == null)
386 || (this.getSupClliNodeId() == null)) {
387 LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
393 public boolean isPceOtnNodeValid(final PceOtnNode pceOtnNode) {
394 if (pceOtnNode == null || pceOtnNode.node == null
395 || pceOtnNode.getNodeId() == null || pceOtnNode.nodeType == null || pceOtnNode.getSupNetworkNodeId() == null
396 || pceOtnNode.getSupClliNodeId() == null || pceOtnNode.otnServiceType == null) {
398 "PceOtnNode: one of parameters is not populated : nodeId, node type, supporting nodeId, otnServiceType"
403 if (!isNodeTypeValid(pceOtnNode)) {
404 LOG.error("PceOtnNode node type: node type isn't one of MUXPDR or SWITCH or TPDR");
408 return isOtnServiceTypeValid(pceOtnNode);
411 private boolean isOtnServiceTypeValid(PceOtnNode pceOtnNode) {
412 if (pceOtnNode.modeType == null) {
416 //Todo refactor Strings (mode and otnServiceType ) to enums
417 if ((pceOtnNode.otnServiceType.equals("ODU4") && pceOtnNode.modeType.equals("AZ"))) {
421 if ((pceOtnNode.otnServiceType.equals("10GE") || pceOtnNode.otnServiceType.equals("1GE"))
422 && (isAz(pceOtnNode) || isIntermediate(pceOtnNode))) {
429 private boolean isIntermediate(PceOtnNode pceOtnNode) {
430 return pceOtnNode.modeType.equals("intermediate")
431 && checkSwPool(null, pceOtnNode.availableXpdrNWTps, 0, 2);
434 private boolean isAz(PceOtnNode pceOtnNode) {
435 return pceOtnNode.modeType.equals("AZ")
436 && checkSwPool(pceOtnNode.availableXpdrClientTps, pceOtnNode.availableXpdrNWTps, 1, 1);
439 private boolean isNodeTypeValid(final PceOtnNode pceOtnNode) {
440 return (pceOtnNode.nodeType == OpenroadmNodeType.MUXPDR)
441 || (pceOtnNode.nodeType == OpenroadmNodeType.SWITCH)
442 || (pceOtnNode.nodeType == OpenroadmNodeType.TPDR);
446 public void addOutgoingLink(PceLink outLink) {
447 this.outgoingLinks.add(outLink);
451 public List<PceLink> getOutgoingLinks() {
452 return outgoingLinks;
456 public String getXpdrClient(String tp) {
457 return this.clientPerNwTp.get(tp);
461 public String toString() {
462 return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + this.getSupClliNodeId();
465 public void printLinksOfNode() {
466 LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks());
470 public Map<String, List<Uint16>> getAvailableTribPorts() {
471 return tpAvailableTribPort;
475 public Map<String, List<Uint16>> getAvailableTribSlots() {
476 return tpAvailableTribSlot;
479 public List<TpId> getUsableXpdrNWTps() {
480 return usableXpdrNWTps;
483 public List<TpId> getUsableXpdrClientTps() {
484 return usableXpdrClientTps;
488 public String getPceNodeType() {
489 return this.pceNodeType;
493 public String getSupNetworkNodeId() {
494 return MapUtils.getSupNetworkNode(this.node);
498 public String getSupClliNodeId() {
499 return MapUtils.getSupClliNode(this.node);
503 public String getRdmSrgClient(String tp) {
508 public NodeId getNodeId() {
513 public boolean checkTP(String tp) {
518 public boolean checkWL(long index) {