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.math.BigDecimal;
12 import java.util.ArrayList;
13 import java.util.BitSet;
14 import java.util.Comparator;
15 import java.util.HashMap;
16 import java.util.List;
18 import java.util.TreeMap;
19 import java.util.stream.Collectors;
20 import org.eclipse.jdt.annotation.Nullable;
21 import org.opendaylight.transportpce.common.StringConstants;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.types.rev200327.xpdr.odu.switching.pools.OduSwitchingPools;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.types.rev200327.xpdr.odu.switching.pools.odu.switching.pools.NonBlockingList;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmNodeType;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmTpType;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.xpdr.tp.supported.interfaces.SupportedInterfaceCapability;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev200327.ODTU4TsAllocated;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev200529.Node1;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev200529.TerminationPoint1;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev200529.networks.network.node.SwitchingPools;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.If100GEODU4;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.If10GEODU2e;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.If1GEODU0;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.IfOCHOTU4ODU4;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
41 import org.opendaylight.yangtools.yang.common.Uint16;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
45 public class PceOtnNode implements PceNode {
47 private static final Logger LOG = LoggerFactory.getLogger(PceOtnNode.class);
48 ////////////////////////// OTN NODES ///////////////////////////
50 * For This Class the node passed shall be at the otn-openroadm Layer
53 private boolean valid = true;
55 private final Node node;
56 private final NodeId nodeId;
57 private final OpenroadmNodeType nodeType;
58 private final String pceNodeType;
59 private final String otnServiceType;
60 private String modeType;
61 // TODO: not adding state check in this class as otn topology has not been modified
62 private final AdminStates adminStates;
63 private final State state;
65 private Map<String, List<Uint16>> tpAvailableTribPort = new TreeMap<>();
66 private Map<String, List<Uint16>> tpAvailableTribSlot = new TreeMap<>();
67 private Map<String, OpenroadmTpType> availableXponderTp = new TreeMap<>();
68 private List<String> usedXpdrNWTps = new ArrayList<>();
69 private List<TpId> availableXpdrNWTps;
70 private List<TpId> usableXpdrNWTps;
71 private List<String> usedXpdrClientTps = new ArrayList<>();
72 private List<TpId> availableXpdrClientTps;
73 private List<TpId> usableXpdrClientTps;
75 private List<PceLink> outgoingLinks = new ArrayList<>();
76 private Map<String, String> clientPerNwTp = new HashMap<>();
78 public PceOtnNode(Node node, OpenroadmNodeType nodeType, NodeId nodeId, String pceNodeType, String serviceType) {
81 this.nodeType = nodeType;
82 this.pceNodeType = pceNodeType;
83 this.otnServiceType = serviceType;
84 this.tpAvailableTribSlot.clear();
85 this.usedXpdrNWTps.clear();
86 this.availableXpdrNWTps = new ArrayList<>();
87 this.usableXpdrNWTps = new ArrayList<>();
88 this.usedXpdrClientTps.clear();
89 this.availableXpdrClientTps = new ArrayList<>();
90 this.usableXpdrClientTps = new ArrayList<>();
91 this.adminStates = node.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
92 .Node1.class).getAdministrativeState();
93 this.state = node.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
94 .Node1.class).getOperationalState();
95 this.tpAvailableTribPort.clear();
96 checkAvailableTribPort();
97 this.tpAvailableTribSlot.clear();
98 checkAvailableTribSlot();
99 if ((node == null) || (nodeId == null) || (nodeType != OpenroadmNodeType.MUXPDR)
100 && (nodeType != OpenroadmNodeType.SWITCH) && (nodeType != OpenroadmNodeType.TPDR)) {
101 LOG.error("PceOtnNode: one of parameters is not populated : nodeId, node type");
106 public void initXndrTps(String mode) {
107 LOG.info("PceOtnNode: initXndrTps for node {}", this.nodeId.getValue());
108 this.availableXponderTp.clear();
110 this.modeType = mode;
112 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1 nodeTp
113 = this.node.augmentation(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
114 .ietf.network.topology.rev180226.Node1.class);
115 List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
116 .node.TerminationPoint> allTps = new ArrayList<>(nodeTp.nonnullTerminationPoint().values());
118 if (allTps.isEmpty()) {
119 LOG.error("PceOtnNode: initXndrTps: XPONDER TerminationPoint list is empty for node {}", this);
123 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network
124 .node.TerminationPoint tp : allTps) {
125 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.@Nullable TerminationPoint1 ocnTp1
126 = tp.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
127 .TerminationPoint1.class);
128 //TODO many nested if-structures below, this needs to be reworked
129 if (OpenroadmTpType.XPONDERNETWORK.equals(ocnTp1.getTpType())
130 && StringConstants.SERVICE_TYPE_ODU4.equals(this.otnServiceType)) {
131 TerminationPoint1 ontTp1;
132 if (tp.augmentation(TerminationPoint1.class) != null) {
133 ontTp1 = tp.augmentation(TerminationPoint1.class);
137 if (checkTpForOdtuTermination(ontTp1)) {
138 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
139 this.availableXpdrNWTps.add(tp.getTpId());
141 LOG.error("TP {} of {} does not allow ODU4 termination creation", tp.getTpId().getValue(),
142 node.getNodeId().getValue());
144 } else if (OpenroadmTpType.XPONDERNETWORK.equals(ocnTp1.getTpType())
145 && (this.otnServiceType.equals(StringConstants.SERVICE_TYPE_10GE)
146 || StringConstants.SERVICE_TYPE_1GE.equals(this.otnServiceType))) {
147 TerminationPoint1 ontTp1;
148 if (tp.augmentation(TerminationPoint1.class) != null) {
149 ontTp1 = tp.augmentation(TerminationPoint1.class);
153 if (StringConstants.SERVICE_TYPE_10GE.equals(otnServiceType)
154 && checkOdtuTTPforLoOduCreation(ontTp1, 10)
155 || StringConstants.SERVICE_TYPE_1GE.equals(otnServiceType)
156 && checkOdtuTTPforLoOduCreation(ontTp1, 1)) {
157 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
158 this.availableXpdrNWTps.add(tp.getTpId());
160 if (StringConstants.SERVICE_TYPE_10GE.equals(otnServiceType)) {
161 LOG.error("TP {} of {} does not allow OD2e termination creation", tp.getTpId().getValue(),
162 node.getNodeId().getValue());
163 } else if (StringConstants.SERVICE_TYPE_1GE.equals(otnServiceType)) {
164 LOG.error("TP {} of {} does not allow ODU0 termination creation", tp.getTpId().getValue(),
165 node.getNodeId().getValue());
167 LOG.error("TP {} of {} does not allow any termination creation", tp.getTpId().getValue(),
168 node.getNodeId().getValue());
171 } else if (OpenroadmTpType.XPONDERCLIENT.equals(ocnTp1.getTpType())
172 && (StringConstants.SERVICE_TYPE_10GE.equals(this.otnServiceType)
173 || StringConstants.SERVICE_TYPE_1GE.equals(this.otnServiceType))) {
174 TerminationPoint1 ontTp1;
175 if (tp.augmentation(TerminationPoint1.class) != null) {
176 ontTp1 = tp.augmentation(TerminationPoint1.class);
180 if (checkClientTp(ontTp1)) {
181 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
182 this.availableXpdrClientTps.add(tp.getTpId());
184 LOG.error("TP {} of {} does not allow lo-ODU (ODU2e or ODU0) termination creation",
185 tp.getTpId().getValue(), node.getNodeId().getValue());
190 if ((StringConstants.SERVICE_TYPE_ODU4.equals(this.otnServiceType) && mode.equals("AZ"))
191 || ((StringConstants.SERVICE_TYPE_10GE.equals(this.otnServiceType)
192 || StringConstants.SERVICE_TYPE_1GE.equals(this.otnServiceType))
193 && ((mode.equals("AZ") && checkSwPool(availableXpdrClientTps, availableXpdrNWTps, 1, 1))
194 || (mode.equals("intermediate") && checkSwPool(null, availableXpdrNWTps, 0, 2)))
202 private boolean checkSwPool(List<TpId> clientTps, List<TpId> netwTps, int nbClient, int nbNetw) {
203 if (clientTps != null && netwTps != null && nbClient == 1 && nbNetw == 1) {
204 clientTps.sort(Comparator.comparing(TpId::getValue));
205 netwTps.sort(Comparator.comparing(TpId::getValue));
206 for (TpId nwTp : netwTps) {
207 for (TpId clTp : clientTps) {
209 List<NonBlockingList> nblList = new ArrayList<>(node.augmentation(Node1.class).getSwitchingPools()
210 .nonnullOduSwitchingPools().values().stream().findFirst().get().getNonBlockingList().values());
211 for (NonBlockingList nbl : nblList) {
212 if (nbl.getTpList().contains(clTp) && nbl.getTpList().contains(nwTp)) {
213 usableXpdrClientTps.add(clTp);
214 usableXpdrNWTps.add(nwTp);
216 if (usableXpdrClientTps.size() >= nbClient && usableXpdrNWTps.size() >= nbNetw) {
217 clientPerNwTp.put(nwTp.getValue(), clTp.getValue());
225 if (clientTps == null && netwTps != null && nbClient == 0 && nbNetw == 2) {
226 netwTps.sort(Comparator.comparing(TpId::getValue));
228 List<NonBlockingList> nblList = new ArrayList<>(node.augmentation(Node1.class).getSwitchingPools()
229 .nonnullOduSwitchingPools().values().stream().findFirst().get().getNonBlockingList().values());
230 for (NonBlockingList nbl : nblList) {
231 for (TpId nwTp : netwTps) {
232 if (nbl.getTpList().contains(nwTp)) {
233 usableXpdrNWTps.add(nwTp);
235 if (usableXpdrNWTps.size() >= nbNetw) {
244 private boolean checkTpForOdtuTermination(TerminationPoint1 ontTp1) {
245 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()
247 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
248 if (sic.getIfCapType().equals(IfOCHOTU4ODU4.class)
249 && ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() == null) {
256 private boolean checkOdtuTTPforLoOduCreation(TerminationPoint1 ontTp1, int tsNb) {
257 if (ontTp1.getXpdrTpPortConnectionAttributes() != null
258 && ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() != null
259 && ontTp1.getXpdrTpPortConnectionAttributes().getOdtuTpnPool() != null
260 && ontTp1.getXpdrTpPortConnectionAttributes().getOdtuTpnPool().values()
261 .stream().findFirst().get().getOdtuType()
262 .equals(ODTU4TsAllocated.class)
263 && !ontTp1.getXpdrTpPortConnectionAttributes().getOdtuTpnPool().values()
264 .stream().findFirst().get().getTpnPool().isEmpty()
265 && (ontTp1.getXpdrTpPortConnectionAttributes().getTsPool().size() >= tsNb)) {
271 private boolean checkClientTp(TerminationPoint1 ontTp1) {
272 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()
274 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
275 switch (otnServiceType) {
276 case StringConstants.SERVICE_TYPE_1GE:
277 // we could also check the administrative status of the tp
278 if (sic.getIfCapType().equals(If1GEODU0.class)) {
282 case StringConstants.SERVICE_TYPE_10GE:
283 if (sic.getIfCapType().equals(If10GEODU2e.class)) {
287 case StringConstants.SERVICE_TYPE_100GE:
288 if (sic.getIfCapType().equals(If100GEODU4.class)) {
299 public void validateXponder(String anodeId, String znodeId) {
303 if (OpenroadmNodeType.SWITCH.equals(this.nodeType)) {
304 initXndrTps("intermediate");
306 if (this.nodeId.getValue().equals(anodeId) || (this.nodeId.getValue().equals(znodeId))) {
309 LOG.info("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
314 public boolean validateSwitchingPoolBandwidth(
315 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
316 .ietf.network.topology.rev180226.networks.network.node.TerminationPoint tp1,
317 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
318 .ietf.network.topology.rev180226.networks.network.node.TerminationPoint tp2,
320 if (this.nodeType != OpenroadmNodeType.TPDR) {
323 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev200529.Node1 node1 =
325 org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev200529.Node1.class);
326 SwitchingPools sp = node1.getSwitchingPools();
327 List<OduSwitchingPools> osp = new ArrayList<>(sp.nonnullOduSwitchingPools().values());
328 for (OduSwitchingPools ospx : osp) {
329 List<NonBlockingList> nbl = new ArrayList<>(ospx.nonnullNonBlockingList().values());
330 for (NonBlockingList nbll : nbl) {
331 if (nbll.getAvailableInterconnectBandwidth().toJava() >= neededBW && nbll.getTpList() != null
332 && nbll.getTpList().contains(tp1.getTpId()) && nbll.getTpList().contains(tp2.getTpId())) {
333 LOG.debug("validateSwitchingPoolBandwidth: couple of tp {} x {} valid for crossconnection",
334 tp1.getTpId(), tp2.getTpId());
340 LOG.debug("validateSwitchingPoolBandwidth: No valid Switching pool for crossconnecting tp {} and {}",
341 tp1.getTpId(), tp2.getTpId());
346 public void validateIntermediateSwitch() {
350 if (this.nodeType != OpenroadmNodeType.SWITCH) {
353 // Validate switch for use as an intermediate XPONDER on the path
354 initXndrTps("intermediate");
356 LOG.debug("validateIntermediateSwitch: Switch unusable for transit == {}", nodeId.getValue());
358 LOG.info("validateIntermediateSwitch: Switch usable for transit == {}", nodeId.getValue());
362 public void checkAvailableTribPort() {
363 List<TerminationPoint> networkTpList = node.augmentation(
364 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1.class)
365 .getTerminationPoint().values().stream()
368 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1.class)
369 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
370 .collect(Collectors.toList());
372 for (TerminationPoint tp : networkTpList) {
373 if (tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes().getOdtuTpnPool() != null
374 && tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes().getOdtuTpnPool()
375 .values().stream().findFirst().get().getOdtuType().equals(ODTU4TsAllocated.class)) {
377 List<Uint16> tpnPool = tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes()
378 .getOdtuTpnPool().values().stream().findFirst().get().getTpnPool();
379 if (tpnPool != null) {
380 tpAvailableTribPort.put(tp.getTpId().getValue(), tpnPool);
386 public void checkAvailableTribSlot() {
387 List<TerminationPoint> networkTpList = node.augmentation(
388 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1.class)
389 .getTerminationPoint().values().stream()
392 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1.class)
393 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
394 .collect(Collectors.toList());
396 for (TerminationPoint tp : networkTpList) {
397 if (tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes().getTsPool() != null) {
399 List<Uint16> tsPool = tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes()
401 tpAvailableTribSlot.put(tp.getTpId().getValue(), tsPool);
406 public boolean isValid() {
407 if ((node == null) || (nodeId == null) || (nodeType == null) || (this.getSupNetworkNodeId() == null)
408 || (this.getSupClliNodeId() == null)) {
409 LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
415 public boolean isPceOtnNodeValid(final PceOtnNode pceOtnNode) {
416 if (pceOtnNode == null || pceOtnNode.node == null
417 || pceOtnNode.getNodeId() == null || pceOtnNode.nodeType == null || pceOtnNode.getSupNetworkNodeId() == null
418 || pceOtnNode.getSupClliNodeId() == null || pceOtnNode.otnServiceType == null) {
420 "PceOtnNode: one of parameters is not populated : nodeId, node type, supporting nodeId, otnServiceType"
425 if (!isNodeTypeValid(pceOtnNode)) {
426 LOG.error("PceOtnNode node type: node type isn't one of MUXPDR or SWITCH or TPDR");
430 return isOtnServiceTypeValid(pceOtnNode);
433 private boolean isOtnServiceTypeValid(PceOtnNode pceOtnNode) {
434 if (pceOtnNode.modeType == null) {
438 //Todo refactor Strings (mode and otnServiceType ) to enums
439 if ((pceOtnNode.otnServiceType.equals(StringConstants.SERVICE_TYPE_ODU4)
440 && pceOtnNode.modeType.equals("AZ"))) {
444 if ((pceOtnNode.otnServiceType.equals(StringConstants.SERVICE_TYPE_10GE)
445 || pceOtnNode.otnServiceType.equals(StringConstants.SERVICE_TYPE_1GE))
446 && (isAz(pceOtnNode) || isIntermediate(pceOtnNode))) {
453 private boolean isIntermediate(PceOtnNode pceOtnNode) {
454 return pceOtnNode.modeType.equals("intermediate")
455 && checkSwPool(null, pceOtnNode.availableXpdrNWTps, 0, 2);
458 private boolean isAz(PceOtnNode pceOtnNode) {
459 return pceOtnNode.modeType.equals("AZ")
460 && checkSwPool(pceOtnNode.availableXpdrClientTps, pceOtnNode.availableXpdrNWTps, 1, 1);
463 private boolean isNodeTypeValid(final PceOtnNode pceOtnNode) {
464 return (pceOtnNode.nodeType == OpenroadmNodeType.MUXPDR)
465 || (pceOtnNode.nodeType == OpenroadmNodeType.SWITCH)
466 || (pceOtnNode.nodeType == OpenroadmNodeType.TPDR);
470 public void addOutgoingLink(PceLink outLink) {
471 this.outgoingLinks.add(outLink);
475 public List<PceLink> getOutgoingLinks() {
476 return outgoingLinks;
480 public AdminStates getAdminStates() {
485 public State getState() {
490 public String getXpdrClient(String tp) {
491 return this.clientPerNwTp.get(tp);
495 public String toString() {
496 return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + this.getSupClliNodeId();
499 public void printLinksOfNode() {
500 LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks());
504 public Map<String, List<Uint16>> getAvailableTribPorts() {
505 return tpAvailableTribPort;
509 public Map<String, List<Uint16>> getAvailableTribSlots() {
510 return tpAvailableTribSlot;
513 public List<TpId> getUsableXpdrNWTps() {
514 return usableXpdrNWTps;
517 public List<TpId> getUsableXpdrClientTps() {
518 return usableXpdrClientTps;
522 public String getPceNodeType() {
523 return this.pceNodeType;
527 public String getSupNetworkNodeId() {
528 return MapUtils.getSupNetworkNode(this.node);
532 public String getSupClliNodeId() {
533 return MapUtils.getSupClliNode(this.node);
537 public String getRdmSrgClient(String tp) {
542 public NodeId getNodeId() {
547 public boolean checkTP(String tp) {
554 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getVersion()
557 public String getVersion() {
558 // TODO Auto-generated method stub
563 public BitSet getBitSetData() {
564 // TODO Auto-generated method stub
571 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getSlotWidthGranularity()
574 public BigDecimal getSlotWidthGranularity() {