Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 1 | /* |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 2 | * Copyright 2016-present Open Networking Laboratory |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [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.drivers.bmv2; |
| 18 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
| 20 | import com.google.common.collect.Maps; |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 21 | import org.apache.commons.lang3.tuple.Pair; |
| 22 | import org.apache.commons.lang3.tuple.Triple; |
| 23 | import org.onosproject.bmv2.api.runtime.Bmv2MatchKey; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 24 | import org.onosproject.bmv2.api.runtime.Bmv2RuntimeException; |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 25 | import org.onosproject.bmv2.api.runtime.Bmv2TableEntry; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 26 | import org.onosproject.bmv2.ctl.Bmv2ThriftClient; |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 27 | import org.onosproject.drivers.bmv2.translators.Bmv2DefaultFlowRuleTranslator; |
| 28 | import org.onosproject.drivers.bmv2.translators.Bmv2FlowRuleTranslator; |
| 29 | import org.onosproject.drivers.bmv2.translators.Bmv2FlowRuleTranslatorException; |
| 30 | import org.onosproject.net.DeviceId; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 31 | import org.onosproject.net.driver.AbstractHandlerBehaviour; |
| 32 | import org.onosproject.net.flow.DefaultFlowEntry; |
| 33 | import org.onosproject.net.flow.FlowEntry; |
| 34 | import org.onosproject.net.flow.FlowRule; |
| 35 | import org.onosproject.net.flow.FlowRuleProgrammable; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 36 | import org.slf4j.Logger; |
| 37 | import org.slf4j.LoggerFactory; |
| 38 | |
| 39 | import java.util.Collection; |
| 40 | import java.util.Collections; |
| 41 | import java.util.List; |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 42 | import java.util.concurrent.ConcurrentMap; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 43 | |
| 44 | public class Bmv2FlowRuleDriver extends AbstractHandlerBehaviour |
| 45 | implements FlowRuleProgrammable { |
| 46 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 47 | private static final Logger LOG = |
| 48 | LoggerFactory.getLogger(Bmv2FlowRuleDriver.class); |
| 49 | // There's no Bmv2 client method to poll flow entries from the device device. gitNeed a local store. |
| 50 | private static final ConcurrentMap<Triple<DeviceId, String, Bmv2MatchKey>, Pair<Long, FlowEntry>> |
| 51 | ENTRIES_MAP = Maps.newConcurrentMap(); |
| 52 | private static final Bmv2FlowRuleTranslator TRANSLATOR = new Bmv2DefaultFlowRuleTranslator(); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 53 | |
| 54 | @Override |
| 55 | public Collection<FlowEntry> getFlowEntries() { |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 56 | |
| 57 | DeviceId deviceId = handler().data().deviceId(); |
| 58 | |
| 59 | List<FlowEntry> entryList = Lists.newArrayList(); |
| 60 | |
| 61 | // FIXME: improve this, e.g. might store a separate Map<DeviceId, Collection<FlowEntry>> |
| 62 | ENTRIES_MAP.forEach((key, value) -> { |
| 63 | if (key.getLeft() == deviceId && value != null) { |
| 64 | entryList.add(value.getRight()); |
| 65 | } |
| 66 | }); |
| 67 | |
| 68 | return Collections.unmodifiableCollection(entryList); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | @Override |
| 72 | public Collection<FlowRule> applyFlowRules(Collection<FlowRule> rules) { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 73 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 74 | return processFlowRules(rules, Operation.APPLY); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | @Override |
| 78 | public Collection<FlowRule> removeFlowRules(Collection<FlowRule> rules) { |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 79 | |
| 80 | return processFlowRules(rules, Operation.REMOVE); |
| 81 | } |
| 82 | |
| 83 | private Collection<FlowRule> processFlowRules(Collection<FlowRule> rules, Operation operation) { |
| 84 | |
| 85 | DeviceId deviceId = handler().data().deviceId(); |
| 86 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 87 | Bmv2ThriftClient deviceClient; |
| 88 | try { |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 89 | deviceClient = Bmv2ThriftClient.of(deviceId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 90 | } catch (Bmv2RuntimeException e) { |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 91 | LOG.error("Failed to connect to Bmv2 device", e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 92 | return Collections.emptyList(); |
| 93 | } |
| 94 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 95 | List<FlowRule> processedFlowRules = Lists.newArrayList(); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 96 | |
| 97 | for (FlowRule rule : rules) { |
| 98 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 99 | Bmv2TableEntry bmv2Entry; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 100 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 101 | try { |
| 102 | bmv2Entry = TRANSLATOR.translate(rule); |
| 103 | } catch (Bmv2FlowRuleTranslatorException e) { |
| 104 | LOG.error("Unable to translate flow rule: {}", e.getMessage()); |
| 105 | continue; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 106 | } |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 107 | |
| 108 | String tableName = bmv2Entry.tableName(); |
| 109 | Triple<DeviceId, String, Bmv2MatchKey> entryKey = Triple.of(deviceId, tableName, bmv2Entry.matchKey()); |
| 110 | |
| 111 | /* |
| 112 | From here on threads are synchronized over entryKey, i.e. serialize operations |
| 113 | over the same matchKey of a specific table and device. |
| 114 | */ |
| 115 | ENTRIES_MAP.compute(entryKey, (key, value) -> { |
| 116 | try { |
| 117 | if (operation == Operation.APPLY) { |
| 118 | // Apply entry |
| 119 | long entryId; |
| 120 | if (value == null) { |
| 121 | // New entry |
| 122 | entryId = deviceClient.addTableEntry(bmv2Entry); |
| 123 | } else { |
| 124 | // Existing entry |
| 125 | entryId = value.getKey(); |
| 126 | // FIXME: check if priority or timeout changed |
| 127 | // In this case we should to re-add the entry (not modify) |
| 128 | deviceClient.modifyTableEntry(tableName, entryId, bmv2Entry.action()); |
| 129 | } |
| 130 | // TODO: evaluate flow entry life, bytes and packets |
| 131 | FlowEntry flowEntry = new DefaultFlowEntry( |
| 132 | rule, FlowEntry.FlowEntryState.ADDED, 0, 0, 0); |
| 133 | value = Pair.of(entryId, flowEntry); |
| 134 | } else { |
| 135 | // Remove entry |
| 136 | if (value == null) { |
| 137 | // Entry not found in map, how come? |
| 138 | LOG.debug("Trying to remove entry, but entry ID not found: " + entryKey); |
| 139 | } else { |
| 140 | deviceClient.deleteTableEntry(tableName, value.getKey()); |
| 141 | value = null; |
| 142 | } |
| 143 | } |
| 144 | // If here, no exceptions... things went well :) |
| 145 | processedFlowRules.add(rule); |
| 146 | } catch (Bmv2RuntimeException e) { |
| 147 | LOG.error("Unable to " + operation.name().toLowerCase() + " flow rule", e); |
| 148 | } catch (Exception e) { |
| 149 | LOG.error("Uncaught exception while processing flow rule", e); |
| 150 | } |
| 151 | return value; |
| 152 | }); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 153 | } |
| 154 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 155 | return processedFlowRules; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 156 | } |
| 157 | |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 158 | private enum Operation { |
| 159 | APPLY, REMOVE |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 160 | } |
Carmelo Cascone | 2954f13 | 2016-04-15 10:26:40 -0700 | [diff] [blame^] | 161 | } |