Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame^] | 2 | * Copyright 2018-present Open Networking Foundation |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -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 | */ |
| 16 | |
| 17 | package org.onosproject.incubator.net.virtual.impl; |
| 18 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
| 20 | import com.google.common.util.concurrent.Futures; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 21 | import org.onlab.metrics.MetricsService; |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 22 | import org.onosproject.cluster.ClusterService; |
| 23 | import org.onosproject.cluster.ControllerNode; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 24 | import org.onosproject.cluster.NodeId; |
| 25 | import org.onosproject.cluster.RoleInfo; |
| 26 | import org.onosproject.core.MetricsHelper; |
| 27 | import org.onosproject.incubator.net.virtual.NetworkId; |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 28 | import org.onosproject.incubator.net.virtual.VirtualDevice; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 29 | import org.onosproject.incubator.net.virtual.VirtualNetworkMastershipStore; |
| 30 | import org.onosproject.incubator.net.virtual.VirtualNetworkService; |
| 31 | import org.onosproject.incubator.net.virtual.event.AbstractVirtualListenerManager; |
| 32 | import org.onosproject.mastership.MastershipAdminService; |
| 33 | import org.onosproject.mastership.MastershipEvent; |
Jordan Halterman | 0a2bd45 | 2018-06-13 17:24:58 -0700 | [diff] [blame] | 34 | import org.onosproject.mastership.MastershipInfo; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 35 | import org.onosproject.mastership.MastershipListener; |
| 36 | import org.onosproject.mastership.MastershipService; |
| 37 | import org.onosproject.mastership.MastershipStoreDelegate; |
| 38 | import org.onosproject.mastership.MastershipTerm; |
| 39 | import org.onosproject.mastership.MastershipTermService; |
| 40 | import org.onosproject.net.DeviceId; |
| 41 | import org.onosproject.net.MastershipRole; |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 42 | import org.slf4j.Logger; |
| 43 | import com.codahale.metrics.Timer; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 44 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 45 | import java.util.Comparator; |
| 46 | import java.util.List; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 47 | import java.util.Set; |
| 48 | import java.util.concurrent.CompletableFuture; |
Yoonseon Han | ea8ac72 | 2017-05-24 17:25:01 -0700 | [diff] [blame] | 49 | import java.util.stream.Collectors; |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 50 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 51 | import static com.google.common.base.Preconditions.checkNotNull; |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 52 | import static org.onlab.metrics.MetricsUtil.startTimer; |
| 53 | import static org.onlab.metrics.MetricsUtil.stopTimer; |
| 54 | import static org.slf4j.LoggerFactory.getLogger; |
| 55 | |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 56 | public class VirtualNetworkMastershipManager |
| 57 | extends AbstractVirtualListenerManager<MastershipEvent, MastershipListener> |
| 58 | implements MastershipService, MastershipAdminService, MastershipTermService, |
| 59 | MetricsHelper { |
| 60 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 61 | private static final String NODE_ID_NULL = "Node ID cannot be null"; |
| 62 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 63 | private static final String ROLE_NULL = "Mastership role cannot be null"; |
| 64 | |
| 65 | private final Logger log = getLogger(getClass()); |
| 66 | |
| 67 | protected ClusterService clusterService; |
| 68 | |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 69 | VirtualNetworkMastershipStore store; |
| 70 | MastershipStoreDelegate storeDelegate; |
| 71 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 72 | private NodeId localNodeId; |
| 73 | private Timer requestRoleTimer; |
| 74 | |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 75 | /** |
| 76 | * Creates a new VirtualNetworkMastershipManager object. |
| 77 | * |
| 78 | * @param manager virtual network manager service |
| 79 | * @param networkId virtual network identifier |
| 80 | */ |
| 81 | public VirtualNetworkMastershipManager(VirtualNetworkService manager, NetworkId networkId) { |
| 82 | super(manager, networkId, MastershipEvent.class); |
| 83 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 84 | clusterService = serviceDirectory.get(ClusterService.class); |
| 85 | |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 86 | store = serviceDirectory.get(VirtualNetworkMastershipStore.class); |
| 87 | this.storeDelegate = new InternalDelegate(); |
| 88 | store.setDelegate(networkId, this.storeDelegate); |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 89 | |
| 90 | requestRoleTimer = createTimer("Virtual-mastership", "requestRole", "responseTime"); |
| 91 | localNodeId = clusterService.getLocalNode().id(); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 92 | } |
| 93 | |
| 94 | @Override |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 95 | public CompletableFuture<Void> setRole(NodeId nodeId, DeviceId deviceId, |
| 96 | MastershipRole role) { |
| 97 | checkNotNull(nodeId, NODE_ID_NULL); |
| 98 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 99 | checkNotNull(role, ROLE_NULL); |
| 100 | |
| 101 | CompletableFuture<MastershipEvent> eventFuture = null; |
| 102 | |
| 103 | switch (role) { |
| 104 | case MASTER: |
| 105 | eventFuture = store.setMaster(networkId, nodeId, deviceId); |
| 106 | break; |
| 107 | case STANDBY: |
| 108 | eventFuture = store.setStandby(networkId, nodeId, deviceId); |
| 109 | break; |
| 110 | case NONE: |
| 111 | eventFuture = store.relinquishRole(networkId, nodeId, deviceId); |
| 112 | break; |
| 113 | default: |
| 114 | log.info("Unknown role; ignoring"); |
| 115 | return CompletableFuture.completedFuture(null); |
| 116 | } |
| 117 | |
| 118 | return eventFuture.thenAccept(this::post).thenApply(v -> null); |
| 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public MastershipRole getLocalRole(DeviceId deviceId) { |
| 123 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 124 | |
| 125 | return store.getRole(networkId, localNodeId, deviceId); |
| 126 | } |
| 127 | |
| 128 | @Override |
| 129 | public CompletableFuture<MastershipRole> requestRoleFor(DeviceId deviceId) { |
| 130 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 131 | |
| 132 | final Timer.Context timer = startTimer(requestRoleTimer); |
| 133 | return store.requestRole(networkId, deviceId) |
| 134 | .whenComplete((result, error) -> stopTimer(timer)); |
| 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public CompletableFuture<Void> relinquishMastership(DeviceId deviceId) { |
| 139 | return store.relinquishRole(networkId, localNodeId, deviceId) |
| 140 | .thenAccept(this::post) |
| 141 | .thenApply(v -> null); |
| 142 | } |
| 143 | |
| 144 | @Override |
| 145 | public NodeId getMasterFor(DeviceId deviceId) { |
| 146 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 147 | |
| 148 | return store.getMaster(networkId, deviceId); |
| 149 | } |
| 150 | |
| 151 | @Override |
| 152 | public RoleInfo getNodesFor(DeviceId deviceId) { |
| 153 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 154 | |
| 155 | return store.getNodes(networkId, deviceId); |
| 156 | } |
| 157 | |
| 158 | @Override |
Jordan Halterman | 0a2bd45 | 2018-06-13 17:24:58 -0700 | [diff] [blame] | 159 | public MastershipInfo getMastershipFor(DeviceId deviceId) { |
| 160 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 161 | return store.getMastership(networkId, deviceId); |
| 162 | } |
| 163 | |
| 164 | @Override |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 165 | public Set<DeviceId> getDevicesOf(NodeId nodeId) { |
| 166 | checkNotNull(nodeId, NODE_ID_NULL); |
| 167 | |
| 168 | return store.getDevices(networkId, nodeId); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | @Override |
| 172 | public MastershipTerm getMastershipTerm(DeviceId deviceId) { |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 173 | return store.getTermFor(networkId, deviceId); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | @Override |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 177 | public MetricsService metricsService() { |
| 178 | //TODO: support metric service for virtual network |
| 179 | log.warn("Currently, virtual network does not support metric service."); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 180 | return null; |
| 181 | } |
| 182 | |
| 183 | @Override |
| 184 | public void balanceRoles() { |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 185 | //FIXME: More advanced logic for balancing virtual network roles. |
Yoonseon Han | ea8ac72 | 2017-05-24 17:25:01 -0700 | [diff] [blame] | 186 | List<ControllerNode> nodes = clusterService.getNodes().stream() |
| 187 | .filter(n -> clusterService.getState(n.id()) |
| 188 | .equals(ControllerNode.State.ACTIVE)) |
| 189 | .collect(Collectors.toList()); |
| 190 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 191 | nodes.sort(Comparator.comparing(ControllerNode::id)); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 192 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 193 | //Pick a node using network Id, |
Yoonseon Han | ea8ac72 | 2017-05-24 17:25:01 -0700 | [diff] [blame] | 194 | NodeId masterNode = nodes.get((int) ((networkId.id() - 1) % nodes.size())).id(); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 195 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 196 | List<CompletableFuture<Void>> setRoleFutures = Lists.newLinkedList(); |
| 197 | for (VirtualDevice device : manager.getVirtualDevices(networkId)) { |
| 198 | setRoleFutures.add(setRole(masterNode, device.id(), MastershipRole.MASTER)); |
| 199 | } |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 200 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 201 | CompletableFuture<Void> balanceRolesFuture = CompletableFuture.allOf( |
| 202 | setRoleFutures.toArray(new CompletableFuture[setRoleFutures.size()])); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 203 | |
Yoonseon Han | aea0f33 | 2017-05-23 10:31:11 -0700 | [diff] [blame] | 204 | Futures.getUnchecked(balanceRolesFuture); |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 205 | } |
| 206 | |
| 207 | public class InternalDelegate implements MastershipStoreDelegate { |
| 208 | @Override |
| 209 | public void notify(MastershipEvent event) { |
| 210 | post(event); |
| 211 | } |
| 212 | } |
Yoonseon Han | a578d76 | 2017-05-08 13:42:02 -0700 | [diff] [blame] | 213 | } |