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.SwitchingPools;
33 import org.opendaylight.yang.gen.v1.http.org.openroadm.otn.network.topology.rev200529.networks.network.node.termination.point.XpdrTpPortConnectionAttributes;
34 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.If100GEODU4;
35 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.If10GEODU2e;
36 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.If1GEODU0;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.IfOCHOTU4ODU4;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.IfOtsiOtsigroup;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.types.rev200327.SupportedIfCapability;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.xponder.rev200529.xpdr.otn.tp.attributes.OdtuTpnPool;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.TpId;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
45 import org.opendaylight.yangtools.yang.common.Uint16;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
49 public class PceOtnNode implements PceNode {
50 ////////////////////////// OTN NODES ///////////////////////////
52 * For This Class the node passed shall be at the otn-openroadm Layer
55 private static final Logger LOG = LoggerFactory.getLogger(PceOtnNode.class);
56 private static final List<String> SERVICE_TYPE_ODU_LIST = List.of(
57 StringConstants.SERVICE_TYPE_ODU4,
58 StringConstants.SERVICE_TYPE_ODUC4,
59 StringConstants.SERVICE_TYPE_ODUC3,
60 StringConstants.SERVICE_TYPE_ODUC2);
61 private static final List<OpenroadmNodeType> VALID_NODETYPES_LIST = List.of(
62 OpenroadmNodeType.MUXPDR,
63 OpenroadmNodeType.SWITCH,
64 OpenroadmNodeType.TPDR);
65 private static final Map<String, Class<? extends SupportedIfCapability>> SERVICE_TYPE_ETH_CLASS_MAP = Map.of(
66 StringConstants.SERVICE_TYPE_1GE, If1GEODU0.class,
67 StringConstants.SERVICE_TYPE_10GE, If10GEODU2e.class,
68 StringConstants.SERVICE_TYPE_100GE_M, If100GEODU4.class,
69 StringConstants.SERVICE_TYPE_100GE_S, If100GEODU4.class);
70 private static final Map<String, Integer> SERVICE_TYPE_ETH_TS_NB_MAP = Map.of(
71 StringConstants.SERVICE_TYPE_1GE, 1,
72 StringConstants.SERVICE_TYPE_10GE, 10,
73 StringConstants.SERVICE_TYPE_100GE_M, 20);
74 private static final Map<String, String> SERVICE_TYPE_ETH_ODU_STRING_MAP = Map.of(
75 StringConstants.SERVICE_TYPE_1GE, "ODU0",
76 StringConstants.SERVICE_TYPE_10GE, "ODU2e",
77 StringConstants.SERVICE_TYPE_100GE_M, "ODU4");
79 private boolean valid = true;
81 private final Node node;
82 private final NodeId nodeId;
83 private final OpenroadmNodeType nodeType;
84 private final String pceNodeType;
85 private final String otnServiceType;
86 private String modeType;
87 // TODO: not adding state check in this class as otn topology has not been modified
88 private final AdminStates adminStates;
89 private final State state;
91 private Map<String, List<Uint16>> tpAvailableTribPort = new TreeMap<>();
92 private Map<String, List<Uint16>> tpAvailableTribSlot = new TreeMap<>();
93 private Map<String, OpenroadmTpType> availableXponderTp = new TreeMap<>();
94 private List<String> usedXpdrNWTps = new ArrayList<>();
95 private List<TpId> availableXpdrNWTps;
96 private List<TpId> usableXpdrNWTps;
97 private List<String> usedXpdrClientTps = new ArrayList<>();
98 private List<TpId> availableXpdrClientTps;
99 private List<TpId> usableXpdrClientTps;
101 private List<PceLink> outgoingLinks = new ArrayList<>();
102 private Map<String, String> clientPerNwTp = new HashMap<>();
103 private String clientPort;
105 public PceOtnNode(Node node, OpenroadmNodeType nodeType, NodeId nodeId, String pceNodeType, String serviceType,
108 this.nodeId = nodeId;
109 this.nodeType = nodeType;
110 this.pceNodeType = pceNodeType;
111 this.otnServiceType = serviceType;
112 this.tpAvailableTribSlot.clear();
113 this.usedXpdrNWTps.clear();
114 this.availableXpdrNWTps = new ArrayList<>();
115 this.usableXpdrNWTps = new ArrayList<>();
116 this.usedXpdrClientTps.clear();
117 this.availableXpdrClientTps = new ArrayList<>();
118 this.usableXpdrClientTps = new ArrayList<>();
119 this.adminStates = node
120 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1.class)
121 .getAdministrativeState();
123 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1.class)
124 .getOperationalState();
125 this.tpAvailableTribPort.clear();
126 checkAvailableTribPort();
127 this.tpAvailableTribSlot.clear();
128 checkAvailableTribSlot();
129 this.clientPort = clientPort;
130 if (node == null || nodeId == null || nodeType == null || !VALID_NODETYPES_LIST.contains(nodeType)) {
131 LOG.error("PceOtnNode: one of parameters is not populated : nodeId, node type");
134 if (!SERVICE_TYPE_ETH_CLASS_MAP.containsKey(serviceType)
135 && !SERVICE_TYPE_ODU_LIST.contains(serviceType)) {
136 LOG.error("PceOtnNode: unsupported OTN Service Type {}", serviceType);
141 public void initXndrTps(String mode) {
142 LOG.info("PceOtnNode: initXndrTps for node {}", this.nodeId.getValue());
143 this.availableXponderTp.clear();
144 this.modeType = mode;
145 List<TerminationPoint> allTps =
147 this.node.augmentation(
148 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
150 .nonnullTerminationPoint()
153 if (allTps.isEmpty()) {
154 LOG.error("PceOtnNode: initXndrTps: XPONDER TerminationPoint list is empty for node {}", this);
157 for (TerminationPoint tp : allTps) {
158 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1 ocnTp1
159 = tp.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
160 .TerminationPoint1.class);
161 if (ocnTp1 == null) {
162 LOG.warn("null ocn TP {}", tp);
165 //TODO many nested structures below, this needs to be reworked
166 switch (ocnTp1.getTpType()) {
168 if (tp.augmentation(TerminationPoint1.class) == null) {
171 TerminationPoint1 ontTp1 = tp.augmentation(TerminationPoint1.class);
172 if (SERVICE_TYPE_ODU_LIST.contains(this.otnServiceType)
173 || StringConstants.SERVICE_TYPE_100GE_S.equals(this.otnServiceType)) {
174 // TODO verify the capability of network port to support ODU4 CTP interface creation
175 if (!checkTpForOdtuTermination(ontTp1)) {
176 LOG.error("TP {} of {} does not allow ODU4 termination creation",
177 tp.getTpId().getValue(), node.getNodeId().getValue());
180 } else if (SERVICE_TYPE_ETH_TS_NB_MAP.containsKey(this.otnServiceType)) {
181 if (!checkOdtuTTPforLoOduCreation(
182 ontTp1, SERVICE_TYPE_ETH_TS_NB_MAP.get(this.otnServiceType))) {
183 LOG.error("TP {} of {} does not allow {} termination creation",
184 tp.getTpId().getValue(),
185 SERVICE_TYPE_ETH_ODU_STRING_MAP.get(this.otnServiceType),
186 node.getNodeId().getValue());
190 LOG.error("TP {} of {} does not allow any termination creation",
191 tp.getTpId().getValue(), node.getNodeId().getValue());
194 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
195 this.availableXpdrNWTps.add(tp.getTpId());
199 if (SERVICE_TYPE_ETH_CLASS_MAP.containsKey(otnServiceType)) {
200 if (tp.augmentation(TerminationPoint1.class) == null) {
203 if (checkClientTp(tp.augmentation(TerminationPoint1.class))) {
204 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
205 this.availableXpdrClientTps.add(tp.getTpId());
207 LOG.error("TP {} of {} does not allow lo-ODU (ODU2e or ODU0) termination creation",
208 tp.getTpId().getValue(), node.getNodeId().getValue());
214 LOG.debug("unsupported ocn TP type {}", ocnTp1.getTpType());
217 this.valid = SERVICE_TYPE_ODU_LIST.contains(this.otnServiceType)
218 || SERVICE_TYPE_ETH_CLASS_MAP.containsKey(this.otnServiceType)
219 && checkSwPool(availableXpdrNWTps, availableXpdrClientTps);
222 private boolean checkSwPool(List<TpId> netwTps, List<TpId> clientTps) {
224 if (netwTps == null) {
227 Node1 node1 = node.augmentation(Node1.class);
231 List<NonBlockingList> nblList = new ArrayList<>(
232 node1.getSwitchingPools().nonnullOduSwitchingPools()
233 .values().stream().findFirst().get()
234 .getNonBlockingList().values());
235 if (nblList == null) {
238 netwTps.sort(Comparator.comparing(TpId::getValue));
243 return checkIntermediateSwPool(nblList, netwTps);
246 if (clientTps == null) {
249 clientTps.sort(Comparator.comparing(TpId::getValue));
250 return checkAzSwPool(nblList, netwTps, clientTps);
253 LOG.error("Unsupported mode type {}", modeType);
259 private boolean checkIntermediateSwPool(List<NonBlockingList> nblList, List<TpId> netwTps) {
260 for (NonBlockingList nbl: nblList) {
261 for (TpId nwTp : netwTps) {
262 if (nbl.getTpList().contains(nwTp)) {
263 usableXpdrNWTps.add(nwTp);
265 if (usableXpdrNWTps.size() >= 2) {
274 private boolean checkAzSwPool(List<NonBlockingList> nblList, List<TpId> netwTps, List<TpId> clientTps) {
275 for (NonBlockingList nbl: nblList) {
276 for (TpId nwTp : netwTps) {
277 for (TpId clTp : clientTps) {
278 if (nbl.getTpList().contains(clTp) && nbl.getTpList().contains(nwTp)) {
279 usableXpdrClientTps.add(clTp);
280 usableXpdrNWTps.add(nwTp);
282 if (usableXpdrClientTps.size() >= 1 && usableXpdrNWTps.size() >= 1
283 && (this.clientPort == null || this.clientPort.equals(clTp.getValue()))) {
284 clientPerNwTp.put(nwTp.getValue(), clTp.getValue());
293 private boolean checkTpForOdtuTermination(TerminationPoint1 ontTp1) {
294 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()
296 LOG.info("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
297 if ((sic.getIfCapType().equals(IfOCHOTU4ODU4.class) || sic.getIfCapType().equals(IfOtsiOtsigroup.class))
298 && (ontTp1.getXpdrTpPortConnectionAttributes() == null
299 || ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() == null)) {
306 private boolean checkOdtuTTPforLoOduCreation(TerminationPoint1 ontTp1, int tsNb) {
307 XpdrTpPortConnectionAttributes portConAttr = ontTp1.getXpdrTpPortConnectionAttributes();
308 if (portConAttr == null
309 || portConAttr.getTsPool() == null
310 || portConAttr.getTsPool().size() < tsNb
311 || portConAttr.getOdtuTpnPool() == null) {
314 return checkFirstOdtuTpn(portConAttr.getOdtuTpnPool().values().stream().findFirst().get());
317 private boolean checkFirstOdtuTpn(OdtuTpnPool otPool) {
318 return (otPool.getOdtuType().equals(ODTU4TsAllocated.class)
319 || otPool.getOdtuType().equals(ODTUCnTs.class))
320 && !otPool.getTpnPool().isEmpty();
323 private boolean checkClientTp(TerminationPoint1 ontTp1) {
324 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()
326 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
327 // we could also check the administrative status of the tp
328 if (SERVICE_TYPE_ETH_CLASS_MAP.containsKey(otnServiceType)
329 && sic.getIfCapType().equals(SERVICE_TYPE_ETH_CLASS_MAP.get(otnServiceType))) {
336 public void validateXponder(String anodeId, String znodeId) {
340 if (this.nodeId.getValue().equals(anodeId) || (this.nodeId.getValue().equals(znodeId))) {
342 } else if (OpenroadmNodeType.SWITCH.equals(this.nodeType)) {
343 initXndrTps("intermediate");
345 LOG.info("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
350 public boolean validateSwitchingPoolBandwidth(TerminationPoint tp1, TerminationPoint tp2, Long neededBW) {
351 if (this.nodeType != OpenroadmNodeType.TPDR) {
354 Node1 node1 = node.augmentation(Node1.class);
355 SwitchingPools sp = node1.getSwitchingPools();
356 List<OduSwitchingPools> osp = new ArrayList<>(sp.nonnullOduSwitchingPools().values());
357 for (OduSwitchingPools ospx : osp) {
358 List<NonBlockingList> nbl = new ArrayList<>(ospx.nonnullNonBlockingList().values());
359 for (NonBlockingList nbll : nbl) {
360 if (nbll.getAvailableInterconnectBandwidth().toJava() >= neededBW && nbll.getTpList() != null
361 && nbll.getTpList().contains(tp1.getTpId()) && nbll.getTpList().contains(tp2.getTpId())) {
362 LOG.debug("validateSwitchingPoolBandwidth: couple of tp {} x {} valid for crossconnection",
363 tp1.getTpId(), tp2.getTpId());
368 LOG.debug("validateSwitchingPoolBandwidth: No valid Switching pool for crossconnecting tp {} and {}",
369 tp1.getTpId(), tp2.getTpId());
373 public void validateIntermediateSwitch() {
377 if (this.nodeType != OpenroadmNodeType.SWITCH) {
380 // Validate switch for use as an intermediate XPONDER on the path
381 initXndrTps("intermediate");
383 LOG.info("validateIntermediateSwitch: Switch usable for transit == {}", nodeId.getValue());
385 LOG.debug("validateIntermediateSwitch: Switch unusable for transit == {}", nodeId.getValue());
389 public void checkAvailableTribPort() {
390 for (TerminationPoint tp :
392 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
394 .getTerminationPoint().values().stream()
397 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
398 .TerminationPoint1.class)
400 .equals(OpenroadmTpType.XPONDERNETWORK))
401 .collect(Collectors.toList())) {
402 XpdrTpPortConnectionAttributes portConAttr =
403 tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes();
404 if (portConAttr != null && portConAttr.getOdtuTpnPool() != null) {
405 OdtuTpnPool otPool = portConAttr.getOdtuTpnPool().values().stream().findFirst().get();
406 if (checkFirstOdtuTpn(otPool)) {
407 tpAvailableTribPort.put(tp.getTpId().getValue(), otPool.getTpnPool());
413 public void checkAvailableTribSlot() {
414 for (TerminationPoint tp :
416 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1.class)
417 .getTerminationPoint().values().stream()
420 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1.class)
421 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
422 .collect(Collectors.toList())
424 XpdrTpPortConnectionAttributes portConAttr =
425 tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes();
426 if (portConAttr != null && portConAttr.getTsPool() != null) {
427 tpAvailableTribSlot.put(tp.getTpId().getValue(), portConAttr.getTsPool());
432 public boolean isValid() {
433 if (nodeId == null || nodeType == null
434 || this.getSupNetworkNodeId() == null || this.getSupClliNodeId() == null) {
435 LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
442 public void addOutgoingLink(PceLink outLink) {
443 this.outgoingLinks.add(outLink);
447 public List<PceLink> getOutgoingLinks() {
448 return outgoingLinks;
452 public AdminStates getAdminStates() {
457 public State getState() {
462 public String getXpdrClient(String tp) {
463 return this.clientPerNwTp.get(tp);
467 public String toString() {
468 return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + this.getSupClliNodeId();
471 public void printLinksOfNode() {
472 LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks());
476 public Map<String, List<Uint16>> getAvailableTribPorts() {
477 return tpAvailableTribPort;
481 public Map<String, List<Uint16>> getAvailableTribSlots() {
482 return tpAvailableTribSlot;
485 public List<TpId> getUsableXpdrNWTps() {
486 return usableXpdrNWTps;
489 public List<TpId> getUsableXpdrClientTps() {
490 return usableXpdrClientTps;
494 public String getPceNodeType() {
495 return this.pceNodeType;
499 public String getSupNetworkNodeId() {
500 return MapUtils.getSupNetworkNode(this.node);
504 public String getSupClliNodeId() {
505 return MapUtils.getSupClliNode(this.node);
509 public String getRdmSrgClient(String tp, String direction) {
514 public NodeId getNodeId() {
519 public boolean checkTP(String tp) {
526 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getVersion()
529 public String getVersion() {
530 // TODO Auto-generated method stub
535 public BitSet getBitSetData() {
536 // TODO Auto-generated method stub
543 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getSlotWidthGranularity()
546 public BigDecimal getSlotWidthGranularity() {
553 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getCentralFreqGranularity()
556 public BigDecimal getCentralFreqGranularity() {