Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -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.drivers.gnmi; |
| 18 | |
| 19 | import gnmi.Gnmi; |
| 20 | import org.onosproject.gnmi.api.GnmiClient; |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 21 | import org.onosproject.gnmi.api.GnmiController; |
| 22 | import org.onosproject.grpc.utils.AbstractGrpcHandlerBehaviour; |
pierventre | c8e8e45 | 2021-09-27 12:35:09 +0200 | [diff] [blame^] | 23 | import org.onosproject.net.Port; |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 24 | import org.onosproject.net.PortNumber; |
| 25 | import org.onosproject.net.behaviour.PortAdmin; |
| 26 | |
| 27 | import java.util.concurrent.CompletableFuture; |
| 28 | |
| 29 | import static java.util.concurrent.CompletableFuture.completedFuture; |
| 30 | |
| 31 | /** |
| 32 | * Implementation of PortAdmin for gNMI devices with OpenConfig support. |
| 33 | */ |
| 34 | public class OpenConfigGnmiPortAdminBehaviour |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 35 | extends AbstractGrpcHandlerBehaviour<GnmiClient, GnmiController> |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 36 | implements PortAdmin { |
| 37 | |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 38 | public OpenConfigGnmiPortAdminBehaviour() { |
| 39 | super(GnmiController.class); |
| 40 | } |
| 41 | |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 42 | @Override |
| 43 | public CompletableFuture<Boolean> enable(PortNumber number) { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 44 | if (!setupBehaviour("enable()")) { |
| 45 | return completedFuture(false); |
| 46 | } |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 47 | doEnable(number, true); |
| 48 | // Always returning true is OK assuming this is used only by the |
| 49 | // GeneralDeviceProvider, which ignores the return value and instead |
| 50 | // waits for a gNMI Update over the Subscribe RPC. |
| 51 | return completedFuture(true); |
| 52 | } |
| 53 | |
| 54 | @Override |
| 55 | public CompletableFuture<Boolean> disable(PortNumber number) { |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 56 | if (!setupBehaviour("disable()")) { |
| 57 | return completedFuture(false); |
| 58 | } |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 59 | doEnable(number, false); |
| 60 | return completedFuture(true); |
| 61 | } |
| 62 | |
| 63 | @Override |
| 64 | public CompletableFuture<Boolean> isEnabled(PortNumber number) { |
| 65 | throw new UnsupportedOperationException("Not implemented"); |
| 66 | } |
| 67 | |
| 68 | private void doEnable(PortNumber portNumber, boolean enabled) { |
| 69 | if (portNumber.isLogical()) { |
| 70 | log.warn("Cannot update port status for logical port {} on {}", |
| 71 | portNumber, deviceId); |
| 72 | return; |
| 73 | } |
pierventre | c8e8e45 | 2021-09-27 12:35:09 +0200 | [diff] [blame^] | 74 | |
| 75 | /* Requests coming from the north may come without name. |
| 76 | When this happens port name equals to port number */ |
| 77 | if (!portNumber.hasName()) { |
| 78 | if (deviceService == null) { |
| 79 | log.warn("Cannot update port status of port {} on {} because the device " + |
| 80 | "service is null", portNumber, deviceId); |
| 81 | return; |
| 82 | } |
| 83 | Port devicePort = deviceService.getPort(deviceId, portNumber); |
| 84 | if (devicePort != null) { |
| 85 | // Some devices may reject the config, make sure we act on the reported port |
| 86 | portNumber = devicePort.number(); |
| 87 | } |
| 88 | } |
| 89 | |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 90 | final Gnmi.Path path = Gnmi.Path.newBuilder() |
| 91 | .addElem(Gnmi.PathElem.newBuilder().setName("interfaces").build()) |
| 92 | .addElem(Gnmi.PathElem.newBuilder().setName("interface") |
| 93 | .putKey("name", portNumber.name()).build()) |
| 94 | .addElem(Gnmi.PathElem.newBuilder().setName("config").build()) |
| 95 | .addElem(Gnmi.PathElem.newBuilder().setName("enabled").build()) |
| 96 | .build(); |
| 97 | final Gnmi.TypedValue value = Gnmi.TypedValue.newBuilder() |
| 98 | .setBoolVal(enabled) |
| 99 | .build(); |
| 100 | final Gnmi.SetRequest request = Gnmi.SetRequest.newBuilder() |
| 101 | .addUpdate(Gnmi.Update.newBuilder() |
| 102 | .setPath(path) |
| 103 | .setVal(value) |
| 104 | .build()) |
| 105 | .build(); |
| 106 | |
| 107 | // Async submit request and forget about it. In case of errors, the |
| 108 | // client will log them. In case of success, we should receive a gNMI |
| 109 | // Update over the Subscribe RPC with the new oper status. |
| 110 | client.set(request); |
| 111 | } |
| 112 | } |