Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 1 | package org.onlab.onos.store.service.impl; |
| 2 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 3 | import static org.slf4j.LoggerFactory.getLogger; |
| 4 | |
Ray Milkey | 241b96a | 2014-11-17 13:08:20 -0800 | [diff] [blame] | 5 | import java.nio.charset.StandardCharsets; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 6 | import java.util.UUID; |
| 7 | import java.util.concurrent.CompletableFuture; |
| 8 | import java.util.concurrent.ExecutionException; |
| 9 | import java.util.concurrent.TimeUnit; |
| 10 | import java.util.concurrent.TimeoutException; |
| 11 | import java.util.concurrent.atomic.AtomicBoolean; |
| 12 | |
| 13 | import org.joda.time.DateTime; |
| 14 | import org.onlab.onos.cluster.ClusterService; |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 15 | import org.onlab.onos.store.service.DatabaseException; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 16 | import org.onlab.onos.store.service.DatabaseService; |
| 17 | import org.onlab.onos.store.service.Lock; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 18 | import org.slf4j.Logger; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 19 | |
| 20 | /** |
| 21 | * A distributed lock implementation. |
| 22 | */ |
| 23 | public class DistributedLock implements Lock { |
| 24 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 25 | private final Logger log = getLogger(getClass()); |
| 26 | |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 27 | private final DistributedLockManager lockManager; |
| 28 | private final DatabaseService databaseService; |
| 29 | private final String path; |
| 30 | private DateTime lockExpirationTime; |
| 31 | private AtomicBoolean isLocked = new AtomicBoolean(false); |
| 32 | private byte[] lockId; |
| 33 | |
| 34 | public DistributedLock( |
| 35 | String path, |
| 36 | DatabaseService databaseService, |
| 37 | ClusterService clusterService, |
| 38 | DistributedLockManager lockManager) { |
| 39 | |
| 40 | this.path = path; |
| 41 | this.databaseService = databaseService; |
| 42 | this.lockManager = lockManager; |
| 43 | this.lockId = |
Ray Milkey | 241b96a | 2014-11-17 13:08:20 -0800 | [diff] [blame] | 44 | (UUID.randomUUID().toString() + "::" + |
| 45 | clusterService.getLocalNode().id().toString()). |
| 46 | getBytes(StandardCharsets.UTF_8); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | @Override |
| 50 | public String path() { |
| 51 | return path; |
| 52 | } |
| 53 | |
| 54 | @Override |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 55 | public void lock(int leaseDurationMillis) throws InterruptedException { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 56 | try { |
| 57 | lockAsync(leaseDurationMillis).get(); |
| 58 | } catch (ExecutionException e) { |
| 59 | throw new DatabaseException(e); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 60 | } |
| 61 | } |
| 62 | |
| 63 | @Override |
Madan Jampani | 1d3494e | 2014-11-20 11:24:22 -0800 | [diff] [blame^] | 64 | public CompletableFuture<Void> lockAsync(int leaseDurationMillis) { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 65 | if (isLocked() || tryLock(leaseDurationMillis)) { |
| 66 | return CompletableFuture.<Void>completedFuture(null); |
| 67 | } |
| 68 | return lockManager.lockIfAvailable(this, leaseDurationMillis); |
| 69 | } |
| 70 | |
| 71 | @Override |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 72 | public boolean tryLock(int leaseDurationMillis) { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 73 | if (databaseService.putIfAbsent( |
Madan Jampani | c22123d | 2014-11-12 02:12:19 -0800 | [diff] [blame] | 74 | DistributedLockManager.ONOS_LOCK_TABLE_NAME, |
| 75 | path, |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 76 | lockId)) { |
| 77 | isLocked.set(true); |
| 78 | lockExpirationTime = DateTime.now().plusMillis(leaseDurationMillis); |
| 79 | return true; |
| 80 | } |
| 81 | return false; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | @Override |
| 85 | public boolean tryLock( |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 86 | int waitTimeMillis, |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 87 | int leaseDurationMillis) throws InterruptedException { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 88 | if (isLocked() || tryLock(leaseDurationMillis)) { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 89 | return true; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 90 | } |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 91 | |
| 92 | CompletableFuture<Void> future = |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 93 | lockManager.lockIfAvailable(this, waitTimeMillis, leaseDurationMillis); |
| 94 | try { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 95 | future.get(waitTimeMillis, TimeUnit.MILLISECONDS); |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 96 | return true; |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 97 | } catch (ExecutionException e) { |
| 98 | throw new DatabaseException(e); |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 99 | } catch (TimeoutException e) { |
| 100 | log.debug("Timed out waiting to acquire lock for {}", path); |
| 101 | return false; |
| 102 | } |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | @Override |
| 106 | public boolean isLocked() { |
| 107 | if (isLocked.get()) { |
| 108 | // We rely on local information to check |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 109 | // if the lock expired. |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 110 | // This should should make this call |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 111 | // light weight, while still retaining the |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 112 | // safety guarantees. |
| 113 | if (DateTime.now().isAfter(lockExpirationTime)) { |
| 114 | isLocked.set(false); |
| 115 | return false; |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 116 | } else { |
| 117 | return true; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 118 | } |
| 119 | } |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 120 | return false; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | @Override |
| 124 | public void unlock() { |
| 125 | if (!isLocked()) { |
| 126 | return; |
| 127 | } else { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 128 | if (databaseService.removeIfValueMatches(DistributedLockManager.ONOS_LOCK_TABLE_NAME, path, lockId)) { |
| 129 | isLocked.set(false); |
| 130 | } |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 131 | } |
| 132 | } |
| 133 | |
| 134 | @Override |
| 135 | public boolean extendExpiration(int leaseDurationMillis) { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 136 | if (!isLocked()) { |
| 137 | log.warn("Ignoring request to extend expiration for lock {}." |
| 138 | + " ExtendExpiration must be called for locks that are already acquired.", path); |
Pavlin Radoslavov | 20ded69 | 2014-11-17 16:03:15 -0800 | [diff] [blame] | 139 | return false; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 140 | } |
| 141 | |
| 142 | if (databaseService.putIfValueMatches( |
| 143 | DistributedLockManager.ONOS_LOCK_TABLE_NAME, |
| 144 | path, |
| 145 | lockId, |
| 146 | lockId)) { |
| 147 | lockExpirationTime = DateTime.now().plusMillis(leaseDurationMillis); |
| 148 | log.debug("Succeeded in extending lock {} expiration time to {}", lockExpirationTime); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 149 | return true; |
| 150 | } else { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 151 | log.info("Failed to extend expiration for {}", path); |
| 152 | return false; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 153 | } |
| 154 | } |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 155 | } |