Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -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 | */ |
| 16 | package org.onosproject.store.primitives.impl; |
| 17 | |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 18 | import java.io.File; |
| 19 | import java.util.Collection; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 20 | import java.util.Map; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 21 | import java.util.Optional; |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 22 | import java.util.Set; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 23 | import java.util.concurrent.CompletableFuture; |
| 24 | import java.util.concurrent.atomic.AtomicBoolean; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 25 | import java.util.function.Supplier; |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 26 | import java.util.stream.Collectors; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 27 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 28 | import com.google.common.collect.Collections2; |
| 29 | import com.google.common.collect.ImmutableMap; |
| 30 | import io.atomix.protocols.raft.cluster.MemberId; |
| 31 | import io.atomix.protocols.raft.service.RaftService; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 32 | import org.onosproject.cluster.ClusterService; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 33 | import org.onosproject.cluster.NodeId; |
| 34 | import org.onosproject.cluster.Partition; |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 35 | import org.onosproject.cluster.PartitionId; |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 36 | import org.onosproject.core.Version; |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 37 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 38 | import org.onosproject.store.primitives.resources.impl.AtomixAtomicCounterMapService; |
| 39 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapService; |
| 40 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentSetMultimapService; |
| 41 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapService; |
| 42 | import org.onosproject.store.primitives.resources.impl.AtomixCounterService; |
Jordan Halterman | 4743258 | 2018-01-25 16:56:45 -0800 | [diff] [blame] | 43 | import org.onosproject.store.primitives.resources.impl.AtomixDistributedLockService; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 44 | import org.onosproject.store.primitives.resources.impl.AtomixDocumentTreeService; |
| 45 | import org.onosproject.store.primitives.resources.impl.AtomixLeaderElectorService; |
| 46 | import org.onosproject.store.primitives.resources.impl.AtomixWorkQueueService; |
| 47 | import org.onosproject.store.service.DistributedPrimitive; |
Jordan Halterman | d0d8035 | 2017-08-10 15:08:27 -0700 | [diff] [blame] | 48 | import org.onosproject.store.service.Ordering; |
Madan Jampani | e14a09c | 2016-02-11 10:43:21 -0800 | [diff] [blame] | 49 | import org.onosproject.store.service.PartitionInfo; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 50 | import org.onosproject.store.service.Serializer; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 51 | |
| 52 | /** |
| 53 | * Storage partition. |
| 54 | */ |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 55 | public abstract class StoragePartition implements Managed<StoragePartition> { |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 56 | |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 57 | static final String PARTITIONS_DIR = |
| 58 | System.getProperty("karaf.data") + "/db/partitions/"; |
| 59 | |
| 60 | protected final AtomicBoolean isOpened = new AtomicBoolean(false); |
| 61 | protected final ClusterCommunicationService clusterCommunicator; |
| 62 | protected Partition partition; |
| 63 | protected NodeId localNodeId; |
| 64 | protected StoragePartitionServer server; |
| 65 | protected StoragePartitionClient client; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 66 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 67 | public static final Map<String, Supplier<RaftService>> RAFT_SERVICES = |
| 68 | ImmutableMap.<String, Supplier<RaftService>>builder() |
| 69 | .put(DistributedPrimitive.Type.CONSISTENT_MAP.name(), AtomixConsistentMapService::new) |
| 70 | .put(DistributedPrimitive.Type.CONSISTENT_TREEMAP.name(), AtomixConsistentTreeMapService::new) |
| 71 | .put(DistributedPrimitive.Type.CONSISTENT_MULTIMAP.name(), AtomixConsistentSetMultimapService::new) |
| 72 | .put(DistributedPrimitive.Type.COUNTER_MAP.name(), AtomixAtomicCounterMapService::new) |
| 73 | .put(DistributedPrimitive.Type.COUNTER.name(), AtomixCounterService::new) |
| 74 | .put(DistributedPrimitive.Type.LEADER_ELECTOR.name(), AtomixLeaderElectorService::new) |
| 75 | .put(DistributedPrimitive.Type.WORK_QUEUE.name(), AtomixWorkQueueService::new) |
Jordan Halterman | d0d8035 | 2017-08-10 15:08:27 -0700 | [diff] [blame] | 76 | .put(DistributedPrimitive.Type.DOCUMENT_TREE.name(), |
| 77 | () -> new AtomixDocumentTreeService(Ordering.NATURAL)) |
| 78 | .put(String.format("%s-%s", DistributedPrimitive.Type.DOCUMENT_TREE.name(), Ordering.NATURAL), |
| 79 | () -> new AtomixDocumentTreeService(Ordering.NATURAL)) |
| 80 | .put(String.format("%s-%s", DistributedPrimitive.Type.DOCUMENT_TREE.name(), Ordering.INSERTION), |
| 81 | () -> new AtomixDocumentTreeService(Ordering.INSERTION)) |
Jordan Halterman | 4743258 | 2018-01-25 16:56:45 -0800 | [diff] [blame] | 82 | .put(DistributedPrimitive.Type.LOCK.name(), AtomixDistributedLockService::new) |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 83 | .build(); |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 84 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 85 | public StoragePartition( |
| 86 | Partition partition, |
Jordan Halterman | 28183ee | 2017-10-17 17:29:10 -0700 | [diff] [blame] | 87 | ClusterCommunicationService clusterCommunicator, |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 88 | ClusterService clusterService) { |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 89 | this.partition = partition; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 90 | this.clusterCommunicator = clusterCommunicator; |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 91 | this.localNodeId = clusterService.getLocalNode().id(); |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 92 | } |
| 93 | |
Madan Jampani | 3a9911c | 2016-02-21 11:25:45 -0800 | [diff] [blame] | 94 | /** |
| 95 | * Returns the partition client instance. |
| 96 | * @return client |
| 97 | */ |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 98 | public StoragePartitionClient client() { |
| 99 | return client; |
| 100 | } |
| 101 | |
| 102 | @Override |
| 103 | public CompletableFuture<Void> open() { |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 104 | if (partition.getMembers().contains(localNodeId)) { |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 105 | return openServer() |
| 106 | .thenCompose(v -> openClient()) |
| 107 | .thenAccept(v -> isOpened.set(true)) |
| 108 | .thenApply(v -> null); |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 109 | } |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 110 | return openClient() |
| 111 | .thenAccept(v -> isOpened.set(true)) |
| 112 | .thenApply(v -> null); |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 113 | } |
| 114 | |
| 115 | @Override |
| 116 | public CompletableFuture<Void> close() { |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 117 | // We do not explicitly close the server and instead let the cluster |
| 118 | // deal with this as an unclean exit. |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 119 | return closeClient(); |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 120 | } |
| 121 | |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 122 | /** |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 123 | * Deletes the partition. |
| 124 | * |
| 125 | * @return future to be completed once the partition has been deleted |
| 126 | */ |
| 127 | public CompletableFuture<Void> delete() { |
| 128 | return closeServer().thenCompose(v -> closeClient()).thenRun(() -> deleteServer()); |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * Returns the partition data folder. |
| 133 | * |
| 134 | * @return the partition data folder |
| 135 | */ |
| 136 | public abstract File getDataFolder(); |
| 137 | |
| 138 | /** |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 139 | * Returns the partition name. |
| 140 | * |
| 141 | * @return the partition name |
| 142 | */ |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 143 | public abstract String getName(); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 144 | |
| 145 | /** |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 146 | * Returns the identifier of the {@link Partition partition} associated with this instance. |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 147 | * |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 148 | * @return partition identifier |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 149 | */ |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 150 | public PartitionId getId() { |
| 151 | return partition.getId(); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Returns the partition version. |
| 156 | * |
| 157 | * @return the partition version |
| 158 | */ |
| 159 | public Version getVersion() { |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 160 | return partition.getVersion(); |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 161 | } |
| 162 | |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 163 | /** |
| 164 | * Returns the identifiers of partition members. |
| 165 | * @return partition member instance ids |
| 166 | */ |
| 167 | public Collection<NodeId> getMembers() { |
| 168 | return partition.getMembers(); |
| 169 | } |
| 170 | |
| 171 | /** |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 172 | * Returns the {@link MemberId identifiers} of partition members. |
| 173 | * @return partition member identifiers |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 174 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 175 | public Collection<MemberId> getMemberIds() { |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 176 | return Collections2.transform(getMembers(), n -> MemberId.from(n.id())); |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 177 | } |
| 178 | |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 179 | /** |
| 180 | * Attempts to rejoin the partition. |
| 181 | * @return future that is completed after the operation is complete |
| 182 | */ |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 183 | protected abstract CompletableFuture<Void> openServer(); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 184 | |
| 185 | /** |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 186 | * Attempts to join the partition as a new member. |
| 187 | * @return future that is completed after the operation is complete |
| 188 | */ |
| 189 | private CompletableFuture<Void> joinCluster() { |
| 190 | Set<NodeId> otherMembers = partition.getMembers() |
| 191 | .stream() |
| 192 | .filter(nodeId -> !nodeId.equals(localNodeId)) |
| 193 | .collect(Collectors.toSet()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 194 | StoragePartitionServer server = new StoragePartitionServer(this, |
| 195 | MemberId.from(localNodeId.id()), |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 196 | clusterCommunicator); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 197 | return server.join(Collections2.transform(otherMembers, n -> MemberId.from(n.id()))) |
| 198 | .thenRun(() -> this.server = server); |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 199 | } |
| 200 | |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 201 | private CompletableFuture<StoragePartitionClient> openClient() { |
| 202 | client = new StoragePartitionClient(this, |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 203 | MemberId.from(localNodeId.id()), |
| 204 | new RaftClientCommunicator( |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 205 | String.format("partition-%s-%s", partition.getId(), partition.getVersion()), |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 206 | Serializer.using(StorageNamespaces.RAFT_PROTOCOL), |
| 207 | clusterCommunicator)); |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 208 | return client.open().thenApply(v -> client); |
| 209 | } |
| 210 | |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 211 | /** |
| 212 | * Closes the partition server if it was previously opened. |
| 213 | * @return future that is completed when the operation completes |
| 214 | */ |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 215 | public CompletableFuture<Void> leaveCluster() { |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 216 | return server != null |
| 217 | ? server.closeAndExit().thenRun(() -> server.delete()) |
| 218 | : CompletableFuture.completedFuture(null); |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 219 | } |
| 220 | |
| 221 | @Override |
| 222 | public boolean isOpen() { |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 223 | return isOpened.get(); |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 224 | } |
| 225 | |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 226 | private CompletableFuture<Void> closeServer() { |
| 227 | if (server != null) { |
| 228 | return server.close(); |
| 229 | } |
| 230 | return CompletableFuture.completedFuture(null); |
| 231 | } |
| 232 | |
| 233 | private void deleteServer() { |
| 234 | if (server != null) { |
| 235 | server.delete(); |
| 236 | } |
| 237 | } |
| 238 | |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 239 | private CompletableFuture<Void> closeClient() { |
| 240 | if (client != null) { |
| 241 | return client.close(); |
| 242 | } |
| 243 | return CompletableFuture.completedFuture(null); |
| 244 | } |
| 245 | |
Madan Jampani | e14a09c | 2016-02-11 10:43:21 -0800 | [diff] [blame] | 246 | /** |
| 247 | * Returns the partition information if this partition is locally managed i.e. |
| 248 | * this node is a active member of the partition. |
| 249 | * @return partition info |
| 250 | */ |
| 251 | public Optional<PartitionInfo> info() { |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 252 | return server != null && server.isOpen() ? Optional.of(server.info()) : Optional.empty(); |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 253 | } |
| 254 | |
Jon Hall | 1195afb | 2016-06-28 18:54:07 -0700 | [diff] [blame] | 255 | /** |
| 256 | * Process updates to partitions and handles joining or leaving a partition. |
| 257 | * @param newValue new Partition |
| 258 | */ |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 259 | void onUpdate(Partition newValue) { |
Jon Hall | 1195afb | 2016-06-28 18:54:07 -0700 | [diff] [blame] | 260 | boolean wasPresent = partition.getMembers().contains(localNodeId); |
| 261 | boolean isPresent = newValue.getMembers().contains(localNodeId); |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 262 | this.partition = newValue; |
Jon Hall | 1195afb | 2016-06-28 18:54:07 -0700 | [diff] [blame] | 263 | if ((wasPresent && isPresent) || (!wasPresent && !isPresent)) { |
| 264 | // no action needed |
| 265 | return; |
| 266 | } |
Jordan Halterman | 07f052b | 2017-10-08 14:22:41 -0700 | [diff] [blame] | 267 | // Only need to do action if our membership changed |
Jon Hall | 1195afb | 2016-06-28 18:54:07 -0700 | [diff] [blame] | 268 | if (wasPresent) { |
Madan Jampani | f172d40 | 2016-03-04 00:56:38 -0800 | [diff] [blame] | 269 | leaveCluster(); |
Ray Milkey | fe0e085 | 2018-01-18 11:14:05 -0800 | [diff] [blame] | 270 | } else { |
Jon Hall | 1195afb | 2016-06-28 18:54:07 -0700 | [diff] [blame] | 271 | joinCluster(); |
Madan Jampani | 3354745 | 2016-02-29 16:45:04 -0800 | [diff] [blame] | 272 | } |
Madan Jampani | e14a09c | 2016-02-11 10:43:21 -0800 | [diff] [blame] | 273 | } |
Madan Jampani | 15b8ef5 | 2016-02-02 17:35:05 -0800 | [diff] [blame] | 274 | } |