Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Sho SHIMIZU | 8992524 | 2016-01-13 14:20:34 -0800 | [diff] [blame] | 2 | * Copyright 2014-2016 Open Networking Laboratory |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.intent.impl; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Reference; |
| 22 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 23 | import org.apache.felix.scr.annotations.Service; |
Sho SHIMIZU | e098172 | 2016-01-14 16:02:48 -0800 | [diff] [blame] | 24 | import org.onlab.util.Tools; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 25 | import org.onosproject.core.CoreService; |
| 26 | import org.onosproject.core.IdGenerator; |
Sho SHIMIZU | 98c0a39 | 2016-01-14 18:40:53 -0800 | [diff] [blame] | 27 | import org.onosproject.event.AbstractListenerManager; |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 28 | import org.onosproject.net.flow.FlowRule; |
Brian O'Connor | 0e271dc | 2015-02-04 18:20:25 -0800 | [diff] [blame] | 29 | import org.onosproject.net.flow.FlowRuleOperations; |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 30 | import org.onosproject.net.flow.FlowRuleOperationsContext; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 31 | import org.onosproject.net.flow.FlowRuleService; |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 32 | import org.onosproject.net.intent.FlowRuleIntent; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 33 | import org.onosproject.net.intent.Intent; |
| 34 | import org.onosproject.net.intent.IntentBatchDelegate; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 35 | import org.onosproject.net.intent.IntentCompiler; |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 36 | import org.onosproject.net.intent.IntentData; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 37 | import org.onosproject.net.intent.IntentEvent; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 38 | import org.onosproject.net.intent.IntentExtensionService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 39 | import org.onosproject.net.intent.IntentListener; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 40 | import org.onosproject.net.intent.IntentService; |
| 41 | import org.onosproject.net.intent.IntentState; |
| 42 | import org.onosproject.net.intent.IntentStore; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 43 | import org.onosproject.net.intent.IntentStoreDelegate; |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 44 | import org.onosproject.net.intent.Key; |
Sho SHIMIZU | 36a8a6e | 2015-02-13 15:38:45 -0800 | [diff] [blame] | 45 | import org.onosproject.net.intent.impl.phase.FinalIntentProcessPhase; |
Sho SHIMIZU | ce49b60 | 2015-02-23 19:15:49 -0800 | [diff] [blame] | 46 | import org.onosproject.net.intent.impl.phase.IntentProcessPhase; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 47 | import org.slf4j.Logger; |
| 48 | |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 49 | import java.util.Collection; |
| 50 | import java.util.EnumSet; |
| 51 | import java.util.List; |
| 52 | import java.util.Map; |
Sho SHIMIZU | ab541a5 | 2016-01-13 23:29:32 -0800 | [diff] [blame] | 53 | import java.util.Objects; |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 54 | import java.util.Optional; |
Sho SHIMIZU | ad8ab27 | 2016-01-13 22:08:58 -0800 | [diff] [blame] | 55 | import java.util.concurrent.CompletableFuture; |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 56 | import java.util.concurrent.ExecutorService; |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 57 | import java.util.stream.Collectors; |
Brian O'Connor | fa81eae | 2014-10-30 13:20:05 -0700 | [diff] [blame] | 58 | |
Brian O'Connor | fa81eae | 2014-10-30 13:20:05 -0700 | [diff] [blame] | 59 | import static com.google.common.base.Preconditions.checkNotNull; |
Yuta HIGUCHI | c2bf3d8 | 2014-11-28 18:50:41 -0800 | [diff] [blame] | 60 | import static java.util.concurrent.Executors.newFixedThreadPool; |
Brian O'Connor | db15b04 | 2015-02-04 14:59:28 -0800 | [diff] [blame] | 61 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
Brian O'Connor | bdc7f00 | 2015-02-18 20:49:41 -0800 | [diff] [blame] | 62 | import static org.onlab.util.Tools.groupedThreads; |
Sho SHIMIZU | 98c0a39 | 2016-01-14 18:40:53 -0800 | [diff] [blame] | 63 | import static org.onosproject.net.intent.IntentState.CORRUPT; |
| 64 | import static org.onosproject.net.intent.IntentState.FAILED; |
| 65 | import static org.onosproject.net.intent.IntentState.INSTALLED; |
| 66 | import static org.onosproject.net.intent.IntentState.INSTALL_REQ; |
| 67 | import static org.onosproject.net.intent.IntentState.WITHDRAWING; |
| 68 | import static org.onosproject.net.intent.IntentState.WITHDRAWN; |
| 69 | import static org.onosproject.net.intent.IntentState.WITHDRAW_REQ; |
Jonathan Hart | 96c5a4a | 2015-07-31 14:23:33 -0700 | [diff] [blame] | 70 | import static org.onosproject.net.intent.constraint.PartialFailureConstraint.intentAllowsPartialFailure; |
Sho SHIMIZU | ce49b60 | 2015-02-23 19:15:49 -0800 | [diff] [blame] | 71 | import static org.onosproject.net.intent.impl.phase.IntentProcessPhase.newInitialPhase; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 72 | import static org.onosproject.security.AppGuard.checkPermission; |
Sho SHIMIZU | 98c0a39 | 2016-01-14 18:40:53 -0800 | [diff] [blame] | 73 | import static org.onosproject.security.AppPermission.Type.INTENT_READ; |
| 74 | import static org.onosproject.security.AppPermission.Type.INTENT_WRITE; |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 75 | import static org.slf4j.LoggerFactory.getLogger; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 76 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 77 | |
| 78 | /** |
Brian O'Connor | ce2d8b5 | 2015-07-29 16:24:13 -0700 | [diff] [blame] | 79 | * An implementation of intent service. |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 80 | */ |
| 81 | @Component(immediate = true) |
| 82 | @Service |
| 83 | public class IntentManager |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 84 | extends AbstractListenerManager<IntentEvent, IntentListener> |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 85 | implements IntentService, IntentExtensionService { |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 86 | |
Sho SHIMIZU | 8b5051d | 2014-11-05 11:24:13 -0800 | [diff] [blame] | 87 | private static final Logger log = getLogger(IntentManager.class); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 88 | |
| 89 | public static final String INTENT_NULL = "Intent cannot be null"; |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 90 | public static final String INTENT_ID_NULL = "Intent key cannot be null"; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 91 | |
Yuta HIGUCHI | c2bf3d8 | 2014-11-28 18:50:41 -0800 | [diff] [blame] | 92 | private static final int NUM_THREADS = 12; |
| 93 | |
Brian O'Connor | 7a71d5d | 2014-12-02 00:12:27 -0800 | [diff] [blame] | 94 | private static final EnumSet<IntentState> RECOMPILE |
| 95 | = EnumSet.of(INSTALL_REQ, FAILED, WITHDRAW_REQ); |
Jonathan Hart | 96c5a4a | 2015-07-31 14:23:33 -0700 | [diff] [blame] | 96 | private static final EnumSet<IntentState> WITHDRAW |
| 97 | = EnumSet.of(WITHDRAW_REQ, WITHDRAWING, WITHDRAWN); |
Brian O'Connor | 7a71d5d | 2014-12-02 00:12:27 -0800 | [diff] [blame] | 98 | |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 99 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 100 | protected CoreService coreService; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 101 | |
| 102 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 103 | protected IntentStore store; |
| 104 | |
| 105 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 106 | protected ObjectiveTrackerService trackerService; |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 107 | |
| 108 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Sho SHIMIZU | 214ac32 | 2015-02-23 19:30:15 -0800 | [diff] [blame] | 109 | protected FlowRuleService flowRuleService; |
Brian O'Connor | f2dbde5 | 2014-10-10 16:20:24 -0700 | [diff] [blame] | 110 | |
Brian O'Connor | db15b04 | 2015-02-04 14:59:28 -0800 | [diff] [blame] | 111 | private ExecutorService batchExecutor; |
| 112 | private ExecutorService workerExecutor; |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 113 | |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 114 | private final CompilerRegistry compilerRegistry = new CompilerRegistry(); |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 115 | private final InternalIntentProcessor processor = new InternalIntentProcessor(); |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 116 | private final IntentStoreDelegate delegate = new InternalStoreDelegate(); |
| 117 | private final TopologyChangeDelegate topoDelegate = new InternalTopoChangeDelegate(); |
| 118 | private final IntentBatchDelegate batchDelegate = new InternalBatchDelegate(); |
| 119 | private IdGenerator idGenerator; |
| 120 | |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 121 | private final IntentAccumulator accumulator = new IntentAccumulator(batchDelegate); |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 122 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 123 | @Activate |
| 124 | public void activate() { |
| 125 | store.setDelegate(delegate); |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 126 | trackerService.setDelegate(topoDelegate); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 127 | eventDispatcher.addSink(IntentEvent.class, listenerRegistry); |
Brian O'Connor | bdc7f00 | 2015-02-18 20:49:41 -0800 | [diff] [blame] | 128 | batchExecutor = newSingleThreadExecutor(groupedThreads("onos/intent", "batch")); |
| 129 | workerExecutor = newFixedThreadPool(NUM_THREADS, groupedThreads("onos/intent", "worker-%d")); |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 130 | idGenerator = coreService.getIdGenerator("intent-ids"); |
| 131 | Intent.bindIdGenerator(idGenerator); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 132 | log.info("Started"); |
| 133 | } |
| 134 | |
| 135 | @Deactivate |
| 136 | public void deactivate() { |
| 137 | store.unsetDelegate(delegate); |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 138 | trackerService.unsetDelegate(topoDelegate); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 139 | eventDispatcher.removeSink(IntentEvent.class); |
Brian O'Connor | db15b04 | 2015-02-04 14:59:28 -0800 | [diff] [blame] | 140 | batchExecutor.shutdown(); |
Brian O'Connor | 3c58e96 | 2015-04-28 23:21:51 -0700 | [diff] [blame] | 141 | workerExecutor.shutdown(); |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 142 | Intent.unbindIdGenerator(idGenerator); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 143 | log.info("Stopped"); |
| 144 | } |
| 145 | |
| 146 | @Override |
| 147 | public void submit(Intent intent) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 148 | checkPermission(INTENT_WRITE); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 149 | checkNotNull(intent, INTENT_NULL); |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 150 | IntentData data = new IntentData(intent, IntentState.INSTALL_REQ, null); |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 151 | store.addPending(data); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | @Override |
| 155 | public void withdraw(Intent intent) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 156 | checkPermission(INTENT_WRITE); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 157 | checkNotNull(intent, INTENT_NULL); |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 158 | IntentData data = new IntentData(intent, IntentState.WITHDRAW_REQ, null); |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 159 | store.addPending(data); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 160 | } |
| 161 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 162 | @Override |
Ray Milkey | 8c6d00e | 2015-03-13 14:14:34 -0700 | [diff] [blame] | 163 | public void purge(Intent intent) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 164 | checkPermission(INTENT_WRITE); |
Ray Milkey | 8c6d00e | 2015-03-13 14:14:34 -0700 | [diff] [blame] | 165 | checkNotNull(intent, INTENT_NULL); |
| 166 | IntentData data = new IntentData(intent, IntentState.PURGE_REQ, null); |
| 167 | store.addPending(data); |
| 168 | } |
| 169 | |
| 170 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 171 | public Intent getIntent(Key key) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 172 | checkPermission(INTENT_READ); |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 173 | return store.getIntent(key); |
| 174 | } |
| 175 | |
| 176 | @Override |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 177 | public Iterable<Intent> getIntents() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 178 | checkPermission(INTENT_READ); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 179 | return store.getIntents(); |
| 180 | } |
| 181 | |
| 182 | @Override |
Thomas Vachuska | c46af20 | 2015-06-03 16:43:27 -0700 | [diff] [blame] | 183 | public Iterable<IntentData> getIntentData() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 184 | checkPermission(INTENT_READ); |
Thomas Vachuska | c46af20 | 2015-06-03 16:43:27 -0700 | [diff] [blame] | 185 | return store.getIntentData(false, 0); |
| 186 | } |
| 187 | |
| 188 | @Override |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 189 | public long getIntentCount() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 190 | checkPermission(INTENT_READ); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 191 | return store.getIntentCount(); |
| 192 | } |
| 193 | |
| 194 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 195 | public IntentState getIntentState(Key intentKey) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 196 | checkPermission(INTENT_READ); |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 197 | checkNotNull(intentKey, INTENT_ID_NULL); |
| 198 | return store.getIntentState(intentKey); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 199 | } |
| 200 | |
| 201 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 202 | public List<Intent> getInstallableIntents(Key intentKey) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 203 | checkPermission(INTENT_READ); |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 204 | checkNotNull(intentKey, INTENT_ID_NULL); |
| 205 | return store.getInstallableIntents(intentKey); |
Thomas Vachuska | 10d4abc | 2014-10-21 12:47:26 -0700 | [diff] [blame] | 206 | } |
| 207 | |
| 208 | @Override |
Brian O'Connor | be28a87 | 2015-02-19 21:44:37 -0800 | [diff] [blame] | 209 | public boolean isLocal(Key intentKey) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 210 | checkPermission(INTENT_READ); |
Brian O'Connor | be28a87 | 2015-02-19 21:44:37 -0800 | [diff] [blame] | 211 | return store.isMaster(intentKey); |
| 212 | } |
| 213 | |
| 214 | @Override |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 215 | public <T extends Intent> void registerCompiler(Class<T> cls, IntentCompiler<T> compiler) { |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 216 | compilerRegistry.registerCompiler(cls, compiler); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 217 | } |
| 218 | |
| 219 | @Override |
| 220 | public <T extends Intent> void unregisterCompiler(Class<T> cls) { |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 221 | compilerRegistry.unregisterCompiler(cls); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 222 | } |
| 223 | |
| 224 | @Override |
| 225 | public Map<Class<? extends Intent>, IntentCompiler<? extends Intent>> getCompilers() { |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 226 | return compilerRegistry.getCompilers(); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 227 | } |
| 228 | |
| 229 | @Override |
Jonathan Hart | 34f1e38 | 2015-02-24 16:52:23 -0800 | [diff] [blame] | 230 | public Iterable<Intent> getPending() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 231 | checkPermission(INTENT_READ); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 232 | |
Jonathan Hart | 34f1e38 | 2015-02-24 16:52:23 -0800 | [diff] [blame] | 233 | return store.getPending(); |
| 234 | } |
| 235 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 236 | // Store delegate to re-post events emitted from the store. |
| 237 | private class InternalStoreDelegate implements IntentStoreDelegate { |
| 238 | @Override |
| 239 | public void notify(IntentEvent event) { |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 240 | post(event); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 241 | } |
Brian O'Connor | ea4d7d1 | 2015-01-28 16:37:46 -0800 | [diff] [blame] | 242 | |
| 243 | @Override |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 244 | public void process(IntentData data) { |
| 245 | accumulator.add(data); |
Brian O'Connor | ea4d7d1 | 2015-01-28 16:37:46 -0800 | [diff] [blame] | 246 | } |
Thomas Vachuska | c46af20 | 2015-06-03 16:43:27 -0700 | [diff] [blame] | 247 | |
| 248 | @Override |
| 249 | public void onUpdate(IntentData intentData) { |
| 250 | trackerService.trackIntent(intentData); |
| 251 | } |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 252 | } |
| 253 | |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 254 | private void buildAndSubmitBatches(Iterable<Key> intentKeys, |
Brian O'Connor | 72a034c | 2014-11-26 18:24:23 -0800 | [diff] [blame] | 255 | boolean compileAllFailed) { |
Brian O'Connor | 72a034c | 2014-11-26 18:24:23 -0800 | [diff] [blame] | 256 | // Attempt recompilation of the specified intents first. |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 257 | for (Key key : intentKeys) { |
| 258 | Intent intent = store.getIntent(key); |
Brian O'Connor | 72a034c | 2014-11-26 18:24:23 -0800 | [diff] [blame] | 259 | if (intent == null) { |
| 260 | continue; |
| 261 | } |
Brian O'Connor | 03406a4 | 2015-02-03 17:28:57 -0800 | [diff] [blame] | 262 | submit(intent); |
Brian O'Connor | 72a034c | 2014-11-26 18:24:23 -0800 | [diff] [blame] | 263 | } |
| 264 | |
Jonathan Hart | 0cca3e8 | 2015-09-23 17:54:11 -0700 | [diff] [blame] | 265 | if (compileAllFailed) { |
| 266 | // If required, compile all currently failed intents. |
| 267 | for (Intent intent : getIntents()) { |
| 268 | IntentState state = getIntentState(intent.key()); |
| 269 | if (RECOMPILE.contains(state) || intentAllowsPartialFailure(intent)) { |
| 270 | if (WITHDRAW.contains(state)) { |
| 271 | withdraw(intent); |
| 272 | } else { |
| 273 | submit(intent); |
| 274 | } |
Brian O'Connor | 72a034c | 2014-11-26 18:24:23 -0800 | [diff] [blame] | 275 | } |
| 276 | } |
| 277 | } |
Brian O'Connor | 72a034c | 2014-11-26 18:24:23 -0800 | [diff] [blame] | 278 | } |
| 279 | |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 280 | // Topology change delegate |
| 281 | private class InternalTopoChangeDelegate implements TopologyChangeDelegate { |
| 282 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 283 | public void triggerCompile(Iterable<Key> intentKeys, |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 284 | boolean compileAllFailed) { |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 285 | buildAndSubmitBatches(intentKeys, compileAllFailed); |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 286 | } |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 287 | } |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 288 | |
Brian O'Connor | fa81eae | 2014-10-30 13:20:05 -0700 | [diff] [blame] | 289 | private class InternalBatchDelegate implements IntentBatchDelegate { |
| 290 | @Override |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 291 | public void execute(Collection<IntentData> operations) { |
Brian O'Connor | ab8ef82 | 2015-02-17 18:08:54 -0800 | [diff] [blame] | 292 | log.debug("Execute {} operation(s).", operations.size()); |
| 293 | log.trace("Execute operations: {}", operations); |
Sho SHIMIZU | 94b03b1 | 2015-04-10 14:53:13 -0700 | [diff] [blame] | 294 | |
| 295 | // batchExecutor is single-threaded, so only one batch is in flight at a time |
Sho SHIMIZU | 489aa9b | 2016-01-14 17:19:32 -0800 | [diff] [blame] | 296 | CompletableFuture.runAsync(() -> { |
Sho SHIMIZU | 8f2b777 | 2016-01-14 18:17:44 -0800 | [diff] [blame] | 297 | // process intent until the phase reaches one of the final phases |
| 298 | List<CompletableFuture<IntentData>> futures = operations.stream() |
| 299 | .map(x -> CompletableFuture.completedFuture(x) |
| 300 | .thenApply(IntentManager.this::createInitialPhase) |
| 301 | .thenApplyAsync(IntentManager.this::process, workerExecutor) |
| 302 | .thenApply(FinalIntentProcessPhase::data) |
| 303 | .exceptionally(e -> { |
| 304 | //FIXME |
| 305 | log.warn("Future failed: {}", e); |
| 306 | return null; |
| 307 | })).collect(Collectors.toList()); |
Sho SHIMIZU | 62bbc60 | 2016-01-13 16:54:35 -0800 | [diff] [blame] | 308 | |
Sho SHIMIZU | 8f2b777 | 2016-01-14 18:17:44 -0800 | [diff] [blame] | 309 | // write multiple data to store in order |
| 310 | store.batchWrite(Tools.allOf(futures).join().stream() |
| 311 | .filter(Objects::nonNull) |
| 312 | .collect(Collectors.toList())); |
| 313 | }, batchExecutor).exceptionally(e -> { |
| 314 | log.error("Error submitting batches:", e); |
| 315 | // FIXME incomplete Intents should be cleaned up |
| 316 | // (transition to FAILED, etc.) |
| 317 | |
| 318 | // the batch has failed |
| 319 | // TODO: maybe we should do more? |
| 320 | log.error("Walk the plank, matey..."); |
Sho SHIMIZU | 8f2b777 | 2016-01-14 18:17:44 -0800 | [diff] [blame] | 321 | return null; |
| 322 | }).thenRun(accumulator::ready); |
| 323 | |
Brian O'Connor | fa81eae | 2014-10-30 13:20:05 -0700 | [diff] [blame] | 324 | } |
Brian O'Connor | fa81eae | 2014-10-30 13:20:05 -0700 | [diff] [blame] | 325 | } |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 326 | |
Sho SHIMIZU | c88b85e | 2016-01-14 18:45:14 -0800 | [diff] [blame] | 327 | private IntentProcessPhase createInitialPhase(IntentData data) { |
| 328 | IntentData current = store.getIntentData(data.key()); |
| 329 | return newInitialPhase(processor, data, current); |
| 330 | } |
| 331 | |
| 332 | private FinalIntentProcessPhase process(IntentProcessPhase initial) { |
| 333 | Optional<IntentProcessPhase> currentPhase = Optional.of(initial); |
| 334 | IntentProcessPhase previousPhase = initial; |
| 335 | |
| 336 | while (currentPhase.isPresent()) { |
| 337 | previousPhase = currentPhase.get(); |
| 338 | currentPhase = previousPhase.execute(); |
| 339 | } |
| 340 | return (FinalIntentProcessPhase) previousPhase; |
| 341 | } |
| 342 | |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 343 | private class InternalIntentProcessor implements IntentProcessor { |
| 344 | @Override |
| 345 | public List<Intent> compile(Intent intent, List<Intent> previousInstallables) { |
| 346 | return compilerRegistry.compile(intent, previousInstallables); |
| 347 | } |
| 348 | |
| 349 | @Override |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 350 | public void apply(Optional<IntentData> toUninstall, Optional<IntentData> toInstall) { |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 351 | IntentManager.this.apply(toUninstall, toInstall); |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 352 | } |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 353 | } |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 354 | |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 355 | private enum Direction { |
| 356 | ADD, |
| 357 | REMOVE |
| 358 | } |
| 359 | |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 360 | private void applyIntentData(Optional<IntentData> intentData, |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 361 | FlowRuleOperations.Builder builder, |
| 362 | Direction direction) { |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 363 | if (!intentData.isPresent()) { |
Sho SHIMIZU | fcf861a | 2015-04-10 14:37:08 -0700 | [diff] [blame] | 364 | return; |
| 365 | } |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 366 | IntentData data = intentData.get(); |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 367 | |
Sho SHIMIZU | fcf861a | 2015-04-10 14:37:08 -0700 | [diff] [blame] | 368 | List<Intent> intentsToApply = data.installables(); |
| 369 | if (!intentsToApply.stream().allMatch(x -> x instanceof FlowRuleIntent)) { |
| 370 | throw new IllegalStateException("installable intents must be FlowRuleIntent"); |
| 371 | } |
| 372 | |
| 373 | if (direction == Direction.ADD) { |
| 374 | trackerService.addTrackedResources(data.key(), data.intent().resources()); |
| 375 | intentsToApply.forEach(installable -> |
| 376 | trackerService.addTrackedResources(data.key(), installable.resources())); |
| 377 | } else { |
| 378 | trackerService.removeTrackedResources(data.key(), data.intent().resources()); |
| 379 | intentsToApply.forEach(installable -> |
| 380 | trackerService.removeTrackedResources(data.intent().key(), |
| 381 | installable.resources())); |
| 382 | } |
| 383 | |
| 384 | // FIXME do FlowRuleIntents have stages??? Can we do uninstall work in parallel? I think so. |
| 385 | builder.newStage(); |
| 386 | |
| 387 | List<Collection<FlowRule>> stages = intentsToApply.stream() |
| 388 | .map(x -> (FlowRuleIntent) x) |
| 389 | .map(FlowRuleIntent::flowRules) |
| 390 | .collect(Collectors.toList()); |
| 391 | |
| 392 | for (Collection<FlowRule> rules : stages) { |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 393 | if (direction == Direction.ADD) { |
Sho SHIMIZU | fcf861a | 2015-04-10 14:37:08 -0700 | [diff] [blame] | 394 | rules.forEach(builder::add); |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 395 | } else { |
Sho SHIMIZU | fcf861a | 2015-04-10 14:37:08 -0700 | [diff] [blame] | 396 | rules.forEach(builder::remove); |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 397 | } |
Sho SHIMIZU | b0a47d4 | 2015-02-19 13:26:30 -0800 | [diff] [blame] | 398 | } |
| 399 | |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 400 | } |
| 401 | |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 402 | private void apply(Optional<IntentData> toUninstall, Optional<IntentData> toInstall) { |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 403 | // need to consider if FlowRuleIntent is only one as installable intent or not |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 404 | |
| 405 | FlowRuleOperations.Builder builder = FlowRuleOperations.builder(); |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 406 | applyIntentData(toUninstall, builder, Direction.REMOVE); |
| 407 | applyIntentData(toInstall, builder, Direction.ADD); |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 408 | |
| 409 | FlowRuleOperations operations = builder.build(new FlowRuleOperationsContext() { |
| 410 | @Override |
| 411 | public void onSuccess(FlowRuleOperations ops) { |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 412 | if (toInstall.isPresent()) { |
| 413 | IntentData installData = toInstall.get(); |
| 414 | log.debug("Completed installing: {}", installData.key()); |
| 415 | installData.setState(INSTALLED); |
| 416 | store.write(installData); |
| 417 | } else if (toUninstall.isPresent()) { |
| 418 | IntentData uninstallData = toUninstall.get(); |
| 419 | log.debug("Completed withdrawing: {}", uninstallData.key()); |
| 420 | switch (uninstallData.request()) { |
| 421 | case INSTALL_REQ: |
| 422 | uninstallData.setState(FAILED); |
| 423 | break; |
| 424 | case WITHDRAW_REQ: |
| 425 | default: //TODO "default" case should not happen |
| 426 | uninstallData.setState(WITHDRAWN); |
| 427 | break; |
| 428 | } |
| 429 | store.write(uninstallData); |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 430 | } |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | @Override |
| 434 | public void onError(FlowRuleOperations ops) { |
Ray Milkey | fd7931d | 2015-03-30 13:58:38 -0700 | [diff] [blame] | 435 | // if toInstall was cause of error, then recompile (manage/increment counter, when exceeded -> CORRUPT) |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 436 | if (toInstall.isPresent()) { |
| 437 | IntentData installData = toInstall.get(); |
| 438 | log.warn("Failed installation: {} {} on {}", |
| 439 | installData.key(), installData.intent(), ops); |
| 440 | installData.setState(CORRUPT); |
Brian O'Connor | 6d8e317 | 2015-04-30 15:43:57 -0700 | [diff] [blame] | 441 | installData.incrementErrorCount(); |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 442 | store.write(installData); |
| 443 | } |
Sho SHIMIZU | d493625 | 2015-04-10 15:03:57 -0700 | [diff] [blame] | 444 | // if toUninstall was cause of error, then CORRUPT (another job will clean this up) |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 445 | if (toUninstall.isPresent()) { |
| 446 | IntentData uninstallData = toUninstall.get(); |
| 447 | log.warn("Failed withdrawal: {} {} on {}", |
| 448 | uninstallData.key(), uninstallData.intent(), ops); |
| 449 | uninstallData.setState(CORRUPT); |
Brian O'Connor | 6d8e317 | 2015-04-30 15:43:57 -0700 | [diff] [blame] | 450 | uninstallData.incrementErrorCount(); |
Brian O'Connor | f0c5a05 | 2015-04-27 00:34:53 -0700 | [diff] [blame] | 451 | store.write(uninstallData); |
| 452 | } |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 453 | } |
| 454 | }); |
| 455 | |
Brian O'Connor | a767426 | 2015-06-04 13:55:18 -0700 | [diff] [blame] | 456 | if (log.isTraceEnabled()) { |
| 457 | log.trace("applying intent {} -> {} with {} rules: {}", |
Sho SHIMIZU | 98c0a39 | 2016-01-14 18:40:53 -0800 | [diff] [blame] | 458 | toUninstall.map(x -> x.key().toString()).orElse("<empty>"), |
| 459 | toInstall.map(x -> x.key().toString()).orElse("<empty>"), |
| 460 | operations.stages().stream().mapToLong(i -> i.size()).sum(), |
| 461 | operations.stages()); |
Brian O'Connor | a767426 | 2015-06-04 13:55:18 -0700 | [diff] [blame] | 462 | } |
| 463 | |
Sho SHIMIZU | ee2aa65 | 2015-02-25 18:56:43 -0800 | [diff] [blame] | 464 | flowRuleService.apply(operations); |
| 465 | } |
| 466 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 467 | } |