tapi/src/main/java/org/opendaylight/transportpce/tapi/topology/TopologyUtils.java

   1 /*
   2  * Copyright © 2021 Nokia, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.transportpce.tapi.topology;
   9
  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;
  17 import java.util.Map;
  18 import java.util.NoSuchElementException;
  19 import java.util.Optional;
  20 import java.util.UUID;
  21 import java.util.concurrent.ExecutionException;
  22 import java.util.stream.Collectors;
  23 import org.eclipse.jdt.annotation.NonNull;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.opendaylight.mdsal.binding.api.DataBroker;
  26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  27 import org.opendaylight.transportpce.common.InstanceIdentifiers;
  28 import org.opendaylight.transportpce.common.NetworkUtils;
  29 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
  30 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.mapping.Mapping;
  31 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.mapping.MappingKey;
  32 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.network.Nodes;
  33 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.network.NodesKey;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Link1;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.TerminationPoint1;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmLinkType;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmNodeType;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev200529.OpenroadmTpType;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Network1;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.Node1;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks.network.Link;
  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.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.LayerProtocolName;
  46 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.Uuid;
  47 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.Name;
  48 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.global._class.NameBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.tapi.context.ServiceInterfacePoint;
  50 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.common.rev181210.tapi.context.ServiceInterfacePointKey;
  51 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.LinkKey;
  52 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.NodeKey;
  53 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.Topology;
  54 import org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.context.TopologyBuilder;
  55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  56 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public final class TopologyUtils {
  61
  62     private final NetworkTransactionService networkTransactionService;
  63     private final DataBroker dataBroker;
  64     private static final Logger LOG = LoggerFactory.getLogger(TopologyUtils.class);
  65     public static final String T0_MULTILAYER = "T0 - Multi-layer topology";
  66     public static final String T0_FULL_MULTILAYER = "T0 - Full Multi-layer topology";
  67     public static final String TPDR_100G = "Transponder 100GE";
  68     private Map<ServiceInterfacePointKey, ServiceInterfacePoint> tapiSips;
  69
  70     public TopologyUtils(NetworkTransactionService networkTransactionService, DataBroker dataBroker) {
  71         this.networkTransactionService = networkTransactionService;
  72         this.dataBroker = dataBroker;
  73         this.tapiSips = new HashMap<>();
  74     }
  75
  76     public Network readTopology(InstanceIdentifier<Network> networkIID) throws TapiTopologyException {
  77         Network topology = null;
  78         ListenableFuture<Optional<Network>> topologyFuture =
  79                 this.networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, networkIID);
  80         try {
  81             topology = topologyFuture.get().get();
  82         } catch (InterruptedException e) {
  83             Thread.currentThread().interrupt();
  84             throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
  85                     .firstKeyOf(Network.class).getNetworkId().getValue(), e);
  86         } catch (ExecutionException e) {
  87             throw new TapiTopologyException("Unable to get from mdsal topology: " + networkIID
  88                     .firstKeyOf(Network.class).getNetworkId().getValue(), e);
  89         } catch (NoSuchElementException e) {
  90             return null;
  91         }
  92         return topology;
  93     }
  94
  95     public Topology createFullOtnTopology() throws TapiTopologyException {
  96         // read openroadm-topology
  97         Network openroadmTopo = readTopology(InstanceIdentifiers.OVERLAY_NETWORK_II);
  98         List<Link> linkList = new ArrayList<>();
  99         if (openroadmTopo.augmentation(Network1.class) != null) {
 100             linkList.addAll(openroadmTopo.augmentation(Network1.class).getLink().values());
 101         }
 102         List<Link> xponderOutLinkList = linkList.stream()
 103             .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDEROUTPUT))
 104             .collect(Collectors.toList());
 105         List<Link> xponderInLinkList = linkList.stream()
 106             .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.XPONDERINPUT))
 107             .collect(Collectors.toList());
 108         // read otn-topology
 109         Network otnTopo = readTopology(InstanceIdentifiers.OTN_NETWORK_II);
 110         Map<NodeId, org.opendaylight.yang.gen.v1.urn
 111             .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> otnNodeMap = otnTopo.nonnullNode()
 112             .values().stream().collect(Collectors.toMap(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 113                 .ietf.network.rev180226.networks.network.Node::getNodeId, node -> node));
 114
 115         Map<String, List<String>> networkPortMap = new HashMap<>();
 116         Iterator<Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
 117             .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node>> itOtnNodeMap = otnNodeMap
 118             .entrySet().iterator();
 119         while (itOtnNodeMap.hasNext()) {
 120             Map.Entry<NodeId, org.opendaylight.yang.gen.v1.urn
 121                 .ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node> entry = itOtnNodeMap.next();
 122             String portMappingNodeId = entry.getValue().getSupportingNode().values().stream()
 123                 .filter(sn -> sn.getNetworkRef().getValue().equals(NetworkUtils.UNDERLAY_NETWORK_ID))
 124                 .findFirst()
 125                 .get().getNodeRef().getValue();
 126             List<String> networkPortList = new ArrayList<>();
 127             for (TerminationPoint tp: entry.getValue().augmentation(Node1.class).getTerminationPoint().values()) {
 128                 // TODO -> why are we checking with respect to XPDR links?? Is there a real purpose on doing that?
 129                 if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERNETWORK)
 130                     && checkTp(entry.getKey().getValue(), portMappingNodeId, tp, xponderOutLinkList,
 131                     xponderInLinkList)) {
 132                     networkPortList.add(tp.getTpId().getValue());
 133                 }
 134             }
 135             if (!networkPortList.isEmpty()) {
 136                 networkPortMap.put(entry.getKey().getValue(), networkPortList);
 137             }
 138         }
 139         Map<NodeKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Node>
 140             tapiNodeList = new HashMap<>();
 141         Map<LinkKey, org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.topology.Link>
 142             tapiLinkList = new HashMap<>();
 143         Uuid topoUuid = new Uuid(UUID.nameUUIDFromBytes(TopologyUtils.T0_FULL_MULTILAYER
 144             .getBytes(Charset.forName("UTF-8"))).toString());
 145         ConvertORTopoToTapiFullTopo tapiFactory = new ConvertORTopoToTapiFullTopo(topoUuid);
 146         Iterator<Map.Entry<String, List<String>>> it = networkPortMap.entrySet().iterator();
 147         while (it.hasNext()) {
 148             String nodeId = it.next().getKey();
 149             tapiFactory.convertNode(otnNodeMap.get(new NodeId(nodeId)), networkPortMap.get(nodeId));
 150             tapiNodeList.putAll(tapiFactory.getTapiNodes());
 151             tapiLinkList.putAll(tapiFactory.getTapiLinks());
 152         }
 153         // roadm infrastructure not abstracted
 154         // read openroadm-network
 155         Network openroadmNet = readTopology(InstanceIdentifiers.UNDERLAY_NETWORK_II);
 156         if (openroadmNet != null && openroadmNet.nonnullNode().values().stream().filter(nt ->
 157                 nt.augmentation(org.opendaylight.yang.gen.v1.http.org.openroadm.common.network.rev200529.Node1.class)
 158                         .getNodeType().equals(OpenroadmNodeType.ROADM)).count() > 0) {
 159             // map roadm nodes
 160             for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node
 161                     roadm:openroadmNet.nonnullNode().values().stream().filter(
 162                             nt -> nt.augmentation(org.opendaylight.yang.gen.v1.http
 163                             .org.openroadm.common.network.rev200529.Node1.class)
 164                             .getNodeType().equals(OpenroadmNodeType.ROADM))
 165                     .collect(Collectors.toList())) {
 166                 tapiFactory.convertRoadmNode(roadm, openroadmTopo);
 167                 tapiNodeList.putAll(tapiFactory.getTapiNodes());
 168             }
 169         } else {
 170             LOG.warn("No roadm nodes exist in the network");
 171         }
 172         // map roadm to roadm link
 173         List<Link> rdmTordmLinkList = linkList.stream()
 174                 .filter(lk -> lk.augmentation(Link1.class).getLinkType().equals(OpenroadmLinkType.ROADMTOROADM))
 175                 .collect(Collectors.toList());
 176         tapiFactory.convertRdmToRdmLinks(rdmTordmLinkList);
 177         tapiLinkList.putAll(tapiFactory.getTapiLinks());
 178         // map xpdr_input to roadm and xpdr_output to roadm links.
 179         xponderInLinkList.addAll(xponderOutLinkList);
 180         tapiFactory.convertXpdrToRdmLinks(xponderInLinkList);
 181         tapiLinkList.putAll(tapiFactory.getTapiLinks());
 182
 183         if (otnTopo.augmentation(Network1.class) != null) {
 184             Map<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev180226.networks
 185                     .network.LinkKey, Link> otnLinkMap = otnTopo.augmentation(Network1.class).getLink();
 186             tapiFactory.convertLinks(otnLinkMap);
 187             tapiLinkList.putAll(tapiFactory.getTapiLinks());
 188         }
 189         Name name = new NameBuilder().setValue(TopologyUtils.T0_FULL_MULTILAYER).setValueName("TAPI Topology Name")
 190                 .build();
 191         // Retrieve created sips map in TapiFactory when mapping all the nodes
 192         this.tapiSips = tapiFactory.getTapiSips();
 193         return new TopologyBuilder()
 194                 .setName(Map.of(name.key(), name))
 195                 .setUuid(topoUuid)
 196                 .setNode(tapiNodeList)
 197                 .setLayerProtocolName(List.of(LayerProtocolName.PHOTONICMEDIA, LayerProtocolName.ODU,
 198                         LayerProtocolName.DSR))
 199                 .setLink(tapiLinkList).build();
 200     }
 201
 202     public Map<ServiceInterfacePointKey, ServiceInterfacePoint> getSipMap() {
 203         return tapiSips;
 204     }
 205
 206     public boolean checkTp(String nodeIdTopo, String nodeIdPortMap, TerminationPoint tp, List<Link> xpdOut,
 207                            List<Link> xpdIn) {
 208         LOG.info("Inside Checktp for node {}-{}", nodeIdTopo, nodeIdPortMap);
 209         String networkLcp;
 210         if (tp.augmentation(TerminationPoint1.class).getTpType().equals(OpenroadmTpType.XPONDERCLIENT)) {
 211             networkLcp = tp.augmentation(
 212                     org.opendaylight.yang.gen.v1.http.transportpce.topology.rev201019.TerminationPoint1.class)
 213                     .getAssociatedConnectionMapPort();
 214         } else {
 215             networkLcp = tp.getTpId().getValue();
 216         }
 217         LOG.info("Network LCP associated = {}", networkLcp);
 218         @NonNull
 219         KeyedInstanceIdentifier<Mapping, MappingKey> pmIID = InstanceIdentifier.create(
 220                 org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210315.Network.class)
 221                 .child(Nodes.class, new NodesKey(nodeIdPortMap)).child(Mapping.class, new MappingKey(networkLcp));
 222         @NonNull
 223         FluentFuture<Optional<Mapping>> mappingOpt = this.dataBroker.newReadOnlyTransaction().read(
 224                 LogicalDatastoreType.CONFIGURATION, pmIID);
 225         Mapping mapping = null;
 226         if (mappingOpt.isDone()) {
 227             try {
 228                 mapping = mappingOpt.get().get();
 229             } catch (InterruptedException | ExecutionException e) {
 230                 LOG.error("Error getting mapping for {}", networkLcp,e);
 231                 return false;
 232             }
 233         } else {
 234             LOG.error("Impossible to get mapping of associated network port {} of tp {}", networkLcp, tp.getTpId()
 235                     .getValue());
 236             return false;
 237         }
 238         LOG.info("Mapping found = {}", mapping);
 239         String networkPortDirection = mapping.getPortDirection();
 240         // long count = 0;
 241         switch (networkPortDirection) {
 242             // TODO -> remove the part of counting only if the Network LCP is part of a Link.
 243             //  We want to have all OTN nodes in the TAPI topology
 244             case "bidirectional":
 245                 return true;
 246             case "tx":
 247             case "rx":
 248                 @Nullable
 249                 String partnerLcp = mapping.getPartnerLcp();
 250                 LOG.info("PartnerLCP = {}", partnerLcp);
 251                 return true;
 252             default:
 253                 LOG.error("Invalid port direction for {}", networkLcp);
 254                 return false;
 255         }
 256     }
 257
 258     public org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210.get.topology.details.output.Topology
 259             transformTopology(Topology topology) {
 260         return new org.opendaylight.yang.gen.v1.urn.onf.otcc.yang.tapi.topology.rev181210
 261             .get.topology.details.output.TopologyBuilder()
 262                 .setUuid(topology.getUuid())
 263                 .setName(topology.getName())
 264                 .setLayerProtocolName(topology.getLayerProtocolName())
 265                 .setNode(topology.getNode())
 266                 .setLink(topology.getLink())
 267                 .build();
 268     }
 269
 270 }