Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store.packet.impl; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 20 | import com.google.common.collect.Sets; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Activate; |
| 22 | import org.apache.felix.scr.annotations.Component; |
| 23 | import org.apache.felix.scr.annotations.Deactivate; |
| 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 26 | import org.apache.felix.scr.annotations.Service; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 27 | import org.onlab.util.KryoNamespace; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 28 | import org.onosproject.cluster.ClusterService; |
| 29 | import org.onosproject.cluster.NodeId; |
| 30 | import org.onosproject.mastership.MastershipService; |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 31 | import org.onosproject.net.flow.TrafficSelector; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 32 | import org.onosproject.net.packet.OutboundPacket; |
| 33 | import org.onosproject.net.packet.PacketEvent; |
| 34 | import org.onosproject.net.packet.PacketEvent.Type; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 35 | import org.onosproject.net.packet.PacketRequest; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 36 | import org.onosproject.net.packet.PacketStore; |
| 37 | import org.onosproject.net.packet.PacketStoreDelegate; |
| 38 | import org.onosproject.store.AbstractStore; |
| 39 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 40 | import org.onosproject.store.cluster.messaging.MessageSubject; |
| 41 | import org.onosproject.store.serializers.KryoNamespaces; |
| 42 | import org.onosproject.store.serializers.KryoSerializer; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 43 | import org.onosproject.store.service.ConsistentMap; |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 44 | import org.onosproject.store.service.ConsistentMapException; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 45 | import org.onosproject.store.service.Serializer; |
| 46 | import org.onosproject.store.service.StorageService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 47 | import org.slf4j.Logger; |
| 48 | |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 49 | import java.util.List; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 50 | import java.util.Set; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 51 | import java.util.concurrent.ExecutorService; |
| 52 | import java.util.concurrent.Executors; |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 53 | import java.util.concurrent.atomic.AtomicBoolean; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 54 | |
| 55 | import static org.onlab.util.Tools.groupedThreads; |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 56 | import static org.onlab.util.Tools.retryable; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 57 | import static org.slf4j.LoggerFactory.getLogger; |
| 58 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 59 | /** |
| 60 | * Distributed packet store implementation allowing packets to be sent to |
| 61 | * remote instances. |
| 62 | */ |
| 63 | @Component(immediate = true) |
| 64 | @Service |
| 65 | public class DistributedPacketStore |
| 66 | extends AbstractStore<PacketEvent, PacketStoreDelegate> |
| 67 | implements PacketStore { |
| 68 | |
| 69 | private final Logger log = getLogger(getClass()); |
| 70 | |
Madan Jampani | d61f2b1 | 2015-12-10 17:01:52 -0800 | [diff] [blame^] | 71 | private static final int MAX_BACKOFF = 50; |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 72 | |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 73 | // TODO: make this configurable. |
| 74 | private static final int MESSAGE_HANDLER_THREAD_POOL_SIZE = 4; |
| 75 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | ff96523 | 2015-03-17 14:10:52 -0700 | [diff] [blame] | 77 | protected MastershipService mastershipService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 78 | |
| 79 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | ff96523 | 2015-03-17 14:10:52 -0700 | [diff] [blame] | 80 | protected ClusterService clusterService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 81 | |
| 82 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | ff96523 | 2015-03-17 14:10:52 -0700 | [diff] [blame] | 83 | protected ClusterCommunicationService communicationService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 84 | |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 85 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 86 | protected StorageService storageService; |
| 87 | |
| 88 | private PacketRequestTracker tracker; |
| 89 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 90 | private static final MessageSubject PACKET_OUT_SUBJECT = |
| 91 | new MessageSubject("packet-out"); |
| 92 | |
| 93 | private static final KryoSerializer SERIALIZER = new KryoSerializer() { |
| 94 | @Override |
| 95 | protected void setupKryoPool() { |
| 96 | serializerPool = KryoNamespace.newBuilder() |
| 97 | .register(KryoNamespaces.API) |
Yuta HIGUCHI | 91768e3 | 2014-11-22 05:06:35 -0800 | [diff] [blame] | 98 | .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID) |
| 99 | .build(); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 100 | } |
| 101 | }; |
| 102 | |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 103 | private ExecutorService messageHandlingExecutor; |
| 104 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 105 | @Activate |
| 106 | public void activate() { |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 107 | messageHandlingExecutor = Executors.newFixedThreadPool( |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 108 | MESSAGE_HANDLER_THREAD_POOL_SIZE, |
Madan Jampani | 6b5b717 | 2015-02-23 13:02:26 -0800 | [diff] [blame] | 109 | groupedThreads("onos/store/packet", "message-handlers")); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 110 | |
Madan Jampani | 01e05fb | 2015-08-13 13:29:36 -0700 | [diff] [blame] | 111 | communicationService.<OutboundPacket>addSubscriber(PACKET_OUT_SUBJECT, |
| 112 | SERIALIZER::decode, |
| 113 | packet -> notifyDelegate(new PacketEvent(Type.EMIT, packet)), |
| 114 | messageHandlingExecutor); |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 115 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 116 | tracker = new PacketRequestTracker(); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 117 | |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 118 | log.info("Started"); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | @Deactivate |
| 122 | public void deactivate() { |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 123 | communicationService.removeSubscriber(PACKET_OUT_SUBJECT); |
| 124 | messageHandlingExecutor.shutdown(); |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 125 | tracker = null; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 126 | log.info("Stopped"); |
| 127 | } |
| 128 | |
| 129 | @Override |
| 130 | public void emit(OutboundPacket packet) { |
| 131 | NodeId myId = clusterService.getLocalNode().id(); |
| 132 | NodeId master = mastershipService.getMasterFor(packet.sendThrough()); |
| 133 | |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 134 | if (master == null) { |
| 135 | return; |
| 136 | } |
| 137 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 138 | if (myId.equals(master)) { |
| 139 | notifyDelegate(new PacketEvent(Type.EMIT, packet)); |
| 140 | return; |
| 141 | } |
| 142 | |
Madan Jampani | 01e05fb | 2015-08-13 13:29:36 -0700 | [diff] [blame] | 143 | communicationService.unicast(packet, PACKET_OUT_SUBJECT, SERIALIZER::encode, master) |
| 144 | .whenComplete((r, error) -> { |
| 145 | if (error != null) { |
| 146 | log.warn("Failed to send packet-out to {}", master, error); |
| 147 | } |
| 148 | }); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 149 | } |
| 150 | |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 151 | @Override |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 152 | public void requestPackets(PacketRequest request) { |
| 153 | tracker.add(request); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | @Override |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 157 | public void cancelPackets(PacketRequest request) { |
| 158 | tracker.remove(request); |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | @Override |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 162 | public List<PacketRequest> existingRequests() { |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 163 | return tracker.requests(); |
| 164 | } |
| 165 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 166 | private final class PacketRequestTracker { |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 167 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 168 | private ConsistentMap<TrafficSelector, Set<PacketRequest>> requests; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 169 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 170 | private PacketRequestTracker() { |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 171 | requests = storageService.<TrafficSelector, Set<PacketRequest>>consistentMapBuilder() |
| 172 | .withName("onos-packet-requests") |
Thomas Vachuska | 19f1229 | 2015-04-20 16:29:15 -0700 | [diff] [blame] | 173 | .withPartitionsDisabled() |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 174 | .withSerializer(Serializer.using(KryoNamespaces.API)) |
| 175 | .build(); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 176 | } |
| 177 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 178 | private void add(PacketRequest request) { |
| 179 | AtomicBoolean firstRequest = |
Madan Jampani | d61f2b1 | 2015-12-10 17:01:52 -0800 | [diff] [blame^] | 180 | retryable(this::addInternal, ConsistentMapException.ConcurrentModification.class, |
| 181 | Integer.MAX_VALUE, MAX_BACKOFF).apply(request); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 182 | if (firstRequest.get() && delegate != null) { |
| 183 | // The instance that makes the first request will push to all devices |
| 184 | delegate.requestPackets(request); |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | private AtomicBoolean addInternal(PacketRequest request) { |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 189 | AtomicBoolean firstRequest = new AtomicBoolean(false); |
| 190 | requests.compute(request.selector(), (s, existingRequests) -> { |
| 191 | if (existingRequests == null) { |
| 192 | firstRequest.set(true); |
| 193 | return ImmutableSet.of(request); |
| 194 | } else if (!existingRequests.contains(request)) { |
| 195 | return ImmutableSet.<PacketRequest>builder() |
| 196 | .addAll(existingRequests) |
| 197 | .add(request) |
| 198 | .build(); |
| 199 | } else { |
| 200 | return existingRequests; |
| 201 | } |
| 202 | }); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 203 | return firstRequest; |
| 204 | } |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 205 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 206 | private void remove(PacketRequest request) { |
| 207 | AtomicBoolean removedLast = |
Madan Jampani | d61f2b1 | 2015-12-10 17:01:52 -0800 | [diff] [blame^] | 208 | retryable(this::removeInternal, ConsistentMapException.ConcurrentModification.class, |
| 209 | Integer.MAX_VALUE, MAX_BACKOFF).apply(request); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 210 | if (removedLast.get() && delegate != null) { |
| 211 | // The instance that removes the last request will remove from all devices |
| 212 | delegate.cancelPackets(request); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 213 | } |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 214 | } |
| 215 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 216 | private AtomicBoolean removeInternal(PacketRequest request) { |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 217 | AtomicBoolean removedLast = new AtomicBoolean(false); |
| 218 | requests.computeIfPresent(request.selector(), (s, existingRequests) -> { |
| 219 | if (existingRequests.contains(request)) { |
| 220 | Set<PacketRequest> newRequests = Sets.newHashSet(existingRequests); |
| 221 | newRequests.remove(request); |
| 222 | if (newRequests.size() > 0) { |
| 223 | return ImmutableSet.copyOf(newRequests); |
| 224 | } else { |
| 225 | removedLast.set(true); |
| 226 | return null; |
| 227 | } |
| 228 | } else { |
| 229 | return existingRequests; |
| 230 | } |
| 231 | }); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 232 | return removedLast; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 233 | } |
| 234 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 235 | private List<PacketRequest> requests() { |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 236 | List<PacketRequest> list = Lists.newArrayList(); |
| 237 | requests.values().forEach(v -> list.addAll(v.value())); |
| 238 | list.sort((o1, o2) -> o1.priority().priorityValue() - o2.priority().priorityValue()); |
| 239 | return list; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 240 | } |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 241 | } |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 242 | } |