Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 1 | package org.onosproject.store.service.impl; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 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; |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 8 | import java.util.Set; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 9 | import java.util.concurrent.CompletableFuture; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 10 | import java.util.concurrent.ExecutorService; |
| 11 | import java.util.concurrent.Executors; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 12 | |
| 13 | import org.apache.felix.scr.annotations.Activate; |
| 14 | import org.apache.felix.scr.annotations.Component; |
| 15 | import org.apache.felix.scr.annotations.Deactivate; |
| 16 | import org.apache.felix.scr.annotations.Reference; |
| 17 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 18 | import org.apache.felix.scr.annotations.Service; |
| 19 | import org.joda.time.DateTime; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.cluster.ClusterService; |
| 21 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
| 22 | import org.onosproject.store.cluster.messaging.ClusterMessage; |
| 23 | import org.onosproject.store.cluster.messaging.ClusterMessageHandler; |
| 24 | import org.onosproject.store.service.DatabaseAdminService; |
| 25 | import org.onosproject.store.service.DatabaseException; |
| 26 | import org.onosproject.store.service.DatabaseService; |
| 27 | import org.onosproject.store.service.Lock; |
| 28 | import org.onosproject.store.service.LockEventListener; |
| 29 | import org.onosproject.store.service.LockService; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 30 | import org.slf4j.Logger; |
| 31 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 32 | import com.google.common.collect.LinkedListMultimap; |
| 33 | import com.google.common.collect.ListMultimap; |
| 34 | import com.google.common.collect.Multimaps; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 35 | |
Brian O'Connor | 5d55ed4 | 2014-12-01 18:27:47 -0800 | [diff] [blame] | 36 | @Component(immediate = false) |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 37 | @Service |
| 38 | public class DistributedLockManager implements LockService { |
| 39 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 40 | private static final ExecutorService THREAD_POOL = |
| 41 | Executors.newCachedThreadPool(namedThreads("lock-manager-%d")); |
| 42 | |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 43 | private final Logger log = getLogger(getClass()); |
| 44 | |
| 45 | public static final String ONOS_LOCK_TABLE_NAME = "onos-locks"; |
| 46 | |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 47 | public static final int DEAD_LOCK_TIMEOUT_MS = 5000; |
| 48 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 49 | private final ListMultimap<String, LockRequest> locksToAcquire = |
| 50 | Multimaps.synchronizedListMultimap(LinkedListMultimap.<String, LockRequest>create()); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 51 | |
| 52 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 53 | private ClusterCommunicationService clusterCommunicator; |
| 54 | |
| 55 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 56 | private DatabaseAdminService databaseAdminService; |
| 57 | |
| 58 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 59 | private DatabaseService databaseService; |
| 60 | |
| 61 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 62 | private ClusterService clusterService; |
| 63 | |
| 64 | @Activate |
| 65 | public void activate() { |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 66 | try { |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 67 | Set<String> tables = databaseAdminService.listTables(); |
| 68 | |
| 69 | if (!tables.contains(ONOS_LOCK_TABLE_NAME)) { |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 70 | if (databaseAdminService.createTable(ONOS_LOCK_TABLE_NAME, DEAD_LOCK_TIMEOUT_MS)) { |
| 71 | log.info("Created {} table.", ONOS_LOCK_TABLE_NAME); |
| 72 | } |
| 73 | } |
| 74 | } catch (DatabaseException e) { |
| 75 | log.error("DistributedLockManager#activate failed.", e); |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 76 | } |
| 77 | |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 78 | clusterCommunicator.addSubscriber( |
| 79 | DatabaseStateMachine.DATABASE_UPDATE_EVENTS, |
| 80 | new LockEventMessageListener()); |
Madan Jampani | ac20195 | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 81 | |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 82 | log.info("Started"); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | @Deactivate |
| 86 | public void deactivate() { |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 87 | clusterCommunicator.removeSubscriber(DatabaseStateMachine.DATABASE_UPDATE_EVENTS); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 88 | locksToAcquire.clear(); |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 89 | log.info("Stopped."); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | @Override |
| 93 | public Lock create(String path) { |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 94 | return new DistributedLock(path, databaseService, clusterService, this); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | @Override |
| 98 | public void addListener(LockEventListener listener) { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 99 | throw new UnsupportedOperationException(); |
| 100 | } |
| 101 | |
| 102 | @Override |
| 103 | public void removeListener(LockEventListener listener) { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 104 | throw new UnsupportedOperationException(); |
| 105 | } |
| 106 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 107 | /** |
| 108 | * Attempts to acquire the lock as soon as it becomes available. |
| 109 | * @param lock lock to acquire. |
| 110 | * @param waitTimeMillis maximum time to wait before giving up. |
| 111 | * @param leaseDurationMillis the duration for which to acquire the lock initially. |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 112 | * @return Future that can be blocked on until lock becomes available. |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 113 | */ |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 114 | protected CompletableFuture<Void> lockIfAvailable( |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 115 | Lock lock, |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 116 | int waitTimeMillis, |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 117 | int leaseDurationMillis) { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 118 | CompletableFuture<Void> future = new CompletableFuture<>(); |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 119 | LockRequest request = new LockRequest( |
| 120 | lock, |
| 121 | leaseDurationMillis, |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 122 | DateTime.now().plusMillis(waitTimeMillis), |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 123 | future); |
| 124 | locksToAcquire.put(lock.path(), request); |
| 125 | return future; |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Attempts to acquire the lock as soon as it becomes available. |
| 130 | * @param lock lock to acquire. |
| 131 | * @param leaseDurationMillis the duration for which to acquire the lock initially. |
| 132 | * @return Future lease expiration date. |
| 133 | */ |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 134 | protected CompletableFuture<Void> lockIfAvailable( |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 135 | Lock lock, |
| 136 | int leaseDurationMillis) { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 137 | CompletableFuture<Void> future = new CompletableFuture<>(); |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 138 | LockRequest request = new LockRequest( |
| 139 | lock, |
| 140 | leaseDurationMillis, |
| 141 | DateTime.now().plusYears(100), |
| 142 | future); |
| 143 | locksToAcquire.put(lock.path(), request); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 144 | return future; |
| 145 | } |
| 146 | |
| 147 | private class LockEventMessageListener implements ClusterMessageHandler { |
| 148 | @Override |
| 149 | public void handle(ClusterMessage message) { |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 150 | TableModificationEvent event = ClusterMessagingProtocol.DB_SERIALIZER |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 151 | .decode(message.payload()); |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 152 | if (event.tableName().equals(ONOS_LOCK_TABLE_NAME) && |
| 153 | event.type().equals(TableModificationEvent.Type.ROW_DELETED)) { |
| 154 | THREAD_POOL.submit(new RetryLockTask(event.key())); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 155 | } |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 156 | } |
| 157 | } |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 158 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 159 | private class RetryLockTask implements Runnable { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 160 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 161 | private final String path; |
| 162 | |
| 163 | public RetryLockTask(String path) { |
| 164 | this.path = path; |
| 165 | } |
| 166 | |
| 167 | @Override |
| 168 | public void run() { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 169 | if (!locksToAcquire.containsKey(path)) { |
| 170 | return; |
| 171 | } |
| 172 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 173 | List<LockRequest> existingRequests = locksToAcquire.get(path); |
| 174 | if (existingRequests == null || existingRequests.isEmpty()) { |
| 175 | return; |
| 176 | } |
| 177 | log.info("Path {} is now available for locking. There are {} outstanding " |
| 178 | + "requests for it.", |
| 179 | path, existingRequests.size()); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 180 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 181 | synchronized (existingRequests) { |
| 182 | Iterator<LockRequest> existingRequestIterator = existingRequests.iterator(); |
| 183 | while (existingRequestIterator.hasNext()) { |
| 184 | LockRequest request = existingRequestIterator.next(); |
| 185 | if (DateTime.now().isAfter(request.requestExpirationTime())) { |
| 186 | // request expired. |
| 187 | existingRequestIterator.remove(); |
| 188 | } else { |
| 189 | if (request.lock().tryLock(request.leaseDurationMillis())) { |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 190 | request.future().complete(null); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 191 | existingRequestIterator.remove(); |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 192 | } |
| 193 | } |
| 194 | } |
| 195 | } |
| 196 | } |
| 197 | } |
| 198 | |
| 199 | private class LockRequest { |
| 200 | |
| 201 | private final Lock lock; |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 202 | private final DateTime requestExpirationTime; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 203 | private final int leaseDurationMillis; |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 204 | private final CompletableFuture<Void> future; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 205 | |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 206 | public LockRequest( |
| 207 | Lock lock, |
| 208 | int leaseDurationMillis, |
| 209 | DateTime requestExpirationTime, |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 210 | CompletableFuture<Void> future) { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 211 | |
| 212 | this.lock = lock; |
Madan Jampani | 71582ed | 2014-11-18 10:06:01 -0800 | [diff] [blame] | 213 | this.requestExpirationTime = requestExpirationTime; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 214 | this.leaseDurationMillis = leaseDurationMillis; |
| 215 | this.future = future; |
| 216 | } |
| 217 | |
| 218 | public Lock lock() { |
| 219 | return lock; |
| 220 | } |
| 221 | |
Madan Jampani | a88d1f5 | 2014-11-14 16:45:24 -0800 | [diff] [blame] | 222 | public DateTime requestExpirationTime() { |
| 223 | return requestExpirationTime; |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | public int leaseDurationMillis() { |
| 227 | return leaseDurationMillis; |
| 228 | } |
| 229 | |
Madan Jampani | 1769a1a | 2014-11-19 21:51:44 -0800 | [diff] [blame] | 230 | public CompletableFuture<Void> future() { |
Madan Jampani | 12390c1 | 2014-11-12 00:35:56 -0800 | [diff] [blame] | 231 | return future; |
| 232 | } |
| 233 | } |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 234 | } |