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