Allow sharing the same gRPC channel between clients
This change introduces a refactoring of the gRPC protocol subsystem that
allows the creation of a gRPC chanel independently of the client, while
allowing multiple clients to share the same channel (e.g. as in Stratum
where we use 3 clients).
Moreover, we refactor the P4RuntimeClient API to support multiple
P4Runtime-internal device ID using the same client. While before the
client was associated to one of such ID.
Finally, we provide an abstract implementation for gRPC-based driver
behaviors, reducing code duplication in P4Runtime, gNMI and gNOI drivers.
Change-Id: I1a46352bbbef1e0d24042f169ae8ba580202944f
diff --git a/protocols/grpc/utils/BUILD b/protocols/grpc/utils/BUILD
new file mode 100644
index 0000000..7baaf52
--- /dev/null
+++ b/protocols/grpc/utils/BUILD
@@ -0,0 +1,8 @@
+COMPILE_DEPS = CORE_DEPS + [
+ "//protocols/grpc/api:onos-protocols-grpc-api",
+ "@io_grpc_grpc_java//core",
+]
+
+osgi_jar(
+ deps = COMPILE_DEPS,
+)
diff --git a/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/AbstractGrpcHandlerBehaviour.java b/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/AbstractGrpcHandlerBehaviour.java
new file mode 100644
index 0000000..c66dede
--- /dev/null
+++ b/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/AbstractGrpcHandlerBehaviour.java
@@ -0,0 +1,100 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.grpc.utils;
+
+import com.google.common.base.Strings;
+import com.google.common.collect.Maps;
+import org.onosproject.grpc.api.GrpcClient;
+import org.onosproject.grpc.api.GrpcClientController;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.config.NetworkConfigService;
+import org.onosproject.net.config.basics.BasicDeviceConfig;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.concurrent.ConcurrentMap;
+
+/**
+ * Abstract implementation of HandlerBehaviour for gNMI-based devices.
+ *
+ * @param <CLIENT> gRPC client class
+ * @param <CTRL> gRPC controller class
+ */
+public class AbstractGrpcHandlerBehaviour
+ <CLIENT extends GrpcClient, CTRL extends GrpcClientController<CLIENT>>
+ extends AbstractHandlerBehaviour {
+
+ static final ConcurrentMap<DeviceId, URI> CHANNEL_URIS = Maps.newConcurrentMap();
+
+ protected final Logger log = LoggerFactory.getLogger(getClass());
+
+ final Class<CTRL> controllerClass;
+ protected DeviceId deviceId;
+ protected DeviceService deviceService;
+ protected CLIENT client;
+
+ public AbstractGrpcHandlerBehaviour(Class<CTRL> controllerClass) {
+ this.controllerClass = controllerClass;
+ }
+
+ protected boolean setupBehaviour(String opName) {
+ deviceId = handler().data().deviceId();
+ deviceService = handler().get(DeviceService.class);
+ client = getClientByNetcfg();
+ if (client == null) {
+ log.warn("Missing client for {}, aborting {}", deviceId, opName);
+ return false;
+ }
+
+ return true;
+ }
+
+ private CLIENT getClientByNetcfg() {
+ // Check if there's a channel for this device and if we created it with
+ // the same URI of that derived from the current netcfg. This makes sure
+ // we return null if the netcfg changed after we created the channel.
+ if (!CHANNEL_URIS.containsKey(data().deviceId()) ||
+ !CHANNEL_URIS.get(data().deviceId()).equals(mgmtUriFromNetcfg())) {
+ return null;
+ }
+ return handler().get(controllerClass).get(data().deviceId());
+ }
+
+ protected URI mgmtUriFromNetcfg() {
+ deviceId = handler().data().deviceId();
+
+ final BasicDeviceConfig cfg = handler().get(NetworkConfigService.class)
+ .getConfig(deviceId, BasicDeviceConfig.class);
+ if (cfg == null || Strings.isNullOrEmpty(cfg.managementAddress())) {
+ log.error("Missing or invalid config for {}, cannot derive " +
+ "gRPC server endpoints", deviceId);
+ return null;
+ }
+
+ try {
+ return new URI(cfg.managementAddress());
+ } catch (URISyntaxException e) {
+ log.error("Management address of {} is not a valid URI: {}",
+ deviceId, cfg.managementAddress());
+ return null;
+ }
+ }
+}
diff --git a/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/AbstractGrpcHandshaker.java b/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/AbstractGrpcHandshaker.java
new file mode 100644
index 0000000..0183133
--- /dev/null
+++ b/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/AbstractGrpcHandshaker.java
@@ -0,0 +1,178 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.grpc.utils;
+
+import com.google.common.util.concurrent.Striped;
+import io.grpc.ManagedChannel;
+import org.onosproject.grpc.api.GrpcChannelController;
+import org.onosproject.grpc.api.GrpcClient;
+import org.onosproject.grpc.api.GrpcClientController;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.device.DeviceAgentListener;
+import org.onosproject.net.device.DeviceHandshaker;
+import org.onosproject.net.provider.ProviderId;
+
+import java.net.URI;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.locks.Lock;
+
+import static java.util.concurrent.CompletableFuture.completedFuture;
+
+/**
+ * Abstract implementation of DeviceHandshaker that uses gRPC to establish a
+ * connection to the device.
+ *
+ * @param <CLIENT> gRPC client class
+ * @param <CTRL> gRPC controller class
+ */
+public abstract class AbstractGrpcHandshaker
+ <CLIENT extends GrpcClient, CTRL extends GrpcClientController<CLIENT>>
+ extends AbstractGrpcHandlerBehaviour<CLIENT, CTRL>
+ implements DeviceHandshaker {
+
+ /**
+ * Creates a new instance of this behaviour for the given gRPC controller
+ * class.
+ *
+ * @param controllerClass gRPC controller class
+ */
+ public AbstractGrpcHandshaker(Class<CTRL> controllerClass) {
+ super(controllerClass);
+ }
+
+ private static final Striped<Lock> DEVICE_LOCKS = Striped.lock(10);
+
+ @Override
+ public boolean connect() {
+ final GrpcChannelController channelController = handler().get(
+ GrpcChannelController.class);
+ final CTRL clientController = handler().get(controllerClass);
+ final DeviceId deviceId = data().deviceId();
+
+ final URI netcfgUri = mgmtUriFromNetcfg();
+ if (netcfgUri == null) {
+ return false;
+ }
+
+ DEVICE_LOCKS.get(deviceId).lock();
+ try {
+ if (clientController.get(deviceId) != null) {
+ throw new IllegalStateException(
+ "A client for this device already exists");
+ }
+
+ // Create or get an existing channel. We support sharing the same
+ // channel by different drivers for the same device.
+ final ManagedChannel channel;
+ final URI existingChannelUri = CHANNEL_URIS.get(deviceId);
+ if (existingChannelUri != null) {
+ if (!existingChannelUri.equals(netcfgUri)) {
+ throw new IllegalStateException(
+ "A gRPC channel with different URI already " +
+ "exists for this device");
+ }
+ channel = channelController.get(existingChannelUri)
+ .orElseThrow(() -> new IllegalStateException(
+ "Missing gRPC channel in controller"));
+ } else {
+ try {
+ channel = channelController.create(netcfgUri);
+ } catch (IllegalArgumentException ex) {
+ throw new IllegalStateException(
+ "A gRPC channel with same URI already exists", ex);
+ }
+ // Store channel URI for future use.
+ CHANNEL_URIS.put(deviceId, netcfgUri);
+ // Trigger connection.
+ channel.getState(true);
+ }
+
+ return clientController.create(deviceId, channel);
+ } finally {
+ DEVICE_LOCKS.get(deviceId).unlock();
+ }
+ }
+
+ @Override
+ public boolean hasConnection() {
+ final DeviceId deviceId = data().deviceId();
+ final URI netcfgUri = mgmtUriFromNetcfg();
+ // If a client already exists for this device, but the netcfg with the
+ // server endpoints has changed, this will return false.
+ DEVICE_LOCKS.get(deviceId).lock();
+ try {
+ final URI existingChannelUri = CHANNEL_URIS.get(deviceId);
+ return existingChannelUri != null &&
+ existingChannelUri.equals(netcfgUri) &&
+ handler().get(GrpcChannelController.class)
+ .get(existingChannelUri).isPresent() &&
+ handler().get(controllerClass)
+ .get(deviceId) != null;
+ } finally {
+ DEVICE_LOCKS.get(deviceId).unlock();
+ }
+ }
+
+ @Override
+ public void disconnect() {
+ final DeviceId deviceId = data().deviceId();
+ final URI netcfgUri = mgmtUriFromNetcfg();
+ // This removes any clients and channels associated with this device ID.
+ DEVICE_LOCKS.get(deviceId).lock();
+ try {
+ final URI existingChannelUri = CHANNEL_URIS.remove(deviceId);
+ handler().get(controllerClass).remove(deviceId);
+ if (existingChannelUri != null) {
+ handler().get(GrpcChannelController.class).destroy(existingChannelUri);
+ }
+ if (netcfgUri != null) {
+ // This should not be needed if we are sure there can never be
+ // two channels for the same device.
+ handler().get(GrpcChannelController.class).destroy(netcfgUri);
+ }
+ } finally {
+ DEVICE_LOCKS.get(deviceId).unlock();
+ }
+ }
+
+ @Override
+ public boolean isReachable() {
+ return setupBehaviour("isReachable()") && client.isServerReachable();
+ }
+
+ @Override
+ public CompletableFuture<Boolean> probeReachability() {
+ if (!setupBehaviour("probeReachability()")) {
+ return completedFuture(false);
+ }
+ return client.probeService();
+ }
+
+ @Override
+ public void addDeviceAgentListener(ProviderId providerId, DeviceAgentListener listener) {
+ // Don't use controller/deviceId class variables as they might be uninitialized.
+ handler().get(controllerClass)
+ .addDeviceAgentListener(data().deviceId(), providerId, listener);
+ }
+
+ @Override
+ public void removeDeviceAgentListener(ProviderId providerId) {
+ // Don't use controller/deviceId class variable as they might be uninitialized.
+ handler().get(controllerClass)
+ .removeDeviceAgentListener(data().deviceId(), providerId);
+ }
+}
diff --git a/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/package-info.java b/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/package-info.java
new file mode 100644
index 0000000..ab13d88
--- /dev/null
+++ b/protocols/grpc/utils/src/main/java/org/onosproject/grpc/utils/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2019-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * gRPC protocol utils.
+ */
+package org.onosproject.grpc.utils;