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