| /* |
| * Copyright 2016-present Open Networking Laboratory |
| * |
| * 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.driver.pipeline; |
| |
| import com.google.common.cache.Cache; |
| import com.google.common.cache.CacheBuilder; |
| import com.google.common.cache.RemovalCause; |
| import com.google.common.cache.RemovalNotification; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Lists; |
| import com.google.common.collect.Sets; |
| import org.onlab.osgi.ServiceDirectory; |
| import org.onlab.packet.IpPrefix; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.MplsLabel; |
| import org.onlab.packet.VlanId; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.GroupId; |
| import org.onosproject.driver.extensions.OfdpaSetVlanVid; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.PortNumber; |
| import org.onosproject.net.behaviour.NextGroup; |
| import org.onosproject.net.behaviour.PipelinerContext; |
| import org.onosproject.net.flow.DefaultTrafficTreatment; |
| import org.onosproject.net.flow.TrafficSelector; |
| import org.onosproject.net.flow.TrafficTreatment; |
| import org.onosproject.net.flow.criteria.Criterion; |
| import org.onosproject.net.flow.criteria.TunnelIdCriterion; |
| import org.onosproject.net.flow.criteria.VlanIdCriterion; |
| import org.onosproject.net.flow.instructions.Instruction; |
| import org.onosproject.net.flow.instructions.Instructions; |
| import org.onosproject.net.flow.instructions.L2ModificationInstruction; |
| import org.onosproject.net.flowobjective.DefaultNextObjective; |
| import org.onosproject.net.flowobjective.FlowObjectiveStore; |
| import org.onosproject.net.flowobjective.NextObjective; |
| import org.onosproject.net.flowobjective.ObjectiveContext; |
| import org.onosproject.net.flowobjective.ObjectiveError; |
| import org.onosproject.net.group.DefaultGroupBucket; |
| import org.onosproject.net.group.DefaultGroupDescription; |
| import org.onosproject.net.group.DefaultGroupKey; |
| import org.onosproject.net.group.Group; |
| import org.onosproject.net.group.GroupBucket; |
| import org.onosproject.net.group.GroupBuckets; |
| import org.onosproject.net.group.GroupDescription; |
| import org.onosproject.net.group.GroupEvent; |
| import org.onosproject.net.group.GroupKey; |
| import org.onosproject.net.group.GroupListener; |
| import org.onosproject.net.group.GroupService; |
| import org.onosproject.store.service.AtomicCounter; |
| import org.onosproject.store.service.StorageService; |
| import org.slf4j.Logger; |
| |
| import java.util.ArrayDeque; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.Deque; |
| import java.util.List; |
| import java.util.Objects; |
| import java.util.Set; |
| import java.util.concurrent.ConcurrentHashMap; |
| import java.util.concurrent.CopyOnWriteArrayList; |
| import java.util.concurrent.Executors; |
| import java.util.concurrent.ScheduledExecutorService; |
| import java.util.concurrent.TimeUnit; |
| import java.util.concurrent.atomic.AtomicInteger; |
| import java.util.stream.Collectors; |
| |
| import static org.onlab.util.Tools.groupedThreads; |
| import static org.onosproject.driver.pipeline.Ofdpa2GroupHandler.OfdpaMplsGroupSubType.OFDPA_GROUP_TYPE_SHIFT; |
| import static org.onosproject.driver.pipeline.Ofdpa2GroupHandler.OfdpaMplsGroupSubType.OFDPA_MPLS_SUBTYPE_SHIFT; |
| import static org.onosproject.driver.pipeline.Ofdpa2Pipeline.isNotMplsBos; |
| import static org.onosproject.net.flow.criteria.Criterion.Type.TUNNEL_ID; |
| import static org.onosproject.net.flow.criteria.Criterion.Type.VLAN_VID; |
| import static org.onosproject.net.flowobjective.NextObjective.Type.HASHED; |
| import static org.onosproject.net.group.GroupDescription.Type.ALL; |
| import static org.onosproject.net.group.GroupDescription.Type.SELECT; |
| import static org.slf4j.LoggerFactory.getLogger; |
| |
| /** |
| * Group handler that emulates Broadcom OF-DPA TTP. |
| */ |
| public class Ofdpa2GroupHandler { |
| /* |
| * OFDPA requires group-id's to have a certain form. |
| * L2 Interface Groups have <4bits-0><12bits-vlanid><16bits-portid> |
| * L3 Unicast Groups have <4bits-2><28bits-index> |
| * MPLS Interface Groups have <4bits-9><4bits:0><24bits-index> |
| * L3 ECMP Groups have <4bits-7><28bits-index> |
| * L2 Flood Groups have <4bits-4><12bits-vlanid><16bits-index> |
| * L3 VPN Groups have <4bits-9><4bits-2><24bits-index> |
| */ |
| protected static final int L2_INTERFACE_TYPE = 0x00000000; |
| protected static final int L3_INTERFACE_TYPE = 0x50000000; |
| protected static final int L3_UNICAST_TYPE = 0x20000000; |
| protected static final int L3_MULTICAST_TYPE = 0x60000000; |
| protected static final int MPLS_INTERFACE_TYPE = 0x90000000; |
| protected static final int MPLS_L3VPN_SUBTYPE = 0x92000000; |
| protected static final int L3_ECMP_TYPE = 0x70000000; |
| protected static final int L2_FLOOD_TYPE = 0x40000000; |
| |
| protected static final int TYPE_MASK = 0x0fffffff; |
| protected static final int SUBTYPE_MASK = 0x00ffffff; |
| protected static final int TYPE_VLAN_MASK = 0x0000ffff; |
| |
| protected static final int THREE_BIT_MASK = 0x0fff; |
| protected static final int FOUR_BIT_MASK = 0xffff; |
| protected static final int PORT_LEN = 16; |
| |
| protected static final int PORT_LOWER_BITS_MASK = 0x3f; |
| protected static final long PORT_HIGHER_BITS_MASK = ~PORT_LOWER_BITS_MASK; |
| |
| protected static final String HEX_PREFIX = "0x"; |
| |
| private final Logger log = getLogger(getClass()); |
| private ServiceDirectory serviceDirectory; |
| protected GroupService groupService; |
| protected StorageService storageService; |
| |
| protected DeviceId deviceId; |
| private FlowObjectiveStore flowObjectiveStore; |
| private Cache<GroupKey, List<OfdpaNextGroup>> pendingAddNextObjectives; |
| private Cache<NextObjective, List<GroupKey>> pendingRemoveNextObjectives; |
| private Cache<GroupKey, Set<GroupChainElem>> pendingGroups; |
| private ConcurrentHashMap<GroupKey, Set<NextObjective>> pendingUpdateNextObjectives; |
| private ScheduledExecutorService groupChecker = |
| Executors.newScheduledThreadPool(2, groupedThreads("onos/pipeliner", "ofdpa2-%d", log)); |
| |
| // index number for group creation |
| private AtomicCounter nextIndex; |
| |
| // local store for pending bucketAdds - by design there can be multiple |
| // pending bucket for a group |
| protected ConcurrentHashMap<Integer, Set<NextObjective>> pendingBuckets = |
| new ConcurrentHashMap<>(); |
| |
| /** |
| * Determines whether this pipeline support copy ttl instructions or not. |
| * |
| * @return true if copy ttl instructions are supported |
| */ |
| protected boolean supportCopyTtl() { |
| return true; |
| } |
| |
| /** |
| * Determines whether this pipeline support set mpls bos instruction or not. |
| * |
| * @return true if set mpls bos instruction is supported |
| */ |
| protected boolean supportSetMplsBos() { |
| return true; |
| } |
| |
| /** |
| * Determines whether this pipeline requires popping VLAN before pushing MPLS. |
| * <p> |
| * If required, pop vlan before push mpls and add an arbitrary vlan back afterward. |
| * MPLS interface group will substitute the arbitrary VLAN with expected VLAN later on. |
| * |
| * @return true if this pipeline requires popping VLAN before pushing MPLS |
| */ |
| protected boolean requireVlanPopBeforeMplsPush() { |
| return false; |
| } |
| |
| protected void init(DeviceId deviceId, PipelinerContext context) { |
| this.deviceId = deviceId; |
| this.flowObjectiveStore = context.store(); |
| this.serviceDirectory = context.directory(); |
| this.groupService = serviceDirectory.get(GroupService.class); |
| this.storageService = serviceDirectory.get(StorageService.class); |
| this.nextIndex = storageService.getAtomicCounter("group-id-index-counter"); |
| |
| pendingAddNextObjectives = CacheBuilder.newBuilder() |
| .expireAfterWrite(20, TimeUnit.SECONDS) |
| .removalListener(( |
| RemovalNotification<GroupKey, List<OfdpaNextGroup>> notification) -> { |
| if (notification.getCause() == RemovalCause.EXPIRED) { |
| notification.getValue().forEach(ofdpaNextGrp -> |
| Ofdpa2Pipeline.fail(ofdpaNextGrp.nextObj, |
| ObjectiveError.GROUPINSTALLATIONFAILED)); |
| } |
| }).build(); |
| |
| pendingRemoveNextObjectives = CacheBuilder.newBuilder() |
| .expireAfterWrite(20, TimeUnit.SECONDS) |
| .removalListener(( |
| RemovalNotification<NextObjective, List<GroupKey>> notification) -> { |
| if (notification.getCause() == RemovalCause.EXPIRED) { |
| Ofdpa2Pipeline.fail(notification.getKey(), |
| ObjectiveError.GROUPREMOVALFAILED); |
| } |
| }).build(); |
| pendingGroups = CacheBuilder.newBuilder() |
| .expireAfterWrite(20, TimeUnit.SECONDS) |
| .removalListener(( |
| RemovalNotification<GroupKey, Set<GroupChainElem>> notification) -> { |
| if (notification.getCause() == RemovalCause.EXPIRED) { |
| log.error("Unable to install group with key {} and pending GCEs: {}", |
| notification.getKey(), notification.getValue()); |
| } |
| }).build(); |
| pendingUpdateNextObjectives = new ConcurrentHashMap<>(); |
| groupChecker.scheduleAtFixedRate(new GroupChecker(), 0, 500, TimeUnit.MILLISECONDS); |
| |
| groupService.addListener(new InnerGroupListener()); |
| } |
| |
| /** |
| * The purpose of this function is to verify if the hashed next |
| * objective is supported by the current pipeline. |
| * |
| * @param nextObjective the hashed objective to verify |
| * @return true if the hashed objective is supported. Otherwise false. |
| */ |
| public boolean verifyHashedNextObjective(NextObjective nextObjective) { |
| // if it is not hashed, there is something wrong; |
| if (nextObjective.type() != HASHED) { |
| return false; |
| } |
| // The case non supported is the MPLS-ECMP. For now, we try |
| // to create a MPLS-ECMP for the transport of a VPWS. The |
| // necessary info are contained in the meta selector. In particular |
| // we are looking for the case of BoS==False; |
| TrafficSelector metaSelector = nextObjective.meta(); |
| if (metaSelector != null && isNotMplsBos(metaSelector)) { |
| return false; |
| } |
| |
| return true; |
| } |
| |
| ////////////////////////////////////// |
| // Group Creation |
| ////////////////////////////////////// |
| |
| protected void addGroup(NextObjective nextObjective) { |
| switch (nextObjective.type()) { |
| case SIMPLE: |
| Collection<TrafficTreatment> treatments = nextObjective.next(); |
| if (treatments.size() != 1) { |
| log.error("Next Objectives of type Simple should only have a " |
| + "single Traffic Treatment. Next Objective Id:{}", |
| nextObjective.id()); |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.BADPARAMS); |
| return; |
| } |
| processSimpleNextObjective(nextObjective); |
| break; |
| case BROADCAST: |
| processBroadcastNextObjective(nextObjective); |
| break; |
| case HASHED: |
| if (!verifyHashedNextObjective(nextObjective)) { |
| log.error("Next Objectives of type hashed not supported. Next Objective Id:{}", |
| nextObjective.id()); |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.BADPARAMS); |
| return; |
| } |
| processHashedNextObjective(nextObjective); |
| break; |
| case FAILOVER: |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.UNSUPPORTED); |
| log.warn("Unsupported next objective type {}", nextObjective.type()); |
| break; |
| default: |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.UNKNOWN); |
| log.warn("Unknown next objective type {}", nextObjective.type()); |
| } |
| } |
| |
| /** |
| * As per the OFDPA 2.0 TTP, packets are sent out of ports by using |
| * a chain of groups. The simple Next Objective passed |
| * in by the application has to be broken up into a group chain |
| * comprising of an L3 Unicast Group that points to an L2 Interface |
| * Group which in-turn points to an output port. In some cases, the simple |
| * next Objective can just be an L2 interface without the need for chaining. |
| * |
| * @param nextObj the nextObjective of type SIMPLE |
| */ |
| private void processSimpleNextObjective(NextObjective nextObj) { |
| TrafficTreatment treatment = nextObj.next().iterator().next(); |
| // determine if plain L2 or L3->L2 |
| boolean plainL2 = true; |
| for (Instruction ins : treatment.allInstructions()) { |
| if (ins.type() == Instruction.Type.L2MODIFICATION) { |
| L2ModificationInstruction l2ins = (L2ModificationInstruction) ins; |
| if (l2ins.subtype() == L2ModificationInstruction.L2SubType.ETH_DST || |
| l2ins.subtype() == L2ModificationInstruction.L2SubType.ETH_SRC) { |
| plainL2 = false; |
| break; |
| } |
| } |
| } |
| |
| if (plainL2) { |
| createL2InterfaceGroup(nextObj); |
| return; |
| } |
| |
| boolean isMpls = false; |
| // In order to understand if it is a pseudo wire related |
| // next objective we look for the tunnel id in the meta. |
| boolean isPw = false; |
| if (nextObj.meta() != null) { |
| isMpls = isNotMplsBos(nextObj.meta()); |
| |
| TunnelIdCriterion tunnelIdCriterion = (TunnelIdCriterion) nextObj |
| .meta() |
| .getCriterion(TUNNEL_ID); |
| if (tunnelIdCriterion != null) { |
| isPw = true; |
| } |
| |
| } |
| |
| if (!isPw) { |
| // break up simple next objective to GroupChain objects |
| GroupInfo groupInfo = createL2L3Chain(treatment, nextObj.id(), |
| nextObj.appId(), isMpls, |
| nextObj.meta()); |
| if (groupInfo == null) { |
| log.error("Could not process nextObj={} in dev:{}", nextObj.id(), deviceId); |
| return; |
| } |
| // create object for local and distributed storage |
| Deque<GroupKey> gkeyChain = new ArrayDeque<>(); |
| gkeyChain.addFirst(groupInfo.innerMostGroupDesc.appCookie()); |
| gkeyChain.addFirst(groupInfo.nextGroupDesc.appCookie()); |
| OfdpaNextGroup ofdpaGrp = |
| new OfdpaNextGroup(Collections.singletonList(gkeyChain), nextObj); |
| |
| // store l3groupkey with the ofdpaNextGroup for the nextObjective that depends on it |
| updatePendingNextObjective(groupInfo.nextGroupDesc.appCookie(), ofdpaGrp); |
| |
| // now we are ready to send the l2 groupDescription (inner), as all the stores |
| // that will get async replies have been updated. By waiting to update |
| // the stores, we prevent nasty race conditions. |
| groupService.addGroup(groupInfo.innerMostGroupDesc); |
| } else { |
| // We handle the pseudo wire with a different a procedure. |
| // This procedure is meant to handle both initiation and |
| // termination of the pseudo wire. |
| processPwNextObjective(nextObj); |
| } |
| } |
| |
| /** |
| * Creates a simple L2 Interface Group. |
| * |
| * @param nextObj the next Objective |
| */ |
| private void createL2InterfaceGroup(NextObjective nextObj) { |
| VlanId assignedVlan = Ofdpa2Pipeline.readVlanFromSelector(nextObj.meta()); |
| if (assignedVlan == null) { |
| log.warn("VLAN ID required by simple next obj is missing. Abort."); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| return; |
| } |
| |
| List<GroupInfo> groupInfos = prepareL2InterfaceGroup(nextObj, assignedVlan); |
| |
| // There is only one L2 interface group in this case |
| GroupDescription l2InterfaceGroupDesc = groupInfos.get(0).innerMostGroupDesc; |
| |
| // Put all dependency information into allGroupKeys |
| List<Deque<GroupKey>> allGroupKeys = Lists.newArrayList(); |
| Deque<GroupKey> gkeyChain = new ArrayDeque<>(); |
| gkeyChain.addFirst(l2InterfaceGroupDesc.appCookie()); |
| allGroupKeys.add(gkeyChain); |
| |
| // Point the next objective to this group |
| OfdpaNextGroup ofdpaGrp = new OfdpaNextGroup(allGroupKeys, nextObj); |
| updatePendingNextObjective(l2InterfaceGroupDesc.appCookie(), ofdpaGrp); |
| |
| // Start installing the inner-most group |
| groupService.addGroup(l2InterfaceGroupDesc); |
| } |
| |
| /** |
| * Creates one of two possible group-chains from the treatment |
| * passed in. Depending on the MPLS boolean, this method either creates |
| * an L3Unicast Group --> L2Interface Group, if mpls is false; |
| * or MPLSInterface Group --> L2Interface Group, if mpls is true; |
| * The returned 'inner' group description is always the L2 Interface group. |
| * |
| * @param treatment that needs to be broken up to create the group chain |
| * @param nextId of the next objective that needs this group chain |
| * @param appId of the application that sent this next objective |
| * @param mpls determines if L3Unicast or MPLSInterface group is created |
| * @param meta metadata passed in by the application as part of the nextObjective |
| * @return GroupInfo containing the GroupDescription of the |
| * L2Interface group(inner) and the GroupDescription of the (outer) |
| * L3Unicast/MPLSInterface group. May return null if there is an |
| * error in processing the chain |
| */ |
| protected GroupInfo createL2L3Chain(TrafficTreatment treatment, int nextId, |
| ApplicationId appId, boolean mpls, |
| TrafficSelector meta) { |
| return createL2L3ChainInternal(treatment, nextId, appId, mpls, meta, true); |
| } |
| |
| /** |
| * Internal implementation of createL2L3Chain. |
| * <p> |
| * The is_present bit in set_vlan_vid action is required to be 0 in OFDPA i12. |
| * Since it is non-OF spec, we need an extension treatment for that. |
| * The useSetVlanExtension must be set to false for OFDPA i12. |
| * </p> |
| * |
| * @param treatment that needs to be broken up to create the group chain |
| * @param nextId of the next objective that needs this group chain |
| * @param appId of the application that sent this next objective |
| * @param mpls determines if L3Unicast or MPLSInterface group is created |
| * @param meta metadata passed in by the application as part of the nextObjective |
| * @param useSetVlanExtension use the setVlanVid extension that has is_present bit set to 0. |
| * @return GroupInfo containing the GroupDescription of the |
| * L2Interface group(inner) and the GroupDescription of the (outer) |
| * L3Unicast/MPLSInterface group. May return null if there is an |
| * error in processing the chain |
| */ |
| protected GroupInfo createL2L3ChainInternal(TrafficTreatment treatment, int nextId, |
| ApplicationId appId, boolean mpls, |
| TrafficSelector meta, boolean useSetVlanExtension) { |
| // for the l2interface group, get vlan and port info |
| // for the outer group, get the src/dst mac, and vlan info |
| TrafficTreatment.Builder outerTtb = DefaultTrafficTreatment.builder(); |
| TrafficTreatment.Builder innerTtb = DefaultTrafficTreatment.builder(); |
| VlanId vlanid = null; |
| long portNum = 0; |
| boolean setVlan = false, popVlan = false; |
| MacAddress srcMac; |
| MacAddress dstMac; |
| for (Instruction ins : treatment.allInstructions()) { |
| if (ins.type() == Instruction.Type.L2MODIFICATION) { |
| L2ModificationInstruction l2ins = (L2ModificationInstruction) ins; |
| switch (l2ins.subtype()) { |
| case ETH_DST: |
| dstMac = ((L2ModificationInstruction.ModEtherInstruction) l2ins).mac(); |
| outerTtb.setEthDst(dstMac); |
| break; |
| case ETH_SRC: |
| srcMac = ((L2ModificationInstruction.ModEtherInstruction) l2ins).mac(); |
| outerTtb.setEthSrc(srcMac); |
| break; |
| case VLAN_ID: |
| vlanid = ((L2ModificationInstruction.ModVlanIdInstruction) l2ins).vlanId(); |
| if (useSetVlanExtension) { |
| OfdpaSetVlanVid ofdpaSetVlanVid = new OfdpaSetVlanVid(vlanid); |
| outerTtb.extension(ofdpaSetVlanVid, deviceId); |
| } else { |
| outerTtb.setVlanId(vlanid); |
| } |
| setVlan = true; |
| break; |
| case VLAN_POP: |
| innerTtb.popVlan(); |
| popVlan = true; |
| break; |
| case DEC_MPLS_TTL: |
| case MPLS_LABEL: |
| case MPLS_POP: |
| case MPLS_PUSH: |
| case VLAN_PCP: |
| case VLAN_PUSH: |
| default: |
| break; |
| } |
| } else if (ins.type() == Instruction.Type.OUTPUT) { |
| portNum = ((Instructions.OutputInstruction) ins).port().toLong(); |
| innerTtb.add(ins); |
| } else { |
| log.warn("Driver does not handle this type of TrafficTreatment" |
| + " instruction in nextObjectives: {}", ins.type()); |
| } |
| } |
| |
| if (vlanid == null && meta != null) { |
| // use metadata if available |
| Criterion vidCriterion = meta.getCriterion(VLAN_VID); |
| if (vidCriterion != null) { |
| vlanid = ((VlanIdCriterion) vidCriterion).vlanId(); |
| } |
| // if vlan is not set, use the vlan in metadata for outerTtb |
| if (vlanid != null && !setVlan) { |
| if (useSetVlanExtension) { |
| OfdpaSetVlanVid ofdpaSetVlanVid = new OfdpaSetVlanVid(vlanid); |
| outerTtb.extension(ofdpaSetVlanVid, deviceId); |
| } else { |
| outerTtb.setVlanId(vlanid); |
| } |
| } |
| } |
| |
| if (vlanid == null) { |
| log.error("Driver cannot process an L2/L3 group chain without " |
| + "egress vlan information for dev: {} port:{}", |
| deviceId, portNum); |
| return null; |
| } |
| |
| if (!setVlan && !popVlan) { |
| // untagged outgoing port |
| TrafficTreatment.Builder temp = DefaultTrafficTreatment.builder(); |
| temp.popVlan(); |
| innerTtb.build().allInstructions().forEach(i -> temp.add(i)); |
| innerTtb = temp; |
| } |
| |
| // assemble information for ofdpa l2interface group |
| int l2groupId = L2_INTERFACE_TYPE | (vlanid.toShort() << 16) | (int) portNum; |
| // a globally unique groupkey that is different for ports in the same device, |
| // but different for the same portnumber on different devices. Also different |
| // for the various group-types created out of the same next objective. |
| int l2gk = l2InterfaceGroupKey(deviceId, vlanid, portNum); |
| final GroupKey l2groupkey = new DefaultGroupKey(Ofdpa2Pipeline.appKryo.serialize(l2gk)); |
| |
| // assemble information for outer group |
| GroupDescription outerGrpDesc = null; |
| if (mpls) { |
| // outer group is MPLSInteface |
| int mplsInterfaceIndex = getNextAvailableIndex(); |
| int mplsgroupId = MPLS_INTERFACE_TYPE | (SUBTYPE_MASK & mplsInterfaceIndex); |
| final GroupKey mplsgroupkey = new DefaultGroupKey( |
| Ofdpa2Pipeline.appKryo.serialize(mplsInterfaceIndex)); |
| outerTtb.group(new GroupId(l2groupId)); |
| // create the mpls-interface group description to wait for the |
| // l2 interface group to be processed |
| GroupBucket mplsinterfaceGroupBucket = |
| DefaultGroupBucket.createIndirectGroupBucket(outerTtb.build()); |
| outerGrpDesc = new DefaultGroupDescription( |
| deviceId, |
| GroupDescription.Type.INDIRECT, |
| new GroupBuckets(Collections.singletonList( |
| mplsinterfaceGroupBucket)), |
| mplsgroupkey, |
| mplsgroupId, |
| appId); |
| log.debug("Trying MPLS-Interface: device:{} gid:{} gkey:{} nextid:{}", |
| deviceId, Integer.toHexString(mplsgroupId), |
| mplsgroupkey, nextId); |
| } else { |
| // outer group is L3Unicast |
| int l3unicastIndex = getNextAvailableIndex(); |
| int l3groupId = L3_UNICAST_TYPE | (TYPE_MASK & l3unicastIndex); |
| final GroupKey l3groupkey = new DefaultGroupKey( |
| Ofdpa2Pipeline.appKryo.serialize(l3unicastIndex)); |
| outerTtb.group(new GroupId(l2groupId)); |
| // create the l3unicast group description to wait for the |
| // l2 interface group to be processed |
| GroupBucket l3unicastGroupBucket = |
| DefaultGroupBucket.createIndirectGroupBucket(outerTtb.build()); |
| outerGrpDesc = new DefaultGroupDescription( |
| deviceId, |
| GroupDescription.Type.INDIRECT, |
| new GroupBuckets(Collections.singletonList( |
| l3unicastGroupBucket)), |
| l3groupkey, |
| l3groupId, |
| appId); |
| log.debug("Trying L3Unicast: device:{} gid:{} gkey:{} nextid:{}", |
| deviceId, Integer.toHexString(l3groupId), |
| l3groupkey, nextId); |
| } |
| |
| // store l2groupkey with the groupChainElem for the outer-group that depends on it |
| GroupChainElem gce = new GroupChainElem(outerGrpDesc, 1, false); |
| updatePendingGroups(l2groupkey, gce); |
| |
| // create group description for the inner l2interfacegroup |
| GroupBucket l2InterfaceGroupBucket = |
| DefaultGroupBucket.createIndirectGroupBucket(innerTtb.build()); |
| GroupDescription l2groupDescription = |
| new DefaultGroupDescription( |
| deviceId, |
| GroupDescription.Type.INDIRECT, |
| new GroupBuckets(Collections.singletonList( |
| l2InterfaceGroupBucket)), |
| l2groupkey, |
| l2groupId, |
| appId); |
| log.debug("Trying L2Interface: device:{} gid:{} gkey:{} nextId:{}", |
| deviceId, Integer.toHexString(l2groupId), |
| l2groupkey, nextId); |
| return new GroupInfo(l2groupDescription, outerGrpDesc); |
| |
| } |
| |
| /** |
| * As per the OFDPA 2.0 TTP, packets are sent out of ports by using |
| * a chain of groups. The broadcast Next Objective passed in by the application |
| * has to be broken up into a group chain comprising of an |
| * L2 Flood group or L3 Multicast group, whose buckets point to L2 Interface groups. |
| * |
| * @param nextObj the nextObjective of type BROADCAST |
| */ |
| private void processBroadcastNextObjective(NextObjective nextObj) { |
| VlanId assignedVlan = Ofdpa2Pipeline.readVlanFromSelector(nextObj.meta()); |
| if (assignedVlan == null) { |
| log.warn("VLAN ID required by broadcast next obj is missing. Abort."); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| return; |
| } |
| |
| List<GroupInfo> groupInfos = prepareL2InterfaceGroup(nextObj, assignedVlan); |
| |
| IpPrefix ipDst = Ofdpa2Pipeline.readIpDstFromSelector(nextObj.meta()); |
| if (ipDst != null) { |
| if (ipDst.isMulticast()) { |
| createL3MulticastGroup(nextObj, assignedVlan, groupInfos); |
| } else { |
| log.warn("Broadcast NextObj with non-multicast IP address {}", nextObj); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| return; |
| } |
| } else { |
| createL2FloodGroup(nextObj, assignedVlan, groupInfos); |
| } |
| } |
| |
| private List<GroupInfo> prepareL2InterfaceGroup(NextObjective nextObj, |
| VlanId assignedVlan) { |
| ImmutableList.Builder<GroupInfo> groupInfoBuilder = ImmutableList.builder(); |
| |
| // break up broadcast next objective to multiple groups |
| Collection<TrafficTreatment> buckets = nextObj.next(); |
| |
| // each treatment is converted to an L2 interface group |
| for (TrafficTreatment treatment : buckets) { |
| TrafficTreatment.Builder newTreatment = DefaultTrafficTreatment.builder(); |
| PortNumber portNum = null; |
| VlanId egressVlan = null; |
| // ensure that the only allowed treatments are pop-vlan and output |
| for (Instruction ins : treatment.allInstructions()) { |
| if (ins.type() == Instruction.Type.L2MODIFICATION) { |
| L2ModificationInstruction l2ins = (L2ModificationInstruction) ins; |
| switch (l2ins.subtype()) { |
| case VLAN_POP: |
| newTreatment.add(l2ins); |
| break; |
| case VLAN_ID: |
| egressVlan = ((L2ModificationInstruction.ModVlanIdInstruction) l2ins).vlanId(); |
| break; |
| default: |
| log.debug("action {} not permitted for broadcast nextObj", |
| l2ins.subtype()); |
| break; |
| } |
| } else if (ins.type() == Instruction.Type.OUTPUT) { |
| portNum = ((Instructions.OutputInstruction) ins).port(); |
| newTreatment.add(ins); |
| } else { |
| log.debug("TrafficTreatment of type {} not permitted in " + |
| " broadcast nextObjective", ins.type()); |
| } |
| } |
| |
| // assemble info for l2 interface group |
| VlanId l2InterfaceGroupVlan = |
| (egressVlan != null && !assignedVlan.equals(egressVlan)) ? |
| egressVlan : assignedVlan; |
| int l2gk = l2InterfaceGroupKey(deviceId, l2InterfaceGroupVlan, portNum.toLong()); |
| final GroupKey l2InterfaceGroupKey = |
| new DefaultGroupKey(Ofdpa2Pipeline.appKryo.serialize(l2gk)); |
| int l2InterfaceGroupId = L2_INTERFACE_TYPE | |
| ((l2InterfaceGroupVlan.toShort() & THREE_BIT_MASK) << PORT_LEN) | |
| ((int) portNum.toLong() & FOUR_BIT_MASK); |
| GroupBucket l2InterfaceGroupBucket = |
| DefaultGroupBucket.createIndirectGroupBucket(newTreatment.build()); |
| GroupDescription l2InterfaceGroupDescription = |
| new DefaultGroupDescription( |
| deviceId, |
| GroupDescription.Type.INDIRECT, |
| new GroupBuckets(Collections.singletonList( |
| l2InterfaceGroupBucket)), |
| l2InterfaceGroupKey, |
| l2InterfaceGroupId, |
| nextObj.appId()); |
| log.debug("Trying L2-Interface: device:{} gid:{} gkey:{} nextid:{}", |
| deviceId, Integer.toHexString(l2InterfaceGroupId), |
| l2InterfaceGroupKey, nextObj.id()); |
| |
| groupInfoBuilder.add(new GroupInfo(l2InterfaceGroupDescription, |
| l2InterfaceGroupDescription)); |
| } |
| return groupInfoBuilder.build(); |
| } |
| |
| private void createL2FloodGroup(NextObjective nextObj, VlanId vlanId, |
| List<GroupInfo> groupInfos) { |
| // assemble info for l2 flood group. Since there can be only one flood |
| // group for a vlan, its index is always the same - 0 |
| Integer l2floodgroupId = L2_FLOOD_TYPE | (vlanId.toShort() << 16); |
| int l2floodgk = l2FloodGroupKey(vlanId); |
| final GroupKey l2floodgroupkey = |
| new DefaultGroupKey(Ofdpa2Pipeline.appKryo.serialize(l2floodgk)); |
| |
| // collection of group buckets pointing to all the l2 interface groups |
| List<GroupBucket> l2floodBuckets = |
| generateNextGroupBuckets(groupInfos, ALL); |
| // create the l2flood group-description to wait for all the |
| // l2interface groups to be processed |
| GroupDescription l2floodGroupDescription = |
| new DefaultGroupDescription( |
| deviceId, |
| ALL, |
| new GroupBuckets(l2floodBuckets), |
| l2floodgroupkey, |
| l2floodgroupId, |
| nextObj.appId()); |
| log.debug("Trying L2-Flood: device:{} gid:{} gkey:{} nextid:{}", |
| deviceId, Integer.toHexString(l2floodgroupId), |
| l2floodgroupkey, nextObj.id()); |
| |
| // Put all dependency information into allGroupKeys |
| List<Deque<GroupKey>> allGroupKeys = Lists.newArrayList(); |
| groupInfos.forEach(groupInfo -> { |
| Deque<GroupKey> gkeyChain = new ArrayDeque<>(); |
| // In this case we should have L2 interface group only |
| gkeyChain.addFirst(groupInfo.nextGroupDesc.appCookie()); |
| gkeyChain.addFirst(l2floodgroupkey); |
| allGroupKeys.add(gkeyChain); |
| }); |
| |
| // Point the next objective to this group |
| OfdpaNextGroup ofdpaGrp = new OfdpaNextGroup(allGroupKeys, nextObj); |
| updatePendingNextObjective(l2floodgroupkey, ofdpaGrp); |
| |
| GroupChainElem gce = new GroupChainElem(l2floodGroupDescription, |
| groupInfos.size(), false); |
| groupInfos.forEach(groupInfo -> { |
| // Point this group to the next group |
| updatePendingGroups(groupInfo.nextGroupDesc.appCookie(), gce); |
| // Start installing the inner-most group |
| groupService.addGroup(groupInfo.innerMostGroupDesc); |
| }); |
| } |
| |
| private int l2FloodGroupKey(VlanId vlanId) { |
| int hash = Objects.hash(deviceId, vlanId); |
| return L2_FLOOD_TYPE | TYPE_MASK & hash; |
| } |
| |
| private void createL3MulticastGroup(NextObjective nextObj, VlanId vlanId, |
| List<GroupInfo> groupInfos) { |
| List<GroupBucket> l3McastBuckets = new ArrayList<>(); |
| groupInfos.forEach(groupInfo -> { |
| // Points to L3 interface group if there is one. |
| // Otherwise points to L2 interface group directly. |
| GroupDescription nextGroupDesc = (groupInfo.nextGroupDesc != null) ? |
| groupInfo.nextGroupDesc : groupInfo.innerMostGroupDesc; |
| TrafficTreatment.Builder ttb = DefaultTrafficTreatment.builder(); |
| ttb.group(new GroupId(nextGroupDesc.givenGroupId())); |
| GroupBucket abucket = DefaultGroupBucket.createAllGroupBucket(ttb.build()); |
| l3McastBuckets.add(abucket); |
| }); |
| |
| int l3MulticastIndex = getNextAvailableIndex(); |
| int l3MulticastGroupId = L3_MULTICAST_TYPE | |
| vlanId.toShort() << 16 | (TYPE_VLAN_MASK & l3MulticastIndex); |
| final GroupKey l3MulticastGroupKey = |
| new DefaultGroupKey(Ofdpa2Pipeline.appKryo.serialize(l3MulticastIndex)); |
| |
| GroupDescription l3MulticastGroupDesc = new DefaultGroupDescription(deviceId, |
| ALL, |
| new GroupBuckets(l3McastBuckets), |
| l3MulticastGroupKey, |
| l3MulticastGroupId, |
| nextObj.appId()); |
| |
| // Put all dependency information into allGroupKeys |
| List<Deque<GroupKey>> allGroupKeys = Lists.newArrayList(); |
| groupInfos.forEach(groupInfo -> { |
| Deque<GroupKey> gkeyChain = new ArrayDeque<>(); |
| gkeyChain.addFirst(groupInfo.innerMostGroupDesc.appCookie()); |
| // Add L3 interface group to the chain if there is one. |
| if (!groupInfo.nextGroupDesc.equals(groupInfo.innerMostGroupDesc)) { |
| gkeyChain.addFirst(groupInfo.nextGroupDesc.appCookie()); |
| } |
| gkeyChain.addFirst(l3MulticastGroupKey); |
| allGroupKeys.add(gkeyChain); |
| }); |
| |
| // Point the next objective to this group |
| OfdpaNextGroup ofdpaGrp = new OfdpaNextGroup(allGroupKeys, nextObj); |
| updatePendingNextObjective(l3MulticastGroupKey, ofdpaGrp); |
| |
| GroupChainElem outerGce = new GroupChainElem(l3MulticastGroupDesc, |
| groupInfos.size(), false); |
| groupInfos.forEach(groupInfo -> { |
| // Point this group (L3 multicast) to the next group |
| updatePendingGroups(groupInfo.nextGroupDesc.appCookie(), outerGce); |
| |
| // Point next group to inner-most group, if any |
| if (!groupInfo.nextGroupDesc.equals(groupInfo.innerMostGroupDesc)) { |
| GroupChainElem innerGce = new GroupChainElem(groupInfo.nextGroupDesc, |
| 1, false); |
| updatePendingGroups(groupInfo.innerMostGroupDesc.appCookie(), innerGce); |
| } |
| |
| // Start installing the inner-most group |
| groupService.addGroup(groupInfo.innerMostGroupDesc); |
| }); |
| } |
| |
| /** |
| * As per the OFDPA 2.0 TTP, packets are sent out of ports by using |
| * a chain of groups. The hashed Next Objective passed in by the application |
| * has to be broken up into a group chain comprising of an |
| * L3 ECMP group as the top level group. Buckets of this group can point |
| * to a variety of groups in a group chain, depending on the whether |
| * MPLS labels are being pushed or not. |
| * <p> |
| * NOTE: We do not create MPLS ECMP groups as they are unimplemented in |
| * OF-DPA 2.0 (even though it is in the spec). Therefore we do not |
| * check the nextObjective meta to see what is matching before being |
| * sent to this nextObjective. |
| * |
| * @param nextObj the nextObjective of type HASHED |
| */ |
| protected void processHashedNextObjective(NextObjective nextObj) { |
| // storage for all group keys in the chain of groups created |
| List<Deque<GroupKey>> allGroupKeys = new ArrayList<>(); |
| List<GroupInfo> unsentGroups = new ArrayList<>(); |
| createHashBucketChains(nextObj, allGroupKeys, unsentGroups); |
| |
| // now we can create the outermost L3 ECMP group |
| List<GroupBucket> l3ecmpGroupBuckets = new ArrayList<>(); |
| for (GroupInfo gi : unsentGroups) { |
| // create ECMP bucket to point to the outer group |
| TrafficTreatment.Builder ttb = DefaultTrafficTreatment.builder(); |
| ttb.group(new GroupId(gi.nextGroupDesc.givenGroupId())); |
| GroupBucket sbucket = DefaultGroupBucket |
| .createSelectGroupBucket(ttb.build()); |
| l3ecmpGroupBuckets.add(sbucket); |
| } |
| int l3ecmpIndex = getNextAvailableIndex(); |
| int l3ecmpGroupId = L3_ECMP_TYPE | (TYPE_MASK & l3ecmpIndex); |
| GroupKey l3ecmpGroupKey = new DefaultGroupKey( |
| Ofdpa2Pipeline.appKryo.serialize(l3ecmpIndex)); |
| GroupDescription l3ecmpGroupDesc = |
| new DefaultGroupDescription( |
| deviceId, |
| SELECT, |
| new GroupBuckets(l3ecmpGroupBuckets), |
| l3ecmpGroupKey, |
| l3ecmpGroupId, |
| nextObj.appId()); |
| GroupChainElem l3ecmpGce = new GroupChainElem(l3ecmpGroupDesc, |
| l3ecmpGroupBuckets.size(), |
| false); |
| |
| // create objects for local and distributed storage |
| allGroupKeys.forEach(gkeyChain -> gkeyChain.addFirst(l3ecmpGroupKey)); |
| OfdpaNextGroup ofdpaGrp = new OfdpaNextGroup(allGroupKeys, nextObj); |
| |
| // store l3ecmpGroupKey with the ofdpaGroupChain for the nextObjective |
| // that depends on it |
| updatePendingNextObjective(l3ecmpGroupKey, ofdpaGrp); |
| |
| log.debug("Trying L3ECMP: device:{} gid:{} gkey:{} nextId:{}", |
| deviceId, Integer.toHexString(l3ecmpGroupId), |
| l3ecmpGroupKey, nextObj.id()); |
| // finally we are ready to send the innermost groups |
| for (GroupInfo gi : unsentGroups) { |
| log.debug("Sending innermost group {} in group chain on device {} ", |
| Integer.toHexString(gi.innerMostGroupDesc.givenGroupId()), deviceId); |
| updatePendingGroups(gi.nextGroupDesc.appCookie(), l3ecmpGce); |
| groupService.addGroup(gi.innerMostGroupDesc); |
| } |
| } |
| |
| /** |
| * Creates group chains for all buckets in a hashed group, and stores the |
| * GroupInfos and GroupKeys for all the groups in the lists passed in, which |
| * should be empty. |
| * <p> |
| * Does not create the top level ECMP group. Does not actually send the |
| * groups to the groupService. |
| * |
| * @param nextObj the Next Objective with buckets that need to be converted |
| * to group chains |
| * @param allGroupKeys a list to store groupKey for each bucket-group-chain |
| * @param unsentGroups a list to store GroupInfo for each bucket-group-chain |
| */ |
| protected void createHashBucketChains(NextObjective nextObj, |
| List<Deque<GroupKey>> allGroupKeys, |
| List<GroupInfo> unsentGroups) { |
| // break up hashed next objective to multiple groups |
| Collection<TrafficTreatment> buckets = nextObj.next(); |
| |
| for (TrafficTreatment bucket : buckets) { |
| //figure out how many labels are pushed in each bucket |
| int labelsPushed = 0; |
| MplsLabel innermostLabel = null; |
| for (Instruction ins : bucket.allInstructions()) { |
| if (ins.type() == Instruction.Type.L2MODIFICATION) { |
| L2ModificationInstruction l2ins = (L2ModificationInstruction) ins; |
| if (l2ins.subtype() == L2ModificationInstruction.L2SubType.MPLS_PUSH) { |
| labelsPushed++; |
| } |
| if (l2ins.subtype() == L2ModificationInstruction.L2SubType.MPLS_LABEL) { |
| if (innermostLabel == null) { |
| innermostLabel = ((L2ModificationInstruction.ModMplsLabelInstruction) l2ins).label(); |
| } |
| } |
| } |
| } |
| |
| Deque<GroupKey> gkeyChain = new ArrayDeque<>(); |
| // XXX we only deal with 0 and 1 label push right now |
| if (labelsPushed == 0) { |
| GroupInfo nolabelGroupInfo; |
| TrafficSelector metaSelector = nextObj.meta(); |
| if (metaSelector != null) { |
| if (isNotMplsBos(metaSelector)) { |
| nolabelGroupInfo = createL2L3Chain(bucket, nextObj.id(), |
| nextObj.appId(), true, |
| nextObj.meta()); |
| } else { |
| nolabelGroupInfo = createL2L3Chain(bucket, nextObj.id(), |
| nextObj.appId(), false, |
| nextObj.meta()); |
| } |
| } else { |
| nolabelGroupInfo = createL2L3Chain(bucket, nextObj.id(), |
| nextObj.appId(), false, |
| nextObj.meta()); |
| } |
| if (nolabelGroupInfo == null) { |
| log.error("Could not process nextObj={} in dev:{}", |
| nextObj.id(), deviceId); |
| return; |
| } |
| gkeyChain.addFirst(nolabelGroupInfo.innerMostGroupDesc.appCookie()); |
| gkeyChain.addFirst(nolabelGroupInfo.nextGroupDesc.appCookie()); |
| |
| // we can't send the inner group description yet, as we have to |
| // create the dependent ECMP group first. So we store.. |
| unsentGroups.add(nolabelGroupInfo); |
| |
| } else if (labelsPushed == 1) { |
| GroupInfo onelabelGroupInfo = createL2L3Chain(bucket, nextObj.id(), |
| nextObj.appId(), true, |
| nextObj.meta()); |
| if (onelabelGroupInfo == null) { |
| log.error("Could not process nextObj={} in dev:{}", |
| nextObj.id(), deviceId); |
| return; |
| } |
| // we need to add another group to this chain - the L3VPN group |
| TrafficTreatment.Builder l3vpnTtb = DefaultTrafficTreatment.builder(); |
| if (requireVlanPopBeforeMplsPush()) { |
| l3vpnTtb.popVlan(); |
| } |
| l3vpnTtb.pushMpls() |
| .setMpls(innermostLabel) |
| .group(new GroupId(onelabelGroupInfo.nextGroupDesc.givenGroupId())); |
| if (supportCopyTtl()) { |
| l3vpnTtb.copyTtlOut(); |
| } |
| if (supportSetMplsBos()) { |
| l3vpnTtb.setMplsBos(true); |
| } |
| if (requireVlanPopBeforeMplsPush()) { |
| l3vpnTtb.pushVlan().setVlanId(VlanId.vlanId(VlanId.RESERVED)); |
| } |
| |
| GroupBucket l3vpnGrpBkt = |
| DefaultGroupBucket.createIndirectGroupBucket(l3vpnTtb.build()); |
| int l3vpnIndex = getNextAvailableIndex(); |
| int l3vpngroupId = MPLS_L3VPN_SUBTYPE | (SUBTYPE_MASK & l3vpnIndex); |
| GroupKey l3vpngroupkey = new DefaultGroupKey( |
| Ofdpa2Pipeline.appKryo.serialize(l3vpnIndex)); |
| GroupDescription l3vpnGroupDesc = |
| new DefaultGroupDescription( |
| deviceId, |
| GroupDescription.Type.INDIRECT, |
| new GroupBuckets(Collections.singletonList( |
| l3vpnGrpBkt)), |
| l3vpngroupkey, |
| l3vpngroupId, |
| nextObj.appId()); |
| GroupChainElem l3vpnGce = new GroupChainElem(l3vpnGroupDesc, 1, false); |
| updatePendingGroups(onelabelGroupInfo.nextGroupDesc.appCookie(), l3vpnGce); |
| |
| gkeyChain.addFirst(onelabelGroupInfo.innerMostGroupDesc.appCookie()); |
| gkeyChain.addFirst(onelabelGroupInfo.nextGroupDesc.appCookie()); |
| gkeyChain.addFirst(l3vpngroupkey); |
| |
| //now we can replace the outerGrpDesc with the one we just created |
| onelabelGroupInfo.nextGroupDesc = l3vpnGroupDesc; |
| |
| // we can't send the innermost group yet, as we have to create |
| // the dependent ECMP group first. So we store ... |
| unsentGroups.add(onelabelGroupInfo); |
| |
| log.debug("Trying L3VPN: device:{} gid:{} gkey:{} nextId:{}", |
| deviceId, Integer.toHexString(l3vpngroupId), |
| l3vpngroupkey, nextObj.id()); |
| |
| } else { |
| log.warn("Driver currently does not handle more than 1 MPLS " |
| + "labels. Not processing nextObjective {}", nextObj.id()); |
| return; |
| } |
| |
| // all groups in this chain |
| allGroupKeys.add(gkeyChain); |
| } |
| } |
| |
| /** |
| * Processes the pseudo wire related next objective. |
| * This procedure try to reuse the mpls label groups, |
| * the mpls interface group and the l2 interface group. |
| * |
| * @param nextObjective the objective to process. |
| */ |
| protected void processPwNextObjective(NextObjective nextObjective) { |
| log.warn("Pseudo wire extensions are not support for the OFDPA 2.0 {}", nextObjective.id()); |
| return; |
| } |
| |
| ////////////////////////////////////// |
| // Group Editing |
| ////////////////////////////////////// |
| |
| /** |
| * Adds a bucket to the top level group of a group-chain, and creates the chain. |
| * Ensures that bucket being added is not a duplicate, by checking existing |
| * buckets for the same outport. |
| * |
| * @param nextObjective the bucket information for a next group |
| * @param next the representation of the existing group-chain for this next objective |
| */ |
| protected void addBucketToGroup(NextObjective nextObjective, NextGroup next) { |
| if (nextObjective.type() != NextObjective.Type.HASHED && |
| nextObjective.type() != NextObjective.Type.BROADCAST) { |
| log.warn("AddBuckets not applied to nextType:{} in dev:{} for next:{}", |
| nextObjective.type(), deviceId, nextObjective.id()); |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.UNSUPPORTED); |
| return; |
| } |
| |
| // first check to see if bucket being added is not a duplicate of an |
| // existing bucket. If it is for an existing outport, then its a duplicate. |
| Set<TrafficTreatment> duplicateBuckets = Sets.newHashSet(); |
| List<Deque<GroupKey>> allActiveKeys = Ofdpa2Pipeline.appKryo.deserialize(next.data()); |
| Set<PortNumber> existingPorts = getExistingOutputPorts(allActiveKeys); |
| Set<TrafficTreatment> nonDuplicateBuckets = Sets.newHashSet(); |
| NextObjective objectiveToAdd; |
| |
| nextObjective.next().forEach(trafficTreatment -> { |
| PortNumber portNumber = readOutPortFromTreatment(trafficTreatment); |
| if (portNumber == null) { |
| return; |
| } |
| if (existingPorts.contains(portNumber)) { |
| duplicateBuckets.add(trafficTreatment); |
| } else { |
| nonDuplicateBuckets.add(trafficTreatment); |
| } |
| }); |
| |
| if (duplicateBuckets.isEmpty()) { |
| // use the original objective |
| objectiveToAdd = nextObjective; |
| } else if (!nonDuplicateBuckets.isEmpty()) { |
| // only use the non-duplicate buckets if there are any |
| log.debug("Some buckets {} already exist in next id {}, duplicate " |
| + "buckets will be ignored.", duplicateBuckets, nextObjective.id()); |
| // new next objective with non duplicate treatments |
| NextObjective.Builder builder = DefaultNextObjective.builder() |
| .withType(nextObjective.type()) |
| .withId(nextObjective.id()) |
| .withMeta(nextObjective.meta()) |
| .fromApp(nextObjective.appId()); |
| nonDuplicateBuckets.forEach(builder::addTreatment); |
| |
| ObjectiveContext context = nextObjective.context().orElse(null); |
| objectiveToAdd = builder.addToExisting(context); |
| } else { |
| // buckets to add are already there - nothing to do |
| return; |
| } |
| |
| if (nextObjective.type() == NextObjective.Type.HASHED) { |
| addBucketToHashGroup(objectiveToAdd, allActiveKeys); |
| } else if (nextObjective.type() == NextObjective.Type.BROADCAST) { |
| addBucketToBroadcastGroup(objectiveToAdd, allActiveKeys); |
| } |
| } |
| |
| private Set<PortNumber> getExistingOutputPorts(List<Deque<GroupKey>> allActiveKeys) { |
| Set<PortNumber> existingPorts = Sets.newHashSet(); |
| |
| allActiveKeys.forEach(keyChain -> { |
| GroupKey ifaceGroupKey = keyChain.peekLast(); |
| Group ifaceGroup = groupService.getGroup(deviceId, ifaceGroupKey); |
| if (ifaceGroup != null && !ifaceGroup.buckets().buckets().isEmpty()) { |
| ifaceGroup.buckets().buckets().forEach(bucket -> { |
| PortNumber portNumber = readOutPortFromTreatment(bucket.treatment()); |
| |
| if (portNumber != null) { |
| existingPorts.add(portNumber); |
| } |
| }); |
| } |
| }); |
| return existingPorts; |
| } |
| |
| private void addBucketToHashGroup(NextObjective nextObjective, |
| List<Deque<GroupKey>> allActiveKeys) { |
| // storage for all group keys in the chain of groups created |
| List<Deque<GroupKey>> allGroupKeys = new ArrayList<>(); |
| List<GroupInfo> unsentGroups = new ArrayList<>(); |
| List<GroupBucket> newBuckets = Lists.newArrayList(); |
| createHashBucketChains(nextObjective, allGroupKeys, unsentGroups); |
| |
| // now we can create the buckets to add to the outermost L3 ECMP group |
| newBuckets = generateNextGroupBuckets(unsentGroups, SELECT); |
| |
| // retrieve the original L3 ECMP group |
| Group l3ecmpGroup = retrieveTopLevelGroup(allActiveKeys, nextObjective.id()); |
| if (l3ecmpGroup == null) { |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.GROUPMISSING); |
| return; |
| } |
| GroupKey l3ecmpGroupKey = l3ecmpGroup.appCookie(); |
| int l3ecmpGroupId = l3ecmpGroup.id().id(); |
| |
| // Although GroupDescriptions are not necessary for adding buckets to |
| // existing groups, we still use one in the GroupChainElem. When the latter is |
| // processed, the info will be extracted for the bucketAdd call to groupService |
| GroupDescription l3ecmpGroupDesc = |
| new DefaultGroupDescription( |
| deviceId, |
| SELECT, |
| new GroupBuckets(newBuckets), |
| l3ecmpGroupKey, |
| l3ecmpGroupId, |
| nextObjective.appId()); |
| GroupChainElem l3ecmpGce = new GroupChainElem(l3ecmpGroupDesc, |
| unsentGroups.size(), |
| true); |
| |
| // update original NextGroup with new bucket-chain |
| // If active keys shows only the top-level group without a chain of groups, |
| // then it represents an empty group. Update by replacing empty chain. |
| Deque<GroupKey> newBucketChain = allGroupKeys.get(0); |
| newBucketChain.addFirst(l3ecmpGroupKey); |
| if (allActiveKeys.size() == 1 && allActiveKeys.get(0).size() == 1) { |
| allActiveKeys.clear(); |
| } |
| allActiveKeys.add(newBucketChain); |
| updatePendingNextObjective(l3ecmpGroupKey, |
| new OfdpaNextGroup(allActiveKeys, nextObjective)); |
| |
| log.debug("Adding to L3ECMP: device:{} gid:{} gkey:{} nextId:{}", |
| deviceId, Integer.toHexString(l3ecmpGroupId), |
| l3ecmpGroupKey, nextObjective.id()); |
| |
| unsentGroups.forEach(groupInfo -> { |
| // send the innermost group |
| log.debug("Sending innermost group {} in group chain on device {} ", |
| Integer.toHexString(groupInfo.innerMostGroupDesc.givenGroupId()), deviceId); |
| updatePendingGroups(groupInfo.nextGroupDesc.appCookie(), l3ecmpGce); |
| groupService.addGroup(groupInfo.innerMostGroupDesc); |
| }); |
| } |
| |
| private void addBucketToBroadcastGroup(NextObjective nextObj, |
| List<Deque<GroupKey>> allActiveKeys) { |
| VlanId assignedVlan = Ofdpa2Pipeline.readVlanFromSelector(nextObj.meta()); |
| if (assignedVlan == null) { |
| log.warn("VLAN ID required by broadcast next obj is missing. " |
| + "Aborting add bucket to broadcast group for next:{} in dev:{}", |
| nextObj.id(), deviceId); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| return; |
| } |
| |
| List<GroupInfo> groupInfos = prepareL2InterfaceGroup(nextObj, assignedVlan); |
| |
| IpPrefix ipDst = Ofdpa2Pipeline.readIpDstFromSelector(nextObj.meta()); |
| if (ipDst != null) { |
| if (ipDst.isMulticast()) { |
| addBucketToL3MulticastGroup(nextObj, allActiveKeys, |
| groupInfos, assignedVlan); |
| } else { |
| log.warn("Broadcast NextObj with non-multicast IP address {}", nextObj); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| return; |
| } |
| } else { |
| addBucketToL2FloodGroup(nextObj, allActiveKeys, |
| groupInfos, assignedVlan); |
| } |
| } |
| |
| private void addBucketToL2FloodGroup(NextObjective nextObj, |
| List<Deque<GroupKey>> allActiveKeys, |
| List<GroupInfo> groupInfos, |
| VlanId assignedVlan) { |
| Group l2FloodGroup = retrieveTopLevelGroup(allActiveKeys, nextObj.id()); |
| |
| if (l2FloodGroup == null) { |
| log.warn("Can't find L2 flood group while adding bucket to it. NextObj = {}", |
| nextObj); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.GROUPMISSING); |
| return; |
| } |
| |
| GroupKey l2floodGroupKey = l2FloodGroup.appCookie(); |
| int l2floodGroupId = l2FloodGroup.id().id(); |
| List<GroupBucket> newBuckets = generateNextGroupBuckets(groupInfos, ALL); |
| |
| GroupDescription l2FloodGroupDescription = |
| new DefaultGroupDescription( |
| deviceId, |
| ALL, |
| new GroupBuckets(newBuckets), |
| l2floodGroupKey, |
| l2floodGroupId, |
| nextObj.appId()); |
| |
| GroupChainElem l2FloodGroupChainElement = |
| new GroupChainElem(l2FloodGroupDescription, |
| groupInfos.size(), |
| true); |
| |
| updatePendingNextObjective(l2floodGroupKey, |
| new OfdpaNextGroup(allActiveKeys, nextObj)); |
| |
| //ensure assignedVlan applies to the chosen group |
| VlanId floodGroupVlan = extractVlanIdFromGroupId(l2floodGroupId); |
| |
| if (!floodGroupVlan.equals(assignedVlan)) { |
| log.warn("VLAN ID {} does not match Flood group {} to which bucket is " |
| + "being added, for next:{} in dev:{}. Abort.", assignedVlan, |
| Integer.toHexString(l2floodGroupId), nextObj.id(), deviceId); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| return; |
| } |
| |
| groupInfos.forEach(groupInfo -> { |
| // update original NextGroup with new bucket-chain |
| // If active keys shows only the top-level group without a chain of groups, |
| // then it represents an empty group. Update by replacing empty chain. |
| Deque<GroupKey> newBucketChain = new ArrayDeque<>(); |
| newBucketChain.addFirst(groupInfo.nextGroupDesc.appCookie()); |
| newBucketChain.addFirst(l2floodGroupKey); |
| if (allActiveKeys.size() == 1 && allActiveKeys.get(0).size() == 1) { |
| allActiveKeys.clear(); |
| } |
| allActiveKeys.add(newBucketChain); |
| |
| log.debug("Adding to L2FLOOD: device:{} gid:{} gkey:{} nextId:{}", |
| deviceId, Integer.toHexString(l2floodGroupId), |
| l2floodGroupKey, nextObj.id()); |
| // send the innermost group |
| log.debug("Sending innermost group {} in group chain on device {} ", |
| Integer.toHexString(groupInfo.innerMostGroupDesc.givenGroupId()), |
| deviceId); |
| |
| updatePendingGroups(groupInfo.nextGroupDesc.appCookie(), l2FloodGroupChainElement); |
| |
| DeviceId innerMostGroupDevice = groupInfo.innerMostGroupDesc.deviceId(); |
| GroupKey innerMostGroupKey = groupInfo.innerMostGroupDesc.appCookie(); |
| Group existsL2IGroup = groupService.getGroup(innerMostGroupDevice, innerMostGroupKey); |
| |
| if (existsL2IGroup != null) { |
| // group already exist |
| processPendingAddGroupsOrNextObjs(innerMostGroupKey, true); |
| } else { |
| groupService.addGroup(groupInfo.innerMostGroupDesc); |
| } |
| |
| }); |
| } |
| |
| private VlanId extractVlanIdFromGroupId(int groupId) { |
| // Extract the 9th to 20th bit from group id as vlan id. |
| short vlanId = (short) ((groupId & 0x0fff0000) >> 16); |
| return VlanId.vlanId(vlanId); |
| } |
| |
| private List<GroupBucket> generateNextGroupBuckets(List<GroupInfo> groupInfos, |
| GroupDescription.Type bucketType) { |
| List<GroupBucket> newBuckets = Lists.newArrayList(); |
| |
| groupInfos.forEach(groupInfo -> { |
| GroupDescription groupDesc = groupInfo.nextGroupDesc; |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| treatmentBuilder.group(new GroupId(groupDesc.givenGroupId())); |
| GroupBucket newBucket = null; |
| switch (bucketType) { |
| case ALL: |
| newBucket = |
| DefaultGroupBucket.createAllGroupBucket(treatmentBuilder.build()); |
| break; |
| case INDIRECT: |
| newBucket = |
| DefaultGroupBucket.createIndirectGroupBucket(treatmentBuilder.build()); |
| break; |
| case SELECT: |
| newBucket = |
| DefaultGroupBucket.createSelectGroupBucket(treatmentBuilder.build()); |
| break; |
| case FAILOVER: |
| // TODO support failover bucket type |
| default: |
| log.warn("Unknown bucket type: {}", bucketType); |
| break; |
| } |
| |
| if (newBucket != null) { |
| newBuckets.add(newBucket); |
| } |
| |
| }); |
| |
| return ImmutableList.copyOf(newBuckets); |
| } |
| |
| private void addBucketToL3MulticastGroup(NextObjective nextObj, |
| List<Deque<GroupKey>> allActiveKeys, |
| List<GroupInfo> groupInfos, |
| VlanId assignedVlan) { |
| // create the buckets to add to the outermost L3 Multicast group |
| List<GroupBucket> newBuckets = Lists.newArrayList(); |
| groupInfos.forEach(groupInfo -> { |
| // Points to L3 interface group if there is one. |
| // Otherwise points to L2 interface group directly. |
| GroupDescription nextGroupDesc = (groupInfo.nextGroupDesc != null) ? |
| groupInfo.nextGroupDesc : groupInfo.innerMostGroupDesc; |
| TrafficTreatment.Builder treatmentBuidler = DefaultTrafficTreatment.builder(); |
| treatmentBuidler.group(new GroupId(nextGroupDesc.givenGroupId())); |
| GroupBucket newBucket = DefaultGroupBucket.createAllGroupBucket(treatmentBuidler.build()); |
| newBuckets.add(newBucket); |
| }); |
| |
| // get the group being edited |
| Group l3mcastGroup = retrieveTopLevelGroup(allActiveKeys, nextObj.id()); |
| if (l3mcastGroup == null) { |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.GROUPMISSING); |
| return; |
| } |
| GroupKey l3mcastGroupKey = l3mcastGroup.appCookie(); |
| int l3mcastGroupId = l3mcastGroup.id().id(); |
| |
| //ensure assignedVlan applies to the chosen group |
| VlanId expectedVlan = extractVlanIdFromGroupId(l3mcastGroupId); |
| if (!expectedVlan.equals(assignedVlan)) { |
| log.warn("VLAN ID {} does not match L3 Mcast group {} to which bucket is " |
| + "being added, for next:{} in dev:{}. Abort.", assignedVlan, |
| Integer.toHexString(l3mcastGroupId), nextObj.id(), deviceId); |
| Ofdpa2Pipeline.fail(nextObj, ObjectiveError.BADPARAMS); |
| } |
| GroupDescription l3mcastGroupDescription = |
| new DefaultGroupDescription( |
| deviceId, |
| ALL, |
| new GroupBuckets(newBuckets), |
| l3mcastGroupKey, |
| l3mcastGroupId, |
| nextObj.appId()); |
| GroupChainElem l3mcastGce = new GroupChainElem(l3mcastGroupDescription, |
| groupInfos.size(), true); |
| groupInfos.forEach(groupInfo -> { |
| // update original NextGroup with new bucket-chain |
| Deque<GroupKey> newBucketChain = new ArrayDeque<>(); |
| newBucketChain.addFirst(groupInfo.innerMostGroupDesc.appCookie()); |
| // Add L3 interface group to the chain if there is one. |
| if (!groupInfo.nextGroupDesc.equals(groupInfo.innerMostGroupDesc)) { |
| newBucketChain.addFirst(groupInfo.nextGroupDesc.appCookie()); |
| } |
| newBucketChain.addFirst(l3mcastGroupKey); |
| // If active keys shows only the top-level group without a chain of groups, |
| // then it represents an empty group. Update by replacing empty chain. |
| if (allActiveKeys.size() == 1 && allActiveKeys.get(0).size() == 1) { |
| allActiveKeys.clear(); |
| } |
| allActiveKeys.add(newBucketChain); |
| |
| updatePendingGroups(groupInfo.nextGroupDesc.appCookie(), l3mcastGce); |
| // Point next group to inner-most group, if any |
| if (!groupInfo.nextGroupDesc.equals(groupInfo.innerMostGroupDesc)) { |
| GroupChainElem innerGce = new GroupChainElem(groupInfo.nextGroupDesc, |
| 1, false); |
| updatePendingGroups(groupInfo.innerMostGroupDesc.appCookie(), innerGce); |
| } |
| log.debug("Adding to L3MCAST: device:{} gid:{} gkey:{} nextId:{}", |
| deviceId, Integer.toHexString(l3mcastGroupId), |
| l3mcastGroupKey, nextObj.id()); |
| // send the innermost group |
| log.debug("Sending innermost group {} in group chain on device {} ", |
| Integer.toHexString(groupInfo.innerMostGroupDesc.givenGroupId()), |
| deviceId); |
| groupService.addGroup(groupInfo.innerMostGroupDesc); |
| |
| }); |
| |
| updatePendingNextObjective(l3mcastGroupKey, |
| new OfdpaNextGroup(allActiveKeys, nextObj)); |
| } |
| |
| /** |
| * Removes the bucket in the top level group of a possible group-chain. Does |
| * not remove the groups in the group-chain pointed to by this bucket, as they |
| * may be in use (referenced by other groups) elsewhere. |
| * |
| * @param nextObjective the bucket information for a next group |
| * @param next the representation of the existing group-chain for this next objective |
| */ |
| protected void removeBucketFromGroup(NextObjective nextObjective, NextGroup next) { |
| if (nextObjective.type() != NextObjective.Type.HASHED && |
| nextObjective.type() != NextObjective.Type.BROADCAST) { |
| log.warn("RemoveBuckets not applied to nextType:{} in dev:{} for next:{}", |
| nextObjective.type(), deviceId, nextObjective.id()); |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.UNSUPPORTED); |
| return; |
| } |
| Set<PortNumber> portsToRemove = Sets.newHashSet(); |
| Collection<TrafficTreatment> treatments = nextObjective.next(); |
| for (TrafficTreatment treatment : treatments) { |
| // find the bucket to remove by noting the outport, and figuring out the |
| // top-level group in the group-chain that indirectly references the port |
| PortNumber portToRemove = readOutPortFromTreatment(treatment); |
| if (portToRemove == null) { |
| log.warn("treatment {} of next objective {} has no outport.. cannot remove bucket" |
| + "from group in dev: {}", treatment, nextObjective.id(), deviceId); |
| } else { |
| portsToRemove.add(portToRemove); |
| } |
| } |
| |
| if (portsToRemove.isEmpty()) { |
| log.warn("next objective {} has no outport.. cannot remove bucket" |
| + "from group in dev: {}", nextObjective.id(), deviceId); |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.BADPARAMS); |
| } |
| |
| List<Deque<GroupKey>> allActiveKeys = Ofdpa2Pipeline.appKryo.deserialize(next.data()); |
| List<Deque<GroupKey>> chainsToRemove = Lists.newArrayList(); |
| for (Deque<GroupKey> gkeys : allActiveKeys) { |
| // last group in group chain should have a single bucket pointing to port |
| |
| GroupKey groupWithPort = gkeys.peekLast(); |
| Group group = groupService.getGroup(deviceId, groupWithPort); |
| if (group == null) { |
| log.warn("Inconsistent group chain found when removing bucket" |
| + "for next:{} in dev:{}", nextObjective.id(), deviceId); |
| continue; |
| } |
| if (group.buckets().buckets().isEmpty()) { |
| log.warn("Can't get output port information from group {} " + |
| "because there is no bucket in the group.", |
| group.id().toString()); |
| continue; |
| } |
| PortNumber pout = readOutPortFromTreatment( |
| group.buckets().buckets().get(0).treatment()); |
| if (portsToRemove.contains(pout)) { |
| chainsToRemove.add(gkeys); |
| } |
| } |
| if (chainsToRemove.isEmpty()) { |
| log.warn("Could not find appropriate group-chain for removing bucket" |
| + " for next id {} in dev:{}", nextObjective.id(), deviceId); |
| Ofdpa2Pipeline.fail(nextObjective, ObjectiveError.BADPARAMS); |
| return; |
| } |
| List<GroupBucket> bucketsToRemove = Lists.newArrayList(); |
| //first group key is the one we want to modify |
| GroupKey modGroupKey = chainsToRemove.get(0).peekFirst(); |
| Group modGroup = groupService.getGroup(deviceId, modGroupKey); |
| for (Deque<GroupKey> foundChain : chainsToRemove) { |
| //second group key is the one we wish to remove the reference to |
| if (foundChain.size() < 2) { |
| // additional check to make sure second group key exist in |
| // the chain. |
| log.warn("Can't find second group key from chain {}", |
| foundChain); |
| continue; |
| } |
| GroupKey pointedGroupKey = foundChain.stream().collect(Collectors.toList()).get(1); |
| Group pointedGroup = groupService.getGroup(deviceId, pointedGroupKey); |
| |
| if (pointedGroup == null) { |
| continue; |
| } |
| |
| GroupBucket bucket; |
| if (nextObjective.type() == NextObjective.Type.HASHED) { |
| bucket = DefaultGroupBucket.createSelectGroupBucket( |
| DefaultTrafficTreatment.builder() |
| .group(pointedGroup.id()) |
| .build()); |
| } else { |
| bucket = DefaultGroupBucket.createAllGroupBucket( |
| DefaultTrafficTreatment.builder() |
| .group(pointedGroup.id()) |
| .build()); |
| } |
| |
| bucketsToRemove.add(bucket); |
| } |
| |
| GroupBuckets removeBuckets = new GroupBuckets(bucketsToRemove); |
| List<String> pointedGroupIds; // for debug log |
| pointedGroupIds = bucketsToRemove.stream() |
| .map(GroupBucket::treatment) |
| .map(TrafficTreatment::allInstructions) |
| .flatMap(List::stream) |
| .filter(inst -> inst instanceof Instructions.GroupInstruction) |
| .map(inst -> (Instructions.GroupInstruction) inst) |
| .map(Instructions.GroupInstruction::groupId) |
| .map(GroupId::id) |
| .map(Integer::toHexString) |
| .map(id -> HEX_PREFIX + id) |
| .collect(Collectors.toList()); |
| |
| log.debug("Removing buckets from group id 0x{} pointing to group id(s) {} " |
| + "for next id {} in device {}", Integer.toHexString(modGroup.id().id()), |
| pointedGroupIds, nextObjective.id(), deviceId); |
| addPendingUpdateNextObjective(modGroupKey, nextObjective); |
| groupService.removeBucketsFromGroup(deviceId, modGroupKey, |
| removeBuckets, modGroupKey, |
| nextObjective.appId()); |
| // update store |
| allActiveKeys.removeAll(chainsToRemove); |
| // If no buckets in the group, then retain an entry for the |
| // top level group which still exists. |
| if (allActiveKeys.isEmpty()) { |
| ArrayDeque<GroupKey> top = new ArrayDeque<>(); |
| top.add(modGroupKey); |
| allActiveKeys.add(top); |
| } |
| flowObjectiveStore.putNextGroup(nextObjective.id(), |
| new OfdpaNextGroup(allActiveKeys, |
| nextObjective)); |
| } |
| |
| /** |
| * Removes all groups in multiple possible group-chains that represent the next-obj. |
| * |
| * @param nextObjective the next objective to remove |
| * @param next the NextGroup that represents the existing group-chain for |
| * this next objective |
| */ |
| protected void removeGroup(NextObjective nextObjective, NextGroup next) { |
| List<Deque<GroupKey>> allActiveKeys = Ofdpa2Pipeline.appKryo.deserialize(next.data()); |
| |
| List<GroupKey> groupKeys = allActiveKeys.stream() |
| .map(Deque::getFirst).collect(Collectors.toList()); |
| pendingRemoveNextObjectives.put(nextObjective, groupKeys); |
| |
| allActiveKeys.forEach(groupChain -> groupChain.forEach(groupKey -> |
| groupService.removeGroup(deviceId, groupKey, nextObjective.appId()))); |
| flowObjectiveStore.removeNextGroup(nextObjective.id()); |
| } |
| |
| ////////////////////////////////////// |
| // Helper Methods and Classes |
| ////////////////////////////////////// |
| |
| protected void updatePendingNextObjective(GroupKey gkey, OfdpaNextGroup value) { |
| pendingAddNextObjectives.asMap().compute(gkey, (k, val) -> { |
| if (val == null) { |
| val = new CopyOnWriteArrayList<OfdpaNextGroup>(); |
| } |
| val.add(value); |
| return val; |
| }); |
| } |
| |
| protected void updatePendingGroups(GroupKey gkey, GroupChainElem gce) { |
| pendingGroups.asMap().compute(gkey, (k, val) -> { |
| if (val == null) { |
| val = Sets.newConcurrentHashSet(); |
| } |
| val.add(gce); |
| return val; |
| }); |
| } |
| |
| private void addPendingUpdateNextObjective(GroupKey groupKey, NextObjective nextObjective) { |
| pendingUpdateNextObjectives.compute(groupKey, (gKey, nextObjs) -> { |
| if (nextObjs != null) { |
| nextObjs.add(nextObjective); |
| } else { |
| nextObjs = Sets.newHashSet(nextObjective); |
| } |
| return nextObjs; |
| }); |
| } |
| |
| /** |
| * Processes next element of a group chain. Assumption is that if this |
| * group points to another group, the latter has already been created |
| * and this driver has received notification for it. A second assumption is |
| * that if there is another group waiting for this group then the appropriate |
| * stores already have the information to act upon the notification for the |
| * creation of this group. |
| * <p> |
| * The processing of the GroupChainElement depends on the number of groups |
| * this element is waiting on. For all group types other than SIMPLE, a |
| * GroupChainElement could be waiting on multiple groups. |
| * |
| * @param gce the group chain element to be processed next |
| */ |
| private void processGroupChain(GroupChainElem gce) { |
| int waitOnGroups = gce.decrementAndGetGroupsWaitedOn(); |
| if (waitOnGroups != 0) { |
| log.debug("GCE: {} not ready to be processed", gce); |
| return; |
| } |
| log.debug("GCE: {} ready to be processed", gce); |
| if (gce.addBucketToGroup) { |
| groupService.addBucketsToGroup(gce.groupDescription.deviceId(), |
| gce.groupDescription.appCookie(), |
| gce.groupDescription.buckets(), |
| gce.groupDescription.appCookie(), |
| gce.groupDescription.appId()); |
| } else { |
| groupService.addGroup(gce.groupDescription); |
| } |
| } |
| |
| private class GroupChecker implements Runnable { |
| @Override |
| public void run() { |
| if (pendingGroups.size() != 0) { |
| log.debug("pending groups being checked: {}", pendingGroups.asMap().keySet()); |
| } |
| if (pendingAddNextObjectives.size() != 0) { |
| log.debug("pending add-next-obj being checked: {}", |
| pendingAddNextObjectives.asMap().keySet()); |
| } |
| Set<GroupKey> keys = pendingGroups.asMap().keySet().stream() |
| .filter(key -> groupService.getGroup(deviceId, key) != null) |
| .collect(Collectors.toSet()); |
| Set<GroupKey> otherkeys = pendingAddNextObjectives.asMap().keySet().stream() |
| .filter(otherkey -> groupService.getGroup(deviceId, otherkey) != null) |
| .collect(Collectors.toSet()); |
| keys.addAll(otherkeys); |
| |
| keys.forEach(key -> |
| processPendingAddGroupsOrNextObjs(key, false)); |
| } |
| } |
| |
| private class InnerGroupListener implements GroupListener { |
| @Override |
| public void event(GroupEvent event) { |
| log.trace("received group event of type {}", event.type()); |
| switch (event.type()) { |
| case GROUP_ADDED: |
| processPendingAddGroupsOrNextObjs(event.subject().appCookie(), true); |
| break; |
| case GROUP_REMOVED: |
| processPendingRemoveNextObjs(event.subject().appCookie()); |
| break; |
| case GROUP_UPDATED: |
| processPendingUpdateNextObjs(event.subject().appCookie()); |
| break; |
| default: |
| break; |
| } |
| } |
| } |
| |
| private void processPendingUpdateNextObjs(GroupKey groupKey) { |
| pendingUpdateNextObjectives.compute(groupKey, (gKey, nextObjs) -> { |
| if (nextObjs != null) { |
| |
| nextObjs.forEach(nextObj -> { |
| log.debug("Group {} updated, update pending next objective {}.", |
| groupKey, nextObj); |
| |
| Ofdpa2Pipeline.pass(nextObj); |
| }); |
| } |
| return Sets.newHashSet(); |
| }); |
| } |
| |
| private void processPendingAddGroupsOrNextObjs(GroupKey key, boolean added) { |
| //first check for group chain |
| Set<GroupChainElem> gceSet = pendingGroups.asMap().remove(key); |
| if (gceSet != null) { |
| for (GroupChainElem gce : gceSet) { |
| log.debug("Group service {} group key {} in device {}. " |
| + "Processing next group in group chain with group id 0x{}", |
| (added) ? "ADDED" : "processed", |
| key, deviceId, |
| Integer.toHexString(gce.groupDescription.givenGroupId())); |
| processGroupChain(gce); |
| } |
| } else { |
| // otherwise chain complete - check for waiting nextObjectives |
| List<OfdpaNextGroup> nextGrpList = pendingAddNextObjectives.getIfPresent(key); |
| if (nextGrpList != null) { |
| pendingAddNextObjectives.invalidate(key); |
| nextGrpList.forEach(nextGrp -> { |
| log.debug("Group service {} group key {} in device:{}. " |
| + "Done implementing next objective: {} <<-->> gid:0x{}", |
| (added) ? "ADDED" : "processed", |
| key, deviceId, nextGrp.nextObjective().id(), |
| Integer.toHexString(groupService.getGroup(deviceId, key) |
| .givenGroupId())); |
| Ofdpa2Pipeline.pass(nextGrp.nextObjective()); |
| flowObjectiveStore.putNextGroup(nextGrp.nextObjective().id(), nextGrp); |
| |
| // check if addBuckets waiting for this completion |
| pendingBuckets.compute(nextGrp.nextObjective().id(), (nextId, pendBkts) -> { |
| if (pendBkts != null) { |
| pendBkts.forEach(pendBkt -> addBucketToGroup(pendBkt, nextGrp)); |
| } |
| return null; |
| }); |
| }); |
| } |
| } |
| } |
| |
| private void processPendingRemoveNextObjs(GroupKey key) { |
| pendingRemoveNextObjectives.asMap().forEach((nextObjective, groupKeys) -> { |
| if (groupKeys.isEmpty()) { |
| pendingRemoveNextObjectives.invalidate(nextObjective); |
| Ofdpa2Pipeline.pass(nextObjective); |
| } else { |
| groupKeys.remove(key); |
| } |
| }); |
| } |
| |
| protected int getNextAvailableIndex() { |
| return (int) nextIndex.incrementAndGet(); |
| } |
| |
| /** |
| * Returns the outport in a traffic treatment. |
| * |
| * @param tt the treatment |
| * @return the PortNumber for the outport or null |
| */ |
| protected static PortNumber readOutPortFromTreatment(TrafficTreatment tt) { |
| for (Instruction ins : tt.allInstructions()) { |
| if (ins.type() == Instruction.Type.OUTPUT) { |
| return ((Instructions.OutputInstruction) ins).port(); |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * Returns a hash as the L2 Interface Group Key. |
| * |
| * Keep the lower 6-bit for port since port number usually smaller than 64. |
| * Hash other information into remaining 28 bits. |
| * |
| * @param deviceId Device ID |
| * @param vlanId VLAN ID |
| * @param portNumber Port number |
| * @return L2 interface group key |
| */ |
| protected int l2InterfaceGroupKey(DeviceId deviceId, VlanId vlanId, long portNumber) { |
| int portLowerBits = (int) portNumber & PORT_LOWER_BITS_MASK; |
| long portHigherBits = portNumber & PORT_HIGHER_BITS_MASK; |
| int hash = Objects.hash(deviceId, vlanId, portHigherBits); |
| return L2_INTERFACE_TYPE | (TYPE_MASK & hash << 6) | portLowerBits; |
| } |
| |
| private Group retrieveTopLevelGroup(List<Deque<GroupKey>> allActiveKeys, |
| int nextid) { |
| GroupKey topLevelGroupKey; |
| if (!allActiveKeys.isEmpty()) { |
| topLevelGroupKey = allActiveKeys.get(0).peekFirst(); |
| } else { |
| log.warn("Could not determine top level group while processing" |
| + "next:{} in dev:{}", nextid, deviceId); |
| return null; |
| } |
| Group topGroup = groupService.getGroup(deviceId, topLevelGroupKey); |
| if (topGroup == null) { |
| log.warn("Could not find top level group while processing " |
| + "next:{} in dev:{}", nextid, deviceId); |
| } |
| return topGroup; |
| } |
| |
| /** |
| * Utility class for moving group information around. |
| * |
| * Example: Suppose we are trying to create a group-chain A-B-C-D, where |
| * A is the top level group, and D is the inner-most group, typically L2 Interface. |
| * The innerMostGroupDesc is always D. At various stages of the creation |
| * process the nextGroupDesc may be C or B. The nextGroupDesc exists to |
| * inform the referencing group about which group it needs to point to, |
| * and wait for. In some cases the group chain may simply be A-B. In this case, |
| * both innerMostGroupDesc and nextGroupDesc will be B. |
| */ |
| protected class GroupInfo { |
| /** |
| * Description of the inner-most group of the group chain. |
| * It is always an L2 interface group. |
| */ |
| private GroupDescription innerMostGroupDesc; |
| |
| /** |
| * Description of the next group in the group chain. |
| * It can be L2 interface, L3 interface, L3 unicast, L3 VPN group. |
| * It is possible that nextGroupDesc is the same as the innerMostGroup. |
| */ |
| private GroupDescription nextGroupDesc; |
| |
| GroupInfo(GroupDescription innerMostGroupDesc, GroupDescription nextGroupDesc) { |
| this.innerMostGroupDesc = innerMostGroupDesc; |
| this.nextGroupDesc = nextGroupDesc; |
| } |
| |
| /** |
| * Getter for innerMostGroupDesc. |
| * |
| * @return the inner most group description |
| */ |
| public GroupDescription getInnerMostGroupDesc() { |
| return innerMostGroupDesc; |
| } |
| |
| /** |
| * Getter for the next group description. |
| * |
| * @return the next group description |
| */ |
| public GroupDescription getNextGroupDesc() { |
| return nextGroupDesc; |
| } |
| } |
| |
| /** |
| * Represents an entire group-chain that implements a Next-Objective from |
| * the application. The objective is represented as a list of deques, where |
| * each deque is a separate chain of groups. |
| * <p> |
| * For example, an ECMP group with 3 buckets, where each bucket points to |
| * a group chain of L3 Unicast and L2 interface groups will look like this: |
| * <ul> |
| * <li>List[0] is a Deque of GroupKeyECMP(first)-GroupKeyL3(middle)-GroupKeyL2(last) |
| * <li>List[1] is a Deque of GroupKeyECMP(first)-GroupKeyL3(middle)-GroupKeyL2(last) |
| * <li>List[2] is a Deque of GroupKeyECMP(first)-GroupKeyL3(middle)-GroupKeyL2(last) |
| * </ul> |
| * where the first element of each deque is the same, representing the |
| * top level ECMP group, while every other element represents a unique groupKey. |
| * <p> |
| * Also includes information about the next objective that |
| * resulted in these group-chains. |
| * |
| */ |
| protected class OfdpaNextGroup implements NextGroup { |
| private final NextObjective nextObj; |
| private final List<Deque<GroupKey>> gkeys; |
| |
| public OfdpaNextGroup(List<Deque<GroupKey>> gkeys, NextObjective nextObj) { |
| this.nextObj = nextObj; |
| this.gkeys = gkeys; |
| } |
| |
| public NextObjective nextObjective() { |
| return nextObj; |
| } |
| |
| public List<Deque<GroupKey>> groupKeys() { |
| return gkeys; |
| } |
| |
| @Override |
| public byte[] data() { |
| return Ofdpa2Pipeline.appKryo.serialize(gkeys); |
| } |
| } |
| |
| /** |
| * Represents a group element that is part of a chain of groups. |
| * Stores enough information to create a Group Description to add the group |
| * to the switch by requesting the Group Service. Objects instantiating this |
| * class are meant to be temporary and live as long as it is needed to wait for |
| * referenced groups in the group chain to be created. |
| */ |
| protected class GroupChainElem { |
| private GroupDescription groupDescription; |
| private AtomicInteger waitOnGroups; |
| private boolean addBucketToGroup; |
| |
| GroupChainElem(GroupDescription groupDescription, int waitOnGroups, |
| boolean addBucketToGroup) { |
| this.groupDescription = groupDescription; |
| this.waitOnGroups = new AtomicInteger(waitOnGroups); |
| this.addBucketToGroup = addBucketToGroup; |
| } |
| |
| /** |
| * This method atomically decrements the counter for the number of |
| * groups this GroupChainElement is waiting on, for notifications from |
| * the Group Service. When this method returns a value of 0, this |
| * GroupChainElement is ready to be processed. |
| * |
| * @return integer indication of the number of notifications being waited on |
| */ |
| int decrementAndGetGroupsWaitedOn() { |
| return waitOnGroups.decrementAndGet(); |
| } |
| |
| @Override |
| public String toString() { |
| return (Integer.toHexString(groupDescription.givenGroupId()) + |
| " groupKey: " + groupDescription.appCookie() + |
| " waiting-on-groups: " + waitOnGroups.get() + |
| " addBucketToGroup: " + addBucketToGroup + |
| " device: " + deviceId); |
| } |
| } |
| |
| /** |
| * Helper enum to handle the different MPLS group |
| * types. |
| */ |
| protected enum OfdpaMplsGroupSubType { |
| MPLS_INTF((short) 0), |
| L2_VPN((short) 1), |
| L3_VPN((short) 2), |
| MPLS_TUNNEL_LABEL_1((short) 3), |
| MPLS_TUNNEL_LABEL_2((short) 4), |
| MPLS_SWAP_LABEL((short) 5), |
| MPLS_ECMP((short) 8); |
| |
| private short value; |
| public static final int OFDPA_GROUP_TYPE_SHIFT = 28; |
| public static final int OFDPA_MPLS_SUBTYPE_SHIFT = 24; |
| |
| OfdpaMplsGroupSubType(short value) { |
| this.value = value; |
| } |
| |
| /** |
| * Gets the value as an short. |
| * |
| * @return the value as an short |
| */ |
| public short getValue() { |
| return this.value; |
| } |
| |
| } |
| |
| /** |
| * Creates MPLS Label group id given a sub type and |
| * the index. |
| * |
| * @param subType the MPLS Label group sub type |
| * @param index the index of the group |
| * @return the OFDPA group id |
| */ |
| public Integer makeMplsLabelGroupId(OfdpaMplsGroupSubType subType, int index) { |
| index = index & 0x00FFFFFF; |
| return index | (9 << OFDPA_GROUP_TYPE_SHIFT) | (subType.value << OFDPA_MPLS_SUBTYPE_SHIFT); |
| } |
| |
| /** |
| * Creates MPLS Forwarding group id given a sub type and |
| * the index. |
| * |
| * @param subType the MPLS forwarding group sub type |
| * @param index the index of the group |
| * @return the OFDPA group id |
| */ |
| public Integer makeMplsForwardingGroupId(OfdpaMplsGroupSubType subType, int index) { |
| index = index & 0x00FFFFFF; |
| return index | (10 << OFDPA_GROUP_TYPE_SHIFT) | (subType.value << OFDPA_MPLS_SUBTYPE_SHIFT); |
| } |
| } |