| /* |
| * 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.bmv2; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Lists; |
| import com.google.common.collect.Maps; |
| import org.onosproject.net.Device; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.driver.AbstractHandlerBehaviour; |
| import org.onosproject.net.flow.DefaultFlowEntry; |
| import org.onosproject.net.flow.FlowEntry; |
| import org.onosproject.net.flow.FlowRule; |
| import org.onosproject.net.flow.FlowRuleProgrammable; |
| import org.onosproject.net.pi.model.PiPipeconf; |
| import org.onosproject.net.pi.model.PiPipelineInterpreter; |
| import org.onosproject.net.pi.model.PiPipelineModel; |
| import org.onosproject.net.pi.model.PiTableModel; |
| import org.onosproject.net.pi.runtime.PiFlowRuleTranslationService; |
| import org.onosproject.net.pi.runtime.PiPipeconfService; |
| import org.onosproject.net.pi.runtime.PiTableEntry; |
| import org.onosproject.net.pi.runtime.PiTableId; |
| import org.onosproject.p4runtime.api.P4RuntimeClient; |
| import org.onosproject.p4runtime.api.P4RuntimeClient.WriteOperationType; |
| import org.onosproject.p4runtime.api.P4RuntimeController; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.concurrent.ConcurrentMap; |
| import java.util.concurrent.ExecutionException; |
| import java.util.concurrent.locks.Lock; |
| import java.util.concurrent.locks.ReentrantLock; |
| |
| import static com.google.common.collect.Lists.newArrayList; |
| import static org.onosproject.drivers.bmv2.Bmv2FlowRuleProgrammable.Operation.APPLY; |
| import static org.onosproject.drivers.bmv2.Bmv2FlowRuleProgrammable.Operation.REMOVE; |
| import static org.onosproject.net.flow.FlowEntry.FlowEntryState.ADDED; |
| import static org.onosproject.p4runtime.api.P4RuntimeClient.WriteOperationType.DELETE; |
| import static org.onosproject.p4runtime.api.P4RuntimeClient.WriteOperationType.INSERT; |
| |
| /** |
| * Implementation of the flow rule programmable behaviour for BMv2. |
| */ |
| public class Bmv2FlowRuleProgrammable extends AbstractHandlerBehaviour implements FlowRuleProgrammable { |
| |
| private final Logger log = LoggerFactory.getLogger(getClass()); |
| |
| // Needed to synchronize operations over the same table entry. |
| private static final ConcurrentMap<Bmv2TableEntryReference, Lock> ENTRY_LOCKS = Maps.newConcurrentMap(); |
| |
| // TODO: replace with distributed store. |
| // Can reuse old BMv2TableEntryService from ONOS 1.6 |
| private static final ConcurrentMap<Bmv2TableEntryReference, Bmv2FlowRuleWrapper> ENTRY_STORE = |
| Maps.newConcurrentMap(); |
| |
| private DeviceId deviceId; |
| private P4RuntimeClient client; |
| private PiPipeconf pipeconf; |
| private PiPipelineModel pipelineModel; |
| private PiPipelineInterpreter interpreter; |
| private PiFlowRuleTranslationService piFlowRuleTranslationService; |
| |
| private boolean init() { |
| |
| deviceId = handler().data().deviceId(); |
| |
| P4RuntimeController controller = handler().get(P4RuntimeController.class); |
| if (!controller.hasClient(deviceId)) { |
| log.warn("Unable to find client for {}, aborting flow rule operation", deviceId); |
| return false; |
| } |
| |
| PiPipeconfService piPipeconfService = handler().get(PiPipeconfService.class); |
| if (!piPipeconfService.ofDevice(deviceId).isPresent() || |
| !piPipeconfService.getPipeconf(piPipeconfService.ofDevice(deviceId).get()).isPresent()) { |
| log.warn("Unable to get the pipeconf of {}", deviceId); |
| return false; |
| } |
| |
| DeviceService deviceService = handler().get(DeviceService.class); |
| Device device = deviceService.getDevice(deviceId); |
| if (!device.is(PiPipelineInterpreter.class)) { |
| log.warn("Unable to get interpreter of {}", deviceId); |
| return false; |
| } |
| |
| client = controller.getClient(deviceId); |
| pipeconf = piPipeconfService.getPipeconf(piPipeconfService.ofDevice(deviceId).get()).get(); |
| pipelineModel = pipeconf.pipelineModel(); |
| interpreter = device.as(PiPipelineInterpreter.class); |
| piFlowRuleTranslationService = handler().get(PiFlowRuleTranslationService.class); |
| |
| return true; |
| } |
| |
| @Override |
| public Collection<FlowEntry> getFlowEntries() { |
| |
| if (!init()) { |
| return Collections.emptyList(); |
| } |
| |
| ImmutableList.Builder<FlowEntry> resultBuilder = ImmutableList.builder(); |
| List<PiTableEntry> inconsistentEntries = Lists.newArrayList(); |
| |
| for (PiTableModel tableModel : pipelineModel.tables()) { |
| |
| PiTableId piTableId = PiTableId.of(tableModel.name()); |
| |
| // Only dump tables that are exposed by the interpreter. |
| // The reason is that some P4 targets (e.g. BMv2's simple_switch) use more table than those defined in the |
| // P4 program, to implement other capabilities, e.g. action execution in control flow. |
| if (!interpreter.mapPiTableId(piTableId).isPresent()) { |
| continue; // next table |
| } |
| |
| Collection<PiTableEntry> installedEntries; |
| try { |
| installedEntries = client.dumpTable(piTableId, pipeconf).get(); |
| } catch (InterruptedException | ExecutionException e) { |
| log.error("Exception while dumping table {} of {}", piTableId, deviceId, e); |
| return Collections.emptyList(); |
| } |
| |
| for (PiTableEntry installedEntry : installedEntries) { |
| |
| Bmv2TableEntryReference entryRef = new Bmv2TableEntryReference(deviceId, piTableId, |
| installedEntry.matchKey()); |
| |
| Bmv2FlowRuleWrapper frWrapper = ENTRY_STORE.get(entryRef); |
| |
| if (frWrapper == null) { |
| // Inconsistent entry |
| inconsistentEntries.add(installedEntry); |
| continue; // next one. |
| } |
| |
| // TODO: implement table entry counter retrieval. |
| long bytes = 0L; |
| long packets = 0L; |
| |
| FlowEntry entry = new DefaultFlowEntry(frWrapper.rule(), ADDED, frWrapper.lifeInSeconds(), |
| packets, bytes); |
| resultBuilder.add(entry); |
| } |
| } |
| |
| if (inconsistentEntries.size() > 0) { |
| log.warn("Found {} entries in {} that are not known by table entry service," + |
| " removing them", inconsistentEntries.size(), deviceId); |
| inconsistentEntries.forEach(entry -> log.debug(entry.toString())); |
| // Async remove them. |
| client.writeTableEntries(inconsistentEntries, DELETE, pipeconf); |
| } |
| |
| return resultBuilder.build(); |
| } |
| |
| @Override |
| public Collection<FlowRule> applyFlowRules(Collection<FlowRule> rules) { |
| return processFlowRules(rules, APPLY); |
| } |
| |
| @Override |
| public Collection<FlowRule> removeFlowRules(Collection<FlowRule> rules) { |
| return processFlowRules(rules, REMOVE); |
| } |
| |
| private Collection<FlowRule> processFlowRules(Collection<FlowRule> rules, Operation operation) { |
| |
| if (!init()) { |
| return Collections.emptyList(); |
| } |
| |
| ImmutableList.Builder<FlowRule> processedFlowRuleListBuilder = ImmutableList.builder(); |
| |
| // TODO: send write operations in bulk (e.g. all entries to insert, modify or delete). |
| // Instead of calling the client for each one of them. |
| |
| for (FlowRule rule : rules) { |
| |
| PiTableEntry piTableEntry; |
| |
| try { |
| piTableEntry = piFlowRuleTranslationService.translate(rule, pipeconf); |
| } catch (PiFlowRuleTranslationService.PiFlowRuleTranslationException e) { |
| log.warn("Unable to translate flow rule: {} - {}", e.getMessage(), rule); |
| continue; // next rule |
| } |
| |
| PiTableId tableId = piTableEntry.table(); |
| Bmv2TableEntryReference entryRef = new Bmv2TableEntryReference(deviceId, tableId, piTableEntry.matchKey()); |
| |
| Lock lock = ENTRY_LOCKS.computeIfAbsent(entryRef, k -> new ReentrantLock()); |
| lock.lock(); |
| |
| try { |
| |
| Bmv2FlowRuleWrapper frWrapper = ENTRY_STORE.get(entryRef); |
| |
| WriteOperationType opType; |
| if (operation == Operation.APPLY) { |
| opType = INSERT; |
| if (frWrapper != null) { |
| // We've seen some strange error when trying to modify existing flow rules. |
| // Remove before re-adding the modified one. |
| try { |
| if (client.writeTableEntries(newArrayList(piTableEntry), DELETE, pipeconf).get()) { |
| frWrapper = null; |
| } else { |
| log.warn("Unable to DELETE table entry (before re-adding) in {}: {}", |
| deviceId, piTableEntry); |
| } |
| } catch (InterruptedException | ExecutionException e) { |
| log.warn("Exception while deleting table entry:", operation.name(), e); |
| } |
| } |
| } else { |
| opType = DELETE; |
| } |
| |
| try { |
| if (client.writeTableEntries(newArrayList(piTableEntry), opType, pipeconf).get()) { |
| processedFlowRuleListBuilder.add(rule); |
| frWrapper = new Bmv2FlowRuleWrapper(rule, System.currentTimeMillis()); |
| } else { |
| log.warn("Unable to {} table entry in {}: {}", opType.name(), deviceId, piTableEntry); |
| } |
| } catch (InterruptedException | ExecutionException e) { |
| log.warn("Exception while performing {} table entry operation:", operation.name(), e); |
| } |
| |
| // Update entryRef binding in table entry service. |
| if (frWrapper != null) { |
| ENTRY_STORE.put(entryRef, frWrapper); |
| } else { |
| ENTRY_STORE.remove(entryRef); |
| } |
| |
| } finally { |
| lock.unlock(); |
| } |
| } |
| |
| return processedFlowRuleListBuilder.build(); |
| } |
| |
| enum Operation { |
| APPLY, REMOVE |
| } |
| } |