Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
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.cluster.impl; |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 17 | |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 18 | import java.time.Instant; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 19 | import java.util.ArrayList; |
| 20 | import java.util.Collection; |
| 21 | import java.util.Collections; |
| 22 | import java.util.HashSet; |
| 23 | import java.util.List; |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 24 | import java.util.Set; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 25 | import java.util.concurrent.atomic.AtomicReference; |
Madan Jampani | 7c8e3b6 | 2016-06-20 12:51:55 -0700 | [diff] [blame] | 26 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 27 | import com.google.common.collect.Sets; |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Activate; |
| 29 | import org.apache.felix.scr.annotations.Component; |
| 30 | import org.apache.felix.scr.annotations.Deactivate; |
| 31 | import org.apache.felix.scr.annotations.Reference; |
| 32 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 33 | import org.apache.felix.scr.annotations.Service; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 34 | import org.apache.karaf.system.SystemService; |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 35 | import org.onlab.packet.IpAddress; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 36 | import org.onlab.util.Tools; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 37 | import org.onosproject.cluster.ClusterAdminService; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 38 | import org.onosproject.cluster.ClusterEvent; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 39 | import org.onosproject.cluster.ClusterEventListener; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 40 | import org.onosproject.cluster.ClusterMetadata; |
| 41 | import org.onosproject.cluster.ClusterMetadataAdminService; |
| 42 | import org.onosproject.cluster.ClusterMetadataDiff; |
| 43 | import org.onosproject.cluster.ClusterMetadataEvent; |
| 44 | import org.onosproject.cluster.ClusterMetadataEventListener; |
| 45 | import org.onosproject.cluster.ClusterMetadataService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 46 | import org.onosproject.cluster.ClusterService; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 47 | import org.onosproject.cluster.ClusterStore; |
| 48 | import org.onosproject.cluster.ClusterStoreDelegate; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 49 | import org.onosproject.cluster.ControllerNode; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 50 | import org.onosproject.cluster.DefaultPartition; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 51 | import org.onosproject.cluster.NodeId; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 52 | import org.onosproject.cluster.Partition; |
| 53 | import org.onosproject.cluster.PartitionId; |
Jordan Halterman | f70bf46 | 2017-07-29 13:12:00 -0700 | [diff] [blame] | 54 | import org.onosproject.core.Version; |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 55 | import org.onosproject.core.VersionService; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 56 | import org.onosproject.event.AbstractListenerManager; |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 57 | import org.slf4j.Logger; |
| 58 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 59 | import static com.google.common.base.Preconditions.checkArgument; |
| 60 | import static com.google.common.base.Preconditions.checkNotNull; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 61 | import static org.onosproject.security.AppGuard.checkPermission; |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 62 | import static org.onosproject.security.AppPermission.Type.CLUSTER_READ; |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 63 | import static org.slf4j.LoggerFactory.getLogger; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 64 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 65 | /** |
| 66 | * Implementation of the cluster service. |
| 67 | */ |
Madan Jampani | dd6479f | 2015-03-02 02:23:44 +0000 | [diff] [blame] | 68 | @Component(immediate = true) |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 69 | @Service |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 70 | public class ClusterManager |
| 71 | extends AbstractListenerManager<ClusterEvent, ClusterEventListener> |
| 72 | implements ClusterService, ClusterAdminService { |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 73 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 74 | public static final String INSTANCE_ID_NULL = "Instance ID cannot be null"; |
| 75 | private static final int DEFAULT_PARTITION_SIZE = 3; |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 76 | private final Logger log = getLogger(getClass()); |
| 77 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 78 | private ClusterStoreDelegate delegate = new InternalStoreDelegate(); |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 79 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 80 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 81 | protected ClusterMetadataService clusterMetadataService; |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 82 | |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 84 | protected ClusterMetadataAdminService clusterMetadataAdminService; |
Madan Jampani | ab7e7cd | 2016-01-14 14:02:32 -0800 | [diff] [blame] | 85 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 86 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 87 | protected ClusterStore store; |
| 88 | |
| 89 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 90 | protected SystemService systemService; |
| 91 | |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 92 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 93 | protected VersionService versionService; |
| 94 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 95 | private final AtomicReference<ClusterMetadata> currentMetadata = new AtomicReference<>(); |
| 96 | private final InternalClusterMetadataListener metadataListener = new InternalClusterMetadataListener(); |
Madan Jampani | 1807057 | 2016-02-29 13:54:45 -0800 | [diff] [blame] | 97 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 98 | @Activate |
| 99 | public void activate() { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 100 | store.setDelegate(delegate); |
| 101 | eventDispatcher.addSink(ClusterEvent.class, listenerRegistry); |
| 102 | clusterMetadataService.addListener(metadataListener); |
| 103 | processMetadata(clusterMetadataService.getClusterMetadata()); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 104 | log.info("Started"); |
| 105 | } |
| 106 | |
| 107 | @Deactivate |
| 108 | public void deactivate() { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 109 | clusterMetadataService.removeListener(metadataListener); |
| 110 | store.unsetDelegate(delegate); |
| 111 | eventDispatcher.removeSink(ClusterEvent.class); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 112 | log.info("Stopped"); |
| 113 | } |
| 114 | |
| 115 | @Override |
| 116 | public ControllerNode getLocalNode() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 117 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 118 | return store.getLocalNode(); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public Set<ControllerNode> getNodes() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 123 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 124 | return store.getNodes(); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | @Override |
| 128 | public ControllerNode getNode(NodeId nodeId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 129 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 130 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 131 | return store.getNode(nodeId); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | @Override |
| 135 | public ControllerNode.State getState(NodeId nodeId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 136 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 137 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 138 | return store.getState(nodeId); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 139 | } |
| 140 | |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 141 | @Override |
Jordan Halterman | f70bf46 | 2017-07-29 13:12:00 -0700 | [diff] [blame] | 142 | public Version getVersion(NodeId nodeId) { |
| 143 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 144 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 145 | return store.getVersion(nodeId); |
Jordan Halterman | f70bf46 | 2017-07-29 13:12:00 -0700 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | @Override |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 149 | public void markFullyStarted(boolean started) { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 150 | store.markFullyStarted(started); |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 151 | } |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 152 | |
| 153 | @Override |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 154 | public Instant getLastUpdatedInstant(NodeId nodeId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 155 | checkPermission(CLUSTER_READ); |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 156 | return store.getLastUpdatedInstant(nodeId); |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 157 | } |
| 158 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 159 | @Override |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 160 | public void formCluster(Set<ControllerNode> nodes) { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 161 | formCluster(nodes, DEFAULT_PARTITION_SIZE); |
Thiago Santos | 7a174cf | 2016-09-01 14:56:54 -0300 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | @Override |
| 165 | public void formCluster(Set<ControllerNode> nodes, int partitionSize) { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 166 | checkNotNull(nodes, "Nodes cannot be null"); |
| 167 | checkArgument(!nodes.isEmpty(), "Nodes cannot be empty"); |
Thomas Vachuska | de563cf | 2015-04-01 00:28:50 -0700 | [diff] [blame] | 168 | |
Jordan Halterman | 3065ba3 | 2018-04-10 15:58:21 -0400 | [diff] [blame] | 169 | // Validate that the given nodes intersect with the currently configured nodes. |
| 170 | Set<ControllerNode> existingNodes = Sets.newHashSet(clusterMetadataService.getClusterMetadata().getNodes()); |
| 171 | checkArgument( |
| 172 | !Sets.intersection(nodes, existingNodes).isEmpty(), |
| 173 | "Nodes must intersect with current cluster configuration"); |
| 174 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 175 | ClusterMetadata metadata = new ClusterMetadata("default", nodes, buildDefaultPartitions(nodes, partitionSize)); |
| 176 | clusterMetadataAdminService.setClusterMetadata(metadata); |
| 177 | try { |
| 178 | log.warn("Shutting down container for cluster reconfiguration!"); |
| 179 | // Clean up persistent state associated with previous cluster configuration. |
Jordan Halterman | ba1bbaf | 2017-11-13 21:06:40 -0800 | [diff] [blame] | 180 | Tools.removeDirectory(System.getProperty("karaf.data") + "/db/partitions/"); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 181 | systemService.reboot("now", SystemService.Swipe.NONE); |
| 182 | } catch (Exception e) { |
| 183 | log.error("Unable to reboot container", e); |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 184 | } |
| 185 | } |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 186 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 187 | @Override |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 188 | public ControllerNode addNode(NodeId nodeId, IpAddress ip, int tcpPort) { |
| 189 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 190 | checkNotNull(ip, "IP address cannot be null"); |
| 191 | checkArgument(tcpPort > 5000, "TCP port must be > 5000"); |
| 192 | return store.addNode(nodeId, ip, tcpPort); |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 193 | } |
Madan Jampani | 1807057 | 2016-02-29 13:54:45 -0800 | [diff] [blame] | 194 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 195 | @Override |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 196 | public void removeNode(NodeId nodeId) { |
| 197 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 198 | store.removeNode(nodeId); |
| 199 | } |
| 200 | |
| 201 | // Store delegate to re-post events emitted from the store. |
| 202 | private class InternalStoreDelegate implements ClusterStoreDelegate { |
| 203 | @Override |
| 204 | public void notify(ClusterEvent event) { |
| 205 | post(event); |
| 206 | } |
| 207 | } |
| 208 | |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 209 | private Set<Partition> buildDefaultPartitions(Collection<ControllerNode> nodes, int partitionSize) { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 210 | List<ControllerNode> sorted = new ArrayList<>(nodes); |
| 211 | Collections.sort(sorted, (o1, o2) -> o1.id().toString().compareTo(o2.id().toString())); |
| 212 | Set<Partition> partitions = Sets.newHashSet(); |
| 213 | // add partitions |
| 214 | int length = nodes.size(); |
| 215 | int count = Math.min(partitionSize, length); |
| 216 | for (int i = 0; i < length; i++) { |
| 217 | int index = i; |
| 218 | Set<NodeId> set = new HashSet<>(count); |
| 219 | for (int j = 0; j < count; j++) { |
| 220 | set.add(sorted.get((i + j) % length).id()); |
| 221 | } |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 222 | partitions.add(new DefaultPartition(PartitionId.from((index + 1)), versionService.version(), set)); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 223 | } |
| 224 | return partitions; |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Processes metadata by adding and removing nodes from the cluster. |
| 229 | */ |
| 230 | private synchronized void processMetadata(ClusterMetadata metadata) { |
| 231 | try { |
| 232 | ClusterMetadataDiff examiner = |
| 233 | new ClusterMetadataDiff(currentMetadata.get(), metadata); |
| 234 | examiner.nodesAdded().forEach(node -> addNode(node.id(), node.ip(), node.tcpPort())); |
| 235 | examiner.nodesRemoved().forEach(this::removeNode); |
| 236 | } finally { |
| 237 | currentMetadata.set(metadata); |
| 238 | } |
| 239 | } |
| 240 | |
| 241 | private class InternalClusterMetadataListener implements ClusterMetadataEventListener { |
| 242 | @Override |
| 243 | public void event(ClusterMetadataEvent event) { |
| 244 | processMetadata(event.subject()); |
| 245 | } |
Madan Jampani | 1807057 | 2016-02-29 13:54:45 -0800 | [diff] [blame] | 246 | } |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 247 | } |