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.onlab.util.Tools.namedThreads; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 4 | import static org.slf4j.LoggerFactory.getLogger; |
| 5 | |
| 6 | import java.util.Iterator; |
| 7 | import java.util.List; |
| 8 | import java.util.concurrent.CompletableFuture; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 9 | import java.util.concurrent.ExecutorService; |
| 10 | import java.util.concurrent.Executors; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 11 | |
| 12 | import org.apache.felix.scr.annotations.Activate; |
| 13 | import org.apache.felix.scr.annotations.Component; |
| 14 | import org.apache.felix.scr.annotations.Deactivate; |
| 15 | import org.apache.felix.scr.annotations.Reference; |
| 16 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 17 | import org.apache.felix.scr.annotations.Service; |
| 18 | import org.joda.time.DateTime; |
| 19 | import org.onlab.onos.cluster.ClusterService; |
| 20 | import org.onlab.onos.store.cluster.messaging.ClusterCommunicationService; |
| 21 | import org.onlab.onos.store.cluster.messaging.ClusterMessage; |
| 22 | import org.onlab.onos.store.cluster.messaging.ClusterMessageHandler; |
| 23 | import org.onlab.onos.store.service.DatabaseService; |
| 24 | import org.onlab.onos.store.service.Lock; |
| 25 | import org.onlab.onos.store.service.LockEventListener; |
| 26 | import org.onlab.onos.store.service.LockService; |
| 27 | import org.slf4j.Logger; |
| 28 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 29 | import com.google.common.collect.LinkedListMultimap; |
| 30 | import com.google.common.collect.ListMultimap; |
| 31 | import com.google.common.collect.Multimaps; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 32 | |
| 33 | @Component(immediate = true) |
| 34 | @Service |
| 35 | public class DistributedLockManager implements LockService { |
| 36 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 37 | private static final ExecutorService THREAD_POOL = |
| 38 | Executors.newCachedThreadPool(namedThreads("lock-manager-%d")); |
| 39 | |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 40 | private final Logger log = getLogger(getClass()); |
| 41 | |
| 42 | public static final String ONOS_LOCK_TABLE_NAME = "onos-locks"; |
| 43 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 44 | private final ListMultimap<String, LockRequest> locksToAcquire = |
| 45 | Multimaps.synchronizedListMultimap(LinkedListMultimap.<String, LockRequest>create()); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 46 | |
| 47 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 48 | private ClusterCommunicationService clusterCommunicator; |
| 49 | |
| 50 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 51 | private DatabaseService databaseService; |
| 52 | |
| 53 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 54 | private ClusterService clusterService; |
| 55 | |
| 56 | @Activate |
| 57 | public void activate() { |
| 58 | clusterCommunicator.addSubscriber( |
| 59 | DatabaseStateMachine.DATABASE_UPDATE_EVENTS, |
| 60 | new LockEventMessageListener()); |
| 61 | log.info("Started."); |
| 62 | |
| 63 | } |
| 64 | |
| 65 | @Deactivate |
| 66 | public void deactivate() { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 67 | clusterCommunicator.removeSubscriber(DatabaseStateMachine.DATABASE_UPDATE_EVENTS); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 68 | locksToAcquire.clear(); |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 69 | log.info("Stopped."); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | @Override |
| 73 | public Lock create(String path) { |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 74 | return new DistributedLock(path, databaseService, clusterService, this); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | @Override |
| 78 | public void addListener(LockEventListener listener) { |
| 79 | // FIXME: |
| 80 | throw new UnsupportedOperationException(); |
| 81 | } |
| 82 | |
| 83 | @Override |
| 84 | public void removeListener(LockEventListener listener) { |
| 85 | // FIXME: |
| 86 | throw new UnsupportedOperationException(); |
| 87 | } |
| 88 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 89 | /** |
| 90 | * Attempts to acquire the lock as soon as it becomes available. |
| 91 | * @param lock lock to acquire. |
| 92 | * @param waitTimeMillis maximum time to wait before giving up. |
| 93 | * @param leaseDurationMillis the duration for which to acquire the lock initially. |
| 94 | * @return Future lease expiration date. |
| 95 | */ |
| 96 | protected CompletableFuture<DateTime> lockIfAvailable( |
| 97 | Lock lock, |
| 98 | long waitTimeMillis, |
| 99 | int leaseDurationMillis) { |
| 100 | CompletableFuture<DateTime> future = new CompletableFuture<>(); |
| 101 | locksToAcquire.put(lock.path(), new LockRequest(lock, waitTimeMillis, leaseDurationMillis, future)); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 102 | return future; |
| 103 | } |
| 104 | |
| 105 | private class LockEventMessageListener implements ClusterMessageHandler { |
| 106 | @Override |
| 107 | public void handle(ClusterMessage message) { |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 108 | TableModificationEvent event = DatabaseStateMachine.SERIALIZER |
| 109 | .decode(message.payload()); |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 110 | if (event.tableName().equals(ONOS_LOCK_TABLE_NAME) && |
| 111 | event.type().equals(TableModificationEvent.Type.ROW_DELETED)) { |
| 112 | THREAD_POOL.submit(new RetryLockTask(event.key())); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 113 | } |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 114 | } |
| 115 | } |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 116 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 117 | private class RetryLockTask implements Runnable { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 118 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 119 | private final String path; |
| 120 | |
| 121 | public RetryLockTask(String path) { |
| 122 | this.path = path; |
| 123 | } |
| 124 | |
| 125 | @Override |
| 126 | public void run() { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 127 | if (!locksToAcquire.containsKey(path)) { |
| 128 | return; |
| 129 | } |
| 130 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 131 | List<LockRequest> existingRequests = locksToAcquire.get(path); |
| 132 | if (existingRequests == null || existingRequests.isEmpty()) { |
| 133 | return; |
| 134 | } |
| 135 | log.info("Path {} is now available for locking. There are {} outstanding " |
| 136 | + "requests for it.", |
| 137 | path, existingRequests.size()); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 138 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 139 | synchronized (existingRequests) { |
| 140 | Iterator<LockRequest> existingRequestIterator = existingRequests.iterator(); |
| 141 | while (existingRequestIterator.hasNext()) { |
| 142 | LockRequest request = existingRequestIterator.next(); |
| 143 | if (DateTime.now().isAfter(request.requestExpirationTime())) { |
| 144 | // request expired. |
| 145 | existingRequestIterator.remove(); |
| 146 | } else { |
| 147 | if (request.lock().tryLock(request.leaseDurationMillis())) { |
| 148 | request.future().complete(DateTime.now().plusMillis(request.leaseDurationMillis())); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 149 | existingRequestIterator.remove(); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 150 | } |
| 151 | } |
| 152 | } |
| 153 | } |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | private class LockRequest { |
| 158 | |
| 159 | private final Lock lock; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 160 | private final DateTime requestExpirationTime; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 161 | private final int leaseDurationMillis; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 162 | private final CompletableFuture<DateTime> future; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 163 | |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 164 | public LockRequest(Lock lock, long waitTimeMillis, |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 165 | int leaseDurationMillis, CompletableFuture<DateTime> future) { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 166 | |
| 167 | this.lock = lock; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 168 | this.requestExpirationTime = DateTime.now().plusMillis((int) waitTimeMillis); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 169 | this.leaseDurationMillis = leaseDurationMillis; |
| 170 | this.future = future; |
| 171 | } |
| 172 | |
| 173 | public Lock lock() { |
| 174 | return lock; |
| 175 | } |
| 176 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 177 | public DateTime requestExpirationTime() { |
| 178 | return requestExpirationTime; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | public int leaseDurationMillis() { |
| 182 | return leaseDurationMillis; |
| 183 | } |
| 184 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame^] | 185 | public CompletableFuture<DateTime> future() { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 186 | return future; |
| 187 | } |
| 188 | } |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 189 | } |