Madan Jampani | 2546111 | 2015-02-17 14:17:29 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 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 | |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 17 | package org.onosproject.store.consistent.impl; |
| 18 | |
| 19 | import java.util.Arrays; |
| 20 | import java.util.Collection; |
Madan Jampani | a89f8f9 | 2015-04-01 14:39:54 -0700 | [diff] [blame] | 21 | import java.util.HashSet; |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 22 | import java.util.Map; |
| 23 | import java.util.Map.Entry; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 24 | import java.util.stream.Collectors; |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 25 | import java.util.Set; |
| 26 | |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 27 | import org.apache.commons.lang3.tuple.Pair; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 28 | import org.onosproject.store.service.DatabaseUpdate; |
| 29 | import org.onosproject.store.service.Transaction; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 30 | import org.onosproject.store.service.Versioned; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 31 | import org.onosproject.store.service.DatabaseUpdate.Type; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 32 | |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 33 | import com.google.common.base.Objects; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 34 | import com.google.common.collect.ImmutableList; |
| 35 | import com.google.common.collect.ImmutableSet; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 36 | import com.google.common.collect.Maps; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 37 | |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 38 | import net.kuujo.copycat.state.Initializer; |
| 39 | import net.kuujo.copycat.state.StateContext; |
| 40 | |
| 41 | /** |
| 42 | * Default database state. |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 43 | */ |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 44 | public class DefaultDatabaseState implements DatabaseState<String, byte[]> { |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 45 | private Long nextVersion; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 46 | private Map<String, Map<String, Versioned<byte[]>>> tables; |
| 47 | |
| 48 | /** |
| 49 | * This locks map has a structure similar to the "tables" map above and |
| 50 | * holds all the provisional updates made during a transaction's prepare phase. |
| 51 | * The entry value is represented as the tuple: (transactionId, newValue) |
| 52 | * If newValue == null that signifies this update is attempting to |
| 53 | * delete the existing value. |
| 54 | * This map also serves as a lock on the entries that are being updated. |
| 55 | * The presence of a entry in this map indicates that element is |
| 56 | * participating in a transaction and is currently locked for updates. |
| 57 | */ |
| 58 | private Map<String, Map<String, Pair<Long, byte[]>>> locks; |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 59 | |
| 60 | @Initializer |
| 61 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 62 | public void init(StateContext<DatabaseState<String, byte[]>> context) { |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 63 | tables = context.get("tables"); |
| 64 | if (tables == null) { |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 65 | tables = Maps.newConcurrentMap(); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 66 | context.put("tables", tables); |
| 67 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 68 | locks = context.get("locks"); |
| 69 | if (locks == null) { |
| 70 | locks = Maps.newConcurrentMap(); |
| 71 | context.put("locks", locks); |
| 72 | } |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 73 | nextVersion = context.get("nextVersion"); |
| 74 | if (nextVersion == null) { |
| 75 | nextVersion = new Long(0); |
| 76 | context.put("nextVersion", nextVersion); |
| 77 | } |
| 78 | } |
| 79 | |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 80 | @Override |
Madan Jampani | a89f8f9 | 2015-04-01 14:39:54 -0700 | [diff] [blame] | 81 | public Set<String> tableNames() { |
| 82 | return new HashSet<>(tables.keySet()); |
| 83 | } |
| 84 | |
| 85 | @Override |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 86 | public int size(String tableName) { |
| 87 | return getTableMap(tableName).size(); |
| 88 | } |
| 89 | |
| 90 | @Override |
| 91 | public boolean isEmpty(String tableName) { |
| 92 | return getTableMap(tableName).isEmpty(); |
| 93 | } |
| 94 | |
| 95 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 96 | public boolean containsKey(String tableName, String key) { |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 97 | return getTableMap(tableName).containsKey(key); |
| 98 | } |
| 99 | |
| 100 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 101 | public boolean containsValue(String tableName, byte[] value) { |
| 102 | return getTableMap(tableName).values().stream().anyMatch(v -> Arrays.equals(v.value(), value)); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 106 | public Versioned<byte[]> get(String tableName, String key) { |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 107 | return getTableMap(tableName).get(key); |
| 108 | } |
| 109 | |
| 110 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 111 | public Result<Versioned<byte[]>> put(String tableName, String key, byte[] value) { |
| 112 | return isLockedForUpdates(tableName, key) |
| 113 | ? Result.locked() |
| 114 | : Result.ok(getTableMap(tableName).put(key, new Versioned<>(value, ++nextVersion))); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 118 | public Result<Versioned<byte[]>> remove(String tableName, String key) { |
| 119 | return isLockedForUpdates(tableName, key) |
| 120 | ? Result.locked() |
| 121 | : Result.ok(getTableMap(tableName).remove(key)); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 125 | public Result<Void> clear(String tableName) { |
| 126 | if (areTransactionsInProgress(tableName)) { |
| 127 | return Result.locked(); |
| 128 | } |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 129 | getTableMap(tableName).clear(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 130 | return Result.ok(null); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 134 | public Set<String> keySet(String tableName) { |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 135 | return ImmutableSet.copyOf(getTableMap(tableName).keySet()); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 139 | public Collection<Versioned<byte[]>> values(String tableName) { |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 140 | return ImmutableList.copyOf(getTableMap(tableName).values()); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 144 | public Set<Entry<String, Versioned<byte[]>>> entrySet(String tableName) { |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 145 | return ImmutableSet.copyOf(getTableMap(tableName) |
| 146 | .entrySet() |
| 147 | .stream() |
| 148 | .map(entry -> Pair.of(entry.getKey(), entry.getValue())) |
| 149 | .collect(Collectors.toSet())); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 150 | } |
| 151 | |
| 152 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 153 | public Result<Versioned<byte[]>> putIfAbsent(String tableName, String key, byte[] value) { |
| 154 | if (isLockedForUpdates(tableName, key)) { |
| 155 | return Result.locked(); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 156 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 157 | Versioned<byte[]> existingValue = get(tableName, key); |
| 158 | Versioned<byte[]> currentValue = existingValue != null ? existingValue : put(tableName, key, value).value(); |
| 159 | return Result.ok(currentValue); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 163 | public Result<Boolean> remove(String tableName, String key, byte[] value) { |
| 164 | if (isLockedForUpdates(tableName, key)) { |
| 165 | return Result.locked(); |
| 166 | } |
| 167 | Versioned<byte[]> existing = get(tableName, key); |
| 168 | if (existing != null && Arrays.equals(existing.value(), value)) { |
| 169 | getTableMap(tableName).remove(key); |
| 170 | return Result.ok(true); |
| 171 | } |
| 172 | return Result.ok(false); |
| 173 | } |
| 174 | |
| 175 | @Override |
| 176 | public Result<Boolean> remove(String tableName, String key, long version) { |
| 177 | if (isLockedForUpdates(tableName, key)) { |
| 178 | return Result.locked(); |
| 179 | } |
| 180 | Versioned<byte[]> existing = get(tableName, key); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 181 | if (existing != null && existing.version() == version) { |
| 182 | remove(tableName, key); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 183 | return Result.ok(true); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 184 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 185 | return Result.ok(false); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 189 | public Result<Boolean> replace(String tableName, String key, byte[] oldValue, byte[] newValue) { |
| 190 | if (isLockedForUpdates(tableName, key)) { |
| 191 | return Result.locked(); |
| 192 | } |
| 193 | Versioned<byte[]> existing = get(tableName, key); |
| 194 | if (existing != null && Arrays.equals(existing.value(), oldValue)) { |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 195 | put(tableName, key, newValue); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 196 | return Result.ok(true); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 197 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 198 | return Result.ok(false); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 199 | } |
| 200 | |
| 201 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 202 | public Result<Boolean> replace(String tableName, String key, long oldVersion, byte[] newValue) { |
| 203 | if (isLockedForUpdates(tableName, key)) { |
| 204 | return Result.locked(); |
| 205 | } |
| 206 | Versioned<byte[]> existing = get(tableName, key); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 207 | if (existing != null && existing.version() == oldVersion) { |
| 208 | put(tableName, key, newValue); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 209 | return Result.ok(true); |
| 210 | } |
| 211 | return Result.ok(false); |
| 212 | } |
| 213 | |
| 214 | @Override |
| 215 | public boolean prepareAndCommit(Transaction transaction) { |
| 216 | if (prepare(transaction)) { |
| 217 | return commit(transaction); |
| 218 | } |
| 219 | return false; |
| 220 | } |
| 221 | |
| 222 | @Override |
| 223 | public boolean prepare(Transaction transaction) { |
| 224 | if (transaction.updates().stream().anyMatch(update -> |
| 225 | isLockedByAnotherTransaction(update.tableName(), |
| 226 | update.key(), |
| 227 | transaction.id()))) { |
| 228 | return false; |
| 229 | } |
| 230 | |
| 231 | if (transaction.updates().stream().allMatch(this::isUpdatePossible)) { |
| 232 | transaction.updates().forEach(update -> doProvisionalUpdate(update, transaction.id())); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 233 | return true; |
| 234 | } |
| 235 | return false; |
| 236 | } |
| 237 | |
| 238 | @Override |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 239 | public boolean commit(Transaction transaction) { |
| 240 | transaction.updates().forEach(update -> commitProvisionalUpdate(update, transaction.id())); |
| 241 | return true; |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 242 | } |
| 243 | |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 244 | @Override |
| 245 | public boolean rollback(Transaction transaction) { |
| 246 | transaction.updates().forEach(update -> undoProvisionalUpdate(update, transaction.id())); |
| 247 | return true; |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 248 | } |
| 249 | |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 250 | private Map<String, Versioned<byte[]>> getTableMap(String tableName) { |
| 251 | return tables.computeIfAbsent(tableName, name -> Maps.newConcurrentMap()); |
| 252 | } |
| 253 | |
| 254 | private Map<String, Pair<Long, byte[]>> getLockMap(String tableName) { |
| 255 | return locks.computeIfAbsent(tableName, name -> Maps.newConcurrentMap()); |
| 256 | } |
| 257 | |
| 258 | private boolean isUpdatePossible(DatabaseUpdate update) { |
| 259 | Versioned<byte[]> existingEntry = get(update.tableName(), update.key()); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 260 | switch (update.type()) { |
| 261 | case PUT: |
| 262 | case REMOVE: |
| 263 | return true; |
| 264 | case PUT_IF_ABSENT: |
| 265 | return existingEntry == null; |
| 266 | case PUT_IF_VERSION_MATCH: |
| 267 | return existingEntry != null && existingEntry.version() == update.currentVersion(); |
| 268 | case PUT_IF_VALUE_MATCH: |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 269 | return existingEntry != null && Arrays.equals(existingEntry.value(), update.currentValue()); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 270 | case REMOVE_IF_VERSION_MATCH: |
| 271 | return existingEntry == null || existingEntry.version() == update.currentVersion(); |
| 272 | case REMOVE_IF_VALUE_MATCH: |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 273 | return existingEntry == null || Arrays.equals(existingEntry.value(), update.currentValue()); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 274 | default: |
| 275 | throw new IllegalStateException("Unsupported type: " + update.type()); |
| 276 | } |
| 277 | } |
| 278 | |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 279 | private void doProvisionalUpdate(DatabaseUpdate update, long transactionId) { |
| 280 | Map<String, Pair<Long, byte[]>> lockMap = getLockMap(update.tableName()); |
| 281 | switch (update.type()) { |
| 282 | case PUT: |
| 283 | case PUT_IF_ABSENT: |
| 284 | case PUT_IF_VERSION_MATCH: |
| 285 | case PUT_IF_VALUE_MATCH: |
| 286 | lockMap.put(update.key(), Pair.of(transactionId, update.value())); |
| 287 | break; |
| 288 | case REMOVE: |
| 289 | case REMOVE_IF_VERSION_MATCH: |
| 290 | case REMOVE_IF_VALUE_MATCH: |
| 291 | lockMap.put(update.key(), null); |
| 292 | break; |
| 293 | default: |
| 294 | throw new IllegalStateException("Unsupported type: " + update.type()); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 295 | } |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame^] | 296 | } |
| 297 | |
| 298 | private void commitProvisionalUpdate(DatabaseUpdate update, long transactionId) { |
| 299 | String tableName = update.tableName(); |
| 300 | String key = update.key(); |
| 301 | Type type = update.type(); |
| 302 | Pair<Long, byte[]> provisionalUpdate = getLockMap(tableName).get(key); |
| 303 | if (Objects.equal(transactionId, provisionalUpdate.getLeft())) { |
| 304 | getLockMap(tableName).remove(key); |
| 305 | } else { |
| 306 | return; |
| 307 | } |
| 308 | |
| 309 | switch (type) { |
| 310 | case PUT: |
| 311 | case PUT_IF_ABSENT: |
| 312 | case PUT_IF_VERSION_MATCH: |
| 313 | case PUT_IF_VALUE_MATCH: |
| 314 | put(tableName, key, provisionalUpdate.getRight()); |
| 315 | break; |
| 316 | case REMOVE: |
| 317 | case REMOVE_IF_VERSION_MATCH: |
| 318 | case REMOVE_IF_VALUE_MATCH: |
| 319 | remove(tableName, key); |
| 320 | break; |
| 321 | default: |
| 322 | break; |
| 323 | } |
| 324 | } |
| 325 | |
| 326 | private void undoProvisionalUpdate(DatabaseUpdate update, long transactionId) { |
| 327 | String tableName = update.tableName(); |
| 328 | String key = update.key(); |
| 329 | Pair<Long, byte[]> provisionalUpdate = getLockMap(tableName).get(key); |
| 330 | if (provisionalUpdate == null) { |
| 331 | return; |
| 332 | } |
| 333 | if (Objects.equal(transactionId, provisionalUpdate.getLeft())) { |
| 334 | getLockMap(tableName).remove(key); |
| 335 | } |
| 336 | } |
| 337 | |
| 338 | private boolean isLockedByAnotherTransaction(String tableName, String key, long transactionId) { |
| 339 | Pair<Long, byte[]> update = getLockMap(tableName).get(key); |
| 340 | return update != null && !Objects.equal(transactionId, update.getLeft()); |
| 341 | } |
| 342 | |
| 343 | private boolean isLockedForUpdates(String tableName, String key) { |
| 344 | return getLockMap(tableName).containsKey(key); |
| 345 | } |
| 346 | |
| 347 | private boolean areTransactionsInProgress(String tableName) { |
| 348 | return !getLockMap(tableName).isEmpty(); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 349 | } |
| 350 | } |