Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Jonathan Hart | 74c8313 | 2015-02-02 18: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 | */ |
| 16 | package org.onosproject.store.intent.impl; |
| 17 | |
| 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; |
| 24 | import org.onosproject.cluster.ClusterService; |
| 25 | import org.onosproject.cluster.Leadership; |
| 26 | import org.onosproject.cluster.LeadershipEvent; |
| 27 | import org.onosproject.cluster.LeadershipEventListener; |
| 28 | import org.onosproject.cluster.LeadershipService; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 29 | import org.onosproject.cluster.NodeId; |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 30 | import org.onosproject.event.EventDeliveryService; |
| 31 | import org.onosproject.event.ListenerRegistry; |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 32 | import org.onosproject.net.intent.WorkPartitionEvent; |
| 33 | import org.onosproject.net.intent.WorkPartitionEventListener; |
| 34 | import org.onosproject.net.intent.WorkPartitionService; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 35 | import org.slf4j.Logger; |
| 36 | import org.slf4j.LoggerFactory; |
| 37 | |
Yuta HIGUCHI | 1624df1 | 2016-07-21 16:54:33 -0700 | [diff] [blame] | 38 | import static org.onlab.util.Tools.groupedThreads; |
| 39 | |
Jonathan Hart | dc9d7b8 | 2015-02-22 17:59:50 -0800 | [diff] [blame] | 40 | import java.util.List; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 41 | import java.util.Objects; |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 42 | import java.util.concurrent.Executors; |
| 43 | import java.util.concurrent.ScheduledExecutorService; |
| 44 | import java.util.concurrent.TimeUnit; |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 45 | import java.util.concurrent.atomic.AtomicBoolean; |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 46 | import java.util.function.Function; |
Jonathan Hart | dc9d7b8 | 2015-02-22 17:59:50 -0800 | [diff] [blame] | 47 | import java.util.stream.Collectors; |
Madan Jampani | a4a5994 | 2016-05-02 11:25:34 -0700 | [diff] [blame] | 48 | import java.util.stream.IntStream; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 49 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 50 | /** |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 51 | * Manages the assignment of work partitions to instances. |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 52 | */ |
| 53 | @Component(immediate = true) |
| 54 | @Service |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 55 | public class WorkPartitionManager implements WorkPartitionService { |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 56 | |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 57 | private static final Logger log = LoggerFactory.getLogger(WorkPartitionManager.class); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 58 | |
| 59 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 60 | protected LeadershipService leadershipService; |
| 61 | |
| 62 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 63 | protected ClusterService clusterService; |
| 64 | |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 66 | protected EventDeliveryService eventDispatcher; |
| 67 | |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 68 | protected final AtomicBoolean rebalanceScheduled = new AtomicBoolean(false); |
| 69 | |
Jonathan Hart | 7061acd | 2015-03-04 13:15:32 -0800 | [diff] [blame] | 70 | static final int NUM_PARTITIONS = 14; |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 71 | private static final int BACKOFF_TIME = 2; |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 72 | private static final int CHECK_PARTITION_BALANCE_PERIOD_SEC = 10; |
| 73 | private static final int RETRY_AFTER_DELAY_SEC = 5; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 74 | |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 75 | private static final String ELECTION_PREFIX = "work-partition-"; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 76 | |
Madan Jampani | a9673fd | 2016-02-02 13:01:29 -0800 | [diff] [blame] | 77 | protected NodeId localNodeId; |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 78 | private ListenerRegistry<WorkPartitionEvent, WorkPartitionEventListener> listenerRegistry; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 79 | private LeadershipEventListener leaderListener = new InternalLeadershipListener(); |
| 80 | |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 81 | private ScheduledExecutorService executor = Executors |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 82 | .newScheduledThreadPool(1, groupedThreads("work-parition", "balancer-%d", log)); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 83 | |
| 84 | @Activate |
| 85 | public void activate() { |
Madan Jampani | a9673fd | 2016-02-02 13:01:29 -0800 | [diff] [blame] | 86 | localNodeId = clusterService.getLocalNode().id(); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 87 | leadershipService.addListener(leaderListener); |
| 88 | |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 89 | listenerRegistry = new ListenerRegistry<>(); |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 90 | eventDispatcher.addSink(WorkPartitionEvent.class, listenerRegistry); |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 91 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 92 | for (int i = 0; i < NUM_PARTITIONS; i++) { |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 93 | leadershipService.runForLeadership(getPartitionPath(i)); |
Madan Jampani | a9673fd | 2016-02-02 13:01:29 -0800 | [diff] [blame] | 94 | log.debug("Registered to run for {}", getPartitionPath(i)); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 95 | } |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 96 | |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 97 | executor.scheduleAtFixedRate(() -> scheduleRebalance(0), 0, |
| 98 | CHECK_PARTITION_BALANCE_PERIOD_SEC, TimeUnit.SECONDS); |
Madan Jampani | a9673fd | 2016-02-02 13:01:29 -0800 | [diff] [blame] | 99 | log.info("Started"); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | @Deactivate |
| 103 | public void deactivate() { |
Jonathan Hart | ac48a95 | 2015-02-25 14:11:55 -0800 | [diff] [blame] | 104 | executor.shutdownNow(); |
| 105 | |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 106 | eventDispatcher.removeSink(WorkPartitionEvent.class); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 107 | leadershipService.removeListener(leaderListener); |
Madan Jampani | a9673fd | 2016-02-02 13:01:29 -0800 | [diff] [blame] | 108 | log.info("Stopped"); |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 109 | } |
| 110 | |
Jonathan Hart | 7061acd | 2015-03-04 13:15:32 -0800 | [diff] [blame] | 111 | /** |
| 112 | * Sets the specified executor to be used for scheduling background tasks. |
| 113 | * |
| 114 | * @param executor scheduled executor service for background tasks |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 115 | * @return this WorkPartitionManager |
Jonathan Hart | 7061acd | 2015-03-04 13:15:32 -0800 | [diff] [blame] | 116 | */ |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 117 | WorkPartitionManager withScheduledExecutor(ScheduledExecutorService executor) { |
Jonathan Hart | 7061acd | 2015-03-04 13:15:32 -0800 | [diff] [blame] | 118 | this.executor = executor; |
| 119 | return this; |
| 120 | } |
| 121 | |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 122 | private String getPartitionPath(int i) { |
| 123 | return ELECTION_PREFIX + i; |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 124 | } |
| 125 | |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 126 | @Override |
| 127 | public <K> boolean isMine(K id, Function<K, Long> hasher) { |
| 128 | return Objects.equals(localNodeId, getLeader(id, hasher)); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | @Override |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 132 | public <K> NodeId getLeader(K id, Function<K, Long> hasher) { |
| 133 | int partition = Math.abs(hasher.apply(id).intValue()) % NUM_PARTITIONS; |
| 134 | PartitionId partitionId = new PartitionId(partition); |
| 135 | return leadershipService.getLeadership(getPartitionPath(partitionId.value())).leaderNodeId(); |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | @Override |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 139 | public void addListener(WorkPartitionEventListener listener) { |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 140 | listenerRegistry.addListener(listener); |
| 141 | } |
| 142 | |
| 143 | @Override |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 144 | public void removeListener(WorkPartitionEventListener listener) { |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 145 | listenerRegistry.removeListener(listener); |
| 146 | } |
| 147 | |
Sho SHIMIZU | b814773 | 2016-01-15 13:13:31 -0800 | [diff] [blame] | 148 | void doRebalance() { |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 149 | rebalanceScheduled.set(false); |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 150 | try { |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 151 | rebalance(); |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 152 | } catch (Exception e) { |
Ray Milkey | 07b5935 | 2017-02-16 15:42:41 -0800 | [diff] [blame] | 153 | log.warn("{} caught during rebalance task. Will retry in " + |
Ray Milkey | ac0a82d | 2017-02-16 08:58:59 -0800 | [diff] [blame] | 154 | RETRY_AFTER_DELAY_SEC + " seconds", e.getMessage()); |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 155 | scheduleRebalance(RETRY_AFTER_DELAY_SEC); |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 156 | } |
| 157 | } |
| 158 | |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 159 | /** |
| 160 | * Determine whether we have more than our fair share of partitions, and if |
| 161 | * so, relinquish leadership of some of them for a little while to let |
| 162 | * other instances take over. |
| 163 | */ |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 164 | private void rebalance() { |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 165 | int activeNodes = (int) clusterService.getNodes() |
| 166 | .stream() |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 167 | .filter(node -> clusterService.getState(node.id()).isActive()) |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 168 | .count(); |
| 169 | |
| 170 | int myShare = (int) Math.ceil((double) NUM_PARTITIONS / activeNodes); |
| 171 | |
Madan Jampani | a4d2c72 | 2016-06-06 16:39:06 -0700 | [diff] [blame] | 172 | // First make sure this node is a candidate for all partitions. |
| 173 | IntStream.range(0, NUM_PARTITIONS) |
| 174 | .mapToObj(this::getPartitionPath) |
| 175 | .map(leadershipService::getLeadership) |
| 176 | .filter(leadership -> !leadership.candidates().contains(localNodeId)) |
| 177 | .map(Leadership::topic) |
| 178 | .forEach(leadershipService::runForLeadership); |
| 179 | |
Madan Jampani | a4a5994 | 2016-05-02 11:25:34 -0700 | [diff] [blame] | 180 | List<String> myPartitions = IntStream.range(0, NUM_PARTITIONS) |
| 181 | .mapToObj(this::getPartitionPath) |
| 182 | .map(leadershipService::getLeadership) |
| 183 | .filter(Objects::nonNull) |
| 184 | .filter(leadership -> localNodeId.equals(leadership.leaderNodeId())) |
| 185 | .map(Leadership::topic) |
| 186 | .collect(Collectors.toList()); |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 187 | |
Jonathan Hart | dc9d7b8 | 2015-02-22 17:59:50 -0800 | [diff] [blame] | 188 | int relinquish = myPartitions.size() - myShare; |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 189 | |
Madan Jampani | a4d2c72 | 2016-06-06 16:39:06 -0700 | [diff] [blame] | 190 | |
Jonathan Hart | dc9d7b8 | 2015-02-22 17:59:50 -0800 | [diff] [blame] | 191 | for (int i = 0; i < relinquish; i++) { |
Madan Jampani | a4a5994 | 2016-05-02 11:25:34 -0700 | [diff] [blame] | 192 | String topic = myPartitions.get(i); |
Madan Jampani | 783d3d2 | 2016-06-13 17:40:02 -0700 | [diff] [blame] | 193 | // Wait till all active nodes are in contention for partition ownership. |
| 194 | // This avoids too many relinquish/reclaim cycles. |
| 195 | if (leadershipService.getCandidates(topic).size() == activeNodes) { |
| 196 | leadershipService.withdraw(topic); |
| 197 | executor.schedule(() -> recontest(topic), BACKOFF_TIME, TimeUnit.SECONDS); |
| 198 | } |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | |
Madan Jampani | 4732c1b | 2015-05-19 17:11:50 -0700 | [diff] [blame] | 202 | private void scheduleRebalance(int afterDelaySec) { |
| 203 | if (rebalanceScheduled.compareAndSet(false, true)) { |
| 204 | executor.schedule(this::doRebalance, afterDelaySec, TimeUnit.SECONDS); |
| 205 | } |
| 206 | } |
| 207 | |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 208 | /** |
| 209 | * Try and recontest for leadership of a partition. |
| 210 | * |
| 211 | * @param path topic name to recontest |
| 212 | */ |
| 213 | private void recontest(String path) { |
| 214 | leadershipService.runForLeadership(path); |
| 215 | } |
| 216 | |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 217 | private final class InternalLeadershipListener implements LeadershipEventListener { |
| 218 | |
| 219 | @Override |
| 220 | public void event(LeadershipEvent event) { |
| 221 | Leadership leadership = event.subject(); |
Jonathan Hart | dc9d7b8 | 2015-02-22 17:59:50 -0800 | [diff] [blame] | 222 | |
Madan Jampani | a9673fd | 2016-02-02 13:01:29 -0800 | [diff] [blame] | 223 | if (Objects.equals(leadership.leaderNodeId(), localNodeId) && |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 224 | leadership.topic().startsWith(ELECTION_PREFIX)) { |
| 225 | |
Madan Jampani | 3b8101a | 2016-09-15 13:22:01 -0700 | [diff] [blame] | 226 | eventDispatcher.post(new WorkPartitionEvent(WorkPartitionEvent.Type.LEADER_CHANGED, |
Brian O'Connor | 69d6ac7 | 2015-05-29 16:24:06 -0700 | [diff] [blame] | 227 | leadership.topic())); |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 228 | } |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 229 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 230 | if (event.type() == LeadershipEvent.Type.CANDIDATES_CHANGED) { |
| 231 | scheduleRebalance(0); |
| 232 | } |
Jonathan Hart | f2fda81 | 2015-02-17 15:21:03 -0800 | [diff] [blame] | 233 | } |
| 234 | } |
Jonathan Hart | 74c8313 | 2015-02-02 18:37:57 -0800 | [diff] [blame] | 235 | } |