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