Madan Jampani | ab7e7cd | 2016-01-14 14:02:32 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Madan Jampani | ab7e7cd | 2016-01-14 14:02:32 -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 | */ |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 16 | package org.onosproject.cluster.impl; |
| 17 | |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 18 | import org.onlab.packet.IpAddress; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 19 | import org.onlab.util.Tools; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 20 | import org.onosproject.cluster.ClusterMetadata; |
Madan Jampani | ab7e7cd | 2016-01-14 14:02:32 -0800 | [diff] [blame] | 21 | import org.onosproject.cluster.ClusterMetadataAdminService; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 22 | import org.onosproject.cluster.ClusterMetadataEvent; |
| 23 | import org.onosproject.cluster.ClusterMetadataEventListener; |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 24 | import org.onosproject.cluster.ClusterMetadataProvider; |
| 25 | import org.onosproject.cluster.ClusterMetadataProviderRegistry; |
| 26 | import org.onosproject.cluster.ClusterMetadataProviderService; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 27 | import org.onosproject.cluster.ClusterMetadataService; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 28 | import org.onosproject.cluster.ControllerNode; |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 29 | import org.onosproject.cluster.DefaultControllerNode; |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 30 | import org.onosproject.cluster.NodeId; |
| 31 | import org.onosproject.cluster.PartitionId; |
| 32 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
| 33 | import org.onosproject.net.provider.AbstractProviderService; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 34 | import org.onosproject.store.service.Versioned; |
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; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 38 | import org.slf4j.Logger; |
| 39 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 40 | import java.net.Inet4Address; |
| 41 | import java.net.InetAddress; |
| 42 | import java.net.MalformedURLException; |
| 43 | import java.net.NetworkInterface; |
| 44 | import java.net.SocketException; |
| 45 | import java.net.URL; |
| 46 | import java.net.UnknownHostException; |
| 47 | import java.util.Enumeration; |
| 48 | |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 49 | import static com.google.common.base.Preconditions.checkNotNull; |
| 50 | import static org.onosproject.security.AppGuard.checkPermission; |
| 51 | import static org.onosproject.security.AppPermission.Type.CLUSTER_READ; |
| 52 | import static org.slf4j.LoggerFactory.getLogger; |
| 53 | |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 54 | /** |
| 55 | * Implementation of ClusterMetadataService. |
| 56 | */ |
Ray Milkey | 86ad7bb | 2018-09-27 12:32:28 -0700 | [diff] [blame] | 57 | @Component(immediate = true, |
| 58 | service = {ClusterMetadataService.class, ClusterMetadataAdminService.class, |
| 59 | ClusterMetadataProviderRegistry.class}) |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 60 | public class ClusterMetadataManager |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 61 | extends AbstractListenerProviderRegistry<ClusterMetadataEvent, |
| 62 | ClusterMetadataEventListener, |
| 63 | ClusterMetadataProvider, |
| 64 | ClusterMetadataProviderService> |
| 65 | implements ClusterMetadataService, ClusterMetadataAdminService, ClusterMetadataProviderRegistry { |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 66 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 67 | private static final int MAX_WAIT_TRIES = 600; |
| 68 | private static final int MAX_WAIT_MS = 100; |
| 69 | |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 70 | private final Logger log = getLogger(getClass()); |
Madan Jampani | ab7e7cd | 2016-01-14 14:02:32 -0800 | [diff] [blame] | 71 | private ControllerNode localNode; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 72 | |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 73 | @Activate |
| 74 | public void activate() { |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 75 | // FIXME: Need to ensure all cluster metadata providers are registered before we activate |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 76 | eventDispatcher.addSink(ClusterMetadataEvent.class, listenerRegistry); |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 77 | log.info("Started"); |
| 78 | } |
| 79 | |
| 80 | @Deactivate |
| 81 | public void deactivate() { |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 82 | eventDispatcher.removeSink(ClusterMetadataEvent.class); |
| 83 | log.info("Stopped"); |
| 84 | } |
| 85 | |
| 86 | @Override |
| 87 | public ClusterMetadata getClusterMetadata() { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 88 | checkPermission(CLUSTER_READ); |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 89 | waitForAvailableProvider(); |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 90 | Versioned<ClusterMetadata> metadata = getProvider().getClusterMetadata(); |
| 91 | return metadata.value(); |
| 92 | } |
| 93 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 94 | // FIXME: Temporary hack to navigate around bootstrap timing issue |
| 95 | private void waitForAvailableProvider() { |
| 96 | for (int i = 0; i < MAX_WAIT_TRIES && getProvider() == null; i++) { |
| 97 | Tools.delay(MAX_WAIT_MS); |
| 98 | } |
| 99 | if (getProvider() == null) { |
| 100 | log.error("Unable to find cluster metadata provider"); |
| 101 | throw new IllegalStateException("Unable to find cluster metadata provider"); |
| 102 | } |
| 103 | } |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 104 | |
| 105 | @Override |
| 106 | protected ClusterMetadataProviderService createProviderService( |
| 107 | ClusterMetadataProvider provider) { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 108 | checkPermission(CLUSTER_READ); |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 109 | return new InternalClusterMetadataProviderService(provider); |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | @Override |
| 113 | public ControllerNode getLocalNode() { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 114 | checkPermission(CLUSTER_READ); |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 115 | if (localNode == null) { |
Jordan Halterman | 19c123a | 2018-07-30 13:57:19 -0700 | [diff] [blame] | 116 | ClusterMetadata metadata = getProvider().getClusterMetadata().value(); |
| 117 | ControllerNode localNode = metadata.getLocalNode(); |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 118 | try { |
| 119 | if (localNode != null) { |
| 120 | this.localNode = new DefaultControllerNode( |
| 121 | localNode.id(), |
| 122 | localNode.ip() != null ? localNode.ip() : findLocalIp(), |
| 123 | localNode.tcpPort()); |
| 124 | } else { |
| 125 | IpAddress ip = findLocalIp(); |
Jordan Halterman | 19c123a | 2018-07-30 13:57:19 -0700 | [diff] [blame] | 126 | localNode = metadata.getControllerNodes().stream() |
| 127 | .filter(node -> node.ip().equals(ip)) |
| 128 | .findFirst() |
| 129 | .orElse(null); |
| 130 | if (localNode != null) { |
| 131 | this.localNode = localNode; |
| 132 | } else { |
| 133 | this.localNode = new DefaultControllerNode(NodeId.nodeId(ip.toString()), ip); |
| 134 | } |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 135 | } |
| 136 | } catch (SocketException e) { |
| 137 | throw new IllegalStateException(e); |
| 138 | } |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 139 | } |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 140 | return localNode; |
| 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public void setClusterMetadata(ClusterMetadata metadata) { |
| 145 | checkNotNull(metadata, "Cluster metadata cannot be null"); |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 146 | ClusterMetadataProvider primaryProvider = getPrimaryProvider(); |
| 147 | if (primaryProvider == null) { |
| 148 | throw new IllegalStateException("Missing primary provider. Cannot update cluster metadata"); |
| 149 | } |
| 150 | primaryProvider.setClusterMetadata(metadata); |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 151 | } |
| 152 | |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 153 | /** |
| 154 | * Returns the provider to use for fetching cluster metadata. |
| 155 | * @return cluster metadata provider |
| 156 | */ |
| 157 | private ClusterMetadataProvider getProvider() { |
| 158 | ClusterMetadataProvider primaryProvider = getPrimaryProvider(); |
| 159 | if (primaryProvider != null && primaryProvider.isAvailable()) { |
| 160 | return primaryProvider; |
| 161 | } |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 162 | return getProvider("default"); |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Returns the primary provider for cluster metadata. |
| 167 | * @return primary cluster metadata provider |
| 168 | */ |
| 169 | private ClusterMetadataProvider getPrimaryProvider() { |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 170 | String metadataUri = System.getProperty("onos.cluster.metadata.uri"); |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 171 | try { |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 172 | String protocol = metadataUri == null ? null : new URL(metadataUri).getProtocol(); |
Ray Milkey | 36cbc71 | 2017-04-07 13:33:59 -0700 | [diff] [blame] | 173 | if (protocol != null && (!"file".equals(protocol) && !"http".equals(protocol))) { |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 174 | return getProvider(protocol); |
| 175 | } |
| 176 | // file provider supports both "file" and "http" uris |
| 177 | return getProvider("file"); |
| 178 | } catch (MalformedURLException e) { |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 179 | return null; |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 180 | } |
| 181 | } |
| 182 | |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 183 | private IpAddress findLocalIp() throws SocketException { |
| 184 | Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces(); |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 185 | while (interfaces.hasMoreElements()) { |
| 186 | NetworkInterface iface = interfaces.nextElement(); |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 187 | if (iface.isLoopback() || iface.isPointToPoint()) { |
| 188 | continue; |
| 189 | } |
| 190 | |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 191 | Enumeration<InetAddress> inetAddresses = iface.getInetAddresses(); |
| 192 | while (inetAddresses.hasMoreElements()) { |
Jordan Halterman | 00e92da | 2018-05-22 23:05:52 -0700 | [diff] [blame] | 193 | InetAddress inetAddress = inetAddresses.nextElement(); |
| 194 | if (inetAddress instanceof Inet4Address) { |
| 195 | Inet4Address inet4Address = (Inet4Address) inetAddress; |
| 196 | try { |
| 197 | if (!inet4Address.getHostAddress().equals(InetAddress.getLocalHost().getHostAddress())) { |
| 198 | return IpAddress.valueOf(inetAddress); |
| 199 | } |
| 200 | } catch (UnknownHostException e) { |
| 201 | return IpAddress.valueOf(inetAddress); |
| 202 | } |
Madan Jampani | ec1df02 | 2015-10-13 21:23:03 -0700 | [diff] [blame] | 203 | } |
| 204 | } |
| 205 | } |
| 206 | throw new IllegalStateException("Unable to determine local ip"); |
| 207 | } |
| 208 | |
Madan Jampani | ad3c526 | 2016-01-20 00:50:17 -0800 | [diff] [blame] | 209 | private class InternalClusterMetadataProviderService |
| 210 | extends AbstractProviderService<ClusterMetadataProvider> |
| 211 | implements ClusterMetadataProviderService { |
| 212 | |
| 213 | InternalClusterMetadataProviderService(ClusterMetadataProvider provider) { |
| 214 | super(provider); |
| 215 | } |
| 216 | |
| 217 | @Override |
| 218 | public void clusterMetadataChanged(Versioned<ClusterMetadata> newMetadata) { |
| 219 | log.info("Cluster metadata changed. New metadata: {}", newMetadata); |
| 220 | post(new ClusterMetadataEvent(ClusterMetadataEvent.Type.METADATA_CHANGED, newMetadata.value())); |
| 221 | } |
| 222 | |
| 223 | @Override |
| 224 | public void newActiveMemberForPartition(PartitionId partitionId, NodeId nodeId) { |
| 225 | log.info("Node {} is active member for partition {}", nodeId, partitionId); |
| 226 | // TODO: notify listeners |
| 227 | } |
| 228 | } |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 229 | } |