Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -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.resources.impl; |
| 17 | |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 18 | import io.atomix.copycat.client.CopycatClient; |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 19 | import io.atomix.resource.AbstractResource; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 20 | import io.atomix.resource.ResourceTypeInfo; |
| 21 | |
| 22 | import java.util.Collection; |
| 23 | import java.util.ConcurrentModificationException; |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 24 | import java.util.List; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 25 | import java.util.Map.Entry; |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 26 | import java.util.Properties; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 27 | import java.util.Set; |
| 28 | import java.util.concurrent.CompletableFuture; |
| 29 | import java.util.concurrent.atomic.AtomicReference; |
| 30 | import java.util.function.BiFunction; |
| 31 | import java.util.function.Predicate; |
| 32 | |
| 33 | import org.onlab.util.Match; |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 34 | import org.onosproject.store.primitives.TransactionId; |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 35 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.Clear; |
| 36 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.ContainsKey; |
| 37 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.ContainsValue; |
| 38 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.EntrySet; |
| 39 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.Get; |
| 40 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.IsEmpty; |
| 41 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.KeySet; |
| 42 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.Listen; |
| 43 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.Size; |
| 44 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.TransactionCommit; |
| 45 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.TransactionPrepare; |
Madan Jampani | 542d9e2 | 2016-04-05 15:39:55 -0700 | [diff] [blame] | 46 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.TransactionPrepareAndCommit; |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 47 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.TransactionRollback; |
| 48 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.Unlisten; |
| 49 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.UpdateAndGet; |
| 50 | import org.onosproject.store.primitives.resources.impl.AtomixConsistentMapCommands.Values; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 51 | import org.onosproject.store.service.AsyncConsistentMap; |
| 52 | import org.onosproject.store.service.MapEvent; |
| 53 | import org.onosproject.store.service.MapEventListener; |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 54 | import org.onosproject.store.service.MapTransaction; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 55 | import org.onosproject.store.service.Versioned; |
| 56 | |
| 57 | import com.google.common.collect.Sets; |
| 58 | |
| 59 | /** |
| 60 | * Distributed resource providing the {@link AsyncConsistentMap} primitive. |
| 61 | */ |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 62 | @ResourceTypeInfo(id = -151, factory = AtomixConsistentMapFactory.class) |
| 63 | public class AtomixConsistentMap extends AbstractResource<AtomixConsistentMap> |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 64 | implements AsyncConsistentMap<String, byte[]> { |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 65 | |
| 66 | private final Set<MapEventListener<String, byte[]>> mapEventListeners = Sets.newCopyOnWriteArraySet(); |
| 67 | |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 68 | public static final String CHANGE_SUBJECT = "changeEvents"; |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 69 | |
Madan Jampani | 65f24bb | 2016-03-15 15:16:18 -0700 | [diff] [blame] | 70 | public AtomixConsistentMap(CopycatClient client, Properties properties) { |
| 71 | super(client, properties); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 72 | } |
| 73 | |
| 74 | @Override |
| 75 | public String name() { |
| 76 | return null; |
| 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public CompletableFuture<AtomixConsistentMap> open() { |
| 81 | return super.open().thenApply(result -> { |
Madan Jampani | 3a9911c | 2016-02-21 11:25:45 -0800 | [diff] [blame] | 82 | client.onEvent(CHANGE_SUBJECT, this::handleEvent); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 83 | return result; |
| 84 | }); |
| 85 | } |
| 86 | |
Madan Jampani | fc98177 | 2016-02-16 09:46:42 -0800 | [diff] [blame] | 87 | private void handleEvent(List<MapEvent<String, byte[]>> events) { |
Madan Jampani | 3780d4b | 2016-04-04 18:18:24 -0700 | [diff] [blame] | 88 | events.forEach(event -> mapEventListeners.forEach(listener -> listener.event(event))); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | @Override |
| 92 | public CompletableFuture<Boolean> isEmpty() { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 93 | return submit(new IsEmpty()); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | @Override |
| 97 | public CompletableFuture<Integer> size() { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 98 | return submit(new Size()); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public CompletableFuture<Boolean> containsKey(String key) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 103 | return submit(new ContainsKey(key)); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public CompletableFuture<Boolean> containsValue(byte[] value) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 108 | return submit(new ContainsValue(value)); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 109 | } |
| 110 | |
| 111 | @Override |
| 112 | public CompletableFuture<Versioned<byte[]>> get(String key) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 113 | return submit(new Get(key)); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
| 117 | public CompletableFuture<Set<String>> keySet() { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 118 | return submit(new KeySet()); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public CompletableFuture<Collection<Versioned<byte[]>>> values() { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 123 | return submit(new Values()); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | @Override |
| 127 | public CompletableFuture<Set<Entry<String, Versioned<byte[]>>>> entrySet() { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 128 | return submit(new EntrySet()); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | @Override |
| 132 | @SuppressWarnings("unchecked") |
| 133 | public CompletableFuture<Versioned<byte[]>> put(String key, byte[] value) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 134 | return submit(new UpdateAndGet(key, value, Match.ANY, Match.ANY)) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 135 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 136 | .thenApply(v -> v.oldValue()); |
| 137 | } |
| 138 | |
| 139 | @Override |
| 140 | @SuppressWarnings("unchecked") |
| 141 | public CompletableFuture<Versioned<byte[]>> putAndGet(String key, byte[] value) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 142 | return submit(new UpdateAndGet(key, value, Match.ANY, Match.ANY)) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 143 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 144 | .thenApply(v -> v.newValue()); |
| 145 | } |
| 146 | |
| 147 | @Override |
| 148 | @SuppressWarnings("unchecked") |
| 149 | public CompletableFuture<Versioned<byte[]>> putIfAbsent(String key, byte[] value) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 150 | return submit(new UpdateAndGet(key, value, Match.NULL, Match.ANY)) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 151 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 152 | .thenApply(v -> v.oldValue()); |
| 153 | } |
| 154 | @Override |
| 155 | @SuppressWarnings("unchecked") |
| 156 | public CompletableFuture<Versioned<byte[]>> remove(String key) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 157 | return submit(new UpdateAndGet(key, null, Match.ANY, Match.ANY)) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 158 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 159 | .thenApply(v -> v.oldValue()); |
| 160 | } |
| 161 | |
| 162 | @Override |
| 163 | @SuppressWarnings("unchecked") |
| 164 | public CompletableFuture<Boolean> remove(String key, byte[] value) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 165 | return submit(new UpdateAndGet(key, null, Match.ifValue(value), Match.ANY)) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 166 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 167 | .thenApply(v -> v.updated()); |
| 168 | } |
| 169 | |
| 170 | @Override |
| 171 | @SuppressWarnings("unchecked") |
| 172 | public CompletableFuture<Boolean> remove(String key, long version) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 173 | return submit(new UpdateAndGet(key, null, Match.ANY, Match.ifValue(version))) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 174 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 175 | .thenApply(v -> v.updated()); |
| 176 | } |
| 177 | |
| 178 | @Override |
| 179 | @SuppressWarnings("unchecked") |
| 180 | public CompletableFuture<Versioned<byte[]>> replace(String key, byte[] value) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 181 | return submit(new UpdateAndGet(key, value, Match.NOT_NULL, Match.ANY)) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 182 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 183 | .thenApply(v -> v.oldValue()); |
| 184 | } |
| 185 | |
| 186 | @Override |
| 187 | @SuppressWarnings("unchecked") |
| 188 | public CompletableFuture<Boolean> replace(String key, byte[] oldValue, byte[] newValue) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 189 | return submit(new UpdateAndGet(key, |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 190 | newValue, |
| 191 | Match.ifValue(oldValue), |
| 192 | Match.ANY)) |
| 193 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 194 | .thenApply(v -> v.updated()); |
| 195 | } |
| 196 | |
| 197 | @Override |
| 198 | @SuppressWarnings("unchecked") |
| 199 | public CompletableFuture<Boolean> replace(String key, long oldVersion, byte[] newValue) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 200 | return submit(new UpdateAndGet(key, |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 201 | newValue, |
| 202 | Match.ANY, |
| 203 | Match.ifValue(oldVersion))) |
| 204 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 205 | .thenApply(v -> v.updated()); |
| 206 | } |
| 207 | |
| 208 | @Override |
| 209 | public CompletableFuture<Void> clear() { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 210 | return submit(new Clear()) |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 211 | .whenComplete((r, e) -> throwIfLocked(r)) |
| 212 | .thenApply(v -> null); |
| 213 | } |
| 214 | |
| 215 | @Override |
| 216 | @SuppressWarnings("unchecked") |
| 217 | public CompletableFuture<Versioned<byte[]>> computeIf(String key, |
| 218 | Predicate<? super byte[]> condition, |
| 219 | BiFunction<? super String, ? super byte[], ? extends byte[]> remappingFunction) { |
| 220 | return get(key).thenCompose(r1 -> { |
| 221 | byte[] existingValue = r1 == null ? null : r1.value(); |
| 222 | // if the condition evaluates to false, return existing value. |
| 223 | if (!condition.test(existingValue)) { |
| 224 | return CompletableFuture.completedFuture(r1); |
| 225 | } |
| 226 | |
| 227 | AtomicReference<byte[]> computedValue = new AtomicReference<>(); |
| 228 | // if remappingFunction throws an exception, return the exception. |
| 229 | try { |
| 230 | computedValue.set(remappingFunction.apply(key, existingValue)); |
| 231 | } catch (Exception e) { |
| 232 | CompletableFuture<Versioned<byte[]>> future = new CompletableFuture<>(); |
| 233 | future.completeExceptionally(e); |
| 234 | return future; |
| 235 | } |
| 236 | if (computedValue.get() == null && r1 == null) { |
| 237 | return CompletableFuture.completedFuture(null); |
| 238 | } |
| 239 | Match<byte[]> valueMatch = r1 == null ? Match.NULL : Match.ANY; |
| 240 | Match<Long> versionMatch = r1 == null ? Match.ANY : Match.ifValue(r1.version()); |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 241 | return submit(new UpdateAndGet(key, |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 242 | computedValue.get(), |
| 243 | valueMatch, |
| 244 | versionMatch)) |
| 245 | .whenComplete((r, e) -> throwIfLocked(r.status())) |
| 246 | .thenApply(v -> v.newValue()); |
| 247 | }); |
| 248 | } |
| 249 | |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 250 | @Override |
| 251 | public synchronized CompletableFuture<Void> addListener(MapEventListener<String, byte[]> listener) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 252 | if (mapEventListeners.isEmpty()) { |
| 253 | return submit(new Listen()).thenRun(() -> mapEventListeners.add(listener)); |
| 254 | } else { |
Madan Jampani | 40f022e | 2016-03-02 21:35:14 -0800 | [diff] [blame] | 255 | mapEventListeners.add(listener); |
| 256 | return CompletableFuture.completedFuture(null); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 257 | } |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | @Override |
| 261 | public synchronized CompletableFuture<Void> removeListener(MapEventListener<String, byte[]> listener) { |
| 262 | if (mapEventListeners.remove(listener) && mapEventListeners.isEmpty()) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 263 | return submit(new Unlisten()).thenApply(v -> null); |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 264 | } |
| 265 | return CompletableFuture.completedFuture(null); |
| 266 | } |
| 267 | |
| 268 | private void throwIfLocked(MapEntryUpdateResult.Status status) { |
| 269 | if (status == MapEntryUpdateResult.Status.WRITE_LOCK) { |
| 270 | throw new ConcurrentModificationException("Cannot update map: Another transaction in progress"); |
| 271 | } |
| 272 | } |
| 273 | |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 274 | @Override |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 275 | public CompletableFuture<Boolean> prepare(MapTransaction<String, byte[]> transaction) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 276 | return submit(new TransactionPrepare(transaction)).thenApply(v -> v == PrepareResult.OK); |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 277 | } |
| 278 | |
| 279 | @Override |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 280 | public CompletableFuture<Void> commit(TransactionId transactionId) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 281 | return submit(new TransactionCommit(transactionId)).thenApply(v -> null); |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 282 | } |
| 283 | |
| 284 | @Override |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 285 | public CompletableFuture<Void> rollback(TransactionId transactionId) { |
Madan Jampani | 27a2a3d | 2016-03-03 08:46:24 -0800 | [diff] [blame] | 286 | return submit(new TransactionRollback(transactionId)) |
Madan Jampani | 74da78b | 2016-02-09 21:18:36 -0800 | [diff] [blame] | 287 | .thenApply(v -> null); |
Madan Jampani | cadd70b | 2016-02-08 13:45:43 -0800 | [diff] [blame] | 288 | } |
Madan Jampani | 542d9e2 | 2016-04-05 15:39:55 -0700 | [diff] [blame] | 289 | |
| 290 | @Override |
| 291 | public CompletableFuture<Boolean> prepareAndCommit(MapTransaction<String, byte[]> transaction) { |
| 292 | return submit(new TransactionPrepareAndCommit(transaction)).thenApply(v -> v == PrepareResult.OK); |
| 293 | } |
Madan Jampani | 5e5b3d6 | 2016-02-01 16:03:33 -0800 | [diff] [blame] | 294 | } |