blob: ef0ea266d406ee56c9a764dbf3054122317103ff [file] [log] [blame]
Marc De Leenheer8c2caac2015-05-28 16:37:33 -07001/*
2 * Copyright 2015 Open Networking Laboratory
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 */
16package org.onosproject.net.intent.impl.compiler;
17
Sho SHIMIZU12d02682016-02-24 13:55:12 -080018import com.google.common.base.Strings;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070019import org.apache.commons.lang3.tuple.Pair;
20import org.apache.felix.scr.annotations.Activate;
Sho SHIMIZU9a2b8292015-10-28 13:00:16 -070021import org.apache.felix.scr.annotations.Component;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070022import org.apache.felix.scr.annotations.Deactivate;
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -070023import org.apache.felix.scr.annotations.Modified;
24import org.apache.felix.scr.annotations.Property;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070025import org.apache.felix.scr.annotations.Reference;
26import org.apache.felix.scr.annotations.ReferenceCardinality;
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -070027import org.onlab.util.Tools;
28import org.onosproject.cfg.ComponentConfigService;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070029import org.onosproject.core.ApplicationId;
30import org.onosproject.core.CoreService;
Marc De Leenheer723f5532015-06-03 20:16:17 -070031import org.onosproject.net.AnnotationKeys;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020032import org.onosproject.net.CltSignalType;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070033import org.onosproject.net.ConnectPoint;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020034import org.onosproject.net.DeviceId;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070035import org.onosproject.net.OchPort;
36import org.onosproject.net.OduCltPort;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020037import org.onosproject.net.OduSignalId;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070038import org.onosproject.net.OduSignalType;
39import org.onosproject.net.Port;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020040import org.onosproject.net.TributarySlot;
41import org.onosproject.net.behaviour.TributarySlotQuery;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070042import org.onosproject.net.device.DeviceService;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020043import org.onosproject.net.driver.Driver;
44import org.onosproject.net.driver.DriverService;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070045import org.onosproject.net.flow.DefaultFlowRule;
46import org.onosproject.net.flow.DefaultTrafficSelector;
47import org.onosproject.net.flow.DefaultTrafficTreatment;
48import org.onosproject.net.flow.FlowRule;
49import org.onosproject.net.flow.TrafficSelector;
50import org.onosproject.net.flow.TrafficTreatment;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020051import org.onosproject.net.flow.criteria.Criteria;
52import org.onosproject.net.flow.instructions.Instructions;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070053import org.onosproject.net.intent.FlowRuleIntent;
54import org.onosproject.net.intent.Intent;
55import org.onosproject.net.intent.IntentCompiler;
56import org.onosproject.net.intent.IntentExtensionService;
57import org.onosproject.net.intent.IntentId;
58import org.onosproject.net.intent.IntentService;
59import org.onosproject.net.intent.OpticalCircuitIntent;
60import org.onosproject.net.intent.OpticalConnectivityIntent;
61import org.onosproject.net.intent.impl.IntentCompilationException;
Sho SHIMIZU5c16df82015-09-29 12:52:07 -070062import org.onosproject.net.newresource.ResourceAllocation;
Sho SHIMIZU8fa670a2016-01-14 11:17:18 -080063import org.onosproject.net.newresource.Resource;
Sho SHIMIZU5c16df82015-09-29 12:52:07 -070064import org.onosproject.net.newresource.ResourceService;
Sho SHIMIZU460b9722016-01-28 10:48:26 -080065import org.onosproject.net.newresource.Resources;
Sho SHIMIZU739873b2016-02-23 17:02:12 -080066import org.onosproject.net.intent.IntentSetMultimap;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070067import org.onosproject.net.resource.link.LinkResourceAllocations;
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -070068import org.osgi.service.component.ComponentContext;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070069import org.slf4j.Logger;
70import org.slf4j.LoggerFactory;
71
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020072import com.google.common.collect.ImmutableList;
73import com.google.common.collect.Sets;
74
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070075import java.util.Collections;
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -070076import java.util.Dictionary;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070077import java.util.LinkedList;
78import java.util.List;
Sho SHIMIZU5c16df82015-09-29 12:52:07 -070079import java.util.Optional;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070080import java.util.Set;
Rimon Ashkenazyf0699702016-01-17 19:28:49 +020081import java.util.stream.Collectors;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070082
83import static com.google.common.base.Preconditions.checkArgument;
84
85/**
86 * An intent compiler for {@link org.onosproject.net.intent.OpticalCircuitIntent}.
87 */
Sho SHIMIZU9a2b8292015-10-28 13:00:16 -070088@Component(immediate = true)
Marc De Leenheer8c2caac2015-05-28 16:37:33 -070089public class OpticalCircuitIntentCompiler implements IntentCompiler<OpticalCircuitIntent> {
90
91 private static final Logger log = LoggerFactory.getLogger(OpticalCircuitIntentCompiler.class);
92
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -070093 private static final int DEFAULT_MAX_CAPACITY = 10;
94
95 @Property(name = "maxCapacity", intValue = DEFAULT_MAX_CAPACITY,
96 label = "Maximum utilization of an optical connection.")
97
98 private int maxCapacity = DEFAULT_MAX_CAPACITY;
99
100 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
101 protected ComponentConfigService cfgService;
102
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700103 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
104 protected IntentExtensionService intentManager;
105
106 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
107 protected CoreService coreService;
108
109 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
110 protected DeviceService deviceService;
111
112 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700113 protected ResourceService resourceService;
114
115 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
Sho SHIMIZU7d20af12015-10-01 16:03:51 -0700116 protected IntentSetMultimap intentSetMultimap;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700117
118 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
119 protected IntentService intentService;
120
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200121 @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
122 protected DriverService driverService;
123
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700124 private ApplicationId appId;
125
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700126 @Modified
127 public void modified(ComponentContext context) {
Rimon Ashkenazya4e3bd32016-02-22 16:12:20 +0200128 if (context == null) {
129 return;
130 }
131
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700132 Dictionary properties = context.getProperties();
133
134 //TODO for reduction check if the new capacity is smaller than the size of the current mapping
135 String propertyString = Tools.get(properties, "maxCapacity");
136
Sho SHIMIZU12d02682016-02-24 13:55:12 -0800137 //Ignore if propertyString is empty or null
138 if (!Strings.isNullOrEmpty(propertyString)) {
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700139 try {
140 int temp = Integer.parseInt(propertyString);
141 //Ensure value is non-negative but allow zero as a way to shutdown the link
142 if (temp >= 0) {
143 maxCapacity = temp;
144 }
145 } catch (NumberFormatException e) {
146 //Malformed arguments lead to no change of value (user should be notified of error)
147 log.error("The value '{}' for maxCapacity was not parsable as an integer.", propertyString, e);
148 }
149 } else {
150 //Notify of empty value but do not return (other properties will also go in this function)
151 log.error("The value for maxCapacity was set to an empty value.");
152 }
153
154 }
155
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700156 @Activate
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700157 public void activate(ComponentContext context) {
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700158 appId = coreService.registerApplication("org.onosproject.net.intent");
159 intentManager.registerCompiler(OpticalCircuitIntent.class, this);
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700160 cfgService.registerProperties(getClass());
161 modified(context);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700162 }
163
164 @Deactivate
165 public void deactivate() {
166 intentManager.unregisterCompiler(OpticalCircuitIntent.class);
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700167 cfgService.unregisterProperties(getClass(), false);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700168 }
169
170 @Override
171 public List<Intent> compile(OpticalCircuitIntent intent, List<Intent> installable,
172 Set<LinkResourceAllocations> resources) {
173 // Check if ports are OduClt ports
174 ConnectPoint src = intent.getSrc();
175 ConnectPoint dst = intent.getDst();
176 Port srcPort = deviceService.getPort(src.deviceId(), src.port());
177 Port dstPort = deviceService.getPort(dst.deviceId(), dst.port());
178 checkArgument(srcPort instanceof OduCltPort);
179 checkArgument(dstPort instanceof OduCltPort);
180
181 log.debug("Compiling optical circuit intent between {} and {}", src, dst);
182
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200183 // Release of intent resources here is only a temporary solution for handling the
184 // case of recompiling due to intent restoration (when intent state is FAILED).
185 // TODO: try to release intent resources in IntentManager.
186 resourceService.release(intent.id());
187
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700188 // Reserve OduClt ports
Sho SHIMIZU460b9722016-01-28 10:48:26 -0800189 Resource srcPortResource = Resources.discrete(src.deviceId(), src.port()).resource();
190 Resource dstPortResource = Resources.discrete(dst.deviceId(), dst.port()).resource();
Sho SHIMIZU8fa670a2016-01-14 11:17:18 -0800191 List<ResourceAllocation> allocation = resourceService.allocate(intent.id(), srcPortResource, dstPortResource);
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700192 if (allocation.isEmpty()) {
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700193 throw new IntentCompilationException("Unable to reserve ports for intent " + intent);
194 }
195
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200196 // Check if both devices support multiplexing (usage of TributarySlots)
Sho SHIMIZUd8f7dc42016-02-29 11:14:18 -0800197 boolean multiplexingSupported = isMultiplexingSupported(intent.getSrc(), intent.getDst());
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200198
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200199 // slots are used only for devices supporting multiplexing
200 Set<TributarySlot> slots = Collections.emptySet();
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700201
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200202 OpticalConnectivityIntent connIntent = findOpticalConnectivityIntent(intent, multiplexingSupported);
203 if ((connIntent != null) && multiplexingSupported) {
204 // Allocate TributarySlots on existing OCH ports
205 slots = assignTributarySlots(intent, Pair.of(connIntent.getSrc(), connIntent.getDst()));
206 }
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700207
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200208 // Create optical connectivity intent if needed - no optical intent or not enough slots available
209 if (connIntent == null || (multiplexingSupported && slots.isEmpty())) {
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700210 // Find OCh ports with available resources
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800211 Pair<OchPort, OchPort> ochPorts = findPorts(intent.getSrc(), intent.getDst(), intent.getSignalType());
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700212
213 if (ochPorts == null) {
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200214 // Release port allocations if unsuccessful
215 resourceService.release(intent.id());
216 throw new IntentCompilationException("Unable to find suitable OCH ports for intent " + intent);
217 }
218
219 ConnectPoint srcCP = new ConnectPoint(src.elementId(), ochPorts.getLeft().number());
220 ConnectPoint dstCP = new ConnectPoint(dst.elementId(), ochPorts.getRight().number());
221
222 if (multiplexingSupported) {
223 // Allocate TributarySlots on OCH ports
224 slots = assignTributarySlots(intent, Pair.of(srcCP, dstCP));
225 if (slots.isEmpty()) {
226 // Release port allocations if unsuccessful
227 resourceService.release(intent.id());
228 throw new IntentCompilationException("Unable to find Tributary Slots for intent " + intent);
229 }
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700230 }
231
232 // Create optical connectivity intent
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200233 OduSignalType signalType = ochPorts.getLeft().signalType();
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700234 connIntent = OpticalConnectivityIntent.builder()
235 .appId(appId)
236 .src(srcCP)
237 .dst(dstCP)
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200238 .signalType(signalType)
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700239 .bidirectional(intent.isBidirectional())
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700240 .build();
Marc De Leenheer723f5532015-06-03 20:16:17 -0700241 intentService.submit(connIntent);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700242 }
243
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700244 // Save circuit to connectivity intent mapping
Sho SHIMIZU7d20af12015-10-01 16:03:51 -0700245 intentSetMultimap.allocateMapping(connIntent.id(), intent.id());
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700246
Sho SHIMIZU874e0a32016-02-26 16:56:11 -0800247 FlowRuleIntent circuitIntent = createFlowRule(intent, connIntent, slots);
Sho SHIMIZU953b0fb2016-02-26 16:42:13 -0800248 return ImmutableList.of(circuitIntent);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700249 }
250
Sho SHIMIZU874e0a32016-02-26 16:56:11 -0800251 private FlowRuleIntent createFlowRule(OpticalCircuitIntent higherIntent,
252 OpticalConnectivityIntent lowerIntent, Set<TributarySlot> slots) {
253 // Create optical circuit intent
254 List<FlowRule> rules = new LinkedList<>();
255 // at the source: ODUCLT port mapping to OCH port
256 rules.add(connectPorts(higherIntent.getSrc(), lowerIntent.getSrc(), higherIntent.priority(), slots));
257 // at the destination: OCH port mapping to ODUCLT port
258 rules.add(connectPorts(lowerIntent.getDst(), higherIntent.getDst(), higherIntent.priority(), slots));
259
260 // Create flow rules for reverse path
261 if (higherIntent.isBidirectional()) {
262 // at the destination: OCH port mapping to ODUCLT port
263 rules.add(connectPorts(lowerIntent.getSrc(), higherIntent.getSrc(), higherIntent.priority(), slots));
264 // at the source: ODUCLT port mapping to OCH port
265 rules.add(connectPorts(higherIntent.getDst(), lowerIntent.getDst(), higherIntent.priority(), slots));
266 }
267
268 return new FlowRuleIntent(appId, rules, higherIntent.resources());
269 }
270
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700271 /**
272 * Checks if current allocations on given resource can satisfy request.
Marc De Leenheer723f5532015-06-03 20:16:17 -0700273 * If the resource is null, return true.
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700274 *
Marc De Leenheerc9733082015-06-04 12:22:38 -0700275 * @param resource the resource on which to map the intent
276 * @return true if the resource can accept the request, false otherwise
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700277 */
Sho SHIMIZU0f9a68c2015-09-29 12:45:36 -0700278 private boolean isAvailable(IntentId resource) {
Marc De Leenheer723f5532015-06-03 20:16:17 -0700279 if (resource == null) {
280 return true;
281 }
282
Sho SHIMIZU7d20af12015-10-01 16:03:51 -0700283 Set<IntentId> mapping = intentSetMultimap.getMapping(resource);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700284
Marc De Leenheer723f5532015-06-03 20:16:17 -0700285 if (mapping == null) {
286 return true;
287 }
288
Aaron Kruglikov6490a3b2015-06-05 14:25:32 -0700289 return mapping.size() < maxCapacity;
Marc De Leenheer723f5532015-06-03 20:16:17 -0700290 }
291
292 private boolean isAllowed(OpticalCircuitIntent circuitIntent, OpticalConnectivityIntent connIntent) {
293 ConnectPoint srcStaticPort = staticPort(circuitIntent.getSrc());
294 if (srcStaticPort != null) {
295 if (!srcStaticPort.equals(connIntent.getSrc())) {
296 return false;
297 }
298 }
299
300 ConnectPoint dstStaticPort = staticPort(circuitIntent.getDst());
301 if (dstStaticPort != null) {
302 if (!dstStaticPort.equals(connIntent.getDst())) {
303 return false;
304 }
305 }
306
307 return true;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700308 }
309
310 /**
311 * Returns existing and available optical connectivity intent that matches the given circuit intent.
312 *
313 * @param circuitIntent optical circuit intent
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200314 * @param multiplexingSupported indicates whether ODU multiplexing is supported
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700315 * @return existing optical connectivity intent, null otherwise.
316 */
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200317 private OpticalConnectivityIntent findOpticalConnectivityIntent(OpticalCircuitIntent circuitIntent,
318 boolean multiplexingSupported) {
319
320 OduSignalType oduSignalType = mappingCltSignalTypeToOduSignalType(circuitIntent.getSignalType());
321
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700322 for (Intent intent : intentService.getIntents()) {
323 if (!(intent instanceof OpticalConnectivityIntent)) {
324 continue;
325 }
326
327 OpticalConnectivityIntent connIntent = (OpticalConnectivityIntent) intent;
328
329 ConnectPoint src = circuitIntent.getSrc();
330 ConnectPoint dst = circuitIntent.getDst();
Marc De Leenheer723f5532015-06-03 20:16:17 -0700331 // Ignore if the intents don't have identical src and dst devices
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200332 if (!src.deviceId().equals(connIntent.getSrc().deviceId()) ||
Marc De Leenheer723f5532015-06-03 20:16:17 -0700333 !dst.deviceId().equals(connIntent.getDst().deviceId())) {
334 continue;
335 }
336
337 if (!isAllowed(circuitIntent, connIntent)) {
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700338 continue;
339 }
340
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200341 if (!isAvailable(connIntent.id())) {
342 continue;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700343 }
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200344
345 if (multiplexingSupported) {
Sho SHIMIZU64339fe2016-02-29 11:21:29 -0800346 if (!isAvailableTributarySlots(connIntent.getSrc(), connIntent.getDst(),
347 oduSignalType.tributarySlots())) {
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200348 continue;
349 }
350 }
351
352 return connIntent;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700353 }
354
355 return null;
356 }
357
Sho SHIMIZU64339fe2016-02-29 11:21:29 -0800358 private boolean isAvailableTributarySlots(ConnectPoint src, ConnectPoint dst, int requestedTsNum) {
359 Set<TributarySlot> common = findCommonTributarySlotsOnCps(src, dst);
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200360 if (common.isEmpty()) {
361 log.debug("No available TributarySlots");
362 return false;
363 }
364 if (common.size() < requestedTsNum) {
365 log.debug("Not enough available TributarySlots={} < requestedTsNum={}", common.size(), requestedTsNum);
366 return false;
367 }
368 return true;
369 }
370
371 private Set<TributarySlot> assignTributarySlots(OpticalCircuitIntent intent,
372 Pair<ConnectPoint, ConnectPoint> ports) {
373
374 OduSignalType oduSignalType = mappingCltSignalTypeToOduSignalType(intent.getSignalType());
375 int requestedTsNum = oduSignalType.tributarySlots();
376 Set<TributarySlot> commonTributarySlots = findCommonTributarySlotsOnCps(ports.getLeft(), ports.getRight());
377 if (commonTributarySlots.isEmpty()) {
378 return Collections.emptySet();
379 }
380 if (commonTributarySlots.size() < requestedTsNum) {
381 return Collections.emptySet();
382 }
383
384 Set<TributarySlot> tributarySlots = commonTributarySlots.stream()
385 .limit(requestedTsNum)
386 .collect(Collectors.toSet());
387
388 final List<ConnectPoint> portsList = ImmutableList.of(ports.getLeft(), ports.getRight());
389 List<Resource> tributarySlotResources = portsList.stream()
390 .flatMap(cp -> tributarySlots
391 .stream()
392 .map(ts-> Resources.discrete(cp.deviceId(), cp.port()).resource().child(ts)))
393 .collect(Collectors.toList());
394
395 List<ResourceAllocation> allocations = resourceService.allocate(intent.id(), tributarySlotResources);
396 if (allocations.isEmpty()) {
397 log.debug("Resource allocation for {} failed (resource request: {})",
398 intent, tributarySlotResources);
399 return Collections.emptySet();
400 }
401 return tributarySlots;
402 }
403
Marc De Leenheer723f5532015-06-03 20:16:17 -0700404 private ConnectPoint staticPort(ConnectPoint connectPoint) {
405 Port port = deviceService.getPort(connectPoint.deviceId(), connectPoint.port());
406
407 String staticPort = port.annotations().value(AnnotationKeys.STATIC_PORT);
408
409 // FIXME: need a better way to match the port
410 if (staticPort != null) {
411 for (Port p : deviceService.getPorts(connectPoint.deviceId())) {
412 if (staticPort.equals(p.number().name())) {
413 return new ConnectPoint(p.element().id(), p.number());
414 }
415 }
416 }
417
418 return null;
419 }
420
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200421 private OchPort findAvailableOchPort(ConnectPoint oduPort, OduSignalType ochPortSignalType) {
Marc De Leenheer723f5532015-06-03 20:16:17 -0700422 // First see if the port mappings are constrained
423 ConnectPoint ochCP = staticPort(oduPort);
424
425 if (ochCP != null) {
426 OchPort ochPort = (OchPort) deviceService.getPort(ochCP.deviceId(), ochCP.port());
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700427 Optional<IntentId> intentId =
Sho SHIMIZUdd3750c2016-02-01 11:37:04 -0800428 resourceService.getResourceAllocations(Resources.discrete(ochCP.deviceId(), ochCP.port()).id())
Sho SHIMIZU6c9e33a2016-01-07 18:45:27 -0800429 .stream()
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700430 .map(ResourceAllocation::consumer)
431 .filter(x -> x instanceof IntentId)
Sho SHIMIZU6c9e33a2016-01-07 18:45:27 -0800432 .map(x -> (IntentId) x)
433 .findAny();
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700434
435 if (isAvailable(intentId.orElse(null))) {
Marc De Leenheer723f5532015-06-03 20:16:17 -0700436 return ochPort;
437 }
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200438 return null;
Marc De Leenheer723f5532015-06-03 20:16:17 -0700439 }
440
441 // No port constraints, so find any port that works
442 List<Port> ports = deviceService.getPorts(oduPort.deviceId());
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700443
444 for (Port port : ports) {
445 if (!(port instanceof OchPort)) {
446 continue;
447 }
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200448 // This should be the first allocation on the OCH port
449 if (!resourceService.isAvailable(Resources.discrete(oduPort.deviceId(), port.number()).resource())) {
450 continue;
451 }
452 // OchPort is required to have the requested oduSignalType
453 if (((OchPort) port).signalType() != ochPortSignalType) {
454 continue;
455 }
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700456
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700457 Optional<IntentId> intentId =
Sho SHIMIZUdd3750c2016-02-01 11:37:04 -0800458 resourceService.getResourceAllocations(Resources.discrete(oduPort.deviceId(), port.number()).id())
Sho SHIMIZU6c9e33a2016-01-07 18:45:27 -0800459 .stream()
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700460 .map(ResourceAllocation::consumer)
461 .filter(x -> x instanceof IntentId)
Sho SHIMIZU6c9e33a2016-01-07 18:45:27 -0800462 .map(x -> (IntentId) x)
463 .findAny();
464
Sho SHIMIZU5c16df82015-09-29 12:52:07 -0700465 if (isAvailable(intentId.orElse(null))) {
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700466 return (OchPort) port;
467 }
468 }
469
470 return null;
471 }
472
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800473 private Pair<OchPort, OchPort> findPorts(ConnectPoint src, ConnectPoint dst, CltSignalType signalType) {
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200474 Pair<OchPort, OchPort> ochPorts = null;
475 // According to the OpticalCircuitIntent's signalType find OCH ports with available TributarySlots resources
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800476 switch (signalType) {
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200477 case CLT_1GBE:
478 case CLT_10GBE:
479 // First search for OCH ports with OduSignalType of ODU2. If not found - search for those with ODU4
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800480 ochPorts = findPorts(src, dst, OduSignalType.ODU2);
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200481 if (ochPorts == null) {
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800482 ochPorts = findPorts(src, dst, OduSignalType.ODU4);
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200483 }
484 break;
485 case CLT_100GBE:
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800486 ochPorts = findPorts(src, dst, OduSignalType.ODU4);
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200487 break;
488 case CLT_40GBE:
489 default:
490 break;
491 }
492 return ochPorts;
493 }
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700494
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800495 private Pair<OchPort, OchPort> findPorts(ConnectPoint src, ConnectPoint dst, OduSignalType ochPortSignalType) {
496 OchPort srcPort = findAvailableOchPort(src, ochPortSignalType);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700497 if (srcPort == null) {
498 return null;
499 }
500
Sho SHIMIZU979c3d92016-02-29 11:08:57 -0800501 OchPort dstPort = findAvailableOchPort(dst, ochPortSignalType);
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700502 if (dstPort == null) {
503 return null;
504 }
505
506 return Pair.of(srcPort, dstPort);
507 }
508
509 /**
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700510 * Builds flow rule for mapping between two ports.
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700511 *
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700512 * @param src source port
513 * @param dst destination port
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200514 * @param priority
515 * @param slots Set of TributarySlots
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700516 * @return flow rules
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700517 */
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200518 private FlowRule connectPorts(ConnectPoint src, ConnectPoint dst, int priority, Set<TributarySlot> slots) {
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700519 checkArgument(src.deviceId().equals(dst.deviceId()));
520
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700521 TrafficSelector.Builder selectorBuilder = DefaultTrafficSelector.builder();
522 TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder();
523
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700524 selectorBuilder.matchInPort(src.port());
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200525 if (!slots.isEmpty()) {
526 Port srcPort = deviceService.getPort(src.deviceId(), src.port());
527 Port dstPort = deviceService.getPort(dst.deviceId(), dst.port());
528 OduSignalType oduCltPortOduSignalType;
529 OduSignalType ochPortOduSignalType;
530
531 if (srcPort instanceof OduCltPort) {
532 oduCltPortOduSignalType = mappingCltSignalTypeToOduSignalType(((OduCltPort) srcPort).signalType());
533 ochPortOduSignalType = ((OchPort) dstPort).signalType();
534
535 selectorBuilder.add(Criteria.matchOduSignalType(oduCltPortOduSignalType));
536 // use Instruction of OduSignalId only in case of ODU Multiplexing
537 if (oduCltPortOduSignalType != ochPortOduSignalType) {
538 OduSignalId oduSignalId = buildOduSignalId(ochPortOduSignalType, slots);
539 treatmentBuilder.add(Instructions.modL1OduSignalId(oduSignalId));
540 }
541 } else { // srcPort is OchPort
542 oduCltPortOduSignalType = mappingCltSignalTypeToOduSignalType(((OduCltPort) dstPort).signalType());
543 ochPortOduSignalType = ((OchPort) srcPort).signalType();
544
545 selectorBuilder.add(Criteria.matchOduSignalType(oduCltPortOduSignalType));
546 // use Criteria of OduSignalId only in case of ODU Multiplexing
547 if (oduCltPortOduSignalType != ochPortOduSignalType) {
548 OduSignalId oduSignalId = buildOduSignalId(ochPortOduSignalType, slots);
549 selectorBuilder.add(Criteria.matchOduSignalId(oduSignalId));
550 }
551 }
552 }
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700553 treatmentBuilder.setOutput(dst.port());
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700554
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700555 FlowRule flowRule = DefaultFlowRule.builder()
556 .forDevice(src.deviceId())
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700557 .withSelector(selectorBuilder.build())
558 .withTreatment(treatmentBuilder.build())
Brian O'Connor81134662015-06-25 17:23:33 -0400559 .withPriority(priority)
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700560 .fromApp(appId)
561 .makePermanent()
562 .build();
563
Marc De Leenheer4a1c1fa2015-06-01 18:08:56 -0700564 return flowRule;
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700565 }
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200566
Rimon Ashkenazya4e3bd32016-02-22 16:12:20 +0200567 protected OduSignalId buildOduSignalId(OduSignalType ochPortSignalType, Set<TributarySlot> slots) {
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200568 int tributaryPortNumber = findFirstTributarySlotIndex(slots);
569 int tributarySlotLen = ochPortSignalType.tributarySlots();
570 byte[] tributarySlotBitmap = new byte[OduSignalId.TRIBUTARY_SLOT_BITMAP_SIZE];
571
572 slots.forEach(ts -> tributarySlotBitmap[(byte) (ts.index() - 1) / 8] |= 0x1 << ((ts.index() - 1) % 8));
573 return OduSignalId.oduSignalId(tributaryPortNumber, tributarySlotLen, tributarySlotBitmap);
574 }
575
576 private int findFirstTributarySlotIndex(Set<TributarySlot> tributarySlots) {
577 return (int) tributarySlots.stream().findFirst().get().index();
578 }
579
580 private boolean isTributarySlotBehaviourSupported(DeviceId deviceId) {
581 Driver driver = driverService.getDriver(deviceId);
582 return (driver != null && driver.hasBehaviour(TributarySlotQuery.class));
583 }
584
Sho SHIMIZUd8f7dc42016-02-29 11:14:18 -0800585 private boolean isMultiplexingSupported(ConnectPoint src, ConnectPoint dst) {
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200586 if (!isTributarySlotBehaviourSupported(src.deviceId()) ||
587 !isTributarySlotBehaviourSupported(dst.deviceId())) {
588 return false;
589 }
590
591 ConnectPoint srcStaticPort = staticPort(src);
592 if (srcStaticPort != null) {
593 return false;
594 }
595 ConnectPoint dstStaticPort = staticPort(dst);
596 if (dstStaticPort != null) {
597 return false;
598 }
599
600 return true;
601 }
602
603 /**
604 * Maps from Intent's OduClt SignalType to OduSignalType.
605 *
606 * @param cltSignalType OduClt port signal type
607 * @return OduSignalType the result of mapping CltSignalType to OduSignalType
608 */
609 OduSignalType mappingCltSignalTypeToOduSignalType(CltSignalType cltSignalType) {
610 OduSignalType oduSignalType = OduSignalType.ODU0;
611 switch (cltSignalType) {
612 case CLT_1GBE:
613 oduSignalType = OduSignalType.ODU0;
614 break;
615 case CLT_10GBE:
616 oduSignalType = OduSignalType.ODU2;
617 break;
618 case CLT_40GBE:
619 oduSignalType = OduSignalType.ODU3;
620 break;
621 case CLT_100GBE:
622 oduSignalType = OduSignalType.ODU4;
623 break;
624 default:
625 log.error("Unsupported CltSignalType {}", cltSignalType);
626 break;
627 }
628 return oduSignalType;
629 }
630
631 /**
632 * Finds the common TributarySlots available on the two connect points.
633 *
Sho SHIMIZU3763a022016-02-29 11:10:17 -0800634 * @param src source connect point
635 * @param dst dest connect point
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200636 * @return set of common TributarySlots on both connect points
637 */
Sho SHIMIZU3763a022016-02-29 11:10:17 -0800638 Set<TributarySlot> findCommonTributarySlotsOnCps(ConnectPoint src, ConnectPoint dst) {
639 Set<TributarySlot> forward = findTributarySlotsOnCp(src);
640 Set<TributarySlot> backward = findTributarySlotsOnCp(dst);
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200641 return Sets.intersection(forward, backward);
642 }
643
644 /**
645 * Finds the TributarySlots available on the connect point.
646 *
647 * @param cp connect point
648 * @return set of TributarySlots available on the connect point
649 */
650 Set<TributarySlot> findTributarySlotsOnCp(ConnectPoint cp) {
Sho SHIMIZUc4ae4d52016-02-19 15:15:31 -0800651 return resourceService.getAvailableResourceValues(
652 Resources.discrete(cp.deviceId(), cp.port()).id(),
653 TributarySlot.class);
Rimon Ashkenazyf0699702016-01-17 19:28:49 +0200654 }
Marc De Leenheer8c2caac2015-05-28 16:37:33 -0700655}