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