Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame^] | 2 | * Copyright 2016-present Open Networking Laboratory |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -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 | */ |
Jonathan Hart | 6af92be | 2016-01-05 20:52:25 -0800 | [diff] [blame] | 16 | |
| 17 | package org.onosproject.routing.impl; |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 18 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 19 | import org.apache.felix.scr.annotations.Activate; |
| 20 | import org.apache.felix.scr.annotations.Component; |
| 21 | import org.apache.felix.scr.annotations.Deactivate; |
| 22 | import org.apache.felix.scr.annotations.Reference; |
| 23 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 24 | import org.apache.felix.scr.annotations.Service; |
| 25 | import org.onosproject.cluster.ClusterService; |
| 26 | import org.onosproject.cluster.LeadershipEvent; |
| 27 | import org.onosproject.cluster.LeadershipEventListener; |
| 28 | import org.onosproject.cluster.LeadershipService; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 29 | import org.onosproject.cluster.NodeId; |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 30 | import org.onosproject.core.ApplicationId; |
| 31 | import org.onosproject.core.CoreService; |
| 32 | import org.onosproject.net.intent.Intent; |
| 33 | import org.onosproject.net.intent.IntentService; |
| 34 | import org.onosproject.net.intent.IntentState; |
Jonathan Hart | 6af92be | 2016-01-05 20:52:25 -0800 | [diff] [blame] | 35 | import org.onosproject.net.intent.IntentUtils; |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 36 | import org.onosproject.net.intent.Key; |
| 37 | import org.onosproject.routing.IntentSynchronizationAdminService; |
| 38 | import org.onosproject.routing.IntentSynchronizationService; |
| 39 | import org.slf4j.Logger; |
| 40 | import org.slf4j.LoggerFactory; |
Pingping Lin | c07781f | 2015-10-30 00:44:41 -0700 | [diff] [blame] | 41 | |
| 42 | import java.util.HashMap; |
| 43 | import java.util.LinkedList; |
| 44 | import java.util.List; |
| 45 | import java.util.Map; |
| 46 | import java.util.Map.Entry; |
| 47 | import java.util.concurrent.ConcurrentHashMap; |
| 48 | import java.util.concurrent.ExecutorService; |
| 49 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 50 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
| 51 | import static org.onlab.util.Tools.groupedThreads; |
Jonathan Hart | 96c5a4a | 2015-07-31 14:23:33 -0700 | [diff] [blame] | 52 | |
Jonathan Hart | 5137218 | 2014-12-03 21:32:34 -0800 | [diff] [blame] | 53 | /** |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 54 | * Synchronizes intents between an in-memory intent store and the IntentService. |
Jonathan Hart | 5137218 | 2014-12-03 21:32:34 -0800 | [diff] [blame] | 55 | */ |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 56 | @Service |
Jonathan Hart | 6af92be | 2016-01-05 20:52:25 -0800 | [diff] [blame] | 57 | @Component(immediate = false) |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 58 | public class IntentSynchronizer implements IntentSynchronizationService, |
| 59 | IntentSynchronizationAdminService { |
Pavlin Radoslavov | 2aa1f32 | 2015-03-11 17:59:44 -0700 | [diff] [blame] | 60 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 61 | private static final Logger log = LoggerFactory.getLogger(IntentSynchronizer.class); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 62 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 63 | private static final String APP_NAME = "org.onosproject.intentsynchronizer"; |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 64 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 66 | protected CoreService coreService; |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 67 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected LeadershipService leadershipService; |
| 70 | |
| 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 72 | protected ClusterService clusterService; |
| 73 | |
| 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 75 | protected IntentService intentService; |
| 76 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 77 | private NodeId localNodeId; |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 78 | private ApplicationId appId; |
| 79 | |
| 80 | private final InternalLeadershipListener leadershipEventListener = |
| 81 | new InternalLeadershipListener(); |
| 82 | |
| 83 | private final Map<Key, Intent> intents = new ConcurrentHashMap<>(); |
| 84 | |
| 85 | private ExecutorService intentsSynchronizerExecutor; |
| 86 | |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 87 | private volatile boolean isElectedLeader = false; |
| 88 | private volatile boolean isActivatedLeader = false; |
| 89 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 90 | @Activate |
| 91 | public void activate() { |
| 92 | intentsSynchronizerExecutor = createExecutor(); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 93 | this.localNodeId = clusterService.getLocalNode().id(); |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 94 | this.appId = coreService.registerApplication(APP_NAME); |
| 95 | |
| 96 | leadershipService.addListener(leadershipEventListener); |
| 97 | leadershipService.runForLeadership(appId.name()); |
| 98 | |
| 99 | log.info("Started"); |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 100 | } |
| 101 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 102 | @Deactivate |
| 103 | public void deactivate() { |
| 104 | leadershipService.withdraw(appId.name()); |
| 105 | leadershipService.removeListener(leadershipEventListener); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 106 | |
Pavlin Radoslavov | a7243cc | 2014-11-22 21:38:02 -0800 | [diff] [blame] | 107 | synchronized (this) { |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 108 | intentsSynchronizerExecutor.shutdownNow(); |
Pavlin Radoslavov | a7243cc | 2014-11-22 21:38:02 -0800 | [diff] [blame] | 109 | } |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 110 | |
| 111 | log.info("Stopped"); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 112 | } |
| 113 | |
Pingping Lin | c07781f | 2015-10-30 00:44:41 -0700 | [diff] [blame] | 114 | /** |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 115 | * Creates an executor that will be used for synchronization tasks. |
| 116 | * <p> |
| 117 | * Can be overridden to change the type of executor used. |
| 118 | * </p> |
| 119 | * |
| 120 | * @return executor service |
Pingping Lin | c07781f | 2015-10-30 00:44:41 -0700 | [diff] [blame] | 121 | */ |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 122 | protected ExecutorService createExecutor() { |
| 123 | return newSingleThreadExecutor(groupedThreads("onos/" + appId, "sync")); |
| 124 | } |
| 125 | |
| 126 | @Override |
Pingping Lin | c07781f | 2015-10-30 00:44:41 -0700 | [diff] [blame] | 127 | public void removeIntents() { |
| 128 | if (!isElectedLeader) { |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 129 | // Only leader will withdraw intents |
Pingping Lin | c07781f | 2015-10-30 00:44:41 -0700 | [diff] [blame] | 130 | return; |
| 131 | } |
| 132 | |
| 133 | log.debug("Intent Synchronizer shutdown: withdrawing all intents..."); |
| 134 | |
| 135 | for (Entry<Key, Intent> entry : intents.entrySet()) { |
| 136 | intentService.withdraw(entry.getValue()); |
| 137 | log.debug("Intent Synchronizer withdrawing intent: {}", |
| 138 | entry.getValue()); |
| 139 | } |
| 140 | |
| 141 | intents.clear(); |
| 142 | log.info("Tried to clean all intents"); |
| 143 | } |
| 144 | |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 145 | @Override |
| 146 | public void submit(Intent intent) { |
| 147 | synchronized (this) { |
| 148 | intents.put(intent.key(), intent); |
| 149 | if (isElectedLeader && isActivatedLeader) { |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 150 | log.trace("Submitting intent: {}", intent); |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 151 | intentService.submit(intent); |
| 152 | } |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | @Override |
| 157 | public void withdraw(Intent intent) { |
| 158 | synchronized (this) { |
| 159 | intents.remove(intent.key(), intent); |
| 160 | if (isElectedLeader && isActivatedLeader) { |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 161 | log.trace("Withdrawing intent: {}", intent); |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 162 | intentService.withdraw(intent); |
| 163 | } |
| 164 | } |
| 165 | } |
| 166 | |
Jonathan Hart | 5137218 | 2014-12-03 21:32:34 -0800 | [diff] [blame] | 167 | /** |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 168 | * Signals the synchronizer that the leadership has changed. |
Jonathan Hart | 5137218 | 2014-12-03 21:32:34 -0800 | [diff] [blame] | 169 | * |
| 170 | * @param isLeader true if this instance is now the leader, otherwise false |
| 171 | */ |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 172 | private void leaderChanged(boolean isLeader) { |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 173 | log.debug("Leader changed: {}", isLeader); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 174 | |
| 175 | if (!isLeader) { |
| 176 | this.isElectedLeader = false; |
| 177 | this.isActivatedLeader = false; |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 178 | // Nothing to do |
| 179 | return; |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 180 | } |
| 181 | this.isActivatedLeader = false; |
| 182 | this.isElectedLeader = true; |
| 183 | |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 184 | // Run the synchronization task |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 185 | intentsSynchronizerExecutor.execute(this::synchronizeIntents); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 186 | } |
| 187 | |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 188 | private void synchronizeIntents() { |
| 189 | Map<Key, Intent> serviceIntents = new HashMap<>(); |
| 190 | intentService.getIntents().forEach(i -> { |
| 191 | if (i.appId().equals(appId)) { |
| 192 | serviceIntents.put(i.key(), i); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 193 | } |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 194 | }); |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 195 | |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 196 | List<Intent> intentsToAdd = new LinkedList<>(); |
| 197 | List<Intent> intentsToRemove = new LinkedList<>(); |
Pavlin Radoslavov | a7243cc | 2014-11-22 21:38:02 -0800 | [diff] [blame] | 198 | |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 199 | for (Intent localIntent : intents.values()) { |
| 200 | Intent serviceIntent = serviceIntents.remove(localIntent.key()); |
| 201 | if (serviceIntent == null) { |
| 202 | intentsToAdd.add(localIntent); |
Pavlin Radoslavov | a7243cc | 2014-11-22 21:38:02 -0800 | [diff] [blame] | 203 | } else { |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 204 | IntentState state = intentService.getIntentState(serviceIntent.key()); |
Ray Milkey | 4fd3ceb | 2015-12-10 14:43:08 -0800 | [diff] [blame] | 205 | if (!IntentUtils.intentsAreEqual(serviceIntent, localIntent) || state == null || |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 206 | state == IntentState.WITHDRAW_REQ || |
| 207 | state == IntentState.WITHDRAWING || |
| 208 | state == IntentState.WITHDRAWN) { |
| 209 | intentsToAdd.add(localIntent); |
Pavlin Radoslavov | a7243cc | 2014-11-22 21:38:02 -0800 | [diff] [blame] | 210 | } |
Pingping Lin | e28ae4c | 2015-03-13 11:37:03 -0700 | [diff] [blame] | 211 | } |
| 212 | } |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 213 | |
| 214 | for (Intent serviceIntent : serviceIntents.values()) { |
| 215 | IntentState state = intentService.getIntentState(serviceIntent.key()); |
| 216 | if (state != null && state != IntentState.WITHDRAW_REQ |
| 217 | && state != IntentState.WITHDRAWING |
| 218 | && state != IntentState.WITHDRAWN) { |
| 219 | intentsToRemove.add(serviceIntent); |
| 220 | } |
| 221 | } |
| 222 | |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 223 | log.debug("Intent Synchronizer: submitting {}, withdrawing {}", |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 224 | intentsToAdd.size(), intentsToRemove.size()); |
| 225 | |
| 226 | // Withdraw Intents |
| 227 | for (Intent intent : intentsToRemove) { |
| 228 | intentService.withdraw(intent); |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 229 | log.trace("Intent Synchronizer: withdrawing intent: {}", |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 230 | intent); |
| 231 | } |
| 232 | if (!isElectedLeader) { |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 233 | log.debug("Intent Synchronizer: cannot withdraw intents: " + |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 234 | "not elected leader anymore"); |
| 235 | isActivatedLeader = false; |
Pingping Lin | e28ae4c | 2015-03-13 11:37:03 -0700 | [diff] [blame] | 236 | return; |
| 237 | } |
| 238 | |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 239 | // Add Intents |
| 240 | for (Intent intent : intentsToAdd) { |
| 241 | intentService.submit(intent); |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 242 | log.trace("Intent Synchronizer: submitting intent: {}", |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 243 | intent); |
| 244 | } |
| 245 | if (!isElectedLeader) { |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 246 | log.debug("Intent Synchronizer: cannot submit intents: " + |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 247 | "not elected leader anymore"); |
| 248 | isActivatedLeader = false; |
Pingping Lin | e28ae4c | 2015-03-13 11:37:03 -0700 | [diff] [blame] | 249 | return; |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 250 | } |
| 251 | |
| 252 | if (isElectedLeader) { |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 253 | // Allow push of Intents |
| 254 | isActivatedLeader = true; |
Pingping Lin | e28ae4c | 2015-03-13 11:37:03 -0700 | [diff] [blame] | 255 | } else { |
Jonathan Hart | 9a426f8 | 2015-09-03 15:43:13 +0200 | [diff] [blame] | 256 | isActivatedLeader = false; |
Pingping Lin | e28ae4c | 2015-03-13 11:37:03 -0700 | [diff] [blame] | 257 | } |
Luca Prete | 00043db | 2015-11-03 15:40:40 -0800 | [diff] [blame] | 258 | log.debug("Intent synchronization completed"); |
Pingping Lin | e28ae4c | 2015-03-13 11:37:03 -0700 | [diff] [blame] | 259 | } |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 260 | |
| 261 | @Override |
| 262 | public void modifyPrimary(boolean isPrimary) { |
| 263 | leaderChanged(isPrimary); |
| 264 | } |
| 265 | |
| 266 | /** |
| 267 | * A listener for leadership events. |
| 268 | */ |
| 269 | private class InternalLeadershipListener implements LeadershipEventListener { |
| 270 | |
| 271 | @Override |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 272 | public boolean isRelevant(LeadershipEvent event) { |
| 273 | return event.subject().topic().equals(appId.name()); |
| 274 | } |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 275 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 276 | @Override |
| 277 | public void event(LeadershipEvent event) { |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 278 | switch (event.type()) { |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 279 | case LEADER_CHANGED: |
| 280 | case LEADER_AND_CANDIDATES_CHANGED: |
| 281 | if (localNodeId.equals(event.subject().leaderNodeId())) { |
| 282 | log.info("IntentSynchronizer gained leadership"); |
| 283 | leaderChanged(true); |
| 284 | } else { |
| 285 | log.info("IntentSynchronizer leader changed. New leader is {}", event.subject().leaderNodeId()); |
| 286 | leaderChanged(false); |
| 287 | } |
Jonathan Hart | 365335e | 2015-12-10 11:09:53 -0800 | [diff] [blame] | 288 | default: |
| 289 | break; |
| 290 | } |
| 291 | } |
| 292 | } |
Pavlin Radoslavov | a071b1e | 2014-11-17 13:37:57 -0800 | [diff] [blame] | 293 | } |