HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [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 | package org.onosproject.incubator.rpc.grpc; |
| 17 | |
| 18 | import static com.google.common.base.Preconditions.checkNotNull; |
| 19 | import static java.util.stream.Collectors.toList; |
HIGUCHI Yuta | 06c1a3f | 2016-05-23 12:54:55 -0700 | [diff] [blame] | 20 | import static org.onosproject.incubator.protobuf.net.ProtobufUtils.translate; |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 21 | import static org.onosproject.net.DeviceId.deviceId; |
| 22 | |
| 23 | import java.util.Collection; |
| 24 | import java.util.List; |
| 25 | import java.util.concurrent.atomic.AtomicBoolean; |
| 26 | |
HIGUCHI Yuta | e3e9063 | 2016-05-11 16:44:01 -0700 | [diff] [blame] | 27 | import org.onosproject.grpc.net.device.DeviceProviderRegistryRpcGrpc; |
| 28 | import org.onosproject.grpc.net.device.DeviceProviderRegistryRpcGrpc.DeviceProviderRegistryRpcStub; |
| 29 | import org.onosproject.grpc.net.device.DeviceService.DeviceProviderMsg; |
| 30 | import org.onosproject.grpc.net.device.DeviceService.DeviceProviderServiceMsg; |
| 31 | import org.onosproject.grpc.net.device.DeviceService.IsReachableRequest; |
| 32 | import org.onosproject.grpc.net.device.DeviceService.RoleChanged; |
| 33 | import org.onosproject.grpc.net.device.DeviceService.TriggerProbe; |
HIGUCHI Yuta | 06c1a3f | 2016-05-23 12:54:55 -0700 | [diff] [blame] | 34 | import org.onosproject.incubator.protobuf.net.ProtobufUtils; |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 35 | import org.onosproject.net.DeviceId; |
| 36 | import org.onosproject.net.MastershipRole; |
| 37 | import org.onosproject.net.device.DeviceDescription; |
| 38 | import org.onosproject.net.device.DeviceProvider; |
| 39 | import org.onosproject.net.device.DeviceProviderService; |
| 40 | import org.onosproject.net.device.PortDescription; |
| 41 | import org.onosproject.net.device.PortStatistics; |
| 42 | import org.onosproject.net.provider.AbstractProviderService; |
| 43 | import org.slf4j.Logger; |
| 44 | import org.slf4j.LoggerFactory; |
| 45 | |
| 46 | import com.google.common.base.MoreObjects; |
| 47 | |
| 48 | import io.grpc.Channel; |
| 49 | import io.grpc.stub.StreamObserver; |
| 50 | |
| 51 | // gRPC Client side |
| 52 | // gRPC wise, this object represents bidirectional streaming service session |
| 53 | // and deals with outgoing message stream |
| 54 | /** |
| 55 | * DeviceProviderService instance associated with given DeviceProvider. |
| 56 | */ |
| 57 | final class DeviceProviderServiceClientProxy |
| 58 | extends AbstractProviderService<DeviceProvider> |
| 59 | implements DeviceProviderService { |
| 60 | |
| 61 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 62 | |
| 63 | private final StreamObserver<DeviceProviderServiceMsg> devProvService; |
| 64 | private final AtomicBoolean hasShutdown = new AtomicBoolean(false); |
| 65 | |
| 66 | private final Channel channel; |
| 67 | |
Yuta HIGUCHI | ad4861e | 2016-07-13 19:19:03 -0700 | [diff] [blame] | 68 | private Throwable error; |
| 69 | |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 70 | DeviceProviderServiceClientProxy(DeviceProvider provider, Channel channel) { |
| 71 | super(provider); |
| 72 | this.channel = channel; |
| 73 | |
| 74 | DeviceProviderRegistryRpcStub stub = DeviceProviderRegistryRpcGrpc.newStub(channel); |
| 75 | log.debug("Calling RPC register({}) against {}", provider.id(), channel.authority()); |
| 76 | devProvService = stub.register(new DeviceProviderClientProxy(provider)); |
| 77 | |
| 78 | // send initialize message |
| 79 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
| 80 | builder.setRegisterProvider(builder.getRegisterProviderBuilder() |
| 81 | .setProviderScheme(provider.id().scheme()) |
| 82 | .build()); |
| 83 | devProvService.onNext(builder.build()); |
| 84 | } |
| 85 | |
| 86 | @Override |
| 87 | public void deviceConnected(DeviceId deviceId, |
| 88 | DeviceDescription deviceDescription) { |
| 89 | checkValidity(); |
| 90 | |
| 91 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
| 92 | builder.setDeviceConnected(builder.getDeviceConnectedBuilder() |
| 93 | .setDeviceId(deviceId.toString()) |
| 94 | .setDeviceDescription(translate(deviceDescription)) |
| 95 | .build()); |
| 96 | |
| 97 | devProvService.onNext(builder.build()); |
| 98 | } |
| 99 | |
| 100 | @Override |
| 101 | public void deviceDisconnected(DeviceId deviceId) { |
| 102 | checkValidity(); |
| 103 | |
| 104 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
| 105 | builder.setDeviceDisconnected(builder.getDeviceDisconnectedBuilder() |
| 106 | .setDeviceId(deviceId.toString()) |
| 107 | .build()); |
| 108 | |
| 109 | devProvService.onNext(builder.build()); |
| 110 | } |
| 111 | |
| 112 | @Override |
| 113 | public void updatePorts(DeviceId deviceId, |
| 114 | List<PortDescription> portDescriptions) { |
| 115 | checkValidity(); |
| 116 | |
| 117 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
HIGUCHI Yuta | e3e9063 | 2016-05-11 16:44:01 -0700 | [diff] [blame] | 118 | List<org.onosproject.grpc.net.Port.PortDescription> portDescs = |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 119 | portDescriptions.stream() |
HIGUCHI Yuta | 06c1a3f | 2016-05-23 12:54:55 -0700 | [diff] [blame] | 120 | .map(ProtobufUtils::translate) |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 121 | .collect(toList()); |
| 122 | |
| 123 | builder.setUpdatePorts(builder.getUpdatePortsBuilder() |
| 124 | .setDeviceId(deviceId.toString()) |
| 125 | .addAllPortDescriptions(portDescs) |
| 126 | .build()); |
| 127 | |
| 128 | devProvService.onNext(builder.build()); |
| 129 | } |
| 130 | |
| 131 | @Override |
| 132 | public void portStatusChanged(DeviceId deviceId, |
| 133 | PortDescription portDescription) { |
| 134 | checkValidity(); |
| 135 | |
| 136 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
| 137 | builder.setPortStatusChanged(builder.getPortStatusChangedBuilder() |
| 138 | .setDeviceId(deviceId.toString()) |
| 139 | .setPortDescription(translate(portDescription)) |
| 140 | .build()); |
| 141 | |
| 142 | devProvService.onNext(builder.build()); |
| 143 | } |
| 144 | |
| 145 | @Override |
| 146 | public void receivedRoleReply(DeviceId deviceId, MastershipRole requested, |
| 147 | MastershipRole response) { |
| 148 | checkValidity(); |
| 149 | |
| 150 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
| 151 | builder.setReceivedRoleReply(builder.getReceivedRoleReplyBuilder() |
| 152 | .setDeviceId(deviceId.toString()) |
| 153 | .setRequested(translate(requested)) |
| 154 | .setResponse(translate(response)) |
| 155 | .build()); |
| 156 | |
| 157 | devProvService.onNext(builder.build()); |
| 158 | } |
| 159 | |
| 160 | @Override |
| 161 | public void updatePortStatistics(DeviceId deviceId, |
| 162 | Collection<PortStatistics> portStatistics) { |
| 163 | checkValidity(); |
| 164 | |
| 165 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
HIGUCHI Yuta | e3e9063 | 2016-05-11 16:44:01 -0700 | [diff] [blame] | 166 | List<org.onosproject.grpc.net.Port.PortStatistics> portStats = |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 167 | portStatistics.stream() |
HIGUCHI Yuta | 06c1a3f | 2016-05-23 12:54:55 -0700 | [diff] [blame] | 168 | .map(ProtobufUtils::translate) |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 169 | .collect(toList()); |
| 170 | builder.setUpdatePortStatistics(builder.getUpdatePortStatisticsBuilder() |
| 171 | .setDeviceId(deviceId.toString()) |
| 172 | .addAllPortStatistics(portStats) |
| 173 | .build()); |
| 174 | |
| 175 | devProvService.onNext(builder.build()); |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Shutdown this session. |
| 180 | */ |
| 181 | public void shutdown() { |
| 182 | if (hasShutdown.compareAndSet(false, true)) { |
| 183 | log.info("Shutting down session over {}", channel.authority()); |
| 184 | // initiate clean shutdown from client |
| 185 | devProvService.onCompleted(); |
| 186 | invalidate(); |
| 187 | } |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * Abnormally terminate this session. |
| 192 | * @param t error details |
| 193 | */ |
| 194 | public void shutdown(Throwable t) { |
| 195 | if (hasShutdown.compareAndSet(false, true)) { |
| 196 | log.error("Shutting down session over {}", channel.authority()); |
| 197 | // initiate abnormal termination from client |
| 198 | devProvService.onError(t); |
Yuta HIGUCHI | ad4861e | 2016-07-13 19:19:03 -0700 | [diff] [blame] | 199 | invalidate(t); |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 200 | } |
| 201 | } |
| 202 | |
Yuta HIGUCHI | ad4861e | 2016-07-13 19:19:03 -0700 | [diff] [blame] | 203 | /** |
| 204 | * Invalidates the ProviderService indicating Failure. |
| 205 | * @param t {@link Throwable} describing last failure |
| 206 | */ |
| 207 | private void invalidate(Throwable t) { |
| 208 | this.error = t; |
| 209 | invalidate(); |
| 210 | } |
| 211 | |
| 212 | @Override |
| 213 | public void checkValidity() { |
| 214 | if (error != null) { |
| 215 | throw new IllegalStateException("DeviceProviderService no longer valid", |
| 216 | error); |
| 217 | } |
| 218 | super.checkValidity(); |
| 219 | } |
| 220 | |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 221 | @Override |
| 222 | public String toString() { |
| 223 | return MoreObjects.toStringHelper(this) |
| 224 | .add("channel", channel.authority()) |
| 225 | .add("hasShutdown", hasShutdown.get()) |
| 226 | .toString(); |
| 227 | } |
| 228 | |
| 229 | // gRPC wise, this object handles incoming message stream |
| 230 | /** |
| 231 | * Translates DeviceProvider instructions received from RPC to Java calls. |
| 232 | */ |
| 233 | private final class DeviceProviderClientProxy |
| 234 | implements StreamObserver<DeviceProviderMsg> { |
| 235 | |
| 236 | private final DeviceProvider provider; |
| 237 | |
| 238 | DeviceProviderClientProxy(DeviceProvider provider) { |
| 239 | this.provider = checkNotNull(provider); |
| 240 | } |
| 241 | |
| 242 | @Override |
| 243 | public void onNext(DeviceProviderMsg msg) { |
| 244 | try { |
| 245 | log.trace("DeviceProviderClientProxy received: {}", msg); |
| 246 | onMethod(msg); |
| 247 | } catch (Exception e) { |
| 248 | log.error("Exception caught handling {} at DeviceProviderClientProxy", msg, e); |
| 249 | // initiate shutdown from client |
| 250 | shutdown(e); |
| 251 | } |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Translates received RPC message to {@link DeviceProvider} method calls. |
| 256 | * @param msg DeviceProvider message |
| 257 | */ |
| 258 | private void onMethod(DeviceProviderMsg msg) { |
| 259 | switch (msg.getMethodCase()) { |
| 260 | case TRIGGER_PROBE: |
| 261 | TriggerProbe triggerProbe = msg.getTriggerProbe(); |
| 262 | provider.triggerProbe(deviceId(triggerProbe.getDeviceId())); |
| 263 | break; |
| 264 | case ROLE_CHANGED: |
| 265 | RoleChanged roleChanged = msg.getRoleChanged(); |
| 266 | provider.roleChanged(deviceId(roleChanged.getDeviceId()), |
| 267 | translate(roleChanged.getNewRole())); |
| 268 | break; |
| 269 | case IS_REACHABLE_REQUEST: |
| 270 | IsReachableRequest isReachableRequest = msg.getIsReachableRequest(); |
| 271 | // check if reachable |
| 272 | boolean reachable = provider.isReachable(deviceId(isReachableRequest.getDeviceId())); |
| 273 | |
| 274 | int xid = isReachableRequest.getXid(); |
| 275 | // send response back DeviceProviderService channel |
| 276 | DeviceProviderServiceMsg.Builder builder = DeviceProviderServiceMsg.newBuilder(); |
| 277 | builder.setIsReachableResponse(builder.getIsReachableResponseBuilder() |
| 278 | .setXid(xid) |
| 279 | .setIsReachable(reachable) |
| 280 | .build()); |
| 281 | devProvService.onNext(builder.build()); |
| 282 | break; |
| 283 | |
| 284 | case METHOD_NOT_SET: |
| 285 | default: |
| 286 | log.warn("Unexpected method, ignoring", msg); |
| 287 | break; |
| 288 | } |
| 289 | } |
| 290 | |
| 291 | @Override |
| 292 | public void onCompleted() { |
| 293 | log.info("DeviceProviderClientProxy completed"); |
| 294 | // session terminated from remote |
Yuta HIGUCHI | ad4861e | 2016-07-13 19:19:03 -0700 | [diff] [blame] | 295 | invalidate(); |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 296 | } |
| 297 | |
| 298 | @Override |
| 299 | public void onError(Throwable t) { |
| 300 | log.error("DeviceProviderClientProxy#onError", t); |
| 301 | // session terminated from remote |
Yuta HIGUCHI | ad4861e | 2016-07-13 19:19:03 -0700 | [diff] [blame] | 302 | invalidate(t); |
HIGUCHI Yuta | 15653fd | 2015-11-09 11:05:09 -0800 | [diff] [blame] | 303 | } |
| 304 | |
| 305 | @Override |
| 306 | public String toString() { |
| 307 | return MoreObjects.toStringHelper(this) |
| 308 | .add("channel", channel.authority()) |
| 309 | .toString(); |
| 310 | } |
| 311 | } |
| 312 | } |
| 313 | |