Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Sho SHIMIZU | 6c28f83 | 2015-02-20 16:12:19 -0800 | [diff] [blame] | 16 | package org.onosproject.net.intent.impl.compiler; |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 17 | |
Sho SHIMIZU | 9909d17 | 2014-11-11 18:33:11 -0800 | [diff] [blame] | 18 | import com.google.common.collect.FluentIterable; |
Sho SHIMIZU | 5653151 | 2014-11-10 15:27:49 -0800 | [diff] [blame] | 19 | import com.google.common.collect.ImmutableList; |
Brian O'Connor | 023a1c7 | 2015-03-20 01:11:29 +0000 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Component; |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Reference; |
| 22 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 23 | import org.onosproject.net.ElementId; |
| 24 | import org.onosproject.net.Path; |
| 25 | import org.onosproject.net.intent.ConnectivityIntent; |
| 26 | import org.onosproject.net.intent.Constraint; |
| 27 | import org.onosproject.net.intent.IntentCompiler; |
| 28 | import org.onosproject.net.intent.IntentExtensionService; |
Sho SHIMIZU | 6c28f83 | 2015-02-20 16:12:19 -0800 | [diff] [blame] | 29 | import org.onosproject.net.intent.impl.PathNotFoundException; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 30 | import org.onosproject.net.provider.ProviderId; |
Brian O'Connor | 6de2e20 | 2015-05-21 14:30:41 -0700 | [diff] [blame] | 31 | import org.onosproject.net.resource.link.LinkResourceService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 32 | import org.onosproject.net.topology.LinkWeight; |
| 33 | import org.onosproject.net.topology.PathService; |
| 34 | import org.onosproject.net.topology.TopologyEdge; |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 35 | |
Sho SHIMIZU | 5653151 | 2014-11-10 15:27:49 -0800 | [diff] [blame] | 36 | import java.util.Collections; |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 37 | import java.util.Iterator; |
| 38 | import java.util.List; |
| 39 | import java.util.Set; |
| 40 | |
| 41 | /** |
| 42 | * Base class for compilers of various |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 43 | * {@link org.onosproject.net.intent.ConnectivityIntent connectivity intents}. |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 44 | */ |
Brian O'Connor | 023a1c7 | 2015-03-20 01:11:29 +0000 | [diff] [blame] | 45 | @Component(immediate = true) |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 46 | public abstract class ConnectivityIntentCompiler<T extends ConnectivityIntent> |
| 47 | implements IntentCompiler<T> { |
| 48 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 49 | private static final ProviderId PID = new ProviderId("core", "org.onosproject.core", true); |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 50 | |
| 51 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 52 | protected IntentExtensionService intentManager; |
| 53 | |
| 54 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 55 | protected PathService pathService; |
| 56 | |
| 57 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 58 | protected LinkResourceService resourceService; |
| 59 | |
| 60 | /** |
| 61 | * Returns an edge-weight capable of evaluating links on the basis of the |
| 62 | * specified constraints. |
| 63 | * |
| 64 | * @param constraints path constraints |
| 65 | * @return edge-weight function |
| 66 | */ |
| 67 | protected LinkWeight weight(List<Constraint> constraints) { |
| 68 | return new ConstraintBasedLinkWeight(constraints); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Validates the specified path against the given constraints. |
| 73 | * |
Thomas Vachuska | b14c77a | 2014-11-04 18:08:01 -0800 | [diff] [blame] | 74 | * @param path path to be checked |
| 75 | * @param constraints path constraints |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 76 | * @return true if the path passes all constraints |
| 77 | */ |
| 78 | protected boolean checkPath(Path path, List<Constraint> constraints) { |
| 79 | for (Constraint constraint : constraints) { |
| 80 | if (!constraint.validate(path, resourceService)) { |
| 81 | return false; |
| 82 | } |
| 83 | } |
| 84 | return true; |
| 85 | } |
| 86 | |
| 87 | /** |
| 88 | * Computes a path between two ConnectPoints. |
| 89 | * |
Thomas Vachuska | b14c77a | 2014-11-04 18:08:01 -0800 | [diff] [blame] | 90 | * @param intent intent on which behalf path is being computed |
| 91 | * @param one start of the path |
| 92 | * @param two end of the path |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 93 | * @return Path between the two |
| 94 | * @throws PathNotFoundException if a path cannot be found |
| 95 | */ |
| 96 | protected Path getPath(ConnectivityIntent intent, |
| 97 | ElementId one, ElementId two) { |
| 98 | Set<Path> paths = pathService.getPaths(one, two, weight(intent.constraints())); |
Sho SHIMIZU | 9909d17 | 2014-11-11 18:33:11 -0800 | [diff] [blame] | 99 | final List<Constraint> constraints = intent.constraints(); |
| 100 | ImmutableList<Path> filtered = FluentIterable.from(paths) |
Sho SHIMIZU | 8b7b3b2 | 2015-09-04 16:04:50 -0700 | [diff] [blame] | 101 | .filter(path -> checkPath(path, constraints)) |
| 102 | .toList(); |
Sho SHIMIZU | 9909d17 | 2014-11-11 18:33:11 -0800 | [diff] [blame] | 103 | if (filtered.isEmpty()) { |
Sho SHIMIZU | 877ec2c | 2015-02-09 12:50:36 -0800 | [diff] [blame] | 104 | throw new PathNotFoundException(one, two); |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 105 | } |
| 106 | // TODO: let's be more intelligent about this eventually |
Sho SHIMIZU | 9909d17 | 2014-11-11 18:33:11 -0800 | [diff] [blame] | 107 | return filtered.iterator().next(); |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Edge-weight capable of evaluating link cost using a set of constraints. |
| 112 | */ |
| 113 | protected class ConstraintBasedLinkWeight implements LinkWeight { |
| 114 | |
| 115 | private final List<Constraint> constraints; |
| 116 | |
| 117 | /** |
| 118 | * Creates a new edge-weight function capable of evaluating links |
| 119 | * on the basis of the specified constraints. |
| 120 | * |
| 121 | * @param constraints path constraints |
| 122 | */ |
| 123 | ConstraintBasedLinkWeight(List<Constraint> constraints) { |
Sho SHIMIZU | 5653151 | 2014-11-10 15:27:49 -0800 | [diff] [blame] | 124 | if (constraints == null) { |
| 125 | this.constraints = Collections.emptyList(); |
| 126 | } else { |
| 127 | this.constraints = ImmutableList.copyOf(constraints); |
| 128 | } |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | @Override |
| 132 | public double weight(TopologyEdge edge) { |
Sho SHIMIZU | 5653151 | 2014-11-10 15:27:49 -0800 | [diff] [blame] | 133 | if (!constraints.iterator().hasNext()) { |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 134 | return 1.0; |
| 135 | } |
| 136 | |
| 137 | // iterate over all constraints in order and return the weight of |
| 138 | // the first one with fast fail over the first failure |
| 139 | Iterator<Constraint> it = constraints.iterator(); |
Ray Milkey | 460f402 | 2014-11-05 15:41:43 -0800 | [diff] [blame] | 140 | |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 141 | double cost = it.next().cost(edge.link(), resourceService); |
| 142 | while (it.hasNext() && cost > 0) { |
| 143 | if (it.next().cost(edge.link(), resourceService) < 0) { |
| 144 | return -1; |
| 145 | } |
| 146 | } |
| 147 | return cost; |
Ray Milkey | 460f402 | 2014-11-05 15:41:43 -0800 | [diff] [blame] | 148 | |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 149 | } |
| 150 | } |
| 151 | |
| 152 | } |