|
| 1 | +// Copyright 2020-present Open Networking Foundation |
| 2 | +// SPDX-License-Identifier: LicenseRef-ONF-Member-Only-1.0 |
| 3 | +package org.stratumproject.fabric.tna.behaviour.upf; |
| 4 | + |
| 5 | +import com.google.common.collect.BiMap; |
| 6 | +import com.google.common.collect.ImmutableBiMap; |
| 7 | +import com.google.common.collect.Maps; |
| 8 | +import org.onosproject.net.behaviour.upf.PacketDetectionRule; |
| 9 | +import org.onlab.packet.Ip4Address; |
| 10 | +import org.onlab.util.ImmutableByteSequence; |
| 11 | +import org.onlab.util.KryoNamespace; |
| 12 | +import org.onosproject.store.serializers.KryoNamespaces; |
| 13 | +import org.onosproject.store.service.ConsistentMap; |
| 14 | +import org.onosproject.store.service.DistributedSet; |
| 15 | +import org.onosproject.store.service.MapEvent; |
| 16 | +import org.onosproject.store.service.MapEventListener; |
| 17 | +import org.onosproject.store.service.Serializer; |
| 18 | +import org.onosproject.store.service.StorageService; |
| 19 | +import org.osgi.service.component.annotations.Activate; |
| 20 | +import org.osgi.service.component.annotations.Component; |
| 21 | +import org.osgi.service.component.annotations.Deactivate; |
| 22 | +import org.osgi.service.component.annotations.Reference; |
| 23 | +import org.osgi.service.component.annotations.ReferenceCardinality; |
| 24 | +import org.slf4j.Logger; |
| 25 | +import org.slf4j.LoggerFactory; |
| 26 | + |
| 27 | +import java.util.HashSet; |
| 28 | +import java.util.Map; |
| 29 | +import java.util.Objects; |
| 30 | +import java.util.Set; |
| 31 | + |
| 32 | +import static com.google.common.base.Preconditions.checkNotNull; |
| 33 | + |
| 34 | +/** |
| 35 | + * Distributed implementation of FabricUpfStore. |
| 36 | + */ |
| 37 | +// FIXME: this store is generic and not tied to a single device, should we have a store based on deviceId? |
| 38 | +@Component(immediate = true, service = DistributedFabricUpfStore.class) |
| 39 | +public final class DistributedFabricUpfStore implements FabricUpfStore { |
| 40 | + |
| 41 | + private final Logger log = LoggerFactory.getLogger(getClass()); |
| 42 | + |
| 43 | + @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| 44 | + protected StorageService storageService; |
| 45 | + |
| 46 | + protected static final String FAR_ID_MAP_NAME = "fabric-upf-far-id-tna"; |
| 47 | + protected static final String BUFFER_FAR_ID_SET_NAME = "fabric-upf-buffer-far-id-tna"; |
| 48 | + protected static final String FAR_ID_UE_MAP_NAME = "fabric-upf-far-id-ue-tna"; |
| 49 | + protected static final KryoNamespace.Builder SERIALIZER = KryoNamespace.newBuilder() |
| 50 | + .register(KryoNamespaces.API) |
| 51 | + .register(UpfRuleIdentifier.class); |
| 52 | + |
| 53 | + // Mapping between scheduling priority ranges with Tofino priority queues |
| 54 | + // i.e., default queues are 8 in Tofino |
| 55 | + private static final BiMap<Integer, Integer> SCHEDULING_PRIORITY_MAP |
| 56 | + = new ImmutableBiMap.Builder<Integer, Integer>() |
| 57 | + // Highest scheduling priority for 3GPP is 1 and highest Tofino queue priority is 7 |
| 58 | + .put(1, 5) |
| 59 | + .put(6, 4) |
| 60 | + .put(7, 3) |
| 61 | + .put(8, 2) |
| 62 | + .put(9, 1) |
| 63 | + .build(); |
| 64 | + |
| 65 | + // Distributed local FAR ID to global FAR ID mapping |
| 66 | + protected ConsistentMap<UpfRuleIdentifier, Integer> farIdMap; |
| 67 | + private MapEventListener<UpfRuleIdentifier, Integer> farIdMapListener; |
| 68 | + // Local, reversed copy of farIdMapper for better reverse lookup performance |
| 69 | + protected Map<Integer, UpfRuleIdentifier> reverseFarIdMap; |
| 70 | + private int nextGlobalFarId = 1; |
| 71 | + |
| 72 | + protected DistributedSet<UpfRuleIdentifier> bufferFarIds; |
| 73 | + protected ConsistentMap<UpfRuleIdentifier, Set<Ip4Address>> farIdToUeAddrs; |
| 74 | + |
| 75 | + @Activate |
| 76 | + protected void activate() { |
| 77 | + // Allow unit test to inject farIdMap here. |
| 78 | + if (storageService != null) { |
| 79 | + this.farIdMap = storageService.<UpfRuleIdentifier, Integer>consistentMapBuilder() |
| 80 | + .withName(FAR_ID_MAP_NAME) |
| 81 | + .withRelaxedReadConsistency() |
| 82 | + .withSerializer(Serializer.using(SERIALIZER.build())) |
| 83 | + .build(); |
| 84 | + this.bufferFarIds = storageService.<UpfRuleIdentifier>setBuilder() |
| 85 | + .withName(BUFFER_FAR_ID_SET_NAME) |
| 86 | + .withRelaxedReadConsistency() |
| 87 | + .withSerializer(Serializer.using(SERIALIZER.build())) |
| 88 | + .build().asDistributedSet(); |
| 89 | + this.farIdToUeAddrs = storageService.<UpfRuleIdentifier, Set<Ip4Address>>consistentMapBuilder() |
| 90 | + .withName(FAR_ID_UE_MAP_NAME) |
| 91 | + .withRelaxedReadConsistency() |
| 92 | + .withSerializer(Serializer.using(SERIALIZER.build())) |
| 93 | + .build(); |
| 94 | + |
| 95 | + } |
| 96 | + farIdMapListener = new FarIdMapListener(); |
| 97 | + farIdMap.addListener(farIdMapListener); |
| 98 | + |
| 99 | + reverseFarIdMap = Maps.newHashMap(); |
| 100 | + farIdMap.entrySet().forEach(entry -> reverseFarIdMap.put(entry.getValue().value(), entry.getKey())); |
| 101 | + |
| 102 | + log.info("Started"); |
| 103 | + } |
| 104 | + |
| 105 | + @Deactivate |
| 106 | + protected void deactivate() { |
| 107 | + farIdMap.removeListener(farIdMapListener); |
| 108 | + farIdMap.destroy(); |
| 109 | + reverseFarIdMap.clear(); |
| 110 | + |
| 111 | + log.info("Stopped"); |
| 112 | + } |
| 113 | + |
| 114 | + @Override |
| 115 | + public void reset() { |
| 116 | + farIdMap.clear(); |
| 117 | + reverseFarIdMap.clear(); |
| 118 | + bufferFarIds.clear(); |
| 119 | + farIdToUeAddrs.clear(); |
| 120 | + nextGlobalFarId = 0; |
| 121 | + } |
| 122 | + |
| 123 | + @Override |
| 124 | + public Map<UpfRuleIdentifier, Integer> getFarIdMap() { |
| 125 | + return Map.copyOf(farIdMap.asJavaMap()); |
| 126 | + } |
| 127 | + |
| 128 | + @Override |
| 129 | + public int globalFarIdOf(UpfRuleIdentifier farIdPair) { |
| 130 | + int globalFarId = farIdMap.compute(farIdPair, |
| 131 | + (k, existingId) -> { |
| 132 | + return Objects.requireNonNullElseGet(existingId, () -> nextGlobalFarId++); |
| 133 | + }).value(); |
| 134 | + log.info("{} translated to GlobalFarId={}", farIdPair, globalFarId); |
| 135 | + return globalFarId; |
| 136 | + } |
| 137 | + |
| 138 | + @Override |
| 139 | + public int globalFarIdOf(ImmutableByteSequence pfcpSessionId, int sessionLocalFarId) { |
| 140 | + UpfRuleIdentifier farId = new UpfRuleIdentifier(pfcpSessionId, sessionLocalFarId); |
| 141 | + return globalFarIdOf(farId); |
| 142 | + |
| 143 | + } |
| 144 | + |
| 145 | + @Override |
| 146 | + public String queueIdOf(int schedulingPriority) { |
| 147 | + return (SCHEDULING_PRIORITY_MAP.get(schedulingPriority)).toString(); |
| 148 | + } |
| 149 | + |
| 150 | + @Override |
| 151 | + public String schedulingPriorityOf(int queueId) { |
| 152 | + return (SCHEDULING_PRIORITY_MAP.inverse().get(queueId)).toString(); |
| 153 | + } |
| 154 | + |
| 155 | + @Override |
| 156 | + public UpfRuleIdentifier localFarIdOf(int globalFarId) { |
| 157 | + return reverseFarIdMap.get(globalFarId); |
| 158 | + } |
| 159 | + |
| 160 | + public void learnFarIdToUeAddrs(PacketDetectionRule pdr) { |
| 161 | + UpfRuleIdentifier ruleId = UpfRuleIdentifier.of(pdr.sessionId(), pdr.farId()); |
| 162 | + farIdToUeAddrs.compute(ruleId, (k, set) -> { |
| 163 | + if (set == null) { |
| 164 | + set = new HashSet<>(); |
| 165 | + } |
| 166 | + set.add(pdr.ueAddress()); |
| 167 | + return set; |
| 168 | + }); |
| 169 | + } |
| 170 | + |
| 171 | + @Override |
| 172 | + public boolean isFarIdBuffering(UpfRuleIdentifier farId) { |
| 173 | + checkNotNull(farId); |
| 174 | + return bufferFarIds.contains(farId); |
| 175 | + } |
| 176 | + |
| 177 | + @Override |
| 178 | + public void learBufferingFarId(UpfRuleIdentifier farId) { |
| 179 | + checkNotNull(farId); |
| 180 | + bufferFarIds.add(farId); |
| 181 | + } |
| 182 | + |
| 183 | + @Override |
| 184 | + public void forgetBufferingFarId(UpfRuleIdentifier farId) { |
| 185 | + checkNotNull(farId); |
| 186 | + bufferFarIds.remove(farId); |
| 187 | + } |
| 188 | + |
| 189 | + @Override |
| 190 | + public void forgetUeAddr(Ip4Address ueAddr) { |
| 191 | + farIdToUeAddrs.keySet().forEach( |
| 192 | + farId -> farIdToUeAddrs.computeIfPresent(farId, (farIdz, ueAddrs) -> { |
| 193 | + ueAddrs.remove(ueAddr); |
| 194 | + return ueAddrs; |
| 195 | + })); |
| 196 | + } |
| 197 | + |
| 198 | + @Override |
| 199 | + public Set<Ip4Address> ueAddrsOfFarId(UpfRuleIdentifier farId) { |
| 200 | + return farIdToUeAddrs.getOrDefault(farId, Set.of()).value(); |
| 201 | + } |
| 202 | + |
| 203 | + @Override |
| 204 | + public Set<UpfRuleIdentifier> getBufferFarIds() { |
| 205 | + return Set.copyOf(bufferFarIds); |
| 206 | + } |
| 207 | + |
| 208 | + @Override |
| 209 | + public Map<UpfRuleIdentifier, Set<Ip4Address>> getFarIdToUeAddrs() { |
| 210 | + return Map.copyOf(farIdToUeAddrs.asJavaMap()); |
| 211 | + } |
| 212 | + |
| 213 | + // NOTE: FarIdMapListener is run on the same thread intentionally in order to ensure that |
| 214 | + // reverseFarIdMap update always finishes right after farIdMap is updated |
| 215 | + private class FarIdMapListener implements MapEventListener<UpfRuleIdentifier, Integer> { |
| 216 | + @Override |
| 217 | + public void event(MapEvent<UpfRuleIdentifier, Integer> event) { |
| 218 | + switch (event.type()) { |
| 219 | + case INSERT: |
| 220 | + reverseFarIdMap.put(event.newValue().value(), event.key()); |
| 221 | + break; |
| 222 | + case UPDATE: |
| 223 | + reverseFarIdMap.remove(event.oldValue().value()); |
| 224 | + reverseFarIdMap.put(event.newValue().value(), event.key()); |
| 225 | + break; |
| 226 | + case REMOVE: |
| 227 | + reverseFarIdMap.remove(event.oldValue().value()); |
| 228 | + break; |
| 229 | + default: |
| 230 | + break; |
| 231 | + } |
| 232 | + } |
| 233 | + } |
| 234 | +} |
0 commit comments