Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present 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; |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Modified; |
| 25 | import org.apache.felix.scr.annotations.Property; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Reference; |
| 27 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 28 | import org.apache.felix.scr.annotations.Service; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 29 | import org.onosproject.cluster.ClusterService; |
| 30 | import org.onosproject.cluster.NodeId; |
| 31 | import org.onosproject.mastership.MastershipService; |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 32 | import org.onosproject.net.flow.TrafficSelector; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 33 | import org.onosproject.net.packet.OutboundPacket; |
| 34 | import org.onosproject.net.packet.PacketEvent; |
| 35 | import org.onosproject.net.packet.PacketEvent.Type; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 36 | import org.onosproject.net.packet.PacketRequest; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 37 | import org.onosproject.net.packet.PacketStore; |
| 38 | import org.onosproject.net.packet.PacketStoreDelegate; |
| 39 | import org.onosproject.store.AbstractStore; |
| 40 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 41 | import org.onosproject.store.cluster.messaging.MessageSubject; |
| 42 | import org.onosproject.store.serializers.KryoNamespaces; |
HIGUCHI Yuta | e729065 | 2016-05-18 11:29:01 -0700 | [diff] [blame] | 43 | import org.onosproject.store.serializers.StoreSerializer; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 44 | import org.onosproject.store.service.ConsistentMap; |
| 45 | import org.onosproject.store.service.Serializer; |
| 46 | import org.onosproject.store.service.StorageService; |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 47 | import org.osgi.service.component.ComponentContext; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 48 | import org.slf4j.Logger; |
| 49 | |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 50 | import java.util.Dictionary; |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 51 | import java.util.List; |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 52 | import java.util.Properties; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 53 | import java.util.Set; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 54 | import java.util.concurrent.ExecutorService; |
| 55 | import java.util.concurrent.Executors; |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 56 | import java.util.concurrent.atomic.AtomicBoolean; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 57 | |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 58 | import static com.google.common.base.Preconditions.checkArgument; |
| 59 | import static com.google.common.base.Strings.isNullOrEmpty; |
| 60 | import static org.onlab.util.Tools.get; |
Brian O'Connor | 5eb77c8 | 2015-03-02 18:09:39 -0800 | [diff] [blame] | 61 | import static org.onlab.util.Tools.groupedThreads; |
| 62 | import static org.slf4j.LoggerFactory.getLogger; |
| 63 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 64 | /** |
| 65 | * Distributed packet store implementation allowing packets to be sent to |
| 66 | * remote instances. |
| 67 | */ |
| 68 | @Component(immediate = true) |
| 69 | @Service |
| 70 | public class DistributedPacketStore |
| 71 | extends AbstractStore<PacketEvent, PacketStoreDelegate> |
| 72 | implements PacketStore { |
| 73 | |
| 74 | private final Logger log = getLogger(getClass()); |
| 75 | |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 76 | private static final String FORMAT = "Setting: messageHandlerThreadPoolSize={}"; |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 77 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 78 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | ff96523 | 2015-03-17 14:10:52 -0700 | [diff] [blame] | 79 | protected MastershipService mastershipService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 80 | |
| 81 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | ff96523 | 2015-03-17 14:10:52 -0700 | [diff] [blame] | 82 | protected ClusterService clusterService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 83 | |
| 84 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Thomas Vachuska | ff96523 | 2015-03-17 14:10:52 -0700 | [diff] [blame] | 85 | protected ClusterCommunicationService communicationService; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 86 | |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 87 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 88 | protected StorageService storageService; |
| 89 | |
| 90 | private PacketRequestTracker tracker; |
| 91 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 92 | private static final MessageSubject PACKET_OUT_SUBJECT = |
| 93 | new MessageSubject("packet-out"); |
| 94 | |
HIGUCHI Yuta | e729065 | 2016-05-18 11:29:01 -0700 | [diff] [blame] | 95 | private static final StoreSerializer SERIALIZER = StoreSerializer.using(KryoNamespaces.API); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 96 | |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 97 | private ExecutorService messageHandlingExecutor; |
| 98 | |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 99 | private static final int DEFAULT_MESSAGE_HANDLER_THREAD_POOL_SIZE = 4; |
| 100 | @Property(name = "messageHandlerThreadPoolSize", intValue = DEFAULT_MESSAGE_HANDLER_THREAD_POOL_SIZE, |
| 101 | label = "Size of thread pool to assign message handler") |
| 102 | private static int messageHandlerThreadPoolSize = DEFAULT_MESSAGE_HANDLER_THREAD_POOL_SIZE; |
| 103 | |
| 104 | private static final int MAX_BACKOFF = 50; |
| 105 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 106 | @Activate |
| 107 | public void activate() { |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 108 | messageHandlingExecutor = Executors.newFixedThreadPool( |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 109 | messageHandlerThreadPoolSize, |
HIGUCHI Yuta | d9e0105 | 2016-04-14 09:31:42 -0700 | [diff] [blame] | 110 | groupedThreads("onos/store/packet", "message-handlers", log)); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 111 | |
Madan Jampani | 01e05fb | 2015-08-13 13:29:36 -0700 | [diff] [blame] | 112 | communicationService.<OutboundPacket>addSubscriber(PACKET_OUT_SUBJECT, |
| 113 | SERIALIZER::decode, |
| 114 | packet -> notifyDelegate(new PacketEvent(Type.EMIT, packet)), |
| 115 | messageHandlingExecutor); |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 116 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 117 | tracker = new PacketRequestTracker(); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 118 | |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 119 | log.info("Started"); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | @Deactivate |
| 123 | public void deactivate() { |
Madan Jampani | 2af244a | 2015-02-22 13:12:01 -0800 | [diff] [blame] | 124 | communicationService.removeSubscriber(PACKET_OUT_SUBJECT); |
| 125 | messageHandlingExecutor.shutdown(); |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 126 | tracker = null; |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 127 | log.info("Stopped"); |
| 128 | } |
| 129 | |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 130 | @Modified |
| 131 | public void modified(ComponentContext context) { |
| 132 | Dictionary<?, ?> properties = context != null ? context.getProperties() : new Properties(); |
| 133 | |
| 134 | int newMessageHandlerThreadPoolSize; |
| 135 | |
| 136 | try { |
| 137 | String s = get(properties, "messageHandlerThreadPoolSize"); |
| 138 | |
| 139 | newMessageHandlerThreadPoolSize = |
| 140 | isNullOrEmpty(s) ? messageHandlerThreadPoolSize : Integer.parseInt(s.trim()); |
| 141 | |
| 142 | } catch (NumberFormatException e) { |
| 143 | log.warn(e.getMessage()); |
| 144 | newMessageHandlerThreadPoolSize = messageHandlerThreadPoolSize; |
| 145 | } |
| 146 | |
| 147 | // Any change in the following parameters implies thread pool restart |
| 148 | if (newMessageHandlerThreadPoolSize != messageHandlerThreadPoolSize) { |
| 149 | setMessageHandlerThreadPoolSize(newMessageHandlerThreadPoolSize); |
| 150 | restartMessageHandlerThreadPool(); |
| 151 | } |
| 152 | |
| 153 | log.info(FORMAT, messageHandlerThreadPoolSize); |
| 154 | } |
| 155 | |
| 156 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 157 | @Override |
| 158 | public void emit(OutboundPacket packet) { |
| 159 | NodeId myId = clusterService.getLocalNode().id(); |
| 160 | NodeId master = mastershipService.getMasterFor(packet.sendThrough()); |
| 161 | |
Jonathan Hart | 7466d61 | 2014-11-24 17:09:53 -0800 | [diff] [blame] | 162 | if (master == null) { |
| 163 | return; |
| 164 | } |
| 165 | |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 166 | if (myId.equals(master)) { |
| 167 | notifyDelegate(new PacketEvent(Type.EMIT, packet)); |
| 168 | return; |
| 169 | } |
| 170 | |
Madan Jampani | 01e05fb | 2015-08-13 13:29:36 -0700 | [diff] [blame] | 171 | communicationService.unicast(packet, PACKET_OUT_SUBJECT, SERIALIZER::encode, master) |
| 172 | .whenComplete((r, error) -> { |
| 173 | if (error != null) { |
| 174 | log.warn("Failed to send packet-out to {}", master, error); |
| 175 | } |
| 176 | }); |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 177 | } |
| 178 | |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 179 | @Override |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 180 | public void requestPackets(PacketRequest request) { |
| 181 | tracker.add(request); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | @Override |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 185 | public void cancelPackets(PacketRequest request) { |
| 186 | tracker.remove(request); |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 187 | } |
| 188 | |
| 189 | @Override |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 190 | public List<PacketRequest> existingRequests() { |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 191 | return tracker.requests(); |
| 192 | } |
| 193 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 194 | private final class PacketRequestTracker { |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 195 | |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 196 | private ConsistentMap<TrafficSelector, Set<PacketRequest>> requests; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 197 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 198 | private PacketRequestTracker() { |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 199 | requests = storageService.<TrafficSelector, Set<PacketRequest>>consistentMapBuilder() |
| 200 | .withName("onos-packet-requests") |
Thomas Vachuska | 19f1229 | 2015-04-20 16:29:15 -0700 | [diff] [blame] | 201 | .withPartitionsDisabled() |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 202 | .withSerializer(Serializer.using(KryoNamespaces.API)) |
| 203 | .build(); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 204 | } |
| 205 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 206 | private void add(PacketRequest request) { |
Madan Jampani | c637188 | 2016-06-03 21:30:17 -0700 | [diff] [blame^] | 207 | AtomicBoolean firstRequest = addInternal(request); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 208 | if (firstRequest.get() && delegate != null) { |
| 209 | // The instance that makes the first request will push to all devices |
| 210 | delegate.requestPackets(request); |
| 211 | } |
| 212 | } |
| 213 | |
| 214 | private AtomicBoolean addInternal(PacketRequest request) { |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 215 | AtomicBoolean firstRequest = new AtomicBoolean(false); |
| 216 | requests.compute(request.selector(), (s, existingRequests) -> { |
| 217 | if (existingRequests == null) { |
| 218 | firstRequest.set(true); |
| 219 | return ImmutableSet.of(request); |
| 220 | } else if (!existingRequests.contains(request)) { |
| 221 | return ImmutableSet.<PacketRequest>builder() |
| 222 | .addAll(existingRequests) |
| 223 | .add(request) |
| 224 | .build(); |
| 225 | } else { |
| 226 | return existingRequests; |
| 227 | } |
| 228 | }); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 229 | return firstRequest; |
| 230 | } |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 231 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 232 | private void remove(PacketRequest request) { |
Madan Jampani | c637188 | 2016-06-03 21:30:17 -0700 | [diff] [blame^] | 233 | AtomicBoolean removedLast = removeInternal(request); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 234 | if (removedLast.get() && delegate != null) { |
| 235 | // The instance that removes the last request will remove from all devices |
| 236 | delegate.cancelPackets(request); |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 237 | } |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 238 | } |
| 239 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 240 | private AtomicBoolean removeInternal(PacketRequest request) { |
Brian O'Connor | 21b028e | 2015-10-08 22:50:02 -0700 | [diff] [blame] | 241 | AtomicBoolean removedLast = new AtomicBoolean(false); |
| 242 | requests.computeIfPresent(request.selector(), (s, existingRequests) -> { |
| 243 | if (existingRequests.contains(request)) { |
| 244 | Set<PacketRequest> newRequests = Sets.newHashSet(existingRequests); |
| 245 | newRequests.remove(request); |
| 246 | if (newRequests.size() > 0) { |
| 247 | return ImmutableSet.copyOf(newRequests); |
| 248 | } else { |
| 249 | removedLast.set(true); |
| 250 | return null; |
| 251 | } |
| 252 | } else { |
| 253 | return existingRequests; |
| 254 | } |
| 255 | }); |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 256 | return removedLast; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 257 | } |
| 258 | |
Thomas Vachuska | 40e63e6 | 2015-10-13 16:16:20 -0700 | [diff] [blame] | 259 | private List<PacketRequest> requests() { |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 260 | List<PacketRequest> list = Lists.newArrayList(); |
| 261 | requests.values().forEach(v -> list.addAll(v.value())); |
| 262 | list.sort((o1, o2) -> o1.priority().priorityValue() - o2.priority().priorityValue()); |
| 263 | return list; |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 264 | } |
alshabib | 4294778 | 2015-03-31 14:59:06 -0700 | [diff] [blame] | 265 | } |
sangyun-han | ad84e0c | 2016-02-19 18:30:03 +0900 | [diff] [blame] | 266 | |
| 267 | /** |
| 268 | * Sets thread pool size of message handler. |
| 269 | * |
| 270 | * @param poolSize |
| 271 | */ |
| 272 | private void setMessageHandlerThreadPoolSize(int poolSize) { |
| 273 | checkArgument(poolSize >= 0, "Message handler pool size must be 0 or more"); |
| 274 | messageHandlerThreadPoolSize = poolSize; |
| 275 | } |
| 276 | |
| 277 | /** |
| 278 | * Restarts thread pool of message handler. |
| 279 | */ |
| 280 | private void restartMessageHandlerThreadPool() { |
| 281 | ExecutorService prevExecutor = messageHandlingExecutor; |
| 282 | messageHandlingExecutor = Executors.newFixedThreadPool(getMessageHandlerThreadPoolSize()); |
| 283 | prevExecutor.shutdown(); |
| 284 | } |
| 285 | |
| 286 | /** |
| 287 | * Gets current thread pool size of message handler. |
| 288 | * |
| 289 | * @return messageHandlerThreadPoolSize |
| 290 | */ |
| 291 | private int getMessageHandlerThreadPoolSize() { |
| 292 | return messageHandlerThreadPoolSize; |
| 293 | } |
Jonathan Hart | 4f60f98 | 2014-10-27 08:11:17 -0700 | [diff] [blame] | 294 | } |