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");
136 public void initXndrTps(String mode) {
137 LOG.info("PceOtnNode: initXndrTps for node {}", this.nodeId.getValue());
138 this.availableXponderTp.clear();
139 this.modeType = mode;
140 List<TerminationPoint> allTps =
142 this.node.augmentation(
143 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
145 .nonnullTerminationPoint()
148 if (allTps.isEmpty()) {
149 LOG.error("PceOtnNode: initXndrTps: XPONDER TerminationPoint list is empty for node {}", this);
152 for (TerminationPoint tp : allTps) {
153 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1 ocnTp1
154 = tp.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
155 .TerminationPoint1.class);
156 if (ocnTp1 == null) {
157 LOG.warn("null ocn TP {}", tp);
160 //TODO many nested structures below, this needs to be reworked
161 switch (ocnTp1.getTpType()) {
163 if (tp.augmentation(TerminationPoint1.class) == null) {
166 TerminationPoint1 ontTp1 = tp.augmentation(TerminationPoint1.class);
167 if (SERVICE_TYPE_ODU_LIST.contains(this.otnServiceType)
168 || StringConstants.SERVICE_TYPE_100GE_S.equals(this.otnServiceType)) {
169 // TODO verify the capability of network port to support ODU4 CTP interface creation
170 if (!checkTpForOdtuTermination(ontTp1)) {
171 LOG.error("TP {} of {} does not allow ODU4 termination creation",
172 tp.getTpId().getValue(), node.getNodeId().getValue());
175 } else if (SERVICE_TYPE_ETH_TS_NB_MAP.containsKey(this.otnServiceType)) {
176 if (!checkOdtuTTPforLoOduCreation(
177 ontTp1, SERVICE_TYPE_ETH_TS_NB_MAP.get(this.otnServiceType))) {
178 LOG.error("TP {} of {} does not allow {} termination creation",
179 tp.getTpId().getValue(),
180 SERVICE_TYPE_ETH_ODU_STRING_MAP.get(this.otnServiceType),
181 node.getNodeId().getValue());
185 LOG.error("TP {} of {} does not allow any termination creation",
186 tp.getTpId().getValue(), node.getNodeId().getValue());
189 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
190 this.availableXpdrNWTps.add(tp.getTpId());
194 if (SERVICE_TYPE_ETH_CLASS_MAP.containsKey(otnServiceType)) {
195 if (tp.augmentation(TerminationPoint1.class) == null) {
198 if (checkClientTp(tp.augmentation(TerminationPoint1.class))) {
199 LOG.info("TP {} of XPONDER {} is validated", tp.getTpId(), node.getNodeId().getValue());
200 this.availableXpdrClientTps.add(tp.getTpId());
202 LOG.error("TP {} of {} does not allow lo-ODU (ODU2e or ODU0) termination creation",
203 tp.getTpId().getValue(), node.getNodeId().getValue());
209 LOG.debug("unsupported ocn TP type {}", ocnTp1.getTpType());
212 this.valid = SERVICE_TYPE_ODU_LIST.contains(this.otnServiceType)
213 || SERVICE_TYPE_ETH_CLASS_MAP.containsKey(this.otnServiceType)
214 && checkSwPool(availableXpdrNWTps, availableXpdrClientTps);
217 private boolean checkSwPool(List<TpId> netwTps, List<TpId> clientTps) {
219 if (netwTps == null) {
222 Node1 node1 = node.augmentation(Node1.class);
226 List<NonBlockingList> nblList = new ArrayList<>(
227 node1.getSwitchingPools().nonnullOduSwitchingPools()
228 .values().stream().findFirst().get()
229 .getNonBlockingList().values());
230 if (nblList == null) {
233 netwTps.sort(Comparator.comparing(TpId::getValue));
238 for (NonBlockingList nbl: nblList) {
239 for (TpId nwTp : netwTps) {
240 if (nbl.getTpList().contains(nwTp)) {
241 usableXpdrNWTps.add(nwTp);
243 if (usableXpdrNWTps.size() >= 2) {
251 if (clientTps == null) {
254 clientTps.sort(Comparator.comparing(TpId::getValue));
255 for (NonBlockingList nbl: nblList) {
256 for (TpId nwTp : netwTps) {
257 for (TpId clTp : clientTps) {
258 if (nbl.getTpList().contains(clTp) && nbl.getTpList().contains(nwTp)) {
259 usableXpdrClientTps.add(clTp);
260 usableXpdrNWTps.add(nwTp);
262 if (usableXpdrClientTps.size() >= 1 && usableXpdrNWTps.size() >= 1
263 && (this.clientPort == null || this.clientPort.equals(clTp.getValue()))) {
264 clientPerNwTp.put(nwTp.getValue(), clTp.getValue());
273 LOG.error("Unsupported mode type {}", modeType);
278 private boolean checkTpForOdtuTermination(TerminationPoint1 ontTp1) {
279 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()
281 LOG.info("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
282 if ((sic.getIfCapType().equals(IfOCHOTU4ODU4.class) || sic.getIfCapType().equals(IfOtsiOtsigroup.class))
283 && (ontTp1.getXpdrTpPortConnectionAttributes() == null
284 || ontTp1.getXpdrTpPortConnectionAttributes().getTsPool() == null)) {
291 private boolean checkOdtuTTPforLoOduCreation(TerminationPoint1 ontTp1, int tsNb) {
292 XpdrTpPortConnectionAttributes portConAttr = ontTp1.getXpdrTpPortConnectionAttributes();
293 if (portConAttr == null
294 || portConAttr.getTsPool() == null
295 || portConAttr.getTsPool().size() < tsNb
296 || portConAttr.getOdtuTpnPool() == null) {
299 return checkFirstOdtuTpn(portConAttr.getOdtuTpnPool().values().stream().findFirst().get());
302 private boolean checkFirstOdtuTpn(OdtuTpnPool otPool) {
303 return (otPool.getOdtuType().equals(ODTU4TsAllocated.class)
304 || otPool.getOdtuType().equals(ODTUCnTs.class))
305 && !otPool.getTpnPool().isEmpty();
308 private boolean checkClientTp(TerminationPoint1 ontTp1) {
309 for (SupportedInterfaceCapability sic : ontTp1.getTpSupportedInterfaces().getSupportedInterfaceCapability()
311 LOG.debug("in checkTpForOduTermination - sic = {}", sic.getIfCapType());
312 // we could also check the administrative status of the tp
313 if (SERVICE_TYPE_ETH_CLASS_MAP.containsKey(otnServiceType)
314 && sic.getIfCapType().equals(SERVICE_TYPE_ETH_CLASS_MAP.get(otnServiceType))) {
321 public void validateXponder(String anodeId, String znodeId) {
325 if (this.nodeId.getValue().equals(anodeId) || (this.nodeId.getValue().equals(znodeId))) {
327 } else if (OpenroadmNodeType.SWITCH.equals(this.nodeType)) {
328 initXndrTps("intermediate");
330 LOG.info("validateAZxponder: XPONDER is ignored == {}", nodeId.getValue());
335 public boolean validateSwitchingPoolBandwidth(TerminationPoint tp1, TerminationPoint tp2, Long neededBW) {
336 if (this.nodeType != OpenroadmNodeType.TPDR) {
339 Node1 node1 = node.augmentation(Node1.class);
340 SwitchingPools sp = node1.getSwitchingPools();
341 List<OduSwitchingPools> osp = new ArrayList<>(sp.nonnullOduSwitchingPools().values());
342 for (OduSwitchingPools ospx : osp) {
343 List<NonBlockingList> nbl = new ArrayList<>(ospx.nonnullNonBlockingList().values());
344 for (NonBlockingList nbll : nbl) {
345 if (nbll.getAvailableInterconnectBandwidth().toJava() >= neededBW && nbll.getTpList() != null
346 && nbll.getTpList().contains(tp1.getTpId()) && nbll.getTpList().contains(tp2.getTpId())) {
347 LOG.debug("validateSwitchingPoolBandwidth: couple of tp {} x {} valid for crossconnection",
348 tp1.getTpId(), tp2.getTpId());
353 LOG.debug("validateSwitchingPoolBandwidth: No valid Switching pool for crossconnecting tp {} and {}",
354 tp1.getTpId(), tp2.getTpId());
358 public void validateIntermediateSwitch() {
362 if (this.nodeType != OpenroadmNodeType.SWITCH) {
365 // Validate switch for use as an intermediate XPONDER on the path
366 initXndrTps("intermediate");
368 LOG.info("validateIntermediateSwitch: Switch usable for transit == {}", nodeId.getValue());
370 LOG.debug("validateIntermediateSwitch: Switch unusable for transit == {}", nodeId.getValue());
374 public void checkAvailableTribPort() {
375 for (TerminationPoint tp :
377 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226
379 .getTerminationPoint().values().stream()
382 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529
383 .TerminationPoint1.class)
385 .equals(OpenroadmTpType.XPONDERNETWORK))
386 .collect(Collectors.toList())) {
387 XpdrTpPortConnectionAttributes portConAttr =
388 tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes();
389 if (portConAttr != null && portConAttr.getOdtuTpnPool() != null) {
390 OdtuTpnPool otPool = portConAttr.getOdtuTpnPool().values().stream().findFirst().get();
391 if (checkFirstOdtuTpn(otPool)) {
392 tpAvailableTribPort.put(tp.getTpId().getValue(), otPool.getTpnPool());
398 public void checkAvailableTribSlot() {
399 for (TerminationPoint tp :
401 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1.class)
402 .getTerminationPoint().values().stream()
405 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1.class)
406 .getTpType().equals(OpenroadmTpType.XPONDERNETWORK))
407 .collect(Collectors.toList())
409 XpdrTpPortConnectionAttributes portConAttr =
410 tp.augmentation(TerminationPoint1.class).getXpdrTpPortConnectionAttributes();
411 if (portConAttr != null && portConAttr.getTsPool() != null) {
412 tpAvailableTribSlot.put(tp.getTpId().getValue(), portConAttr.getTsPool());
417 public boolean isValid() {
418 if (nodeId == null || nodeType == null
419 || this.getSupNetworkNodeId() == null || this.getSupClliNodeId() == null) {
420 LOG.error("PceNode: one of parameters is not populated : nodeId, node type, supporting nodeId");
427 public void addOutgoingLink(PceLink outLink) {
428 this.outgoingLinks.add(outLink);
432 public List<PceLink> getOutgoingLinks() {
433 return outgoingLinks;
437 public AdminStates getAdminStates() {
442 public State getState() {
447 public String getXpdrClient(String tp) {
448 return this.clientPerNwTp.get(tp);
452 public String toString() {
453 return "PceNode type=" + nodeType + " ID=" + nodeId.getValue() + " CLLI=" + this.getSupClliNodeId();
456 public void printLinksOfNode() {
457 LOG.info(" outgoing links of node {} : {} ", nodeId.getValue(), this.getOutgoingLinks());
461 public Map<String, List<Uint16>> getAvailableTribPorts() {
462 return tpAvailableTribPort;
466 public Map<String, List<Uint16>> getAvailableTribSlots() {
467 return tpAvailableTribSlot;
470 public List<TpId> getUsableXpdrNWTps() {
471 return usableXpdrNWTps;
474 public List<TpId> getUsableXpdrClientTps() {
475 return usableXpdrClientTps;
479 public String getPceNodeType() {
480 return this.pceNodeType;
484 public String getSupNetworkNodeId() {
485 return MapUtils.getSupNetworkNode(this.node);
489 public String getSupClliNodeId() {
490 return MapUtils.getSupClliNode(this.node);
494 public String getRdmSrgClient(String tp, String direction) {
499 public NodeId getNodeId() {
504 public boolean checkTP(String tp) {
511 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getVersion()
514 public String getVersion() {
515 // TODO Auto-generated method stub
520 public BitSet getBitSetData() {
521 // TODO Auto-generated method stub
528 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getSlotWidthGranularity()
531 public BigDecimal getSlotWidthGranularity() {
538 * @see org.opendaylight.transportpce.pce.networkanalyzer.PceNode#getCentralFreqGranularity()
541 public BigDecimal getCentralFreqGranularity() {