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