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 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 18 | import org.apache.karaf.system.SystemService; |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 19 | import org.onlab.packet.IpAddress; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.cluster.ClusterAdminService; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 21 | import org.onosproject.cluster.ClusterEvent; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 22 | import org.onosproject.cluster.ClusterEventListener; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 23 | import org.onosproject.cluster.ClusterMetadata; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 24 | import org.onosproject.cluster.ClusterMetadataDiff; |
| 25 | import org.onosproject.cluster.ClusterMetadataEvent; |
| 26 | import org.onosproject.cluster.ClusterMetadataEventListener; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 27 | import org.onosproject.cluster.ClusterService; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 28 | import org.onosproject.cluster.ClusterStore; |
| 29 | import org.onosproject.cluster.ClusterStoreDelegate; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 30 | import org.onosproject.cluster.ControllerNode; |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 31 | import org.onosproject.cluster.Node; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 32 | import org.onosproject.cluster.NodeId; |
Jordan Halterman | f70bf46 | 2017-07-29 13:12:00 -0700 | [diff] [blame] | 33 | import org.onosproject.core.Version; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 34 | import org.onosproject.event.AbstractListenerManager; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 35 | import org.osgi.service.component.annotations.Activate; |
| 36 | import org.osgi.service.component.annotations.Component; |
| 37 | import org.osgi.service.component.annotations.Deactivate; |
| 38 | import org.osgi.service.component.annotations.Reference; |
| 39 | import org.osgi.service.component.annotations.ReferenceCardinality; |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 40 | import org.slf4j.Logger; |
| 41 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 42 | import java.time.Instant; |
| 43 | import java.util.Set; |
| 44 | import java.util.concurrent.atomic.AtomicReference; |
| 45 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 46 | import static com.google.common.base.Preconditions.checkArgument; |
| 47 | import static com.google.common.base.Preconditions.checkNotNull; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 48 | import static org.onosproject.security.AppGuard.checkPermission; |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 49 | import static org.onosproject.security.AppPermission.Type.CLUSTER_READ; |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 50 | import static org.slf4j.LoggerFactory.getLogger; |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 51 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 52 | /** |
| 53 | * Implementation of the cluster service. |
| 54 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 55 | @Component(immediate = true, service = {ClusterService.class, ClusterAdminService.class}) |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 56 | public class ClusterManager |
| 57 | extends AbstractListenerManager<ClusterEvent, ClusterEventListener> |
| 58 | implements ClusterService, ClusterAdminService { |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 59 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 60 | public static final String INSTANCE_ID_NULL = "Instance ID cannot be null"; |
| 61 | private static final int DEFAULT_PARTITION_SIZE = 3; |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 62 | private final Logger log = getLogger(getClass()); |
| 63 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 64 | private ClusterStoreDelegate delegate = new InternalStoreDelegate(); |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 65 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 66 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 67 | protected ClusterStore store; |
| 68 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 69 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 70 | protected SystemService systemService; |
| 71 | |
| 72 | private final AtomicReference<ClusterMetadata> currentMetadata = new AtomicReference<>(); |
| 73 | private final InternalClusterMetadataListener metadataListener = new InternalClusterMetadataListener(); |
Madan Jampani | 1807057 | 2016-02-29 13:54:45 -0800 | [diff] [blame] | 74 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 75 | @Activate |
| 76 | public void activate() { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 77 | store.setDelegate(delegate); |
| 78 | eventDispatcher.addSink(ClusterEvent.class, listenerRegistry); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 79 | log.info("Started"); |
| 80 | } |
| 81 | |
| 82 | @Deactivate |
| 83 | public void deactivate() { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 84 | store.unsetDelegate(delegate); |
| 85 | eventDispatcher.removeSink(ClusterEvent.class); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 86 | log.info("Stopped"); |
| 87 | } |
| 88 | |
| 89 | @Override |
| 90 | public ControllerNode getLocalNode() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 91 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 92 | return store.getLocalNode(); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | @Override |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 96 | public Set<Node> getConsensusNodes() { |
| 97 | checkPermission(CLUSTER_READ); |
| 98 | return store.getStorageNodes(); |
| 99 | } |
| 100 | |
| 101 | @Override |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 102 | public Set<ControllerNode> getNodes() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 103 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 104 | return store.getNodes(); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | @Override |
| 108 | public ControllerNode getNode(NodeId nodeId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 109 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 110 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 111 | return store.getNode(nodeId); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | @Override |
| 115 | public ControllerNode.State getState(NodeId nodeId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 116 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 117 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 118 | return store.getState(nodeId); |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 119 | } |
| 120 | |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 121 | @Override |
Jordan Halterman | f70bf46 | 2017-07-29 13:12:00 -0700 | [diff] [blame] | 122 | public Version getVersion(NodeId nodeId) { |
| 123 | checkPermission(CLUSTER_READ); |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 124 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 125 | return store.getVersion(nodeId); |
Jordan Halterman | f70bf46 | 2017-07-29 13:12:00 -0700 | [diff] [blame] | 126 | } |
| 127 | |
| 128 | @Override |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 129 | public void markFullyStarted(boolean started) { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 130 | store.markFullyStarted(started); |
Thomas Vachuska | 7a8de84 | 2016-03-07 20:56:35 -0800 | [diff] [blame] | 131 | } |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 132 | |
| 133 | @Override |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 134 | public Instant getLastUpdatedInstant(NodeId nodeId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 135 | checkPermission(CLUSTER_READ); |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 136 | return store.getLastUpdatedInstant(nodeId); |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 137 | } |
| 138 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 139 | @Override |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 140 | public void formCluster(Set<ControllerNode> nodes) { |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 141 | formCluster(nodes, DEFAULT_PARTITION_SIZE); |
Thiago Santos | 7a174cf | 2016-09-01 14:56:54 -0300 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | @Override |
| 145 | public void formCluster(Set<ControllerNode> nodes, int partitionSize) { |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 146 | log.warn("formCluster is deprecated"); |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 147 | } |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 148 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 149 | @Override |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 150 | public ControllerNode addNode(NodeId nodeId, IpAddress ip, int tcpPort) { |
| 151 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 152 | checkNotNull(ip, "IP address cannot be null"); |
| 153 | checkArgument(tcpPort > 5000, "TCP port must be > 5000"); |
| 154 | return store.addNode(nodeId, ip, tcpPort); |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 155 | } |
Madan Jampani | 1807057 | 2016-02-29 13:54:45 -0800 | [diff] [blame] | 156 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 157 | @Override |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 158 | public void removeNode(NodeId nodeId) { |
| 159 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 160 | store.removeNode(nodeId); |
| 161 | } |
| 162 | |
| 163 | // Store delegate to re-post events emitted from the store. |
| 164 | private class InternalStoreDelegate implements ClusterStoreDelegate { |
| 165 | @Override |
| 166 | public void notify(ClusterEvent event) { |
| 167 | post(event); |
| 168 | } |
| 169 | } |
| 170 | |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 171 | /** |
| 172 | * Processes metadata by adding and removing nodes from the cluster. |
| 173 | */ |
| 174 | private synchronized void processMetadata(ClusterMetadata metadata) { |
| 175 | try { |
| 176 | ClusterMetadataDiff examiner = |
| 177 | new ClusterMetadataDiff(currentMetadata.get(), metadata); |
| 178 | examiner.nodesAdded().forEach(node -> addNode(node.id(), node.ip(), node.tcpPort())); |
| 179 | examiner.nodesRemoved().forEach(this::removeNode); |
| 180 | } finally { |
| 181 | currentMetadata.set(metadata); |
| 182 | } |
| 183 | } |
| 184 | |
| 185 | private class InternalClusterMetadataListener implements ClusterMetadataEventListener { |
| 186 | @Override |
| 187 | public void event(ClusterMetadataEvent event) { |
| 188 | processMetadata(event.subject()); |
| 189 | } |
Madan Jampani | 1807057 | 2016-02-29 13:54:45 -0800 | [diff] [blame] | 190 | } |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 191 | } |