Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 | */ |
Madan Jampani | f4c8850 | 2016-01-21 12:35:36 -0800 | [diff] [blame] | 16 | package org.onosproject.store.primitives.impl; |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 17 | |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 18 | import com.google.common.collect.Sets; |
| 19 | import com.google.common.util.concurrent.Futures; |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 20 | |
| 21 | import org.onlab.util.SharedExecutors; |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 22 | import org.onosproject.store.service.DistributedPrimitive; |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 23 | import org.onosproject.store.service.DistributedQueue; |
| 24 | import org.onosproject.store.service.Serializer; |
Aaron Kruglikov | 1110b2c | 2016-02-02 16:24:37 -0800 | [diff] [blame] | 25 | import org.onosproject.utils.MeteringAgent; |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 26 | |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 27 | import java.util.List; |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 28 | import java.util.Set; |
| 29 | import java.util.concurrent.CompletableFuture; |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 30 | |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 31 | import static com.google.common.base.Preconditions.checkNotNull; |
Madan Jampani | f4c8850 | 2016-01-21 12:35:36 -0800 | [diff] [blame] | 32 | import static org.onosproject.store.primitives.impl.StateMachineUpdate.Target.QUEUE_PUSH; |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 33 | |
| 34 | /** |
| 35 | * DistributedQueue implementation that provides FIFO ordering semantics. |
| 36 | * |
| 37 | * @param <E> queue entry type |
| 38 | */ |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 39 | public class DefaultDistributedQueue<E> implements DistributedQueue<E> { |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 40 | |
| 41 | private final String name; |
| 42 | private final Database database; |
| 43 | private final Serializer serializer; |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 44 | private final Set<CompletableFuture<E>> pendingFutures = Sets.newIdentityHashSet(); |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 45 | |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 46 | private static final String PRIMITIVE_NAME = "distributedQueue"; |
| 47 | private static final String SIZE = "size"; |
| 48 | private static final String PUSH = "push"; |
| 49 | private static final String POP = "pop"; |
| 50 | private static final String PEEK = "peek"; |
| 51 | |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 52 | private static final String ERROR_NULL_ENTRY = "Null entries are not allowed"; |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 53 | private final MeteringAgent monitor; |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 54 | |
| 55 | public DefaultDistributedQueue(String name, |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 56 | Database database, |
| 57 | Serializer serializer, |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 58 | boolean meteringEnabled) { |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 59 | this.name = checkNotNull(name, "queue name cannot be null"); |
| 60 | this.database = checkNotNull(database, "database cannot be null"); |
| 61 | this.serializer = checkNotNull(serializer, "serializer cannot be null"); |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 62 | this.monitor = new MeteringAgent(PRIMITIVE_NAME, name, meteringEnabled); |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 63 | this.database.registerConsumer(update -> { |
| 64 | SharedExecutors.getSingleThreadExecutor().execute(() -> { |
| 65 | if (update.target() == QUEUE_PUSH) { |
| 66 | List<Object> input = update.input(); |
| 67 | String queueName = (String) input.get(0); |
| 68 | if (queueName.equals(name)) { |
| 69 | tryPoll(); |
| 70 | } |
| 71 | } |
| 72 | }); |
| 73 | }); |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 74 | } |
| 75 | |
| 76 | @Override |
| 77 | public long size() { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 78 | final MeteringAgent.Context timer = monitor.startTimer(SIZE); |
Flavio Castro | 6e04461 | 2015-08-13 14:13:58 -0700 | [diff] [blame] | 79 | return Futures.getUnchecked(database.queueSize(name).whenComplete((r, e) -> timer.stop(e))); |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | @Override |
| 83 | public void push(E entry) { |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 84 | checkNotNull(entry, ERROR_NULL_ENTRY); |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 85 | final MeteringAgent.Context timer = monitor.startTimer(PUSH); |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 86 | Futures.getUnchecked(database.queuePush(name, serializer.encode(entry)) |
Flavio Castro | 6e04461 | 2015-08-13 14:13:58 -0700 | [diff] [blame] | 87 | .whenComplete((r, e) -> timer.stop(e))); |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | @Override |
| 91 | public CompletableFuture<E> pop() { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 92 | final MeteringAgent.Context timer = monitor.startTimer(POP); |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 93 | return database.queuePop(name) |
Flavio Castro | 6e04461 | 2015-08-13 14:13:58 -0700 | [diff] [blame] | 94 | .whenComplete((r, e) -> timer.stop(e)) |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 95 | .thenCompose(v -> { |
| 96 | if (v != null) { |
HIGUCHI Yuta | 1b9c8ac | 2015-08-28 15:35:43 -0700 | [diff] [blame] | 97 | return CompletableFuture.<E>completedFuture(serializer.decode(v)); |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 98 | } |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 99 | CompletableFuture<E> newPendingFuture = new CompletableFuture<>(); |
| 100 | pendingFutures.add(newPendingFuture); |
| 101 | return newPendingFuture; |
| 102 | }); |
Flavio Castro | 6e04461 | 2015-08-13 14:13:58 -0700 | [diff] [blame] | 103 | |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public E peek() { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 108 | final MeteringAgent.Context timer = monitor.startTimer(PEEK); |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 109 | return Futures.getUnchecked(database.queuePeek(name) |
| 110 | .thenApply(v -> v != null ? serializer.<E>decode(v) : null) |
Flavio Castro | 6e04461 | 2015-08-13 14:13:58 -0700 | [diff] [blame] | 111 | .whenComplete((r, e) -> timer.stop(e))); |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 112 | } |
| 113 | |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 114 | @Override |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 115 | public String name() { |
| 116 | return name; |
| 117 | } |
| 118 | |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 119 | @Override |
Madan Jampani | 39fff10 | 2016-02-14 13:17:28 -0800 | [diff] [blame] | 120 | public DistributedPrimitive.Type primitiveType() { |
Madan Jampani | a090a11 | 2016-01-18 16:38:17 -0800 | [diff] [blame] | 121 | return DistributedPrimitive.Type.QUEUE; |
| 122 | } |
| 123 | |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 124 | protected void tryPoll() { |
| 125 | Set<CompletableFuture<E>> completedFutures = Sets.newHashSet(); |
| 126 | for (CompletableFuture<E> future : pendingFutures) { |
Madan Jampani | a6d787b | 2015-08-11 11:02:02 -0700 | [diff] [blame] | 127 | E entry = Futures.getUnchecked(database.queuePop(name) |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 128 | .thenApply(v -> v != null ? serializer.decode(v) : null)); |
| 129 | if (entry != null) { |
| 130 | future.complete(entry); |
| 131 | completedFutures.add(future); |
| 132 | } else { |
| 133 | break; |
| 134 | } |
| 135 | } |
| 136 | pendingFutures.removeAll(completedFutures); |
| 137 | } |
| 138 | } |