Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-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.p4runtime; |
| 18 | |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 19 | import com.google.common.cache.CacheBuilder; |
| 20 | import com.google.common.cache.CacheLoader; |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 21 | import com.google.common.cache.LoadingCache; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 22 | import com.google.common.collect.Sets; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 23 | import org.onosproject.drivers.p4runtime.mirror.P4RuntimeMeterMirror; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 24 | import org.onosproject.net.DeviceId; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 25 | import org.onosproject.net.meter.Band; |
| 26 | import org.onosproject.net.meter.DefaultBand; |
| 27 | import org.onosproject.net.meter.DefaultMeter; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 28 | import org.onosproject.net.meter.DefaultMeterFeatures; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 29 | import org.onosproject.net.meter.Meter; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 30 | import org.onosproject.net.meter.MeterFeatures; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 31 | import org.onosproject.net.meter.MeterOperation; |
| 32 | import org.onosproject.net.meter.MeterProgrammable; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 33 | import org.onosproject.net.meter.MeterScope; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 34 | import org.onosproject.net.meter.MeterState; |
| 35 | import org.onosproject.net.pi.model.PiMeterId; |
| 36 | import org.onosproject.net.pi.model.PiMeterModel; |
| 37 | import org.onosproject.net.pi.model.PiPipelineModel; |
| 38 | import org.onosproject.net.pi.runtime.PiMeterCellConfig; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 39 | import org.onosproject.net.pi.runtime.PiMeterCellHandle; |
Wailok Shum | 9664209 | 2021-08-06 16:23:36 +0800 | [diff] [blame^] | 40 | import org.onosproject.net.pi.runtime.PiMeterCellId; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 41 | import org.onosproject.net.pi.service.PiMeterTranslator; |
| 42 | import org.onosproject.net.pi.service.PiTranslationException; |
| 43 | |
| 44 | import java.util.Collection; |
| 45 | import java.util.Collections; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 46 | import java.util.HashSet; |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 47 | import java.util.Set; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 48 | import java.util.concurrent.CompletableFuture; |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 49 | import java.util.concurrent.TimeUnit; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 50 | import java.util.concurrent.locks.Lock; |
| 51 | import java.util.concurrent.locks.ReentrantLock; |
| 52 | import java.util.stream.Collectors; |
| 53 | |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 54 | import static com.google.common.base.Preconditions.checkNotNull; |
Wailok Shum | 9664209 | 2021-08-06 16:23:36 +0800 | [diff] [blame^] | 55 | import static org.onosproject.net.meter.MeterOperation.Type.ADD; |
| 56 | import static org.onosproject.net.meter.MeterOperation.Type.MODIFY; |
| 57 | import static org.onosproject.net.meter.MeterOperation.Type.REMOVE; |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 58 | |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 59 | /** |
| 60 | * Implementation of MeterProgrammable behaviour for P4Runtime. |
| 61 | */ |
| 62 | public class P4RuntimeMeterProgrammable extends AbstractP4RuntimeHandlerBehaviour implements MeterProgrammable { |
| 63 | |
| 64 | private static final int METER_LOCK_EXPIRE_TIME_IN_MIN = 10; |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 65 | private static final LoadingCache<PiMeterCellHandle, Lock> |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 66 | ENTRY_LOCKS = CacheBuilder.newBuilder() |
| 67 | .expireAfterAccess(METER_LOCK_EXPIRE_TIME_IN_MIN, TimeUnit.MINUTES) |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 68 | .build(new CacheLoader<PiMeterCellHandle, Lock>() { |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 69 | @Override |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 70 | public Lock load(PiMeterCellHandle handle) { |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 71 | return new ReentrantLock(); |
| 72 | } |
| 73 | }); |
| 74 | |
| 75 | private PiMeterTranslator translator; |
| 76 | private P4RuntimeMeterMirror meterMirror; |
| 77 | private PiPipelineModel pipelineModel; |
| 78 | |
| 79 | @Override |
Carmelo Cascone | c32976e | 2019-04-08 14:50:52 -0700 | [diff] [blame] | 80 | protected boolean setupBehaviour(String opName) { |
| 81 | if (!super.setupBehaviour(opName)) { |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 82 | return false; |
| 83 | } |
| 84 | |
Yi Tseng | d771648 | 2018-10-31 15:34:30 -0700 | [diff] [blame] | 85 | translator = translationService.meterTranslator(); |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 86 | meterMirror = handler().get(P4RuntimeMeterMirror.class); |
| 87 | pipelineModel = pipeconf.pipelineModel(); |
| 88 | return true; |
| 89 | } |
| 90 | |
| 91 | @Override |
| 92 | public CompletableFuture<Boolean> performMeterOperation(MeterOperation meterOp) { |
| 93 | |
Carmelo Cascone | c32976e | 2019-04-08 14:50:52 -0700 | [diff] [blame] | 94 | if (!setupBehaviour("performMeterOperation()")) { |
Kevin Chuang | c267df2 | 2018-05-02 16:26:04 +0800 | [diff] [blame] | 95 | return CompletableFuture.completedFuture(false); |
| 96 | } |
| 97 | |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 98 | return CompletableFuture.completedFuture(processMeterOp(meterOp)); |
| 99 | } |
| 100 | |
| 101 | private boolean processMeterOp(MeterOperation meterOp) { |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 102 | PiMeterCellConfig piMeterCellConfig; |
Wailok Shum | 9664209 | 2021-08-06 16:23:36 +0800 | [diff] [blame^] | 103 | switch (meterOp.type()) { |
| 104 | case ADD: |
| 105 | case MODIFY: |
| 106 | // Create a config for modify operation |
| 107 | try { |
| 108 | piMeterCellConfig = translator.translate(meterOp.meter(), pipeconf); |
| 109 | } catch (PiTranslationException e) { |
| 110 | log.warn("Unable translate meter, aborting meter operation {}: {}", meterOp.type(), e.getMessage()); |
| 111 | log.debug("exception", e); |
| 112 | return false; |
| 113 | } |
| 114 | break; |
| 115 | case REMOVE: |
| 116 | // Create a empty config for reset operation |
| 117 | PiMeterCellId piMeterCellId = (PiMeterCellId) meterOp.meter().meterCellId(); |
| 118 | piMeterCellConfig = PiMeterCellConfig.reset(piMeterCellId); |
| 119 | break; |
| 120 | default: |
| 121 | log.warn("Meter Operation type {} not supported", meterOp.type()); |
| 122 | return false; |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 123 | } |
| 124 | |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 125 | final PiMeterCellHandle handle = PiMeterCellHandle.of(deviceId, piMeterCellConfig); |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 126 | ENTRY_LOCKS.getUnchecked(handle).lock(); |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 127 | final boolean result = client.write(p4DeviceId, pipeconf) |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 128 | .modify(piMeterCellConfig).submitSync().isSuccess(); |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 129 | if (result) { |
| 130 | meterMirror.put(handle, piMeterCellConfig); |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 131 | } |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 132 | ENTRY_LOCKS.getUnchecked(handle).unlock(); |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 133 | |
| 134 | return result; |
| 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public CompletableFuture<Collection<Meter>> getMeters() { |
| 139 | |
Carmelo Cascone | c32976e | 2019-04-08 14:50:52 -0700 | [diff] [blame] | 140 | if (!setupBehaviour("getMeters()")) { |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 141 | return CompletableFuture.completedFuture(Collections.emptyList()); |
| 142 | } |
| 143 | |
| 144 | Collection<PiMeterCellConfig> piMeterCellConfigs; |
| 145 | |
| 146 | Set<PiMeterId> meterIds = new HashSet<>(); |
| 147 | for (PiMeterModel mode : pipelineModel.meters()) { |
| 148 | meterIds.add(mode.id()); |
| 149 | } |
| 150 | |
Carmelo Cascone | c2be50a | 2019-04-10 00:15:39 -0700 | [diff] [blame] | 151 | piMeterCellConfigs = client.read(p4DeviceId, pipeconf) |
Carmelo Cascone | 4c289b7 | 2019-01-22 15:30:45 -0800 | [diff] [blame] | 152 | .meterCells(meterIds).submitSync().all(PiMeterCellConfig.class); |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 153 | |
| 154 | Collection<Meter> meters = piMeterCellConfigs.stream() |
| 155 | .map(p -> { |
| 156 | DefaultMeter meter = (DefaultMeter) DefaultMeter.builder() |
| 157 | .withBands(p.meterBands().stream().map(b -> DefaultBand.builder() |
| 158 | .withRate(b.rate()) |
| 159 | .burstSize(b.burst()) |
| 160 | .ofType(Band.Type.NONE) |
| 161 | .build()).collect(Collectors.toList())) |
| 162 | .withCellId(p.cellId()).build(); |
| 163 | meter.setState(MeterState.ADDED); |
| 164 | return meter; |
| 165 | }) |
| 166 | .collect(Collectors.toList()); |
| 167 | |
| 168 | return CompletableFuture.completedFuture(meters); |
| 169 | } |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 170 | |
| 171 | @Override |
| 172 | public CompletableFuture<Collection<MeterFeatures>> getMeterFeatures() { |
| 173 | |
| 174 | if (!setupBehaviour("getMeterFeatures()")) { |
| 175 | return CompletableFuture.completedFuture(Collections.emptyList()); |
| 176 | } |
| 177 | |
| 178 | Collection<MeterFeatures> meterFeatures = new HashSet<>(); |
| 179 | pipeconf.pipelineModel().meters().forEach( |
| 180 | m -> meterFeatures.add(new P4RuntimeMeterFeaturesBuilder(m, deviceId).build())); |
| 181 | |
| 182 | return CompletableFuture.completedFuture(meterFeatures); |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * P4 meter features builder. |
| 187 | */ |
| 188 | public class P4RuntimeMeterFeaturesBuilder { |
| 189 | private final PiMeterModel piMeterModel; |
| 190 | private DeviceId deviceId; |
| 191 | |
| 192 | private static final long PI_METER_START_INDEX = 0L; |
| 193 | private static final short PI_METER_MAX_BAND = 2; |
| 194 | private static final short PI_METER_MAX_COLOR = 3; |
| 195 | |
| 196 | public P4RuntimeMeterFeaturesBuilder(PiMeterModel piMeterModel, DeviceId deviceId) { |
| 197 | this.piMeterModel = checkNotNull(piMeterModel); |
| 198 | this.deviceId = deviceId; |
| 199 | } |
| 200 | |
| 201 | /** |
| 202 | * To build a MeterFeatures using the PiMeterModel object |
| 203 | * retrieved from pipeconf. |
| 204 | * |
| 205 | * @return the meter features object |
| 206 | */ |
| 207 | public MeterFeatures build() { |
| 208 | /* |
| 209 | * We set the basic values before to extract the other information. |
| 210 | */ |
| 211 | MeterFeatures.Builder builder = DefaultMeterFeatures.builder() |
| 212 | .forDevice(deviceId) |
| 213 | // The scope value will be PiMeterId |
| 214 | .withScope(MeterScope.of(piMeterModel.id().id())) |
| 215 | .withMaxBands(PI_METER_MAX_BAND) |
| 216 | .withMaxColors(PI_METER_MAX_COLOR) |
| 217 | .withStartIndex(PI_METER_START_INDEX) |
| 218 | .withEndIndex(piMeterModel.size() - 1); |
| 219 | /* |
| 220 | * Pi meter only support NONE type |
| 221 | */ |
| 222 | Set<Band.Type> bands = Sets.newHashSet(); |
| 223 | bands.add(Band.Type.NONE); |
| 224 | builder.withBandTypes(bands); |
| 225 | /* |
| 226 | * We extract the supported units; |
| 227 | */ |
| 228 | Set<Meter.Unit> units = Sets.newHashSet(); |
| 229 | if (piMeterModel.unit() == PiMeterModel.Unit.BYTES) { |
| 230 | units.add(Meter.Unit.KB_PER_SEC); |
| 231 | } else if (piMeterModel.unit() == PiMeterModel.Unit.PACKETS) { |
| 232 | units.add(Meter.Unit.PKTS_PER_SEC); |
| 233 | } |
| 234 | builder.withUnits(units); |
| 235 | /* |
| 236 | * Burst is supported ? |
| 237 | */ |
| 238 | builder.hasBurst(true); |
| 239 | /* |
| 240 | * Stats are supported ? |
| 241 | */ |
| 242 | builder.hasStats(false); |
| 243 | |
| 244 | return builder.build(); |
| 245 | } |
| 246 | |
| 247 | /** |
| 248 | * To build an empty meter features. |
| 249 | * @param deviceId the device id |
| 250 | * @return the meter features |
| 251 | */ |
| 252 | public MeterFeatures noMeterFeatures(DeviceId deviceId) { |
| 253 | return DefaultMeterFeatures.noMeterFeatures(deviceId); |
| 254 | } |
| 255 | } |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 256 | } |