Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 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 | */ |
| 16 | |
Hyunsun Moon | 7170129 | 2016-05-09 12:00:54 -0700 | [diff] [blame] | 17 | package org.onosproject.scalablegateway.impl; |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 18 | |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [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 | |
| 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 26 | import org.apache.felix.scr.annotations.Service; |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 27 | import org.onlab.util.KryoNamespace; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 28 | import org.onosproject.core.ApplicationId; |
| 29 | import org.onosproject.core.CoreService; |
| 30 | |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 31 | import org.onosproject.core.GroupId; |
| 32 | import org.onosproject.net.DeviceId; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 33 | import org.onosproject.net.Port; |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 34 | import org.onosproject.net.PortNumber; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 35 | import org.onosproject.net.config.ConfigFactory; |
| 36 | import org.onosproject.net.config.NetworkConfigEvent; |
| 37 | import org.onosproject.net.config.NetworkConfigListener; |
| 38 | import org.onosproject.net.config.NetworkConfigRegistry; |
| 39 | import org.onosproject.net.config.NetworkConfigService; |
| 40 | import org.onosproject.net.config.basics.SubjectFactories; |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 41 | import org.onosproject.net.device.DeviceEvent; |
| 42 | import org.onosproject.net.device.DeviceListener; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 43 | import org.onosproject.net.device.DeviceService; |
Kyuhwi Choi | b071821 | 2016-06-01 11:33:27 +0900 | [diff] [blame] | 44 | import org.onosproject.net.driver.DriverService; |
| 45 | import org.onosproject.net.group.Group; |
| 46 | import org.onosproject.net.group.GroupDescription; |
| 47 | import org.onosproject.net.group.GroupService; |
Hyunsun Moon | 7170129 | 2016-05-09 12:00:54 -0700 | [diff] [blame] | 48 | import org.onosproject.scalablegateway.api.GatewayNode; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 49 | import org.onosproject.scalablegateway.api.GatewayNodeConfig; |
Hyunsun Moon | 7170129 | 2016-05-09 12:00:54 -0700 | [diff] [blame] | 50 | import org.onosproject.scalablegateway.api.ScalableGatewayService; |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 51 | |
| 52 | import java.util.List; |
sangho | 6032f34 | 2016-07-07 14:32:03 +0900 | [diff] [blame] | 53 | import java.util.Optional; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 54 | |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 55 | import org.onosproject.store.serializers.KryoNamespaces; |
| 56 | import org.onosproject.store.service.ConsistentMap; |
| 57 | import org.onosproject.store.service.Serializer; |
| 58 | import org.onosproject.store.service.StorageService; |
| 59 | import org.onosproject.store.service.Versioned; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 60 | import org.slf4j.Logger; |
| 61 | import org.slf4j.LoggerFactory; |
| 62 | |
| 63 | import static com.google.common.base.Preconditions.checkNotNull; |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 64 | |
| 65 | /** |
| 66 | * Manages gateway node for gateway scalability. |
| 67 | */ |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 68 | |
| 69 | @Service |
| 70 | @Component(immediate = true) |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 71 | public class ScalableGatewayManager implements ScalableGatewayService { |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 72 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 73 | |
| 74 | private ApplicationId appId; |
| 75 | private static final String APP_ID = "org.onosproject.scalablegateway"; |
| 76 | private static final String APP_NAME = "scalablegateway"; |
| 77 | private static final String GATEWAYNODE_CAN_NOT_BE_NULL = "The gateway node can not be null"; |
| 78 | private static final String PORT_CAN_NOT_BE_NULL = "The port can not be null"; |
| 79 | private static final String FAIL_ADD_GATEWAY = "Adding process is failed as existing deivce id"; |
| 80 | private static final String FAIL_REMOVE_GATEWAY = "Removing process is failed as unknown deivce id"; |
| 81 | private static final String PORT_NAME = "portName"; |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 82 | private static final String GATEWAYNODE_MAP_NAME = "gatewaynode-map"; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 83 | |
| 84 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 85 | protected CoreService coreService; |
| 86 | |
| 87 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 88 | protected NetworkConfigService configService; |
| 89 | |
| 90 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 91 | protected NetworkConfigRegistry configRegistry; |
| 92 | |
| 93 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 94 | protected DeviceService deviceService; |
| 95 | |
Kyuhwi Choi | b071821 | 2016-06-01 11:33:27 +0900 | [diff] [blame] | 96 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 97 | protected DriverService driverService; |
| 98 | |
| 99 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 100 | protected GroupService groupService; |
| 101 | |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 102 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 103 | protected StorageService storageService; |
| 104 | |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 105 | private GatewayNodeConfig config; |
Kyuhwi Choi | b071821 | 2016-06-01 11:33:27 +0900 | [diff] [blame] | 106 | private SelectGroupHandler selectGroupHandler; |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 107 | |
| 108 | private final NetworkConfigListener configListener = new InternalConfigListener(); |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 109 | private InternalDeviceListener internalDeviceListener = new InternalDeviceListener(); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 110 | |
| 111 | private final ConfigFactory configFactory = |
| 112 | new ConfigFactory(SubjectFactories.APP_SUBJECT_FACTORY, GatewayNodeConfig.class, APP_NAME) { |
| 113 | @Override |
| 114 | public GatewayNodeConfig createConfig() { |
| 115 | return new GatewayNodeConfig(); |
| 116 | } |
| 117 | }; |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 118 | private ConsistentMap<DeviceId, GatewayNode> gatewayNodeMap; // Map<GatewayNode`s Id, GatewayNode object> |
| 119 | private static final KryoNamespace.Builder GATEWAYNODE_SERIALIZER = KryoNamespace.newBuilder() |
| 120 | .register(KryoNamespaces.API) |
| 121 | .register(DeviceId.class) |
| 122 | .register(GatewayNode.class); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 123 | |
| 124 | @Activate |
| 125 | protected void activate() { |
| 126 | appId = coreService.registerApplication(APP_ID); |
| 127 | configRegistry.registerConfigFactory(configFactory); |
| 128 | configService.addListener(configListener); |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 129 | deviceService.addListener(internalDeviceListener); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 130 | |
Kyuhwi Choi | b071821 | 2016-06-01 11:33:27 +0900 | [diff] [blame] | 131 | selectGroupHandler = new SelectGroupHandler(groupService, deviceService, driverService, appId); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 132 | |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 133 | gatewayNodeMap = storageService.<DeviceId, GatewayNode>consistentMapBuilder() |
| 134 | .withSerializer(Serializer.using(GATEWAYNODE_SERIALIZER.build())) |
| 135 | .withName(GATEWAYNODE_MAP_NAME) |
| 136 | .withApplicationId(appId) |
| 137 | .build(); |
| 138 | |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 139 | log.info("started"); |
| 140 | } |
| 141 | |
| 142 | @Deactivate |
| 143 | protected void deactivate() { |
| 144 | gatewayNodeMap.clear(); |
| 145 | |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 146 | deviceService.removeListener(internalDeviceListener); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 147 | configService.removeListener(configListener); |
| 148 | |
| 149 | log.info("stopped"); |
| 150 | } |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 151 | |
| 152 | @Override |
| 153 | public GatewayNode getGatewayNode(DeviceId deviceId) { |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 154 | return checkNotNull(gatewayNodeMap.get(deviceId).value(), GATEWAYNODE_CAN_NOT_BE_NULL); |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | @Override |
Kyuhwi Choi | 176c83d | 2016-07-14 11:39:37 +0900 | [diff] [blame] | 158 | public PortNumber getGatewayExternalPort(DeviceId deviceId) { |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 159 | GatewayNode gatewayNode = checkNotNull(gatewayNodeMap.get(deviceId).value(), GATEWAYNODE_CAN_NOT_BE_NULL); |
Kyuhwi Choi | 176c83d | 2016-07-14 11:39:37 +0900 | [diff] [blame] | 160 | String externalInterfaceName = gatewayNode.getGatewayExternalInterfaceName(); |
| 161 | Optional<Port> port = deviceService.getPorts(deviceId) |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 162 | .stream() |
Kyuhwi Choi | 176c83d | 2016-07-14 11:39:37 +0900 | [diff] [blame] | 163 | .filter(p -> p.annotations().value(PORT_NAME).equals(externalInterfaceName)) |
sangho | 6032f34 | 2016-07-07 14:32:03 +0900 | [diff] [blame] | 164 | .findFirst(); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 165 | |
sangho | 6032f34 | 2016-07-07 14:32:03 +0900 | [diff] [blame] | 166 | if (!port.isPresent()) { |
Kyuhwi Choi | 176c83d | 2016-07-14 11:39:37 +0900 | [diff] [blame] | 167 | log.error("Cannot find port {} in gateway device {}", externalInterfaceName, deviceId); |
sangho | 6032f34 | 2016-07-07 14:32:03 +0900 | [diff] [blame] | 168 | return null; |
| 169 | } |
| 170 | |
| 171 | return port.get().number(); |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | @Override |
| 175 | public GroupId getGroupIdForGatewayLoadBalance(DeviceId srcDeviceId) { |
Kyuhwi Choi | b071821 | 2016-06-01 11:33:27 +0900 | [diff] [blame] | 176 | GroupDescription description = selectGroupHandler.createSelectGroupInVxlan(srcDeviceId, getGatewayNodes()); |
| 177 | groupService.addGroup(description); |
| 178 | Group group = groupService.getGroup(description.deviceId(), description.appCookie()); |
| 179 | return group != null ? group.id() : null; |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | @Override |
| 183 | public List<GatewayNode> getGatewayNodes() { |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 184 | List<GatewayNode> gatewayNodeList = Lists.newArrayList(); |
| 185 | gatewayNodeMap.values() |
| 186 | .stream() |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 187 | .map(Versioned::value) |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 188 | .forEach(gatewayNode -> gatewayNodeList.add(gatewayNode)); |
| 189 | return gatewayNodeList; |
| 190 | |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | @Override |
| 194 | public List<DeviceId> getGatewayDeviceIds() { |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 195 | List<DeviceId> deviceIdList = Lists.newArrayList(); |
| 196 | gatewayNodeMap.values() |
| 197 | .stream() |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 198 | .map(Versioned::value) |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 199 | .forEach(gatewayNode -> deviceIdList.add(gatewayNode.getGatewayDeviceId())); |
| 200 | return deviceIdList; |
| 201 | |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 202 | } |
| 203 | |
| 204 | @Override |
| 205 | public boolean addGatewayNode(GatewayNode gatewayNode) { |
Hyunsun Moon | d331afd | 2016-07-20 02:19:20 -0700 | [diff] [blame^] | 206 | Versioned<GatewayNode> existingNode = gatewayNodeMap.putIfAbsent( |
| 207 | gatewayNode.getGatewayDeviceId(), gatewayNode); |
| 208 | if (existingNode == null) { |
| 209 | updateGatewayLoadBalance(gatewayNode, true); |
| 210 | log.info("Added {} to gateway pool", gatewayNode); |
| 211 | return true; |
| 212 | } else { |
| 213 | return false; |
| 214 | } |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 215 | } |
| 216 | |
| 217 | @Override |
| 218 | public boolean deleteGatewayNode(GatewayNode gatewayNode) { |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 219 | boolean result = gatewayNodeMap.remove(gatewayNode.getGatewayDeviceId(), gatewayNode); |
| 220 | if (result) { |
| 221 | updateGatewayLoadBalance(gatewayNode, false); |
| 222 | } |
| 223 | return result; |
| 224 | } |
| 225 | |
| 226 | private void updateGatewayLoadBalance(GatewayNode gatewayNode, boolean nodeInsertion) { |
| 227 | deviceService.getAvailableDevices().forEach(device -> |
| 228 | groupService.getGroups(device.id(), appId).forEach(group -> |
| 229 | selectGroupHandler.updateBucketToSelectGroupInVxlan(device.id(), group.appCookie(), |
| 230 | Lists.newArrayList(gatewayNode), nodeInsertion))); |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 231 | } |
| 232 | |
| 233 | private class InternalConfigListener implements NetworkConfigListener { |
| 234 | @Override |
| 235 | public void event(NetworkConfigEvent event) { |
| 236 | if (!event.configClass().equals(GatewayNodeConfig.class)) { |
| 237 | return; |
| 238 | } |
| 239 | switch (event.type()) { |
| 240 | case CONFIG_UPDATED: |
| 241 | gatewayNodeMap.clear(); |
| 242 | readConfiguration(); |
| 243 | break; |
| 244 | case CONFIG_ADDED: |
| 245 | readConfiguration(); |
| 246 | break; |
| 247 | default: |
| 248 | log.debug("Unsupportable event type is occurred"); |
| 249 | break; |
| 250 | } |
| 251 | } |
| 252 | } |
| 253 | |
Kyuhwi Choi | 7053788 | 2016-06-24 17:24:12 +0900 | [diff] [blame] | 254 | private class InternalDeviceListener implements DeviceListener { |
| 255 | |
| 256 | @Override |
| 257 | public void event(DeviceEvent deviceEvent) { |
| 258 | if (deviceEvent.type() == DeviceEvent.Type.DEVICE_SUSPENDED || |
| 259 | deviceEvent.type() == DeviceEvent.Type.DEVICE_REMOVED) { |
| 260 | deleteGatewayNode(getGatewayNode(deviceEvent.subject().id())); |
| 261 | } |
| 262 | } |
| 263 | } |
| 264 | |
Kyuhwi Choi | dc2973b | 2016-05-13 14:54:31 +0900 | [diff] [blame] | 265 | private void readConfiguration() { |
| 266 | config = configService.getConfig(appId, GatewayNodeConfig.class); |
| 267 | if (config == null) { |
| 268 | log.error("No configuration found"); |
| 269 | return; |
| 270 | } |
| 271 | |
| 272 | config.gatewayNodes().forEach(gatewayNode -> addGatewayNode(gatewayNode)); |
| 273 | |
| 274 | log.info("ScalableGateway configured"); |
Kyuhwi Choi | c5b33ea | 2016-04-26 11:45:32 +0900 | [diff] [blame] | 275 | } |
| 276 | } |