Refactor channel and mastership handling in P4Runtime
This (big) change aims at solving the issue observed with mastership flapping
and device connection/disconnection with P4Runtime.
Channel handling is now based on the underlying gRPC channel state. Before,
channel events (open/close/error) were generated as a consequence of P4Runtime
StreamChannel events, making device availability dependent on mastership. Now
Stream Channel events only affect mastership (MASTER/STANDBY or NONE when the
SteamChannel RPC is not active).
Mastership handling has been refactored to generate P4Runtime election IDs that
are compatible with the mastership preference decided by the MastershipService.
GeneralDeviceProvider has been re-implemented to support in-order
device event processing and to reduce implementation complexity. Stats polling
has been moved to a separate component, and netcfg handling updated to only
depend on BasicDeviceConfig, augmented with a pipeconf field, and re-using the
managementAddress field to set the gRPC server endpoints (e.g.
grpc://myswitch.local:50051). Before it was depending on 3 different config
classes, making hard to detect changes.
Finally, this change affects some core interfaces:
- Adds a method to DeviceProvider and DeviceHandshaker to check for device
availability, making the meaning of availability device-specific. This is needed
in cases where the device manager needs to change the availability state of a
device (as in change #20842)
- Support device providers not capable of reconciling mastership role responses
with requests (like P4Runtime).
- Clarify the meaning of "connection" in the DeviceConnect behavior.
- Allows driver-based providers to check devices for reachability and
availability without probing the device via the network.
Change-Id: I7ff30d29f5d02ad938e3171536e54ae2916629a2
diff --git a/protocols/grpc/api/src/main/java/org/onosproject/grpc/api/GrpcClientKey.java b/protocols/grpc/api/src/main/java/org/onosproject/grpc/api/GrpcClientKey.java
index 99ea23f..d1d0b0f 100644
--- a/protocols/grpc/api/src/main/java/org/onosproject/grpc/api/GrpcClientKey.java
+++ b/protocols/grpc/api/src/main/java/org/onosproject/grpc/api/GrpcClientKey.java
@@ -20,8 +20,11 @@
import com.google.common.base.Objects;
import org.onosproject.net.DeviceId;
+import java.net.URI;
+
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
+import static com.google.common.base.Strings.isNullOrEmpty;
import static java.lang.String.format;
/**
@@ -29,32 +32,36 @@
*/
@Beta
public class GrpcClientKey {
+
+ private static final String GRPC = "grpc";
+ private static final String GRPCS = "grpcs";
+
private final String serviceName;
private final DeviceId deviceId;
- private final String serverAddr;
- private final int serverPort;
+ private final URI serverUri;
/**
* Creates a new client key.
*
* @param serviceName gRPC service name of the client
- * @param deviceId ONOS device ID
- * @param serverAddr gRPC server address
- * @param serverPort gRPC server port
+ * @param deviceId ONOS device ID
+ * @param serverUri gRPC server URI
*/
- public GrpcClientKey(String serviceName, DeviceId deviceId, String serverAddr, int serverPort) {
+ public GrpcClientKey(String serviceName, DeviceId deviceId, URI serverUri) {
checkNotNull(serviceName);
checkNotNull(deviceId);
- checkNotNull(serverAddr);
+ checkNotNull(serverUri);
checkArgument(!serviceName.isEmpty(),
- "Service name can not be null");
- checkArgument(!serverAddr.isEmpty(),
- "Server address should not be empty");
- checkArgument(serverPort > 0 && serverPort <= 65535, "Invalid server port");
+ "Service name can not be null");
+ checkArgument(serverUri.getScheme().equals(GRPC)
+ || serverUri.getScheme().equals(GRPCS),
+ format("Server URI scheme must be %s or %s", GRPC, GRPCS));
+ checkArgument(!isNullOrEmpty(serverUri.getHost()),
+ "Server host address should not be empty");
+ checkArgument(serverUri.getPort() > 0 && serverUri.getPort() <= 65535, "Invalid server port");
this.serviceName = serviceName;
this.deviceId = deviceId;
- this.serverAddr = serverAddr;
- this.serverPort = serverPort;
+ this.serverUri = serverUri;
}
/**
@@ -76,21 +83,21 @@
}
/**
- * Gets the gRPC server address.
+ * Returns the gRPC server URI.
*
- * @return the gRPC server address.
+ * @return the gRPC server URI.
*/
- public String serverAddr() {
- return serverAddr;
+ public URI serveUri() {
+ return serverUri;
}
/**
- * Gets the gRPC server port.
+ * Returns true if the client requires TLS/SSL, false otherwise.
*
- * @return the gRPC server port.
+ * @return boolean
*/
- public int serverPort() {
- return serverPort;
+ public boolean requiresSecureChannel() {
+ return serverUri.getScheme().equals(GRPCS);
}
@Override
@@ -102,19 +109,18 @@
return false;
}
GrpcClientKey that = (GrpcClientKey) o;
- return serverPort == that.serverPort &&
- Objects.equal(serviceName, that.serviceName) &&
+ return Objects.equal(serviceName, that.serviceName) &&
Objects.equal(deviceId, that.deviceId) &&
- Objects.equal(serverAddr, that.serverAddr);
+ Objects.equal(serverUri, that.serverUri);
}
@Override
public int hashCode() {
- return Objects.hashCode(serviceName, deviceId, serverAddr, serverPort);
+ return Objects.hashCode(serviceName, deviceId, serverUri);
}
@Override
public String toString() {
- return format("%s/%s@%s:%s", deviceId, serviceName, serverAddr, serverPort);
+ return format("%s/%s@%s", deviceId, serviceName, serverUri);
}
}