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.opendaylight.transportpce.common.StringConstants;
21 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.state.types.rev191129.State;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.equipment.states.types.rev191129.AdminStates;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.types.rev200327.xpdr.odu.switching.pools.OduSwitchingPools;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.types.rev200327.xpdr.odu.switching.pools.odu.switching.pools.NonBlockingList;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmNodeType;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmTpType;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.xpdr.tp.supported.interfaces.SupportedInterfaceCapability;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev200327.ODTU4TsAllocated;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.common.types.rev200327.ODTUCnTs;
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.termination.point.XpdrTpPortConnectionAttributes;
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.http.org.openroadm.port.types.rev200327.IfOtsiOtsigroup;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.SupportedIfCapability;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.xponder.rev200529.xpdr.otn.tp.attributes.OdtuTpnPool;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
44 import org.opendaylight.yangtools.yang.common.Uint16;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
48 public class PceOtnNode implements PceNode {
49 ////////////////////////// OTN NODES ///////////////////////////
51 * For This Class the node passed shall be at the otn-openroadm Layer
54 private static final Logger LOG = LoggerFactory.getLogger(PceOtnNode.class);
55 private static final List<String> SERVICE_TYPE_ODU_LIST = List.of(
56 StringConstants.SERVICE_TYPE_ODU4,
57 StringConstants.SERVICE_TYPE_ODUC4,
58 StringConstants.SERVICE_TYPE_ODUC3,
59 StringConstants.SERVICE_TYPE_ODUC2);
60 private static final List<OpenroadmNodeType> VALID_NODETYPES_LIST = List.of(
61 OpenroadmNodeType.MUXPDR,
62 OpenroadmNodeType.SWITCH,
63 OpenroadmNodeType.TPDR);
64 private static final Map<String, Class<? extends SupportedIfCapability>> SERVICE_TYPE_ETH_CLASS_MAP = Map.of(
65 StringConstants.SERVICE_TYPE_1GE, If1GEODU0.class,
66 StringConstants.SERVICE_TYPE_10GE, If10GEODU2e.class,
67 StringConstants.SERVICE_TYPE_100GE_M, If100GEODU4.class,
68 StringConstants.SERVICE_TYPE_100GE_S, If100GEODU4.class);
69 private static final Map<String, Integer> SERVICE_TYPE_ETH_TS_NB_MAP = Map.of(
70 StringConstants.SERVICE_TYPE_1GE, 1,
71 StringConstants.SERVICE_TYPE_10GE, 10,
72 StringConstants.SERVICE_TYPE_100GE_M, 20);
73 private static final Map<String, String> SERVICE_TYPE_ETH_ODU_STRING_MAP = Map.of(
74 StringConstants.SERVICE_TYPE_1GE, "ODU0",
75 StringConstants.SERVICE_TYPE_10GE, "ODU2e",
76 StringConstants.SERVICE_TYPE_100GE_M, "ODU4");
78 private boolean valid = true;
80 private final Node node;
81 private final NodeId nodeId;
82 private final OpenroadmNodeType nodeType;
83 private final String pceNodeType;
84 private final String otnServiceType;
85 private String modeType;
86 // TODO: not adding state check in this class as otn topology has not been modified
87 private final AdminStates adminStates;
88 private final State state;
90 private Map<String, List<Uint16>> tpAvailableTribPort = new TreeMap<>();
91 private Map<String, List<Uint16>> tpAvailableTribSlot = new TreeMap<>();
92 private Map<String, OpenroadmTpType> availableXponderTp = new TreeMap<>();
93 private List<String> usedXpdrNWTps = new ArrayList<>();
94 private List<TpId> availableXpdrNWTps;
95 private List<TpId> usableXpdrNWTps;
96 private List<String> usedXpdrClientTps = new ArrayList<>();
97 private List<TpId> availableXpdrClientTps;
98 private List<TpId> usableXpdrClientTps;
100 private List<PceLink> outgoingLinks = new ArrayList<>();
101 private Map<String, String> clientPerNwTp = new HashMap<>();
102 private String clientPort;
106 OpenroadmNodeType nodeType,
112 this.nodeId = nodeId;
113 this.nodeType = nodeType;
114 this.pceNodeType = pceNodeType;
115 this.otnServiceType = serviceType;
116 this.tpAvailableTribSlot.clear();
117 this.usedXpdrNWTps.clear();
118 this.availableXpdrNWTps = new ArrayList<>();
119 this.usableXpdrNWTps = new ArrayList<>();
120 this.usedXpdrClientTps.clear();
121 this.availableXpdrClientTps = new ArrayList<>();
122 this.usableXpdrClientTps = new ArrayList<>();
123 this.adminStates = node
124 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1.class)
125 .getAdministrativeState();
127 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1.class)
128 .getOperationalState();
129 this.tpAvailableTribPort.clear();
130 checkAvailableTribPort();
131 this.tpAvailableTribSlot.clear();
132 checkAvailableTribSlot();
133 this.clientPort = clientPort;
137 || !VALID_NODETYPES_LIST.contains(nodeType)) {
138 LOG.error("PceOtnNode: one of parameters is not populated : nodeId, node type");
141 if (!SERVICE_TYPE_ETH_CLASS_MAP.containsKey(serviceType)
142 && !SERVICE_TYPE_ODU_LIST.contains(serviceType)) {
143 LOG.error("PceOtnNode: unsupported OTN Service Type {}", serviceType);
148 public void initXndrTps(String mode) {
149 LOG.info("PceOtnNode: initXndrTps for node {}", this.nodeId.getValue());
150 this.availableXponderTp.clear();
151 this.modeType = mode;
152 List<TerminationPoint> allTps =
154 this.node.augmentation(
155 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
157 .nonnullTerminationPoint()
160 if (allTps.isEmpty()) {
161 LOG.error("PceOtnNode: initXndrTps: XPONDER TerminationPoint list is empty for node {}", this);
164 for (TerminationPoint tp : allTps) {
165 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
166 .TerminationPoint1 ocnTp1
168 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
169 .TerminationPoint1.class);
170 if (ocnTp1 == null) {
171 LOG.warn("null ocn TP {}", tp);
174 TerminationPoint1 ontTp1 = tp.augmentation(TerminationPoint1.class);
175 if (ontTp1 == null) {
178 //TODO many nested structures below, this needs to be reworked
179 switch (ocnTp1.getTpType()) {
181 if (SERVICE_TYPE_ODU_LIST.contains(this.otnServiceType)
182 || StringConstants.SERVICE_TYPE_100GE_S.equals(this.otnServiceType)) {
183 // TODO verify the capability of network port to support ODU4 CTP interface creation
184 if (!checkTpForOdtuTermination(ontTp1)) {
185 LOG.error("TP {} of {} does not allow {} termination creation",
186 tp.getTpId().getValue(),
187 node.getNodeId().getValue(),
191 } else if (SERVICE_TYPE_ETH_TS_NB_MAP.containsKey(this.otnServiceType)) {
192 if (!checkOdtuTTPforLoOduCreation(
193 ontTp1, SERVICE_TYPE_ETH_TS_NB_MAP.get(this.otnServiceType))) {
194 LOG.error("TP {} of {} does not allow {} termination creation",
195 tp.getTpId().getValue(),
196 node.getNodeId().getValue(),
197 SERVICE_TYPE_ETH_ODU_STRING_MAP.get(this.otnServiceType));
201 LOG.error("TP {} of {} does not allow {} termination creation",
202 tp.getTpId().getValue(),
203 node.getNodeId().getValue(),
207 LOG.info("TP {} of XPONDER {} is validated",
209 node.getNodeId().getValue());
210 this.availableXpdrNWTps.add(tp.getTpId());
214 if (SERVICE_TYPE_ETH_CLASS_MAP.containsKey(otnServiceType)) {
215 if (checkClientTp(ontTp1)) {
216 LOG.info("TP {} of XPONDER {} is validated",
218 node.getNodeId().getValue());
219 this.availableXpdrClientTps.add(tp.getTpId());
221 LOG.error("TP {} of {} does not allow lo-ODU (ODU2e or ODU0) termination creation",
222 tp.getTpId().getValue(),
223 node.getNodeId().getValue());
229 LOG.debug("unsupported ocn TP type {}", ocnTp1.getTpType());
232 this.valid = SERVICE_TYPE_ODU_LIST.contains(this.otnServiceType)
233 || SERVICE_TYPE_ETH_CLASS_MAP.containsKey(this.otnServiceType)
234 && checkSwPool(availableXpdrNWTps, availableXpdrClientTps);
237 private boolean checkSwPool(List<TpId> netwTps, List<TpId> clientTps) {
239 if (netwTps == null) {
242 Node1 node1 = node.augmentation(Node1.class);
246 List<NonBlockingList> nblList = new ArrayList<>(
247 node1.getSwitchingPools().nonnullOduSwitchingPools()
248 .values().stream().findFirst().get()
249 .getNonBlockingList().values());
250 if (nblList == null) {
253 netwTps.sort(Comparator.comparing(TpId::getValue));
258 return checkIntermediateSwPool(nblList, netwTps);
261 if (clientTps == null) {
264 clientTps.sort(Comparator.comparing(TpId::getValue));
265 return checkAzSwPool(nblList, netwTps, clientTps);
268 LOG.error("Unsupported mode type {}", modeType);
274 private boolean checkIntermediateSwPool(List<NonBlockingList> nblList, List<TpId> netwTps) {
275 for (NonBlockingList nbl: nblList) {
276 for (TpId nwTp : netwTps) {
277 if (nbl.getTpList().contains(nwTp)) {
278 usableXpdrNWTps.add(nwTp);
280 if (usableXpdrNWTps.size() >= 2) {
289 private boolean checkAzSwPool(List<NonBlockingList> nblList, List<TpId> netwTps, List<TpId> clientTps) {
290 for (NonBlockingList nbl: nblList) {
291 for (TpId nwTp : netwTps) {
292 for (TpId clTp : clientTps) {
293 if (nbl.getTpList().contains(clTp)
294 && nbl.getTpList().contains(nwTp)) {
295 usableXpdrClientTps.add(clTp);
296 usableXpdrNWTps.add(nwTp);
298 if (usableXpdrClientTps.size() >= 1
299 && usableXpdrNWTps.size() >= 1
300 && (this.clientPort == null || this.clientPort.equals(clTp.getValue()))) {
301 clientPerNwTp.put(nwTp.getValue(), clTp.getValue());
310 private boolean checkTpForOdtuTermination(TerminationPoint1 ontTp1) {
311 for (SupportedInterfaceCapability sic :
312 ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability().values()) {
313 LOG.info("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
314 if ((sic.getIfCapType().equals(IfOCHOTU4ODU4.class) || sic.getIfCapType().equals(IfOtsiOtsigroup.class))
315 && (ontTp1.getXpdrTpPortConnectionAttributes() == null
316 || ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() == null)) {
323 private boolean checkOdtuTTPforLoOduCreation(TerminationPoint1 ontTp1, int tsNb) {
324 XpdrTpPortConnectionAttributes portConAttr = ontTp1.getXpdrTpPortConnectionAttributes();
325 if (portConAttr == null
326 || portConAttr.getTsPool() == null
327 || portConAttr.getTsPool().size() < tsNb
328 || portConAttr.getOdtuTpnPool() == null) {
331 return checkFirstOdtuTpn(portConAttr.getOdtuTpnPool().values().stream().findFirst().get());
334 private boolean checkFirstOdtuTpn(OdtuTpnPool otPool) {
335 return (otPool.getOdtuType().equals(ODTU4TsAllocated.class)
336 || otPool.getOdtuType().equals(ODTUCnTs.class))
337 && !otPool.getTpnPool().isEmpty();
340 private boolean checkClientTp(TerminationPoint1 ontTp1) {
341 for (SupportedInterfaceCapability sic :
342 ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability().values()) {
343 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
344 // we could also check the administrative status of the tp
345 if (SERVICE_TYPE_ETH_CLASS_MAP.containsKey(otnServiceType)
346 && sic.getIfCapType().equals(SERVICE_TYPE_ETH_CLASS_MAP.get(otnServiceType))) {
353 public void validateXponder(String anodeId, String znodeId) {
357 if (this.nodeId.getValue().equals(anodeId)
358 || (this.nodeId.getValue().equals(znodeId))) {
360 } else if (OpenroadmNodeType.SWITCH.equals(this.nodeType)) {
361 initXndrTps("intermediate");
363 LOG.info("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
368 public boolean validateSwitchingPoolBandwidth(TerminationPoint tp1, TerminationPoint tp2, Long neededBW) {
369 if (this.nodeType != OpenroadmNodeType.TPDR) {
372 for (OduSwitchingPools ospx :
373 node.augmentation(Node1.class)
375 .nonnullOduSwitchingPools().values()) {
376 for (NonBlockingList nbll : ospx.nonnullNonBlockingList().values()) {
377 if (nbll.getAvailableInterconnectBandwidth().toJava() >= neededBW
378 && nbll.getTpList() != null
379 && nbll.getTpList().contains(tp1.getTpId())
380 && nbll.getTpList().contains(tp2.getTpId())) {
381 LOG.debug("validateSwitchingPoolBandwidth: couple of tp {} x {} valid for crossconnection",
382 tp1.getTpId(), tp2.getTpId());
387 LOG.debug("validateSwitchingPoolBandwidth: No valid Switching pool for crossconnecting tp {} and {}",
388 tp1.getTpId(), tp2.getTpId());
392 public void validateIntermediateSwitch() {
396 if (this.nodeType != OpenroadmNodeType.SWITCH) {
399 // Validate switch for use as an intermediate XPONDER on the path
400 initXndrTps("intermediate");
402 LOG.info("validateIntermediateSwitch: Switch usable for transit == {}", nodeId.getValue());
404 LOG.debug("validateIntermediateSwitch: Switch unusable for transit == {}", nodeId.getValue());
408 public void checkAvailableTribPort() {
409 for (TerminationPoint tp :
411 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
413 .getTerminationPoint().values().stream()
416 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
417 .TerminationPoint1.class)
419 .equals(OpenroadmTpType.XPONDERNETWORK))
420 .collect(Collectors.toList())) {
421 XpdrTpPortConnectionAttributes portConAttr =
422 tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes();
423 if (portConAttr != null && portConAttr.getOdtuTpnPool() != null) {
424 OdtuTpnPool otPool = portConAttr.getOdtuTpnPool().values().stream().findFirst().get();
425 if (checkFirstOdtuTpn(otPool)) {
426 tpAvailableTribPort.put(tp.getTpId().getValue(), otPool.getTpnPool());
432 public void checkAvailableTribSlot() {
433 for (TerminationPoint tp :
435 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
437 .getTerminationPoint().values().stream()
440 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
441 .TerminationPoint1.class)
442 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
443 .collect(Collectors.toList())
445 XpdrTpPortConnectionAttributes portConAttr =
446 tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes();
447 if (portConAttr != null && portConAttr.getTsPool() != null) {
448 tpAvailableTribSlot.put(tp.getTpId().getValue(), portConAttr.getTsPool());
453 public boolean isValid() {
456 || this.getSupNetworkNodeId() == null
457 || this.getSupClliNodeId() == null) {
458 LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
465 public void addOutgoingLink(PceLink outLink) {
466 this.outgoingLinks.add(outLink);
470 public List<PceLink> getOutgoingLinks() {
471 return outgoingLinks;
475 public AdminStates getAdminStates() {
480 public State getState() {
485 public String getXpdrClient(String tp) {
486 return this.clientPerNwTp.get(tp);
490 public String toString() {
491 return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + this.getSupClliNodeId();
494 public void printLinksOfNode() {
495 LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks());
499 public Map<String, List<Uint16>> getAvailableTribPorts() {
500 return tpAvailableTribPort;
504 public Map<String, List<Uint16>> getAvailableTribSlots() {
505 return tpAvailableTribSlot;
508 public List<TpId> getUsableXpdrNWTps() {
509 return usableXpdrNWTps;
512 public List<TpId> getUsableXpdrClientTps() {
513 return usableXpdrClientTps;
517 public String getPceNodeType() {
518 return this.pceNodeType;
522 public String getSupNetworkNodeId() {
523 return MapUtils.getSupNetworkNode(this.node);
527 public String getSupClliNodeId() {
528 return MapUtils.getSupClliNode(this.node);
532 public String getRdmSrgClient(String tp, String direction) {
537 public NodeId getNodeId() {
542 public boolean checkTP(String tp) {
549 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getVersion()
552 public String getVersion() {
553 // TODO Auto-generated method stub
558 public BitSet getBitSetData() {
559 // TODO Auto-generated method stub
566 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getSlotWidthGranularity()
569 public BigDecimal getSlotWidthGranularity() {
576 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getCentralFreqGranularity()
579 public BigDecimal getCentralFreqGranularity() {