2 * Copyright © 2021 Nokia, 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
8 package org.opendaylight.transportpce.tapi.topology;
10 import com.google.common.util.concurrent.FluentFuture;
11 import com.google.common.util.concurrent.ListenableFuture;
12 import java.nio.charset.Charset;
13 import java.util.ArrayList;
14 import java.util.HashMap;
15 import java.util.Iterator;
16 import java.util.List;
18 import java.util.NoSuchElementException;
19 import java.util.Optional;
21 import java.util.UUID;
22 import java.util.concurrent.ExecutionException;
23 import java.util.stream.Collectors;
24 import org.eclipse.jdt.annotation.NonNull;
25 import org.eclipse.jdt.annotation.Nullable;
26 import org.opendaylight.mdsal.binding.api.DataBroker;
27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
28 import org.opendaylight.transportpce.common.InstanceIdentifiers;
29 import org.opendaylight.transportpce.common.NetworkUtils;
30 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
31 import org.opendaylight.transportpce.tapi.TapiStringConstants;
32 import org.opendaylight.transportpce.tapi.utils.TapiLink;
33 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220922.mapping.Mapping;
34 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220922.mapping.MappingKey;
35 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220922.network.Nodes;
36 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220922.network.NodesKey;
37 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Link1;
38 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.TerminationPoint1;
39 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev230526.OpenroadmLinkType;
40 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev230526.OpenroadmNodeType;
41 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev230526.OpenroadmTpType;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.node.TerminationPoint;
48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Context;
49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.LayerProtocolName;
50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.Uuid;
51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.global._class.Name;
52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.global._class.NameBuilder;
53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.global._class.NameKey;
54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.tapi.context.ServiceInterfacePoint;
55 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev221121.tapi.context.ServiceInterfacePointKey;
56 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.connectivity.rev221121.OwnedNodeEdgePoint1;
57 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.context.TopologyContext;
58 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePoint;
59 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePointBuilder;
60 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.node.OwnedNodeEdgePointKey;
61 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.LinkKey;
62 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node;
63 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.NodeBuilder;
64 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.NodeKey;
65 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.Topology;
66 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.TopologyBuilder;
67 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.context.TopologyKey;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
69 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
73 public final class TopologyUtils {
75 private final NetworkTransactionService networkTransactionService;
76 private final DataBroker dataBroker;
77 private static final Logger LOG = LoggerFactory.getLogger(TopologyUtils.class);
78 private Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSips;
79 private final TapiLink tapiLink;
81 public TopologyUtils(NetworkTransactionService networkTransactionService, DataBroker dataBroker,
83 this.networkTransactionService = networkTransactionService;
84 this.dataBroker = dataBroker;
85 this.tapiSips = new HashMap<>();
86 this.tapiLink = tapiLink;
89 public Network readTopology(InstanceIdentifier<Network> networkIID) throws TapiTopologyException {
90 Network topology = null;
91 ListenableFuture<Optional<Network>> topologyFuture =
92 this.networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, networkIID);
94 topology = topologyFuture.get().orElseThrow();
95 } catch (InterruptedException e) {
96 Thread.currentThread().interrupt();
97 throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
98 .firstKeyOf(Network.class).getNetworkId().getValue(), e);
99 } catch (ExecutionException e) {
100 throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
101 .firstKeyOf(Network.class).getNetworkId().getValue(), e);
102 } catch (NoSuchElementException e) {
108 public List<String> readTopologyName(Uuid topoUuid) throws TapiTopologyException {
109 Topology topology = null;
110 InstanceIdentifier<Topology> topoIID = InstanceIdentifier.builder(
111 Context.class).augmentation(org.opendaylight.yang.gen.v1.urn
112 .onf.otcc.yang.tapi.topology.rev221121.Context1.class).child(TopologyContext.class)
113 .child(Topology.class, new TopologyKey(topoUuid)).build();
115 ListenableFuture<Optional<Topology>> topologyFuture =
116 this.networkTransactionService.read(LogicalDatastoreType.OPERATIONAL, topoIID);
118 topology = topologyFuture.get().orElseThrow();
119 } catch (InterruptedException e) {
120 Thread.currentThread().interrupt();
121 throw new TapiTopologyException("Unable to get from mdsal topology: " + topoIID
122 .firstKeyOf(Topology.class).getUuid().getValue(), e);
123 } catch (ExecutionException e) {
124 throw new TapiTopologyException("Unable to get from mdsal topology: " + topoIID
125 .firstKeyOf(Topology.class).getUuid().getValue(), e);
126 } catch (NoSuchElementException e) {
129 List<String> nameList = new ArrayList<>();
130 for (Map.Entry<NameKey, Name> entry : topology.getName().entrySet()) {
131 nameList.add(entry.getValue().getValue());
133 LOG.debug("Topology nameList {} = ", nameList.toString());
137 public Topology createFullOtnTopology() throws TapiTopologyException {
138 // read openroadm-topology
139 Network openroadmTopo = readTopology(InstanceIdentifiers.OVERLAY_NETWORK_II);
140 Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(TapiStringConstants.T0_FULL_MULTILAYER
141 .getBytes(Charset.forName("UTF-8"))).toString());
142 Name name = new NameBuilder()
143 .setValue(TapiStringConstants.T0_FULL_MULTILAYER)
144 .setValueName("TAPI Topology Name")
146 if (openroadmTopo != null) {
147 List<Link> linkList = new ArrayList<>();
148 if (openroadmTopo.augmentation(Network1.class) != null) {
149 linkList.addAll(openroadmTopo.augmentation(Network1.class).getLink().values());
151 List<Link> xponderOutLinkList = linkList.stream()
152 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
153 .collect(Collectors.toList());
154 List<Link> xponderInLinkList = linkList.stream()
155 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDERINPUT))
156 .collect(Collectors.toList());
158 Network otnTopo = readTopology(InstanceIdentifiers.OTN_NETWORK_II);
159 Map<NodeId, org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
160 .ietf.network.rev180226.networks.network.Node> otnNodeMap = otnTopo.nonnullNode()
161 .values().stream().collect(Collectors.toMap(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
162 .ietf.network.rev180226.networks.network.Node::getNodeId, node -> node));
164 Map<String, List<String>> networkPortMap = new HashMap<>();
165 Iterator<Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
166 .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node>> itOtnNodeMap = otnNodeMap
167 .entrySet().iterator();
168 while (itOtnNodeMap.hasNext()) {
169 Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
170 .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> entry = itOtnNodeMap.next();
171 String portMappingNodeId = entry.getValue().getSupportingNode().values().stream()
172 .filter(sn -> sn.getNetworkRef().getValue().equals(NetworkUtils.UNDERLAY_NETWORK_ID))
174 .orElseThrow().getNodeRef().getValue();
175 List<String> networkPortList = new ArrayList<>();
176 for (TerminationPoint tp: entry.getValue().augmentation(Node1.class).getTerminationPoint().values()) {
177 // TODO -> why are we checking with respect to XPDR links?? Is there a real purpose on doing that?
178 if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERNETWORK)
179 && checkTp(entry.getKey().getValue(), portMappingNodeId, tp, xponderOutLinkList,
180 xponderInLinkList)) {
181 networkPortList.add(tp.getTpId().getValue());
184 if (!networkPortList.isEmpty()) {
185 networkPortMap.put(entry.getKey().getValue(), networkPortList);
188 Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Node>
189 tapiNodeList = new HashMap<>();
190 Map<LinkKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.topology.Link>
191 tapiLinkList = new HashMap<>();
192 ConvertORTopoToTapiFullTopo tapiFullFactory = new ConvertORTopoToTapiFullTopo(topoUuid, this.tapiLink);
193 ConvertORToTapiTopology tapiFactory = new ConvertORToTapiTopology(topoUuid);
194 Iterator<Map.Entry<String, List<String>>> it = networkPortMap.entrySet().iterator();
195 while (it.hasNext()) {
196 String nodeId = it.next().getKey();
197 tapiFactory.convertNode(otnNodeMap.get(new NodeId(nodeId)), networkPortMap.get(nodeId));
198 this.tapiSips.putAll(tapiFactory.getTapiSips());
199 tapiFullFactory.setTapiNodes(tapiFactory.getTapiNodes());
200 tapiFullFactory.setTapiSips(tapiFactory.getTapiSips());
201 tapiNodeList.putAll(tapiFactory.getTapiNodes());
202 tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
204 // roadm infrastructure not abstracted
205 // read openroadm-network
206 Network openroadmNet = readTopology(InstanceIdentifiers.UNDERLAY_NETWORK_II);
207 if (openroadmNet != null && openroadmNet.nonnullNode().values().stream()
209 .augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Node1.class)
211 .equals(OpenroadmNodeType.ROADM))
214 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network
215 .Node roadm:openroadmNet.nonnullNode().values().stream()
218 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.Node1.class)
220 .equals(OpenroadmNodeType.ROADM))
221 .collect(Collectors.toList())) {
222 tapiFullFactory.convertRoadmNode(roadm, openroadmTopo);
223 this.tapiSips.putAll(tapiFullFactory.getTapiSips());
224 tapiNodeList.putAll(tapiFullFactory.getTapiNodes());
225 tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
228 LOG.warn("No roadm nodes exist in the network");
230 // map roadm to roadm link
231 List<Link> rdmTordmLinkList = linkList.stream()
232 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.ROADMTOROADM))
233 .collect(Collectors.toList());
234 tapiFullFactory.convertRdmToRdmLinks(rdmTordmLinkList);
235 tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
236 // map xpdr_input to roadm and xpdr_output to roadm links.
237 xponderInLinkList.addAll(xponderOutLinkList);
238 tapiFullFactory.convertXpdrToRdmLinks(xponderInLinkList);
239 tapiLinkList.putAll(tapiFullFactory.getTapiLinks());
241 // Retrieve created sips map in TapiFactory when mapping all the nodes
242 this.tapiSips.putAll(tapiFullFactory.getTapiSips());
243 return new TopologyBuilder()
244 .setName(Map.of(name.key(), name))
246 .setNode(tapiNodeList)
247 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
248 LayerProtocolName.DSR))
249 .setLink(tapiLinkList).build();
251 return new TopologyBuilder()
252 .setName(Map.of(name.key(), name))
254 .setLayerProtocolName(Set.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
255 LayerProtocolName.DSR))
259 public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getSipMap() {
263 public boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut,
265 LOG.info("Inside Checktp for node {}-{}", nodeIdTopo, nodeIdPortMap);
267 if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)) {
268 networkLcp = tp.augmentation(
269 org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev230526.TerminationPoint1.class)
270 .getAssociatedConnectionMapTp().iterator().next().getValue();
272 networkLcp = tp.getTpId().getValue();
274 LOG.info("Network LCP associated = {}", networkLcp);
276 KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
277 org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220922.Network.class)
278 .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
280 FluentFuture<Optional<Mapping>> mappingOpt = this.dataBroker.newReadOnlyTransaction().read(
281 LogicalDatastoreType.CONFIGURATION, pmIID);
282 Mapping mapping = null;
283 if (mappingOpt.isDone()) {
285 mapping = mappingOpt.get().orElseThrow();
286 } catch (InterruptedException | ExecutionException e) {
287 LOG.error("Error getting mapping for {}", networkLcp,e);
291 LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
295 LOG.info("Mapping found = {}", mapping);
296 String networkPortDirection = mapping.getPortDirection();
297 switch (networkPortDirection) {
298 // TODO -> remove the part of counting only if the Network LCP is part of a Link.
299 // We want to have all OTN nodes in the TAPI topology
300 case "bidirectional":
305 String partnerLcp = mapping.getPartnerLcp();
306 LOG.info("PartnerLCP = {}", partnerLcp);
309 LOG.error("Invalid port direction for {}", networkLcp);
314 public org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121.get.topology.details.output.Topology
315 transformTopology(Topology topology) {
316 org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121
317 .get.topology.details.output.TopologyBuilder topologyBuilder =
318 new org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev221121
319 .get.topology.details.output.TopologyBuilder()
320 .setUuid(topology.getUuid())
321 .setName(topology.getName())
322 .setLayerProtocolName(topology.getLayerProtocolName())
323 .setNode(topology.getNode())
324 .setLink(topology.getLink());
325 if (topology.getNode() == null) {
326 topologyBuilder.setNode(topology.getNode());
327 return topologyBuilder.build();
329 // TODO -> Need to remove CEPs from NEPs. If not error from get Topology details output
330 Map<NodeKey, Node> mapNode = new HashMap<>();
331 for (Node node: topology.getNode().values()) {
332 Map<OwnedNodeEdgePointKey, OwnedNodeEdgePoint> onepMap = new HashMap<>();
333 for (OwnedNodeEdgePoint onep: node.getOwnedNodeEdgePoint().values()) {
334 OwnedNodeEdgePoint1 onep1 = onep.augmentation(OwnedNodeEdgePoint1.class);
336 onepMap.put(onep.key(), onep);
339 OwnedNodeEdgePointBuilder newOnepBuilder = new OwnedNodeEdgePointBuilder()
340 .setUuid(onep.getUuid())
341 .setLayerProtocolName(onep.getLayerProtocolName())
342 .setName(onep.getName())
343 .setSupportedCepLayerProtocolQualifierInstances(onep
344 .getSupportedCepLayerProtocolQualifierInstances())
345 .setAdministrativeState(onep.getAdministrativeState())
346 .setOperationalState(onep.getOperationalState())
347 .setLifecycleState(onep.getLifecycleState())
348 // .setTerminationDirection(onep.getTerminationDirection())
349 // .setTerminationState(onep.getTerminationState())
350 .setDirection(onep.getDirection())
351 .setLinkPortRole(onep.getLinkPortRole());
352 if (onep.getMappedServiceInterfacePoint() != null) {
353 newOnepBuilder.setMappedServiceInterfacePoint(onep.getMappedServiceInterfacePoint());
355 OwnedNodeEdgePoint nep = newOnepBuilder.build();
356 onepMap.put(nep.key(), nep);
358 Node newNode = new NodeBuilder(node)
359 .setOwnedNodeEdgePoint(onepMap)
361 mapNode.put(newNode.key(), newNode);
363 topologyBuilder.setNode(mapNode);
364 return topologyBuilder.build();