[ONOS-7051] Support for P4Runtime meters
Change-Id: Id71374af65aeb84b71636b4ec230dc6001a77a8b
diff --git a/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/P4RuntimeMeterProgrammable.java b/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/P4RuntimeMeterProgrammable.java
new file mode 100644
index 0000000..04654c8
--- /dev/null
+++ b/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/P4RuntimeMeterProgrammable.java
@@ -0,0 +1,161 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.drivers.p4runtime;
+
+import com.google.common.cache.LoadingCache;
+import com.google.common.cache.CacheBuilder;
+import com.google.common.cache.CacheLoader;
+import org.onosproject.drivers.p4runtime.mirror.P4RuntimeMeterMirror;
+import org.onosproject.net.meter.Band;
+import org.onosproject.net.meter.DefaultBand;
+import org.onosproject.net.meter.DefaultMeter;
+import org.onosproject.net.meter.Meter;
+import org.onosproject.net.meter.MeterOperation;
+import org.onosproject.net.meter.MeterProgrammable;
+import org.onosproject.net.meter.MeterState;
+import org.onosproject.net.pi.model.PiMeterId;
+import org.onosproject.net.pi.model.PiMeterModel;
+import org.onosproject.net.pi.model.PiPipelineModel;
+import org.onosproject.net.pi.runtime.PiMeterCellConfig;
+import org.onosproject.net.pi.runtime.PiMeterHandle;
+import org.onosproject.net.pi.service.PiMeterTranslator;
+import org.onosproject.net.pi.service.PiTranslationException;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Set;
+import java.util.HashSet;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReentrantLock;
+import java.util.stream.Collectors;
+
+import static com.google.common.collect.Lists.newArrayList;
+
+/**
+ * Implementation of MeterProgrammable behaviour for P4Runtime.
+ */
+public class P4RuntimeMeterProgrammable extends AbstractP4RuntimeHandlerBehaviour implements MeterProgrammable {
+
+ private static final int METER_LOCK_EXPIRE_TIME_IN_MIN = 10;
+ private static final LoadingCache<PiMeterHandle, Lock>
+ ENTRY_LOCKS = CacheBuilder.newBuilder()
+ .expireAfterAccess(METER_LOCK_EXPIRE_TIME_IN_MIN, TimeUnit.MINUTES)
+ .build(new CacheLoader<PiMeterHandle, Lock>() {
+ @Override
+ public Lock load(PiMeterHandle handle) {
+ return new ReentrantLock();
+ }
+ });
+
+ private PiMeterTranslator translator;
+ private P4RuntimeMeterMirror meterMirror;
+ private PiPipelineModel pipelineModel;
+
+ @Override
+ protected boolean setupBehaviour() {
+ if (!super.setupBehaviour()) {
+ return false;
+ }
+
+ translator = piTranslationService.meterTranslator();
+ meterMirror = handler().get(P4RuntimeMeterMirror.class);
+ pipelineModel = pipeconf.pipelineModel();
+ return true;
+ }
+
+ @Override
+ public CompletableFuture<Boolean> performMeterOperation(MeterOperation meterOp) {
+
+ return CompletableFuture.completedFuture(processMeterOp(meterOp));
+ }
+
+ private boolean processMeterOp(MeterOperation meterOp) {
+
+ if (meterOp.type() != MeterOperation.Type.MODIFY) {
+ log.warn("P4runtime meter operations must be MODIFY!");
+ return false;
+ }
+
+ PiMeterCellConfig piMeterCellConfig;
+ try {
+ piMeterCellConfig = translator.translate(meterOp.meter(), pipeconf);
+ } catch (PiTranslationException e) {
+ log.warn("Unable translate meter, aborting meter operation {}: {}", meterOp.type(), e.getMessage());
+ log.debug("exception", e);
+ return false;
+ }
+
+ final PiMeterHandle handle = PiMeterHandle.of(deviceId, piMeterCellConfig);
+ ENTRY_LOCKS.getUnchecked(handle).lock();
+ boolean result = false;
+ try {
+ if (client.writeMeterCells(newArrayList(piMeterCellConfig), pipeconf).get()) {
+ meterMirror.put(handle, piMeterCellConfig);
+ result = true;
+ }
+
+ } catch (InterruptedException | ExecutionException e) {
+ log.warn("Exception while modify meter entry:", e);
+ } finally {
+ ENTRY_LOCKS.getUnchecked(handle).unlock();
+ }
+
+ return result;
+ }
+
+ @Override
+ public CompletableFuture<Collection<Meter>> getMeters() {
+
+ if (!setupBehaviour()) {
+ return CompletableFuture.completedFuture(Collections.emptyList());
+ }
+
+ Collection<PiMeterCellConfig> piMeterCellConfigs;
+
+ Set<PiMeterId> meterIds = new HashSet<>();
+ for (PiMeterModel mode : pipelineModel.meters()) {
+ meterIds.add(mode.id());
+ }
+
+ try {
+ piMeterCellConfigs = client.readAllMeterCells(meterIds, pipeconf).get();
+ } catch (InterruptedException | ExecutionException e) {
+ log.warn("Exception while reading meters from {}: {}", deviceId, e.toString());
+ log.debug("", e);
+ return CompletableFuture.completedFuture(Collections.emptyList());
+ }
+
+ Collection<Meter> meters = piMeterCellConfigs.stream()
+ .map(p -> {
+ DefaultMeter meter = (DefaultMeter) DefaultMeter.builder()
+ .withBands(p.meterBands().stream().map(b -> DefaultBand.builder()
+ .withRate(b.rate())
+ .burstSize(b.burst())
+ .ofType(Band.Type.NONE)
+ .build()).collect(Collectors.toList()))
+ .withCellId(p.cellId()).build();
+ meter.setState(MeterState.ADDED);
+ return meter;
+ })
+ .collect(Collectors.toList());
+
+ return CompletableFuture.completedFuture(meters);
+ }
+}
\ No newline at end of file
diff --git a/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/mirror/DistributedP4RuntimeMeterMirror.java b/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/mirror/DistributedP4RuntimeMeterMirror.java
new file mode 100644
index 0000000..f5c1778
--- /dev/null
+++ b/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/mirror/DistributedP4RuntimeMeterMirror.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.drivers.p4runtime.mirror;
+
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Service;
+import org.onlab.util.KryoNamespace;
+import org.onosproject.net.pi.runtime.PiMeterHandle;
+import org.onosproject.net.pi.runtime.PiMeterCellConfig;
+import org.onosproject.store.serializers.KryoNamespaces;
+
+/**
+ * Distributed implementation of a P4Runtime meter mirror.
+ */
+@Component(immediate = true)
+@Service
+public final class DistributedP4RuntimeMeterMirror
+ extends AbstractDistributedP4RuntimeMirror
+ <PiMeterHandle, PiMeterCellConfig>
+ implements P4RuntimeMeterMirror {
+
+ private static final String DIST_MAP_NAME = "onos-p4runtime-meter-mirror";
+
+ @Override
+ String mapName() {
+ return DIST_MAP_NAME;
+ }
+
+ @Override
+ KryoNamespace storeSerializer() {
+ return KryoNamespace.newBuilder()
+ .register(KryoNamespaces.API)
+ .register(TimedEntry.class)
+ .build();
+ }
+}
\ No newline at end of file
diff --git a/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/mirror/P4RuntimeMeterMirror.java b/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/mirror/P4RuntimeMeterMirror.java
new file mode 100644
index 0000000..668492a
--- /dev/null
+++ b/drivers/p4runtime/src/main/java/org/onosproject/drivers/p4runtime/mirror/P4RuntimeMeterMirror.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2017-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.drivers.p4runtime.mirror;
+
+import com.google.common.annotations.Beta;
+import org.onosproject.net.pi.runtime.PiMeterCellConfig;
+import org.onosproject.net.pi.runtime.PiMeterHandle;
+
+/**
+ * Mirror of meters installed on a P4Runtime device.
+ */
+@Beta
+public interface P4RuntimeMeterMirror
+ extends P4RuntimeMirror<PiMeterHandle, PiMeterCellConfig> {
+}
diff --git a/drivers/p4runtime/src/main/resources/p4runtime-drivers.xml b/drivers/p4runtime/src/main/resources/p4runtime-drivers.xml
index 3f00bde..5ee2c92 100644
--- a/drivers/p4runtime/src/main/resources/p4runtime-drivers.xml
+++ b/drivers/p4runtime/src/main/resources/p4runtime-drivers.xml
@@ -24,6 +24,8 @@
impl="org.onosproject.drivers.p4runtime.P4RuntimeFlowRuleProgrammable"/>
<behaviour api="org.onosproject.net.group.GroupProgrammable"
impl="org.onosproject.drivers.p4runtime.P4RuntimeGroupProgrammable"/>
+ <behaviour api="org.onosproject.net.meter.MeterProgrammable"
+ impl="org.onosproject.drivers.p4runtime.P4RuntimeMeterProgrammable"/>
<property name="supportPacketRequest">true</property>
</driver>
</drivers>