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