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