Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 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.onosproject.grpc.ctl; |
| 18 | |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 19 | import com.google.common.collect.ImmutableMap; |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 20 | import com.google.common.util.concurrent.Striped; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 21 | import io.grpc.ManagedChannel; |
| 22 | import io.grpc.ManagedChannelBuilder; |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 23 | import io.grpc.Status; |
| 24 | import io.grpc.StatusRuntimeException; |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 25 | import org.onlab.util.Tools; |
| 26 | import org.onosproject.cfg.ComponentConfigService; |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 27 | import org.onosproject.grpc.api.GrpcChannelController; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 28 | import org.onosproject.grpc.api.GrpcChannelId; |
Carmelo Cascone | 6a1ae71 | 2018-08-10 12:19:47 -0700 | [diff] [blame] | 29 | import org.onosproject.grpc.proto.dummy.Dummy; |
| 30 | import org.onosproject.grpc.proto.dummy.DummyServiceGrpc; |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 31 | import org.osgi.service.component.ComponentContext; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 32 | import org.osgi.service.component.annotations.Activate; |
| 33 | import org.osgi.service.component.annotations.Component; |
| 34 | import org.osgi.service.component.annotations.Deactivate; |
| 35 | import org.osgi.service.component.annotations.Modified; |
| 36 | import org.osgi.service.component.annotations.Reference; |
| 37 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 38 | import org.slf4j.Logger; |
| 39 | import org.slf4j.LoggerFactory; |
| 40 | |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 41 | import java.util.Dictionary; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 42 | import java.util.Map; |
| 43 | import java.util.Optional; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 44 | import java.util.concurrent.CompletableFuture; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 45 | import java.util.concurrent.ConcurrentHashMap; |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 46 | import java.util.concurrent.TimeUnit; |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 47 | import java.util.concurrent.atomic.AtomicBoolean; |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 48 | import java.util.concurrent.locks.Lock; |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 49 | |
| 50 | import static com.google.common.base.Preconditions.checkNotNull; |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 51 | import static java.lang.String.format; |
Thomas Vachuska | 00b5d4f | 2018-10-30 15:13:20 -0700 | [diff] [blame] | 52 | import static org.onosproject.grpc.ctl.OsgiPropertyConstants.ENABLE_MESSAGE_LOG; |
| 53 | import static org.onosproject.grpc.ctl.OsgiPropertyConstants.ENABLE_MESSAGE_LOG_DEFAULT; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 54 | |
| 55 | /** |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 56 | * Default implementation of the GrpcChannelController. |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 57 | */ |
Ray Milkey | 5739b2c | 2018-11-06 14:04:51 -0800 | [diff] [blame] | 58 | @Component(immediate = true, service = GrpcChannelController.class, |
Thomas Vachuska | 00b5d4f | 2018-10-30 15:13:20 -0700 | [diff] [blame] | 59 | property = { |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 60 | ENABLE_MESSAGE_LOG + ":Boolean=" + ENABLE_MESSAGE_LOG_DEFAULT, |
Thomas Vachuska | 00b5d4f | 2018-10-30 15:13:20 -0700 | [diff] [blame] | 61 | }) |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 62 | public class GrpcChannelControllerImpl implements GrpcChannelController { |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 63 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 64 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 65 | protected ComponentConfigService componentConfigService; |
| 66 | |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 67 | /** |
| 68 | * Indicates whether to log gRPC messages. |
| 69 | */ |
| 70 | private final AtomicBoolean enableMessageLog = new AtomicBoolean( |
| 71 | ENABLE_MESSAGE_LOG_DEFAULT); |
Carmelo Cascone | 8d99b17 | 2017-07-18 17:26:31 -0400 | [diff] [blame] | 72 | |
Carmelo Cascone | 47a853b | 2018-01-05 02:40:58 +0100 | [diff] [blame] | 73 | private final Logger log = LoggerFactory.getLogger(getClass()); |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 74 | |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 75 | private Map<GrpcChannelId, ManagedChannel> channels; |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 76 | private Map<GrpcChannelId, GrpcLoggingInterceptor> interceptors; |
| 77 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 78 | private final Striped<Lock> channelLocks = Striped.lock(30); |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 79 | |
| 80 | @Activate |
| 81 | public void activate() { |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 82 | componentConfigService.registerProperties(getClass()); |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 83 | channels = new ConcurrentHashMap<>(); |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 84 | interceptors = new ConcurrentHashMap<>(); |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 85 | log.info("Started"); |
| 86 | } |
| 87 | |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 88 | @Modified |
| 89 | public void modified(ComponentContext context) { |
| 90 | if (context != null) { |
| 91 | Dictionary<?, ?> properties = context.getProperties(); |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 92 | enableMessageLog.set(Tools.isPropertyEnabled( |
| 93 | properties, ENABLE_MESSAGE_LOG, ENABLE_MESSAGE_LOG_DEFAULT)); |
| 94 | log.info("Configured. Logging of gRPC messages is {}", |
| 95 | enableMessageLog.get() |
| 96 | ? "ENABLED for new channels" |
| 97 | : "DISABLED for new and existing channels"); |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 98 | } |
| 99 | } |
| 100 | |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 101 | @Deactivate |
| 102 | public void deactivate() { |
Andrea Campanella | a74bdba | 2018-05-15 16:45:00 +0200 | [diff] [blame] | 103 | componentConfigService.unregisterProperties(getClass(), false); |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 104 | channels.values().forEach(ManagedChannel::shutdownNow); |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 105 | channels.clear(); |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 106 | channels = null; |
| 107 | interceptors.values().forEach(GrpcLoggingInterceptor::close); |
| 108 | interceptors.clear(); |
| 109 | interceptors = null; |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 110 | log.info("Stopped"); |
| 111 | } |
| 112 | |
| 113 | @Override |
Carmelo Cascone | 47a853b | 2018-01-05 02:40:58 +0100 | [diff] [blame] | 114 | public ManagedChannel connectChannel(GrpcChannelId channelId, |
Carmelo Cascone | a71b849 | 2018-12-17 17:47:50 -0800 | [diff] [blame] | 115 | ManagedChannelBuilder<?> channelBuilder) { |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 116 | checkNotNull(channelId); |
| 117 | checkNotNull(channelBuilder); |
Carmelo Cascone | 8d99b17 | 2017-07-18 17:26:31 -0400 | [diff] [blame] | 118 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 119 | Lock lock = channelLocks.get(channelId); |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 120 | lock.lock(); |
| 121 | |
| 122 | try { |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 123 | if (channels.containsKey(channelId)) { |
| 124 | throw new IllegalArgumentException(format( |
| 125 | "A channel with ID '%s' already exists", channelId)); |
| 126 | } |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 127 | |
| 128 | GrpcLoggingInterceptor interceptor = null; |
| 129 | if (enableMessageLog.get()) { |
| 130 | interceptor = new GrpcLoggingInterceptor(channelId, enableMessageLog); |
| 131 | channelBuilder.intercept(interceptor); |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 132 | } |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 133 | ManagedChannel channel = channelBuilder.build(); |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 134 | // Forced connection API is still experimental. Use workaround... |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 135 | // channel.getState(true); |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 136 | try { |
| 137 | doDummyMessage(channel); |
| 138 | } catch (StatusRuntimeException e) { |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 139 | if (interceptor != null) { |
| 140 | interceptor.close(); |
| 141 | } |
Carmelo Cascone | a71b849 | 2018-12-17 17:47:50 -0800 | [diff] [blame] | 142 | shutdownNowAndWait(channel, channelId); |
| 143 | throw e; |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 144 | } |
| 145 | // If here, channel is open. |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 146 | channels.put(channelId, channel); |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 147 | if (interceptor != null) { |
| 148 | interceptors.put(channelId, interceptor); |
| 149 | } |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 150 | return channel; |
| 151 | } finally { |
| 152 | lock.unlock(); |
Carmelo Cascone | 8d99b17 | 2017-07-18 17:26:31 -0400 | [diff] [blame] | 153 | } |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 154 | } |
| 155 | |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 156 | private void doDummyMessage(ManagedChannel channel) throws StatusRuntimeException { |
Carmelo Cascone | 47a853b | 2018-01-05 02:40:58 +0100 | [diff] [blame] | 157 | DummyServiceGrpc.DummyServiceBlockingStub dummyStub = DummyServiceGrpc |
| 158 | .newBlockingStub(channel) |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 159 | .withDeadlineAfter(CONNECTION_TIMEOUT_SECONDS, TimeUnit.SECONDS); |
| 160 | try { |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 161 | //noinspection ResultOfMethodCallIgnored |
| 162 | dummyStub.sayHello(Dummy.DummyMessageThatNoOneWouldReallyUse |
| 163 | .getDefaultInstance()); |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 164 | } catch (StatusRuntimeException e) { |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 165 | if (!e.getStatus().equals(Status.UNIMPLEMENTED)) { |
Carmelo Cascone | 47a853b | 2018-01-05 02:40:58 +0100 | [diff] [blame] | 166 | // UNIMPLEMENTED means that the server received our message but |
| 167 | // doesn't know how to handle it. Hence, channel is open. |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 168 | throw e; |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 169 | } |
| 170 | } |
| 171 | } |
| 172 | |
| 173 | @Override |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 174 | public void disconnectChannel(GrpcChannelId channelId) { |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 175 | checkNotNull(channelId); |
| 176 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 177 | Lock lock = channelLocks.get(channelId); |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 178 | lock.lock(); |
Carmelo Cascone | 59f57de | 2017-07-11 19:55:09 -0400 | [diff] [blame] | 179 | try { |
Carmelo Cascone | 6d57f32 | 2018-12-13 23:15:17 -0800 | [diff] [blame] | 180 | final ManagedChannel channel = channels.remove(channelId); |
Carmelo Cascone | a71b849 | 2018-12-17 17:47:50 -0800 | [diff] [blame] | 181 | if (channel != null) { |
| 182 | shutdownNowAndWait(channel, channelId); |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 183 | } |
Carmelo Cascone | 73f4530 | 2019-02-04 23:11:26 -0800 | [diff] [blame] | 184 | final GrpcLoggingInterceptor interceptor = interceptors.remove(channelId); |
| 185 | if (interceptor != null) { |
| 186 | interceptor.close(); |
| 187 | } |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 188 | } finally { |
| 189 | lock.unlock(); |
| 190 | } |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 191 | } |
| 192 | |
Carmelo Cascone | a71b849 | 2018-12-17 17:47:50 -0800 | [diff] [blame] | 193 | private void shutdownNowAndWait(ManagedChannel channel, GrpcChannelId channelId) { |
| 194 | try { |
| 195 | if (!channel.shutdownNow() |
| 196 | .awaitTermination(5, TimeUnit.SECONDS)) { |
| 197 | log.error("Channel '{}' didn't terminate, although we " + |
| 198 | "triggered a shutdown and waited", |
| 199 | channelId); |
| 200 | } |
| 201 | } catch (InterruptedException e) { |
| 202 | log.warn("Channel {} didn't shutdown in time", channelId); |
| 203 | Thread.currentThread().interrupt(); |
| 204 | } |
| 205 | } |
| 206 | |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 207 | @Override |
| 208 | public Map<GrpcChannelId, ManagedChannel> getChannels() { |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 209 | return ImmutableMap.copyOf(channels); |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 210 | } |
| 211 | |
| 212 | @Override |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 213 | public Optional<ManagedChannel> getChannel(GrpcChannelId channelId) { |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 214 | checkNotNull(channelId); |
| 215 | |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 216 | Lock lock = channelLocks.get(channelId); |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 217 | lock.lock(); |
Carmelo Cascone | fb92407 | 2017-08-29 20:21:55 +0200 | [diff] [blame] | 218 | try { |
| 219 | return Optional.ofNullable(channels.get(channelId)); |
| 220 | } finally { |
| 221 | lock.unlock(); |
| 222 | } |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 223 | } |
Carmelo Cascone | 8d99b17 | 2017-07-18 17:26:31 -0400 | [diff] [blame] | 224 | |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 225 | @Override |
| 226 | public CompletableFuture<Boolean> probeChannel(GrpcChannelId channelId) { |
| 227 | final ManagedChannel channel = channels.get(channelId); |
| 228 | if (channel == null) { |
| 229 | log.warn("Unable to find any channel with ID {}, cannot send probe", |
| 230 | channelId); |
| 231 | return CompletableFuture.completedFuture(false); |
| 232 | } |
| 233 | return CompletableFuture.supplyAsync(() -> { |
| 234 | try { |
| 235 | doDummyMessage(channel); |
| 236 | return true; |
| 237 | } catch (StatusRuntimeException e) { |
| 238 | log.debug("Probe for {} failed", channelId); |
| 239 | log.debug("", e); |
| 240 | return false; |
| 241 | } |
| 242 | }); |
| 243 | } |
Andrea Campanella | 378e21a | 2017-06-07 12:09:59 +0200 | [diff] [blame] | 244 | } |