Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [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 | |
| 17 | package org.onosproject.p4runtime.ctl; |
| 18 | |
| 19 | import com.google.common.collect.Maps; |
| 20 | import io.grpc.ManagedChannel; |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 21 | import org.onosproject.grpc.ctl.AbstractGrpcClientController; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 22 | import org.onosproject.net.DeviceId; |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 23 | import org.onosproject.net.device.DeviceAgentEvent; |
| 24 | import org.onosproject.net.device.DeviceAgentListener; |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 25 | import org.onosproject.net.provider.ProviderId; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 26 | import org.onosproject.p4runtime.api.P4RuntimeClient; |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 27 | import org.onosproject.p4runtime.api.P4RuntimeClientKey; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 28 | import org.onosproject.p4runtime.api.P4RuntimeController; |
| 29 | import org.onosproject.p4runtime.api.P4RuntimeEvent; |
| 30 | import org.onosproject.p4runtime.api.P4RuntimeEventListener; |
Yi Tseng | 3e7f145 | 2017-10-20 10:31:53 -0700 | [diff] [blame] | 31 | import org.onosproject.store.service.StorageService; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 32 | import org.osgi.service.component.annotations.Activate; |
| 33 | import org.osgi.service.component.annotations.Component; |
| 34 | import org.osgi.service.component.annotations.Deactivate; |
| 35 | import org.osgi.service.component.annotations.Reference; |
| 36 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 37 | import org.slf4j.Logger; |
| 38 | |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 39 | import java.math.BigInteger; |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 40 | import java.util.concurrent.ConcurrentMap; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 41 | |
| 42 | import static com.google.common.base.Preconditions.checkNotNull; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 43 | import static org.slf4j.LoggerFactory.getLogger; |
| 44 | |
| 45 | /** |
| 46 | * P4Runtime controller implementation. |
| 47 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 48 | @Component(immediate = true, service = P4RuntimeController.class) |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 49 | public class P4RuntimeControllerImpl |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 50 | extends AbstractGrpcClientController |
| 51 | <P4RuntimeClientKey, P4RuntimeClient, P4RuntimeEvent, P4RuntimeEventListener> |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 52 | implements P4RuntimeController { |
| 53 | |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 54 | private final Logger log = getLogger(getClass()); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 55 | |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 56 | private final ConcurrentMap<DeviceId, ConcurrentMap<ProviderId, DeviceAgentListener>> |
| 57 | deviceAgentListeners = Maps.newConcurrentMap(); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 58 | |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 59 | private DistributedElectionIdGenerator electionIdGenerator; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 60 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 61 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Carmelo Cascone | 44448a5 | 2018-06-25 23:36:57 +0200 | [diff] [blame] | 62 | private StorageService storageService; |
Yi Tseng | 3e7f145 | 2017-10-20 10:31:53 -0700 | [diff] [blame] | 63 | |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 64 | @Activate |
| 65 | public void activate() { |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 66 | super.activate(); |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 67 | eventDispatcher.addSink(P4RuntimeEvent.class, listenerRegistry); |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 68 | electionIdGenerator = new DistributedElectionIdGenerator(storageService); |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 69 | log.info("Started"); |
| 70 | } |
| 71 | |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 72 | @Deactivate |
| 73 | public void deactivate() { |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 74 | super.deactivate(); |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 75 | deviceAgentListeners.clear(); |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 76 | electionIdGenerator.destroy(); |
| 77 | electionIdGenerator = null; |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 78 | log.info("Stopped"); |
| 79 | } |
| 80 | |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 81 | @Override |
Yi Tseng | 2a340f7 | 2018-11-02 16:52:47 -0700 | [diff] [blame] | 82 | protected P4RuntimeClient createClientInstance(P4RuntimeClientKey clientKey, ManagedChannel channel) { |
| 83 | return new P4RuntimeClientImpl(clientKey, channel, this); |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 84 | } |
| 85 | |
Yi Tseng | 3e7f145 | 2017-10-20 10:31:53 -0700 | [diff] [blame] | 86 | @Override |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 87 | public void addDeviceAgentListener(DeviceId deviceId, ProviderId providerId, DeviceAgentListener listener) { |
Carmelo Cascone | 7044efd | 2018-07-06 13:01:36 +0200 | [diff] [blame] | 88 | checkNotNull(deviceId, "deviceId cannot be null"); |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 89 | checkNotNull(deviceId, "providerId cannot be null"); |
Carmelo Cascone | 7044efd | 2018-07-06 13:01:36 +0200 | [diff] [blame] | 90 | checkNotNull(listener, "listener cannot be null"); |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 91 | deviceAgentListeners.putIfAbsent(deviceId, Maps.newConcurrentMap()); |
| 92 | deviceAgentListeners.get(deviceId).put(providerId, listener); |
Yi Tseng | 3e7f145 | 2017-10-20 10:31:53 -0700 | [diff] [blame] | 93 | } |
| 94 | |
Andrea Campanella | 1e57344 | 2018-05-17 17:07:13 +0200 | [diff] [blame] | 95 | @Override |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 96 | public void removeDeviceAgentListener(DeviceId deviceId, ProviderId providerId) { |
Carmelo Cascone | 7044efd | 2018-07-06 13:01:36 +0200 | [diff] [blame] | 97 | checkNotNull(deviceId, "deviceId cannot be null"); |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 98 | checkNotNull(providerId, "listener cannot be null"); |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 99 | deviceAgentListeners.computeIfPresent(deviceId, (did, listeners) -> { |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 100 | listeners.remove(providerId); |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 101 | return listeners; |
Andrea Campanella | 1e57344 | 2018-05-17 17:07:13 +0200 | [diff] [blame] | 102 | }); |
| 103 | } |
| 104 | |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 105 | BigInteger newMasterElectionId(DeviceId deviceId) { |
| 106 | return electionIdGenerator.generate(deviceId); |
Andrea Campanella | 1e57344 | 2018-05-17 17:07:13 +0200 | [diff] [blame] | 107 | } |
| 108 | |
Carmelo Cascone | 44448a5 | 2018-06-25 23:36:57 +0200 | [diff] [blame] | 109 | void postEvent(P4RuntimeEvent event) { |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 110 | switch (event.type()) { |
| 111 | case CHANNEL_EVENT: |
| 112 | handleChannelEvent(event); |
| 113 | break; |
| 114 | case ARBITRATION_RESPONSE: |
| 115 | handleArbitrationReply(event); |
| 116 | break; |
Carmelo Cascone | de3b684 | 2018-09-05 17:45:10 -0700 | [diff] [blame] | 117 | case PERMISSION_DENIED: |
| 118 | handlePermissionDenied(event); |
| 119 | break; |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 120 | default: |
| 121 | post(event); |
| 122 | break; |
Andrea Campanella | 1e57344 | 2018-05-17 17:07:13 +0200 | [diff] [blame] | 123 | } |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 124 | } |
Carmelo Cascone | 44448a5 | 2018-06-25 23:36:57 +0200 | [diff] [blame] | 125 | |
Carmelo Cascone | de3b684 | 2018-09-05 17:45:10 -0700 | [diff] [blame] | 126 | private void handlePermissionDenied(P4RuntimeEvent event) { |
| 127 | postDeviceAgentEvent(event.subject().deviceId(), new DeviceAgentEvent( |
| 128 | DeviceAgentEvent.Type.NOT_MASTER, event.subject().deviceId())); |
| 129 | } |
| 130 | |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 131 | private void handleChannelEvent(P4RuntimeEvent event) { |
| 132 | final ChannelEvent channelEvent = (ChannelEvent) event.subject(); |
| 133 | final DeviceId deviceId = channelEvent.deviceId(); |
| 134 | final DeviceAgentEvent.Type agentEventType; |
| 135 | switch (channelEvent.type()) { |
| 136 | case OPEN: |
| 137 | agentEventType = DeviceAgentEvent.Type.CHANNEL_OPEN; |
| 138 | break; |
| 139 | case CLOSED: |
| 140 | agentEventType = DeviceAgentEvent.Type.CHANNEL_CLOSED; |
| 141 | break; |
| 142 | case ERROR: |
Carmelo Cascone | 158b8c4 | 2018-07-04 19:42:37 +0200 | [diff] [blame] | 143 | agentEventType = !isReachable(deviceId) |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 144 | ? DeviceAgentEvent.Type.CHANNEL_CLOSED |
| 145 | : DeviceAgentEvent.Type.CHANNEL_ERROR; |
| 146 | break; |
| 147 | default: |
| 148 | log.warn("Unrecognized channel event type {}", channelEvent.type()); |
| 149 | return; |
| 150 | } |
| 151 | postDeviceAgentEvent(deviceId, new DeviceAgentEvent(agentEventType, deviceId)); |
| 152 | } |
| 153 | |
| 154 | private void handleArbitrationReply(P4RuntimeEvent event) { |
| 155 | final DeviceId deviceId = event.subject().deviceId(); |
| 156 | final ArbitrationResponse response = (ArbitrationResponse) event.subject(); |
| 157 | final DeviceAgentEvent.Type roleType = response.isMaster() |
| 158 | ? DeviceAgentEvent.Type.ROLE_MASTER |
| 159 | : DeviceAgentEvent.Type.ROLE_STANDBY; |
| 160 | postDeviceAgentEvent(deviceId, new DeviceAgentEvent( |
| 161 | roleType, response.deviceId())); |
| 162 | } |
| 163 | |
| 164 | private void postDeviceAgentEvent(DeviceId deviceId, DeviceAgentEvent event) { |
| 165 | if (deviceAgentListeners.containsKey(deviceId)) { |
Carmelo Cascone | 9e4972c | 2018-08-30 00:29:16 -0700 | [diff] [blame] | 166 | deviceAgentListeners.get(deviceId).values().forEach(l -> l.event(event)); |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 167 | } |
| 168 | } |
Carmelo Cascone | f7aa3f9 | 2017-07-06 23:56:50 -0400 | [diff] [blame] | 169 | } |