Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -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 | */ |
| 16 | |
| 17 | package org.onlab.onos.store.service.impl; |
| 18 | |
| 19 | import java.io.IOException; |
| 20 | import java.util.HashMap; |
| 21 | import java.util.Map; |
| 22 | import java.util.Objects; |
| 23 | import java.util.concurrent.TimeUnit; |
| 24 | import java.util.concurrent.atomic.AtomicBoolean; |
| 25 | |
| 26 | import net.jodah.expiringmap.ExpiringMap; |
| 27 | import net.jodah.expiringmap.ExpiringMap.ExpirationListener; |
| 28 | import net.jodah.expiringmap.ExpiringMap.ExpirationPolicy; |
| 29 | import net.kuujo.copycat.cluster.Member; |
| 30 | import net.kuujo.copycat.event.EventHandler; |
| 31 | import net.kuujo.copycat.event.LeaderElectEvent; |
| 32 | |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 33 | import org.onlab.onos.cluster.ControllerNode; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 34 | import org.onlab.onos.store.cluster.messaging.ClusterCommunicationService; |
| 35 | import org.onlab.onos.store.cluster.messaging.ClusterMessage; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 36 | import org.onlab.onos.store.service.DatabaseService; |
| 37 | import org.onlab.onos.store.service.VersionedValue; |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 38 | import org.onlab.onos.store.service.impl.DatabaseStateMachine.State; |
| 39 | import org.onlab.onos.store.service.impl.DatabaseStateMachine.TableMetadata; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 40 | import org.slf4j.Logger; |
| 41 | import org.slf4j.LoggerFactory; |
| 42 | |
| 43 | /** |
| 44 | * Plugs into the database update stream and track the TTL of entries added to |
| 45 | * the database. For tables with pre-configured finite TTL, this class has |
| 46 | * mechanisms for expiring (deleting) old, expired entries from the database. |
| 47 | */ |
| 48 | public class DatabaseEntryExpirationTracker implements |
| 49 | DatabaseUpdateEventListener, EventHandler<LeaderElectEvent> { |
| 50 | |
| 51 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 52 | |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 53 | private final DatabaseService databaseService; |
| 54 | private final ClusterCommunicationService clusterCommunicator; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 55 | |
| 56 | private final Member localMember; |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 57 | private final ControllerNode localNode; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 58 | private final AtomicBoolean isLocalMemberLeader = new AtomicBoolean(false); |
| 59 | |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 60 | private final Map<String, Map<DatabaseRow, Long>> tableEntryExpirationMap = new HashMap<>(); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 61 | |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 62 | private final ExpirationListener<DatabaseRow, Long> expirationObserver = new ExpirationObserver(); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 63 | |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 64 | DatabaseEntryExpirationTracker( |
| 65 | Member localMember, |
| 66 | ControllerNode localNode, |
| 67 | ClusterCommunicationService clusterCommunicator, |
| 68 | DatabaseService databaseService) { |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 69 | this.localMember = localMember; |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 70 | this.localNode = localNode; |
| 71 | this.clusterCommunicator = clusterCommunicator; |
| 72 | this.databaseService = databaseService; |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 73 | } |
| 74 | |
| 75 | @Override |
| 76 | public void tableModified(TableModificationEvent event) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 77 | log.debug("Received a table modification event {}", event); |
| 78 | |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 79 | if (!tableEntryExpirationMap.containsKey(event.tableName())) { |
| 80 | return; |
| 81 | } |
| 82 | |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 83 | Map<DatabaseRow, Long> map = tableEntryExpirationMap.get(event.tableName()); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 84 | DatabaseRow row = new DatabaseRow(event.tableName(), event.key()); |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 85 | Long eventVersion = event.value().version(); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 86 | |
| 87 | switch (event.type()) { |
| 88 | case ROW_DELETED: |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 89 | map.remove(row, eventVersion); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 90 | if (isLocalMemberLeader.get()) { |
| 91 | try { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 92 | // FIXME: The broadcast message should be sent to self. |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 93 | clusterCommunicator.broadcast(new ClusterMessage( |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 94 | localNode.id(), DatabaseStateMachine.DATABASE_UPDATE_EVENTS, |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 95 | DatabaseStateMachine.SERIALIZER.encode(event))); |
| 96 | } catch (IOException e) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 97 | log.error("Failed to broadcast a database row deleted event.", e); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 98 | } |
| 99 | } |
| 100 | break; |
| 101 | case ROW_ADDED: |
| 102 | case ROW_UPDATED: |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 103 | // To account for potential reordering of notifications, |
| 104 | // check to make sure we are replacing an old version with a new version |
| 105 | Long currentVersion = map.get(row); |
| 106 | if (currentVersion == null || currentVersion < eventVersion) { |
| 107 | map.put(row, eventVersion); |
| 108 | } |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 109 | break; |
| 110 | default: |
| 111 | break; |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | @Override |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 116 | public void tableCreated(TableMetadata metadata) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 117 | log.debug("Received a table created event {}", metadata); |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 118 | if (metadata.expireOldEntries()) { |
| 119 | tableEntryExpirationMap.put(metadata.tableName(), ExpiringMap.builder() |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 120 | .expiration(metadata.ttlMillis(), TimeUnit.MILLISECONDS) |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 121 | .expirationListener(expirationObserver) |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 122 | // TODO: make the expiration policy configurable. |
| 123 | // Do we need to support expiration based on last access time? |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 124 | .expirationPolicy(ExpirationPolicy.CREATED).build()); |
| 125 | } |
| 126 | } |
| 127 | |
| 128 | @Override |
| 129 | public void tableDeleted(String tableName) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 130 | log.debug("Received a table deleted event for table ({})", tableName); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 131 | tableEntryExpirationMap.remove(tableName); |
| 132 | } |
| 133 | |
| 134 | private class ExpirationObserver implements |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 135 | ExpirationListener<DatabaseRow, Long> { |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 136 | @Override |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 137 | public void expired(DatabaseRow row, Long version) { |
| 138 | Map<DatabaseRow, Long> map = tableEntryExpirationMap.get(row.tableName); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 139 | try { |
| 140 | if (isLocalMemberLeader.get()) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 141 | if (!databaseService.removeIfVersionMatches(row.tableName, |
| 142 | row.key, version)) { |
| 143 | log.info("Entry in database was updated right before its expiration."); |
| 144 | } else { |
| 145 | log.info("Successfully expired old entry with key ({}) from table ({})", |
| 146 | row.key, row.tableName); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 147 | } |
| 148 | } else { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 149 | // Only the current leader will expire keys from database. |
| 150 | // Everyone else function as standby just in case they need to take over |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 151 | if (map != null) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 152 | map.putIfAbsent(row, version); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 153 | } |
| 154 | } |
| 155 | |
| 156 | } catch (Exception e) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 157 | log.warn("Failed to delete entry from the database after ttl " |
| 158 | + "expiration. Operation will be retried.", e); |
| 159 | map.putIfAbsent(row, version); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 160 | } |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | @Override |
| 165 | public void handle(LeaderElectEvent event) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 166 | isLocalMemberLeader.set(localMember.equals(event.leader())); |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Wrapper class for a database row identifier. |
| 171 | */ |
| 172 | private class DatabaseRow { |
| 173 | |
| 174 | String tableName; |
| 175 | String key; |
| 176 | |
| 177 | public DatabaseRow(String tableName, String key) { |
| 178 | this.tableName = tableName; |
| 179 | this.key = key; |
| 180 | } |
| 181 | |
| 182 | @Override |
| 183 | public boolean equals(Object obj) { |
| 184 | if (this == obj) { |
| 185 | return true; |
| 186 | } |
| 187 | if (!(obj instanceof DatabaseRow)) { |
| 188 | return false; |
| 189 | } |
| 190 | DatabaseRow that = (DatabaseRow) obj; |
| 191 | |
| 192 | return Objects.equals(this.tableName, that.tableName) |
| 193 | && Objects.equals(this.key, that.key); |
| 194 | } |
| 195 | |
| 196 | @Override |
| 197 | public int hashCode() { |
| 198 | return Objects.hash(tableName, key); |
| 199 | } |
| 200 | } |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 201 | |
| 202 | @Override |
| 203 | public void snapshotInstalled(State state) { |
| 204 | if (!tableEntryExpirationMap.isEmpty()) { |
| 205 | return; |
| 206 | } |
| 207 | for (String tableName : state.getTableNames()) { |
| 208 | |
| 209 | TableMetadata metadata = state.getTableMetadata(tableName); |
| 210 | if (!metadata.expireOldEntries()) { |
| 211 | continue; |
| 212 | } |
| 213 | |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 214 | Map<DatabaseRow, Long> tableExpirationMap = ExpiringMap.builder() |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 215 | .expiration(metadata.ttlMillis(), TimeUnit.MILLISECONDS) |
| 216 | .expirationListener(expirationObserver) |
| 217 | .expirationPolicy(ExpirationPolicy.CREATED).build(); |
| 218 | for (Map.Entry<String, VersionedValue> entry : state.getTable(tableName).entrySet()) { |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame^] | 219 | tableExpirationMap.put(new DatabaseRow(tableName, entry.getKey()), entry.getValue().version()); |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | tableEntryExpirationMap.put(tableName, tableExpirationMap); |
| 223 | } |
| 224 | } |
Madan Jampani | 9b37d57 | 2014-11-12 11:53:24 -0800 | [diff] [blame] | 225 | } |