2 * Copyright © 2016 AT&T 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.pce.constraints;
10 import java.util.ArrayList;
11 import java.util.List;
12 import java.util.Optional;
13 import java.util.concurrent.ExecutionException;
14 import java.util.concurrent.TimeUnit;
15 import java.util.concurrent.TimeoutException;
16 import java.util.stream.Collectors;
17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
18 import org.opendaylight.transportpce.common.Timeouts;
19 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
20 import org.opendaylight.transportpce.pce.constraints.PceConstraints.ResourcePair;
21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.pce.rev220118.PathComputationRequestInput;
22 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.node.types.rev181130.NodeIdType;
23 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.CoRoutingOrGeneral;
24 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.co.routing.or.general.CoRouting;
25 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.co.routing.or.general.General;
26 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.co.routing.or.general.general.Diversity;
27 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.co.routing.or.general.general.Exclude;
28 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.co.routing.or.general.general.Include;
29 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.constraints.co.routing.or.general.general.Latency;
30 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.diversity.existing.service.constraints.ExistingServiceApplicability;
31 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.routing.constraints.HardConstraints;
32 import org.opendaylight.yang.gen.v1.http.org.openroadm.routing.constrains.rev190329.routing.constraints.SoftConstraints;
33 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.PathDescription;
34 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.path.description.atoz.direction.AToZ;
35 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.pce.resource.resource.resource.Link;
36 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.pathdescription.rev210705.pce.resource.resource.resource.Node;
37 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.service.types.rev220118.PceMetric;
38 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.servicepath.rev171017.ServicePathList;
39 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.servicepath.rev171017.service.path.list.ServicePaths;
40 import org.opendaylight.yang.gen.v1.http.org.transportpce.b.c._interface.servicepath.rev171017.service.path.list.ServicePathsKey;
41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
42 import org.opendaylight.yangtools.yang.common.Uint32;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
46 public class PceConstraintsCalc {
48 private static final Logger LOG = LoggerFactory.getLogger(PceConstraintsCalc.class);
50 private PceConstraints pceHardConstraints = new PceConstraints();
51 private PceConstraints pceSoftConstraints = new PceConstraints();
52 private PceMetric pceMetrics = PceMetric.HopCount;
53 private NetworkTransactionService networkTransactionService;
55 public PceConstraintsCalc(PathComputationRequestInput input, NetworkTransactionService networkTransactionService) {
56 LOG.debug("In PceconstraintsCalc start");
58 pceMetrics = input.getPceRoutingMetric();
60 this.networkTransactionService = networkTransactionService;
62 // TODO. for now metrics are set into hard structure
63 LOG.info("In PceConstraintsCalc: read PceMetric {}", pceMetrics);
64 pceHardConstraints.setPceMetrics(pceMetrics);
66 calcHardconstraints(input);
67 calcSoftconstraints(input);
70 private void calcHardconstraints(PathComputationRequestInput input) {
71 HardConstraints servicePathHardConstraints = input.getHardConstraints();
72 if (servicePathHardConstraints == null) {
73 LOG.info("In calcHardconstraints: no hard constraints.");
77 CoRoutingOrGeneral coRoutingOrGeneral = servicePathHardConstraints.getCoRoutingOrGeneral();
78 readconstraints(coRoutingOrGeneral, pceHardConstraints);
82 private void calcSoftconstraints(PathComputationRequestInput input) {
83 SoftConstraints servicePathSoftConstraints = input.getSoftConstraints();
84 if (servicePathSoftConstraints == null) {
85 LOG.info("In calcSoftconstraints: no soft constraints.");
89 CoRoutingOrGeneral coRoutingOrGeneral = servicePathSoftConstraints.getCoRoutingOrGeneral();
90 readconstraints(coRoutingOrGeneral, pceSoftConstraints);
94 private void readconstraints(CoRoutingOrGeneral coRoutingOrGeneral, PceConstraints constraints) {
95 LOG.debug("In readconstraints start");
97 if (coRoutingOrGeneral == null) {
98 LOG.info("In readHardconstraints: no CoRoutingOrGeneral constraints.");
102 General tmpGeneral = null;
103 CoRouting tmpCoRouting = null;
105 if (coRoutingOrGeneral instanceof General) {
106 LOG.info("In readconstraints General {}", coRoutingOrGeneral);
107 tmpGeneral = (General) coRoutingOrGeneral;
108 readGeneralContrains(tmpGeneral, constraints);
112 if (coRoutingOrGeneral instanceof CoRouting) {
113 LOG.info("In readconstraints CoRouting {}", coRoutingOrGeneral);
114 tmpCoRouting = (CoRouting) coRoutingOrGeneral;
115 readCoRoutingContrains(tmpCoRouting, constraints);
119 private void readGeneralContrains(General tmpGeneral, PceConstraints constraints) {
120 LOG.debug("In readGeneralContrains start");
122 if (tmpGeneral == null) {
123 LOG.info("In readGeneralContrains: no General constraints.");
127 Latency latency = tmpGeneral.getLatency();
128 if (latency != null) {
129 constraints.setMaxLatency(latency.getMaxLatency().toJava());
130 LOG.info("In readGeneralContrains: read latency {}", latency);
133 Exclude exclude = tmpGeneral.getExclude();
134 if (exclude != null) {
135 readExclude(exclude, constraints);
138 Include include = tmpGeneral.getInclude();
139 if (include != null) {
140 readInclude(include, constraints);
143 Diversity diversity = tmpGeneral.getDiversity();
144 PceConstraints.ResourceType rt = PceConstraints.ResourceType.NONE;
145 if (diversity != null) {
146 ExistingServiceApplicability temp = diversity.getExistingServiceApplicability();
150 if (Boolean.TRUE.equals(temp.getNode())) {
151 rt = PceConstraints.ResourceType.NODE;
153 if (Boolean.TRUE.equals(temp.getSrlg())) {
154 rt = PceConstraints.ResourceType.SRLG;
156 if (Boolean.TRUE.equals(temp.getSite())) {
157 rt = PceConstraints.ResourceType.CLLI;
159 LOG.info("in readGeneralContrains {} list is :{}", rt, diversity);
160 readDiversity(diversity.getExistingService(), constraints, rt);
164 private void readExclude(Exclude exclude, PceConstraints constraints) {
165 List<NodeIdType> nodes = exclude.getNodeId();
167 List<String> elementsToExclude = new ArrayList<>();
168 for (NodeIdType node : nodes) {
169 elementsToExclude.add(node.getValue());
171 constraints.setExcludeSupNodes(elementsToExclude);
173 List<Uint32> srlgs = exclude.getSrlgId();
175 List<Long> elementsToExclude = new ArrayList<>();
176 for (Uint32 srlg : srlgs) {
177 elementsToExclude.add(srlg.longValue());
179 constraints.setExcludeSRLG(elementsToExclude);
181 List<String> sites = exclude.getSite();
183 constraints.setExcludeCLLI(exclude.getSite());
187 private void readInclude(Include include, PceConstraints constraints) {
188 List<NodeIdType> nodes = include.getNodeId();
190 for (NodeIdType node : nodes) {
191 constraints.setListToInclude(new ResourcePair(PceConstraints.ResourceType.NODE, node.getValue()));
194 List<Uint32> srlgs = include.getSrlgId();
196 for (Uint32 srlg : srlgs) {
197 constraints.setListToInclude(new ResourcePair(PceConstraints.ResourceType.SRLG, srlg.toString()));
200 List<String> sites = include.getSite();
202 for (String site : sites) {
203 constraints.setListToInclude(new ResourcePair(PceConstraints.ResourceType.CLLI, site));
208 private void readDiversity(List<String> srvList, PceConstraints constraints, PceConstraints.ResourceType rt) {
210 List<String> elementsToExclude = new ArrayList<>();
211 LOG.info("in readDiversity {}", srvList);
213 for (String srv : srvList) {
214 Optional<PathDescription> service = getPathDescriptionFromDatastore(srv);
215 if (service.isPresent()) {
216 LOG.info("in readDiversity service list {}", service);
219 elementsToExclude.addAll(getAToZNodeList(service.get()));
220 LOG.info("readDiversity NODE : {}", elementsToExclude);
221 if (elementsToExclude != null) {
222 constraints.setExcludeNodes(elementsToExclude);
226 elementsToExclude.addAll(getSRLGList(service.get()));
227 LOG.info("readDiversity SRLG : {}", elementsToExclude);
228 if (elementsToExclude != null) {
229 constraints.setExcludeSrlgLinks(elementsToExclude);
233 /// Retrieve nodes into dedicated CLLI list
234 /// during node validation check their CLLI and build CLLI exclude list
235 elementsToExclude.addAll(getAToZNodeList(service.get()));
236 LOG.info("readDiversity CLLI : {}", elementsToExclude);
237 if (elementsToExclude != null) {
238 constraints.setExcludeClliNodes(elementsToExclude);
242 LOG.info("in readDiversity unsupported divercity type {}", rt);
246 LOG.info("in readDiversity srv={} is not present", srv);
251 private List<String> getAToZNodeList(PathDescription pathDescription) {
252 List<AToZ> aendToZList = new ArrayList<>(pathDescription.getAToZDirection().nonnullAToZ().values());
253 return aendToZList.stream().filter(aToZ -> {
254 if (aToZ.getResource() == null || aToZ.getResource().getResource() == null) {
255 LOG.warn("Diversity constraint: Resource of AToZ node {} is null! Skipping this node!", aToZ.getId());
258 return aToZ.getResource().getResource() instanceof Node;
260 Node node = (Node) aToZ.getResource().getResource();
261 if (node.getNodeId() == null) {
262 LOG.warn("Node in AToZ node {} contains null! Skipping this node!", aToZ.getId());
267 Node node = ((Node) aToZ.getResource().getResource());
268 return node.getNodeId();
269 }).collect(Collectors.toList());
272 private List<String> getSRLGList(PathDescription pathDescription) {
273 List<AToZ> aendToZList = new ArrayList<>(pathDescription.getAToZDirection().nonnullAToZ().values());
274 return aendToZList.stream().filter(aToZ -> {
275 if (aToZ.getResource() == null
276 || aToZ.getResource().getResource() == null) {
277 LOG.warn("Diversity constraint: Resource of AToZ {} is null! Skipping this resource!", aToZ.getId());
280 return aToZ.getResource().getResource() instanceof Link;
282 Link link = (Link) aToZ.getResource().getResource();
283 if (link.getLinkId() == null) {
284 LOG.warn("Link in AToZ link {} contains null! Skipping this link!", aToZ.getId());
289 return ((Link) aToZ.getResource().getResource()).getLinkId();
290 }).collect(Collectors.toList());
293 private Optional<PathDescription> getPathDescriptionFromDatastore(String serviceName) {
294 Optional<PathDescription> result = Optional.empty();
295 InstanceIdentifier<ServicePaths> pathDescriptionIID = InstanceIdentifier.create(ServicePathList.class)
296 .child(ServicePaths.class, new ServicePathsKey(serviceName));
298 LOG.info("PCE diversity constraints: Getting path description for service {}", serviceName);
299 ServicePaths servicePaths =
300 networkTransactionService.read(LogicalDatastoreType.CONFIGURATION, pathDescriptionIID)
301 .get(Timeouts.DATASTORE_READ, TimeUnit.MILLISECONDS).get();
302 if (servicePaths != null) {
303 PathDescription path = servicePaths.getPathDescription();
305 result = Optional.of(path);
308 } catch (InterruptedException | ExecutionException | TimeoutException e) {
310 "PCE diversity constraints: Exception while getting path description from datastore {} for service {}!",
311 pathDescriptionIID,serviceName, e);
317 private void readCoRoutingContrains(CoRouting tmpcoRouting, PceConstraints constraints) {
318 LOG.info("In readCoRoutingContrains start");
320 if (tmpcoRouting == null) {
321 LOG.info("In readCoRoutingContrains: no General constraints.");
326 public PceConstraints getPceHardConstraints() {
327 return pceHardConstraints;
330 public PceConstraints getPceSoftConstraints() {
331 return pceSoftConstraints;
334 public PceMetric getPceMetrics() {