Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019-present Open Networking Foundation |
| 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.p4runtime.ctl.client; |
| 18 | |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 19 | import com.google.common.collect.Maps; |
| 20 | import io.grpc.ConnectivityState; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 21 | import io.grpc.ManagedChannel; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 22 | import io.grpc.Status; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 23 | import io.grpc.StatusRuntimeException; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 24 | import io.grpc.stub.StreamObserver; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 25 | import org.onosproject.grpc.ctl.AbstractGrpcClient; |
| 26 | import org.onosproject.net.DeviceId; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 27 | import org.onosproject.net.device.DeviceAgentEvent; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 28 | import org.onosproject.net.pi.model.PiPipeconf; |
| 29 | import org.onosproject.net.pi.runtime.PiPacketOperation; |
| 30 | import org.onosproject.net.pi.service.PiPipeconfService; |
| 31 | import org.onosproject.p4runtime.api.P4RuntimeClient; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 32 | import org.onosproject.p4runtime.ctl.controller.MasterElectionIdStore; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 33 | import org.onosproject.p4runtime.ctl.controller.P4RuntimeControllerImpl; |
| 34 | import p4.v1.P4RuntimeGrpc; |
| 35 | import p4.v1.P4RuntimeOuterClass; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 36 | import p4.v1.P4RuntimeOuterClass.GetForwardingPipelineConfigRequest; |
| 37 | import p4.v1.P4RuntimeOuterClass.GetForwardingPipelineConfigResponse; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 38 | |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 39 | import java.math.BigInteger; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 40 | import java.nio.ByteBuffer; |
| 41 | import java.util.concurrent.CompletableFuture; |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 42 | import java.util.concurrent.ConcurrentMap; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 43 | import java.util.concurrent.TimeUnit; |
| 44 | import java.util.function.Consumer; |
| 45 | |
| 46 | import static com.google.common.base.Preconditions.checkNotNull; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 47 | import static p4.v1.P4RuntimeOuterClass.GetForwardingPipelineConfigRequest.ResponseType.COOKIE_ONLY; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * Implementation of P4RuntimeClient. |
| 51 | */ |
| 52 | public final class P4RuntimeClientImpl |
| 53 | extends AbstractGrpcClient implements P4RuntimeClient { |
| 54 | |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 55 | private static final long DEFAULT_P4_DEVICE_ID = 1; |
| 56 | |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 57 | // TODO: consider making timeouts configurable per-device via netcfg |
pierventre | 270cf6d | 2022-02-22 15:43:46 -0800 | [diff] [blame] | 58 | // We have measured that some devices can take up to 15s to push a pipeline |
| 59 | // which can block potentially other READ done against the target. |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 60 | /** |
| 61 | * Timeout in seconds for short/fast RPCs. |
| 62 | */ |
pierventre | 270cf6d | 2022-02-22 15:43:46 -0800 | [diff] [blame] | 63 | static final int SHORT_TIMEOUT_SECONDS = 15; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 64 | /** |
| 65 | * Timeout in seconds for RPCs that involve transfer of potentially large |
| 66 | * amount of data. This shoulld be long enough to allow for network delay |
| 67 | * (e.g. to transfer large pipeline binaries over slow network). |
| 68 | */ |
| 69 | static final int LONG_TIMEOUT_SECONDS = 60; |
| 70 | |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 71 | private final P4RuntimeControllerImpl controller; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 72 | private final PipelineConfigClientImpl pipelineConfigClient; |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 73 | private final PiPipeconfService pipeconfService; |
| 74 | private final MasterElectionIdStore masterElectionIdStore; |
| 75 | private final ConcurrentMap<Long, StreamClientImpl> streamClients = Maps.newConcurrentMap(); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Instantiates a new client with the given arguments. |
| 79 | * |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 80 | * @param deviceId device ID |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 81 | * @param channel gRPC managed channel |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 82 | * @param controller P4Runtime controller instance |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 83 | * @param pipeconfService pipeconf service instance |
| 84 | * @param masterElectionIdStore master election ID store |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 85 | */ |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 86 | public P4RuntimeClientImpl(DeviceId deviceId, |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 87 | ManagedChannel channel, |
| 88 | P4RuntimeControllerImpl controller, |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 89 | PiPipeconfService pipeconfService, |
| 90 | MasterElectionIdStore masterElectionIdStore) { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 91 | super(deviceId, channel, true, controller); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 92 | checkNotNull(channel); |
| 93 | checkNotNull(controller); |
| 94 | checkNotNull(pipeconfService); |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 95 | checkNotNull(masterElectionIdStore); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 96 | |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 97 | this.controller = controller; |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 98 | this.pipeconfService = pipeconfService; |
| 99 | this.masterElectionIdStore = masterElectionIdStore; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 100 | this.pipelineConfigClient = new PipelineConfigClientImpl(this); |
| 101 | } |
| 102 | |
| 103 | @Override |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 104 | public void shutdown() { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 105 | streamClients.forEach((p4DeviceId, streamClient) -> |
| 106 | streamClient.closeSession(p4DeviceId)); |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 107 | super.shutdown(); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | @Override |
| 111 | public CompletableFuture<Boolean> setPipelineConfig( |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 112 | long p4DeviceId, PiPipeconf pipeconf, ByteBuffer deviceData) { |
| 113 | return pipelineConfigClient.setPipelineConfig(p4DeviceId, pipeconf, deviceData); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
| 117 | public CompletableFuture<Boolean> isPipelineConfigSet( |
Carmelo Cascone | adb8905 | 2019-04-17 20:02:33 -0700 | [diff] [blame] | 118 | long p4DeviceId, PiPipeconf pipeconf) { |
| 119 | return pipelineConfigClient.isPipelineConfigSet(p4DeviceId, pipeconf); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 123 | public CompletableFuture<Boolean> isAnyPipelineConfigSet(long p4DeviceId) { |
| 124 | return pipelineConfigClient.isAnyPipelineConfigSet(p4DeviceId); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 128 | public ReadRequest read(long p4DeviceId, PiPipeconf pipeconf) { |
| 129 | return new ReadRequestImpl(this, p4DeviceId, pipeconf); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 133 | public boolean isSessionOpen(long p4DeviceId) { |
| 134 | return streamClients.containsKey(p4DeviceId) && |
| 135 | streamClients.get(p4DeviceId).isSessionOpen(p4DeviceId); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 139 | public void closeSession(long p4DeviceId) { |
| 140 | if (streamClients.containsKey(p4DeviceId)) { |
| 141 | streamClients.get(p4DeviceId).closeSession(p4DeviceId); |
| 142 | } |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 146 | public void setMastership(long p4DeviceId, boolean master, BigInteger newElectionId) { |
| 147 | streamClients.putIfAbsent(p4DeviceId, new StreamClientImpl( |
| 148 | pipeconfService, masterElectionIdStore, this, p4DeviceId, controller)); |
| 149 | streamClients.get(p4DeviceId).setMastership(p4DeviceId, master, newElectionId); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 150 | } |
| 151 | |
| 152 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 153 | public boolean isMaster(long p4DeviceId) { |
| 154 | return streamClients.containsKey(p4DeviceId) && |
| 155 | streamClients.get(p4DeviceId).isMaster(p4DeviceId); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 159 | public void packetOut(long p4DeviceId, PiPacketOperation packet, PiPipeconf pipeconf) { |
| 160 | if (streamClients.containsKey(p4DeviceId)) { |
| 161 | streamClients.get(p4DeviceId).packetOut(p4DeviceId, packet, pipeconf); |
| 162 | } |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | @Override |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 166 | public WriteRequest write(long p4DeviceId, PiPipeconf pipeconf) { |
| 167 | return new WriteRequestImpl(this, p4DeviceId, pipeconf); |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 168 | } |
| 169 | |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 170 | @Override |
| 171 | public CompletableFuture<Boolean> probeService() { |
| 172 | final CompletableFuture<Boolean> future = new CompletableFuture<>(); |
| 173 | final StreamObserver<GetForwardingPipelineConfigResponse> responseObserver = |
| 174 | new StreamObserver<GetForwardingPipelineConfigResponse>() { |
| 175 | @Override |
| 176 | public void onNext(GetForwardingPipelineConfigResponse value) { |
| 177 | future.complete(true); |
| 178 | } |
| 179 | |
| 180 | @Override |
| 181 | public void onError(Throwable t) { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 182 | log.debug("", t); |
| 183 | // FIXME: The P4Runtime spec is not explicit about error |
| 184 | // codes when a pipeline config is not set, which would |
| 185 | // be useful here as it's an indication that the |
| 186 | // service is available. As a workaround, we simply |
| 187 | // check the channel state. |
| 188 | future.complete(ConnectivityState.READY.equals( |
| 189 | channel.getState(false))); |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | @Override |
| 193 | public void onCompleted() { |
| 194 | // Ignore, unary call. |
| 195 | } |
| 196 | }; |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 197 | // Get any p4DeviceId under the control of this client or a default one. |
| 198 | final long p4DeviceId = streamClients.isEmpty() ? DEFAULT_P4_DEVICE_ID |
| 199 | : streamClients.keySet().iterator().next(); |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 200 | // Use long timeout as the device might return the full P4 blob |
| 201 | // (e.g. server does not support cookie), over a slow network. |
| 202 | execRpc(s -> s.getForwardingPipelineConfig( |
| 203 | GetForwardingPipelineConfigRequest.newBuilder() |
| 204 | .setDeviceId(p4DeviceId) |
| 205 | .setResponseType(COOKIE_ONLY) |
| 206 | .build(), responseObserver), |
| 207 | SHORT_TIMEOUT_SECONDS); |
| 208 | return future; |
| 209 | } |
| 210 | |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 211 | @Override |
| 212 | protected void handleRpcError(Throwable throwable, String opDescription) { |
| 213 | if (throwable instanceof StatusRuntimeException) { |
| 214 | checkGrpcException((StatusRuntimeException) throwable); |
| 215 | } |
| 216 | super.handleRpcError(throwable, opDescription); |
| 217 | } |
| 218 | |
| 219 | private void checkGrpcException(StatusRuntimeException sre) { |
| 220 | if (sre.getStatus().getCode() == Status.Code.PERMISSION_DENIED) { |
| 221 | // Notify upper layers that this node is not master. |
| 222 | controller.postEvent(new DeviceAgentEvent( |
| 223 | DeviceAgentEvent.Type.NOT_MASTER, deviceId)); |
| 224 | } |
| 225 | } |
| 226 | |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 227 | /** |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 228 | * Returns the ONOS device ID associated with this client. |
| 229 | * |
| 230 | * @return ONOS device ID |
| 231 | */ |
| 232 | DeviceId deviceId() { |
| 233 | return this.deviceId; |
| 234 | } |
| 235 | |
| 236 | /** |
| 237 | * Returns the election ID last used in a MasterArbitrationUpdate message |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 238 | * sent by the client to the server for the given P4Runtime-internal device |
| 239 | * ID. No guarantees are given that this is the current election ID |
| 240 | * associated to the session, nor that the server has acknowledged this |
| 241 | * value as valid. |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 242 | * |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 243 | * @param p4DeviceId P4Runtime-internal device ID |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 244 | * @return election ID uint128 protobuf message |
| 245 | */ |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 246 | P4RuntimeOuterClass.Uint128 lastUsedElectionId(long p4DeviceId) { |
| 247 | if (streamClients.containsKey(p4DeviceId)) { |
| 248 | return streamClients.get(p4DeviceId).lastUsedElectionId(); |
| 249 | } else { |
| 250 | return P4RuntimeOuterClass.Uint128.getDefaultInstance(); |
| 251 | } |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Forces execution of an RPC in a cancellable context with the given |
| 256 | * timeout (in seconds). |
| 257 | * |
| 258 | * @param stubConsumer P4Runtime stub consumer |
| 259 | * @param timeout timeout in seconds |
| 260 | */ |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 261 | void execRpc(Consumer<P4RuntimeGrpc.P4RuntimeStub> stubConsumer, |
| 262 | int timeout) { |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 263 | if (log.isTraceEnabled()) { |
| 264 | log.trace("Executing RPC with timeout {} seconds (context deadline {})...", |
| 265 | timeout, context().getDeadline()); |
| 266 | } |
| 267 | runInCancellableContext(() -> stubConsumer.accept( |
| 268 | P4RuntimeGrpc.newStub(channel) |
| 269 | .withDeadlineAfter(timeout, TimeUnit.SECONDS))); |
| 270 | } |
| 271 | |
| 272 | /** |
| 273 | * Forces execution of an RPC in a cancellable context with no timeout. |
| 274 | * |
| 275 | * @param stubConsumer P4Runtime stub consumer |
| 276 | */ |
| 277 | void execRpcNoTimeout(Consumer<P4RuntimeGrpc.P4RuntimeStub> stubConsumer) { |
| 278 | if (log.isTraceEnabled()) { |
| 279 | log.trace("Executing RPC with no timeout (context deadline {})...", |
| 280 | context().getDeadline()); |
| 281 | } |
| 282 | runInCancellableContext(() -> stubConsumer.accept( |
| 283 | P4RuntimeGrpc.newStub(channel))); |
| 284 | } |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 285 | } |