Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 1 | package org.onlab.onos.store.service.impl; |
| 2 | |
Yuta HIGUCHI | a3982c1 | 2014-11-10 09:47:08 -0800 | [diff] [blame] | 3 | import static com.google.common.base.Verify.verifyNotNull; |
Yuta HIGUCHI | a3982c1 | 2014-11-10 09:47:08 -0800 | [diff] [blame] | 4 | import static org.onlab.onos.store.service.impl.ClusterMessagingProtocol.SERIALIZER; |
Yuta HIGUCHI | 2b75f1a | 2014-11-14 16:07:34 -0800 | [diff] [blame] | 5 | import static org.onlab.util.Tools.namedThreads; |
Madan Jampani | 2b6ca91 | 2014-11-21 14:44:45 -0800 | [diff] [blame^] | 6 | import static org.slf4j.LoggerFactory.getLogger; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 7 | |
| 8 | import java.io.IOException; |
| 9 | import java.util.concurrent.CompletableFuture; |
| 10 | import java.util.concurrent.ExecutionException; |
Yuta HIGUCHI | 2b75f1a | 2014-11-14 16:07:34 -0800 | [diff] [blame] | 11 | import java.util.concurrent.ExecutorService; |
| 12 | import java.util.concurrent.Executors; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 13 | import java.util.concurrent.TimeUnit; |
| 14 | import java.util.concurrent.TimeoutException; |
Madan Jampani | 2b6ca91 | 2014-11-21 14:44:45 -0800 | [diff] [blame^] | 15 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 16 | import net.kuujo.copycat.cluster.TcpMember; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 17 | import net.kuujo.copycat.protocol.PingRequest; |
| 18 | import net.kuujo.copycat.protocol.PingResponse; |
| 19 | import net.kuujo.copycat.protocol.PollRequest; |
| 20 | import net.kuujo.copycat.protocol.PollResponse; |
| 21 | import net.kuujo.copycat.protocol.SubmitRequest; |
| 22 | import net.kuujo.copycat.protocol.SubmitResponse; |
| 23 | import net.kuujo.copycat.protocol.SyncRequest; |
| 24 | import net.kuujo.copycat.protocol.SyncResponse; |
| 25 | import net.kuujo.copycat.spi.protocol.ProtocolClient; |
| 26 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 27 | import org.onlab.onos.cluster.ClusterEvent; |
| 28 | import org.onlab.onos.cluster.ClusterEventListener; |
| 29 | import org.onlab.onos.cluster.ClusterService; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 30 | import org.onlab.onos.cluster.ControllerNode; |
| 31 | import org.onlab.onos.store.cluster.messaging.ClusterCommunicationService; |
| 32 | import org.onlab.onos.store.cluster.messaging.ClusterMessage; |
| 33 | import org.onlab.onos.store.cluster.messaging.MessageSubject; |
| 34 | import org.slf4j.Logger; |
| 35 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 36 | /** |
Madan Jampani | dfbfa18 | 2014-11-04 22:06:41 -0800 | [diff] [blame] | 37 | * ONOS Cluster messaging based Copycat protocol client. |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 38 | */ |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 39 | public class ClusterMessagingProtocolClient implements ProtocolClient { |
| 40 | |
| 41 | private final Logger log = getLogger(getClass()); |
| 42 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 43 | public static final long RETRY_INTERVAL_MILLIS = 2000; |
| 44 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 45 | private final ClusterService clusterService; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 46 | private final ClusterCommunicationService clusterCommunicator; |
Madan Jampani | 515865d | 2014-11-09 22:29:34 -0800 | [diff] [blame] | 47 | private final ControllerNode localNode; |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 48 | private final TcpMember remoteMember; |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 49 | |
| 50 | // (remoteNode == null) => disconnected state |
| 51 | private volatile ControllerNode remoteNode; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 52 | |
Yuta HIGUCHI | 2b75f1a | 2014-11-14 16:07:34 -0800 | [diff] [blame] | 53 | // TODO: make this non-static and stop on close |
| 54 | private static final ExecutorService THREAD_POOL |
| 55 | = Executors.newCachedThreadPool(namedThreads("copycat-netty-messaging-%d")); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 56 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 57 | private volatile CompletableFuture<Void> appeared; |
| 58 | |
| 59 | private volatile InternalClusterEventListener listener; |
| 60 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 61 | public ClusterMessagingProtocolClient( |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 62 | ClusterService clusterService, |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 63 | ClusterCommunicationService clusterCommunicator, |
Madan Jampani | 515865d | 2014-11-09 22:29:34 -0800 | [diff] [blame] | 64 | ControllerNode localNode, |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 65 | TcpMember remoteMember) { |
| 66 | |
| 67 | this.clusterService = clusterService; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 68 | this.clusterCommunicator = clusterCommunicator; |
Madan Jampani | 515865d | 2014-11-09 22:29:34 -0800 | [diff] [blame] | 69 | this.localNode = localNode; |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 70 | this.remoteMember = remoteMember; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | @Override |
| 74 | public CompletableFuture<PingResponse> ping(PingRequest request) { |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 75 | return connect().thenCompose((connected) -> { return requestReply(request); }); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 76 | } |
| 77 | |
| 78 | @Override |
| 79 | public CompletableFuture<SyncResponse> sync(SyncRequest request) { |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 80 | return connect().thenCompose((connected) -> { return requestReply(request); }); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | @Override |
| 84 | public CompletableFuture<PollResponse> poll(PollRequest request) { |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 85 | return connect().thenCompose((connected) -> { return requestReply(request); }); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | @Override |
| 89 | public CompletableFuture<SubmitResponse> submit(SubmitRequest request) { |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 90 | return connect().thenCompose((connected) -> { return requestReply(request); }); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 91 | } |
| 92 | |
| 93 | @Override |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 94 | public synchronized CompletableFuture<Void> connect() { |
| 95 | if (remoteNode != null) { |
| 96 | // done |
| 97 | return CompletableFuture.completedFuture(null); |
| 98 | } |
| 99 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 100 | if (appeared != null) { |
| 101 | // already waiting for member to appear |
| 102 | return appeared; |
| 103 | } |
| 104 | |
| 105 | appeared = new CompletableFuture<>(); |
| 106 | listener = new InternalClusterEventListener(); |
| 107 | clusterService.addListener(listener); |
| 108 | |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 109 | remoteNode = getControllerNode(remoteMember); |
| 110 | |
| 111 | if (remoteNode != null) { |
| 112 | // done |
| 113 | return CompletableFuture.completedFuture(null); |
| 114 | } |
| 115 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 116 | // wait for specified controller node to come up |
Yuta HIGUCHI | 2fe6334 | 2014-11-17 21:33:38 -0800 | [diff] [blame] | 117 | return appeared; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | @Override |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 121 | public synchronized CompletableFuture<Void> close() { |
| 122 | if (listener != null) { |
| 123 | clusterService.removeListener(listener); |
| 124 | listener = null; |
| 125 | } |
| 126 | if (appeared != null) { |
| 127 | appeared.cancel(true); |
| 128 | appeared = null; |
| 129 | } |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 130 | return CompletableFuture.completedFuture(null); |
| 131 | } |
| 132 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 133 | private synchronized void checkIfMemberAppeared() { |
| 134 | final ControllerNode controllerNode = getControllerNode(remoteMember); |
| 135 | if (controllerNode == null) { |
| 136 | // still not there: no-op |
| 137 | return; |
| 138 | } |
| 139 | |
| 140 | // found |
| 141 | remoteNode = controllerNode; |
| 142 | if (appeared != null) { |
| 143 | appeared.complete(null); |
| 144 | } |
| 145 | |
| 146 | if (listener != null) { |
| 147 | clusterService.removeListener(listener); |
| 148 | listener = null; |
| 149 | } |
| 150 | } |
| 151 | |
Yuta HIGUCHI | 3b01673 | 2014-11-07 15:32:18 -0800 | [diff] [blame] | 152 | private <I> MessageSubject messageType(I input) { |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 153 | Class<?> clazz = input.getClass(); |
| 154 | if (clazz.equals(PollRequest.class)) { |
| 155 | return ClusterMessagingProtocol.COPYCAT_POLL; |
| 156 | } else if (clazz.equals(SyncRequest.class)) { |
| 157 | return ClusterMessagingProtocol.COPYCAT_SYNC; |
| 158 | } else if (clazz.equals(SubmitRequest.class)) { |
| 159 | return ClusterMessagingProtocol.COPYCAT_SUBMIT; |
| 160 | } else if (clazz.equals(PingRequest.class)) { |
| 161 | return ClusterMessagingProtocol.COPYCAT_PING; |
| 162 | } else { |
| 163 | throw new IllegalArgumentException("Unknown class " + clazz.getName()); |
| 164 | } |
| 165 | |
| 166 | } |
| 167 | |
| 168 | private <I, O> CompletableFuture<O> requestReply(I request) { |
| 169 | CompletableFuture<O> future = new CompletableFuture<>(); |
Yuta HIGUCHI | 2b75f1a | 2014-11-14 16:07:34 -0800 | [diff] [blame] | 170 | THREAD_POOL.submit(new RPCTask<I, O>(request, future)); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 171 | return future; |
| 172 | } |
| 173 | |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 174 | private ControllerNode getControllerNode(TcpMember remoteMember) { |
| 175 | final String host = remoteMember.host(); |
| 176 | final int port = remoteMember.port(); |
| 177 | for (ControllerNode node : clusterService.getNodes()) { |
| 178 | if (node.ip().toString().equals(host) && node.tcpPort() == port) { |
| 179 | return node; |
| 180 | } |
| 181 | } |
| 182 | return null; |
| 183 | } |
| 184 | |
| 185 | private final class InternalClusterEventListener |
| 186 | implements ClusterEventListener { |
| 187 | |
| 188 | public InternalClusterEventListener() { |
| 189 | } |
| 190 | |
| 191 | @Override |
| 192 | public void event(ClusterEvent event) { |
| 193 | checkIfMemberAppeared(); |
| 194 | } |
Yuta HIGUCHI | 71b9d09 | 2014-11-12 13:31:11 -0800 | [diff] [blame] | 195 | } |
| 196 | |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 197 | private class RPCTask<I, O> implements Runnable { |
| 198 | |
Yuta HIGUCHI | e59656d | 2014-11-07 01:57:32 -0800 | [diff] [blame] | 199 | private final I request; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 200 | private final ClusterMessage message; |
| 201 | private final CompletableFuture<O> future; |
| 202 | |
| 203 | public RPCTask(I request, CompletableFuture<O> future) { |
Yuta HIGUCHI | e59656d | 2014-11-07 01:57:32 -0800 | [diff] [blame] | 204 | this.request = request; |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 205 | this.message = |
| 206 | new ClusterMessage( |
Madan Jampani | 515865d | 2014-11-09 22:29:34 -0800 | [diff] [blame] | 207 | localNode.id(), |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 208 | messageType(request), |
Yuta HIGUCHI | a3982c1 | 2014-11-10 09:47:08 -0800 | [diff] [blame] | 209 | verifyNotNull(SERIALIZER.encode(request))); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 210 | this.future = future; |
| 211 | } |
| 212 | |
| 213 | @Override |
| 214 | public void run() { |
| 215 | try { |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 216 | ControllerNode node = remoteNode; |
| 217 | if (node == null) { |
| 218 | throw new IOException("Remote node disappeared"); |
| 219 | } |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 220 | byte[] response = clusterCommunicator |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 221 | .sendAndReceive(message, node.id()) |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 222 | .get(RETRY_INTERVAL_MILLIS, TimeUnit.MILLISECONDS); |
Yuta HIGUCHI | a3982c1 | 2014-11-10 09:47:08 -0800 | [diff] [blame] | 223 | future.complete(verifyNotNull(SERIALIZER.decode(response))); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 224 | |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 225 | } catch (IOException | TimeoutException e) { |
Yuta HIGUCHI | 4520716 | 2014-11-17 15:25:13 -0800 | [diff] [blame] | 226 | log.warn("RPCTask for {} failed: {}", request, e.getMessage()); |
| 227 | log.debug("RPCTask for {} failed.", request, e); |
Madan Jampani | 515865d | 2014-11-09 22:29:34 -0800 | [diff] [blame] | 228 | future.completeExceptionally(e); |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 229 | // Treating this client as disconnected |
| 230 | remoteNode = null; |
Madan Jampani | 2b6ca91 | 2014-11-21 14:44:45 -0800 | [diff] [blame^] | 231 | appeared = null; |
Yuta HIGUCHI | d249943 | 2014-11-20 12:07:43 -0800 | [diff] [blame] | 232 | } catch (ExecutionException e) { |
| 233 | log.warn("RPCTask execution for {} failed: {}", request, e.getMessage()); |
| 234 | log.debug("RPCTask execution for {} failed.", request, e); |
| 235 | future.completeExceptionally(e); |
Yuta HIGUCHI | 2b75f1a | 2014-11-14 16:07:34 -0800 | [diff] [blame] | 236 | } catch (InterruptedException e) { |
Yuta HIGUCHI | 4520716 | 2014-11-17 15:25:13 -0800 | [diff] [blame] | 237 | log.warn("RPCTask for {} was interrupted: {}", request, e.getMessage()); |
| 238 | log.debug("RPCTask for {} was interrupted.", request, e); |
Yuta HIGUCHI | 2b75f1a | 2014-11-14 16:07:34 -0800 | [diff] [blame] | 239 | future.completeExceptionally(e); |
| 240 | Thread.currentThread().interrupt(); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 241 | } catch (Exception e) { |
Yuta HIGUCHI | 9bbaca3 | 2014-11-07 13:08:31 -0800 | [diff] [blame] | 242 | log.warn("RPCTask for {} terribly failed.", request, e); |
Madan Jampani | 9b19a82 | 2014-11-04 21:37:13 -0800 | [diff] [blame] | 243 | future.completeExceptionally(e); |
| 244 | } |
| 245 | } |
| 246 | } |
Madan Jampani | 515865d | 2014-11-09 22:29:34 -0800 | [diff] [blame] | 247 | } |