Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 1 | package org.onlab.onos.store.service.impl; |
| 2 | |
| 3 | import static org.slf4j.LoggerFactory.getLogger; |
| 4 | |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 5 | import java.io.File; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 6 | import java.util.ArrayList; |
| 7 | import java.util.Arrays; |
| 8 | import java.util.List; |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 9 | import java.util.concurrent.CountDownLatch; |
| 10 | import java.util.concurrent.TimeUnit; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 11 | |
| 12 | import net.kuujo.copycat.Copycat; |
| 13 | import net.kuujo.copycat.StateMachine; |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 14 | import net.kuujo.copycat.cluster.ClusterConfig; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 15 | import net.kuujo.copycat.cluster.TcpCluster; |
| 16 | import net.kuujo.copycat.cluster.TcpClusterConfig; |
| 17 | import net.kuujo.copycat.cluster.TcpMember; |
Yuta HIGUCHI | 0c1c100 | 2014-11-05 13:47:25 -0800 | [diff] [blame] | 18 | import net.kuujo.copycat.log.InMemoryLog; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 19 | import net.kuujo.copycat.log.Log; |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 20 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Activate; |
Madan Jampani | dfbfa18 | 2014-11-04 22:06:41 -0800 | [diff] [blame] | 22 | import org.apache.felix.scr.annotations.Component; |
Yuta HIGUCHI | 657626e | 2014-11-04 20:54:58 -0800 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Deactivate; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
Madan Jampani | dfbfa18 | 2014-11-04 22:06:41 -0800 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Service; |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 27 | import org.onlab.onos.cluster.ClusterEvent; |
| 28 | import org.onlab.onos.cluster.ClusterEventListener; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 29 | import org.onlab.onos.cluster.ClusterService; |
| 30 | import org.onlab.onos.cluster.ControllerNode; |
| 31 | import org.onlab.onos.store.service.DatabaseAdminService; |
| 32 | import org.onlab.onos.store.service.DatabaseException; |
| 33 | import org.onlab.onos.store.service.DatabaseService; |
| 34 | import org.onlab.onos.store.service.NoSuchTableException; |
| 35 | import org.onlab.onos.store.service.OptimisticLockException; |
| 36 | import org.onlab.onos.store.service.OptionalResult; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 37 | import org.onlab.onos.store.service.ReadRequest; |
| 38 | import org.onlab.onos.store.service.ReadResult; |
| 39 | import org.onlab.onos.store.service.WriteAborted; |
| 40 | import org.onlab.onos.store.service.WriteRequest; |
| 41 | import org.onlab.onos.store.service.WriteResult; |
| 42 | import org.slf4j.Logger; |
| 43 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 44 | /** |
| 45 | * Strongly consistent and durable state management service based on |
| 46 | * Copycat implementation of Raft consensus protocol. |
| 47 | */ |
Madan Jampani | dfbfa18 | 2014-11-04 22:06:41 -0800 | [diff] [blame] | 48 | @Component(immediate = true) |
| 49 | @Service |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 50 | public class DatabaseManager implements DatabaseService, DatabaseAdminService { |
| 51 | |
| 52 | private final Logger log = getLogger(getClass()); |
| 53 | |
| 54 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Yuta HIGUCHI | 5001ba9 | 2014-11-04 21:33:54 -0800 | [diff] [blame] | 55 | protected ClusterService clusterService; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 56 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 57 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Yuta HIGUCHI | 0c1c100 | 2014-11-05 13:47:25 -0800 | [diff] [blame] | 58 | protected DatabaseProtocolService copycatMessagingProtocol; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 59 | |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 60 | public static final String LOG_FILE_PREFIX = "/tmp/onos-copy-cat-log"; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 61 | |
| 62 | private Copycat copycat; |
| 63 | private DatabaseClient client; |
| 64 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 65 | // guarded by synchronized block |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 66 | private ClusterConfig<TcpMember> clusterConfig; |
| 67 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 68 | private CountDownLatch clusterEventLatch; |
| 69 | |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 70 | private ClusterEventListener clusterEventListener; |
| 71 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 72 | @Activate |
| 73 | public void activate() { |
Madan Jampani | dfbfa18 | 2014-11-04 22:06:41 -0800 | [diff] [blame] | 74 | |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 75 | // TODO: Not every node should be part of the consensus ring. |
Madan Jampani | dfbfa18 | 2014-11-04 22:06:41 -0800 | [diff] [blame] | 76 | |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 77 | final ControllerNode localNode = clusterService.getLocalNode(); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 78 | TcpMember localMember = |
| 79 | new TcpMember( |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 80 | localNode.ip().toString(), |
| 81 | localNode.tcpPort()); |
| 82 | |
| 83 | clusterConfig = new TcpClusterConfig(); |
| 84 | clusterConfig.setLocalMember(localMember); |
| 85 | |
| 86 | List<TcpMember> remoteMembers = new ArrayList<>(clusterService.getNodes().size()); |
| 87 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 88 | clusterEventLatch = new CountDownLatch(1); |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 89 | clusterEventListener = new InternalClusterEventListener(); |
| 90 | clusterService.addListener(clusterEventListener); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 91 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 92 | // note: from this point beyond, clusterConfig requires synchronization |
| 93 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 94 | for (ControllerNode node : clusterService.getNodes()) { |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 95 | TcpMember member = new TcpMember(node.ip().toString(), node.tcpPort()); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 96 | if (!member.equals(localMember)) { |
| 97 | remoteMembers.add(member); |
| 98 | } |
| 99 | } |
| 100 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 101 | if (remoteMembers.isEmpty()) { |
| 102 | log.info("This node is the only node in the cluster. " |
| 103 | + "Waiting for others to show up."); |
| 104 | // FIXME: hack trying to relax cases forming multiple consensus rings. |
| 105 | // add seed node configuration to avoid this |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 106 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 107 | // If the node is alone on it's own, wait some time |
| 108 | // hoping other will come up soon |
| 109 | try { |
| 110 | if (!clusterEventLatch.await(120, TimeUnit.SECONDS)) { |
| 111 | log.info("Starting as single node cluster"); |
| 112 | } |
| 113 | } catch (InterruptedException e) { |
| 114 | log.info("Interrupted waiting for others", e); |
| 115 | } |
| 116 | } |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 117 | |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 118 | final TcpCluster cluster; |
| 119 | synchronized (clusterConfig) { |
| 120 | clusterConfig.addRemoteMembers(remoteMembers); |
| 121 | |
| 122 | // Create the cluster. |
| 123 | cluster = new TcpCluster(clusterConfig); |
| 124 | } |
| 125 | log.info("Starting cluster: {}", cluster); |
| 126 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 127 | |
| 128 | StateMachine stateMachine = new DatabaseStateMachine(); |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 129 | // Chronicle + OSGi issue |
Yuta HIGUCHI | 0c1c100 | 2014-11-05 13:47:25 -0800 | [diff] [blame] | 130 | //Log consensusLog = new ChronicleLog(LOG_FILE_PREFIX + "_" + thisNode.id()); |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 131 | //Log consensusLog = new KryoRegisteredInMemoryLog(); |
| 132 | Log consensusLog = new MapDBLog(new File(LOG_FILE_PREFIX + localNode.id()), |
| 133 | ClusterMessagingProtocol.SERIALIZER); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 134 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 135 | copycat = new Copycat(stateMachine, consensusLog, cluster, copycatMessagingProtocol); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 136 | copycat.start(); |
| 137 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 138 | client = new DatabaseClient(copycatMessagingProtocol.createClient(localMember)); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 139 | |
| 140 | log.info("Started."); |
| 141 | } |
| 142 | |
Yuta HIGUCHI | 657626e | 2014-11-04 20:54:58 -0800 | [diff] [blame] | 143 | @Deactivate |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 144 | public void deactivate() { |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 145 | clusterService.removeListener(clusterEventListener); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 146 | copycat.stop(); |
Yuta HIGUCHI | 657626e | 2014-11-04 20:54:58 -0800 | [diff] [blame] | 147 | log.info("Stopped."); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | @Override |
| 151 | public boolean createTable(String name) { |
| 152 | return client.createTable(name); |
| 153 | } |
| 154 | |
| 155 | @Override |
| 156 | public void dropTable(String name) { |
| 157 | client.dropTable(name); |
| 158 | } |
| 159 | |
| 160 | @Override |
| 161 | public void dropAllTables() { |
| 162 | client.dropAllTables(); |
| 163 | } |
| 164 | |
| 165 | @Override |
| 166 | public List<String> listTables() { |
| 167 | return client.listTables(); |
| 168 | } |
| 169 | |
| 170 | @Override |
| 171 | public ReadResult read(ReadRequest request) { |
| 172 | return batchRead(Arrays.asList(request)).get(0).get(); |
| 173 | } |
| 174 | |
| 175 | @Override |
| 176 | public List<OptionalResult<ReadResult, DatabaseException>> batchRead( |
| 177 | List<ReadRequest> batch) { |
| 178 | List<OptionalResult<ReadResult, DatabaseException>> readResults = new ArrayList<>(batch.size()); |
| 179 | for (InternalReadResult internalReadResult : client.batchRead(batch)) { |
| 180 | if (internalReadResult.status() == InternalReadResult.Status.NO_SUCH_TABLE) { |
| 181 | readResults.add(new DatabaseOperationResult<ReadResult, DatabaseException>( |
| 182 | new NoSuchTableException())); |
| 183 | } else { |
| 184 | readResults.add(new DatabaseOperationResult<ReadResult, DatabaseException>( |
| 185 | internalReadResult.result())); |
| 186 | } |
| 187 | } |
| 188 | return readResults; |
| 189 | } |
| 190 | |
| 191 | @Override |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 192 | public OptionalResult<WriteResult, DatabaseException> writeNothrow(WriteRequest request) { |
| 193 | return batchWrite(Arrays.asList(request)).get(0); |
| 194 | } |
| 195 | |
| 196 | @Override |
Yuta HIGUCHI | c6b8f61 | 2014-11-06 19:04:13 -0800 | [diff] [blame^] | 197 | public WriteResult write(WriteRequest request) { |
| 198 | // throws OptimisticLockException, PreconditionFailedException { |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 199 | return writeNothrow(request).get(); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 200 | } |
| 201 | |
| 202 | @Override |
| 203 | public List<OptionalResult<WriteResult, DatabaseException>> batchWrite( |
| 204 | List<WriteRequest> batch) { |
| 205 | List<OptionalResult<WriteResult, DatabaseException>> writeResults = new ArrayList<>(batch.size()); |
| 206 | for (InternalWriteResult internalWriteResult : client.batchWrite(batch)) { |
| 207 | if (internalWriteResult.status() == InternalWriteResult.Status.NO_SUCH_TABLE) { |
| 208 | writeResults.add(new DatabaseOperationResult<WriteResult, DatabaseException>( |
| 209 | new NoSuchTableException())); |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 210 | } else if (internalWriteResult.status() == InternalWriteResult.Status.PREVIOUS_VERSION_MISMATCH) { |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 211 | writeResults.add(new DatabaseOperationResult<WriteResult, DatabaseException>( |
| 212 | new OptimisticLockException())); |
| 213 | } else if (internalWriteResult.status() == InternalWriteResult.Status.PREVIOUS_VALUE_MISMATCH) { |
| 214 | // TODO: throw a different exception? |
| 215 | writeResults.add(new DatabaseOperationResult<WriteResult, DatabaseException>( |
Yuta HIGUCHI | 361664e | 2014-11-06 17:28:47 -0800 | [diff] [blame] | 216 | new OptimisticLockException())); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 217 | } else if (internalWriteResult.status() == InternalWriteResult.Status.ABORTED) { |
| 218 | writeResults.add(new DatabaseOperationResult<WriteResult, DatabaseException>( |
| 219 | new WriteAborted())); |
| 220 | } else { |
| 221 | writeResults.add(new DatabaseOperationResult<WriteResult, DatabaseException>( |
| 222 | internalWriteResult.result())); |
| 223 | } |
| 224 | } |
| 225 | return writeResults; |
| 226 | |
| 227 | } |
| 228 | |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 229 | private final class InternalClusterEventListener |
| 230 | implements ClusterEventListener { |
| 231 | |
| 232 | @Override |
| 233 | public void event(ClusterEvent event) { |
| 234 | // TODO: Not every node should be part of the consensus ring. |
| 235 | |
| 236 | final ControllerNode node = event.subject(); |
| 237 | final TcpMember tcpMember = new TcpMember(node.ip().toString(), |
| 238 | node.tcpPort()); |
| 239 | |
| 240 | log.trace("{}", event); |
| 241 | switch (event.type()) { |
| 242 | case INSTANCE_ACTIVATED: |
| 243 | case INSTANCE_ADDED: |
| 244 | log.info("{} was added to the cluster", tcpMember); |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 245 | synchronized (clusterConfig) { |
| 246 | clusterConfig.addRemoteMember(tcpMember); |
| 247 | } |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 248 | break; |
| 249 | case INSTANCE_DEACTIVATED: |
| 250 | case INSTANCE_REMOVED: |
| 251 | log.info("{} was removed from the cluster", tcpMember); |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 252 | synchronized (clusterConfig) { |
| 253 | clusterConfig.removeRemoteMember(tcpMember); |
| 254 | } |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 255 | break; |
| 256 | default: |
| 257 | break; |
| 258 | } |
Yuta HIGUCHI | 79a1e5e | 2014-11-05 17:42:01 -0800 | [diff] [blame] | 259 | if (copycat != null) { |
| 260 | log.debug("Current cluster: {}", copycat.cluster()); |
| 261 | } |
| 262 | clusterEventLatch.countDown(); |
Yuta HIGUCHI | 5027b6b | 2014-11-05 16:23:26 -0800 | [diff] [blame] | 263 | } |
| 264 | |
| 265 | } |
| 266 | |
| 267 | public static final class KryoRegisteredInMemoryLog extends InMemoryLog { |
| 268 | public KryoRegisteredInMemoryLog() { |
| 269 | super(); |
| 270 | // required to deserialize object across bundles |
| 271 | super.kryo.register(TcpMember.class, new TcpMemberSerializer()); |
| 272 | super.kryo.register(TcpClusterConfig.class, new TcpClusterConfigSerializer()); |
| 273 | } |
| 274 | } |
| 275 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 276 | private class DatabaseOperationResult<R, E extends DatabaseException> implements OptionalResult<R, E> { |
| 277 | |
| 278 | private final R result; |
| 279 | private final DatabaseException exception; |
| 280 | |
| 281 | public DatabaseOperationResult(R result) { |
| 282 | this.result = result; |
| 283 | this.exception = null; |
| 284 | } |
| 285 | |
| 286 | public DatabaseOperationResult(DatabaseException exception) { |
| 287 | this.result = null; |
| 288 | this.exception = exception; |
| 289 | } |
| 290 | |
| 291 | @Override |
| 292 | public R get() { |
| 293 | if (result != null) { |
| 294 | return result; |
| 295 | } |
| 296 | throw exception; |
| 297 | } |
| 298 | |
| 299 | @Override |
| 300 | public boolean hasValidResult() { |
| 301 | return result != null; |
| 302 | } |
| 303 | |
| 304 | @Override |
| 305 | public String toString() { |
| 306 | if (result != null) { |
| 307 | return result.toString(); |
| 308 | } else { |
| 309 | return exception.toString(); |
| 310 | } |
| 311 | } |
| 312 | } |
| 313 | } |