Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -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 | */ |
| 16 | package org.onosproject.store.consistent.impl; |
| 17 | |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 18 | import org.onosproject.store.service.AsyncAtomicCounter; |
| 19 | import org.slf4j.Logger; |
| 20 | |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 21 | import java.util.concurrent.CompletableFuture; |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 22 | import java.util.concurrent.ScheduledExecutorService; |
| 23 | import java.util.concurrent.TimeUnit; |
| 24 | import java.util.function.BiFunction; |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 25 | |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 26 | import static com.google.common.base.Preconditions.checkNotNull; |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 27 | import static org.slf4j.LoggerFactory.getLogger; |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 28 | |
| 29 | /** |
| 30 | * Default implementation for a distributed AsyncAtomicCounter backed by |
| 31 | * partitioned Raft DB. |
| 32 | * <p> |
| 33 | * The initial value will be zero. |
| 34 | */ |
| 35 | public class DefaultAsyncAtomicCounter implements AsyncAtomicCounter { |
| 36 | |
| 37 | private final String name; |
| 38 | private final Database database; |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 39 | private final boolean retryOnFailure; |
| 40 | private final ScheduledExecutorService retryExecutor; |
| 41 | // TODO: configure delay via builder |
| 42 | private static final int DELAY_BETWEEN_RETRY_SEC = 1; |
| 43 | private final Logger log = getLogger(getClass()); |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 44 | private final MeteringAgent monitor; |
| 45 | |
| 46 | private static final String PRIMITIVE_NAME = "atomicCounter"; |
| 47 | private static final String INCREMENT_AND_GET = "incrementAndGet"; |
| 48 | private static final String GET_AND_INCREMENT = "getAndIncrement"; |
| 49 | private static final String GET_AND_ADD = "getAndAdd"; |
| 50 | private static final String ADD_AND_GET = "addAndGet"; |
| 51 | private static final String GET = "get"; |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 52 | |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 53 | public DefaultAsyncAtomicCounter(String name, |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 54 | Database database, |
| 55 | boolean retryOnException, |
| 56 | boolean meteringEnabled, |
| 57 | ScheduledExecutorService retryExecutor) { |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 58 | this.name = checkNotNull(name); |
| 59 | this.database = checkNotNull(database); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 60 | this.retryOnFailure = retryOnException; |
| 61 | this.retryExecutor = retryExecutor; |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 62 | this.monitor = new MeteringAgent(PRIMITIVE_NAME, name, meteringEnabled); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | @Override |
| 66 | public CompletableFuture<Long> incrementAndGet() { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 67 | final MeteringAgent.Context timer = monitor.startTimer(INCREMENT_AND_GET); |
| 68 | return addAndGet(1L) |
| 69 | .whenComplete((r, e) -> timer.stop()); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | @Override |
| 73 | public CompletableFuture<Long> get() { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 74 | final MeteringAgent.Context timer = monitor.startTimer(GET); |
| 75 | return database.counterGet(name) |
| 76 | .whenComplete((r, e) -> timer.stop()); |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public CompletableFuture<Long> getAndIncrement() { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 81 | final MeteringAgent.Context timer = monitor.startTimer(GET_AND_INCREMENT); |
| 82 | return getAndAdd(1L) |
| 83 | .whenComplete((r, e) -> timer.stop()); |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 84 | } |
| 85 | |
| 86 | @Override |
| 87 | public CompletableFuture<Long> getAndAdd(long delta) { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 88 | final MeteringAgent.Context timer = monitor.startTimer(GET_AND_ADD); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 89 | CompletableFuture<Long> result = database.counterGetAndAdd(name, delta); |
| 90 | if (!retryOnFailure) { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 91 | return result |
| 92 | .whenComplete((r, e) -> timer.stop()); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | CompletableFuture<Long> future = new CompletableFuture<>(); |
| 96 | return result.whenComplete((r, e) -> { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 97 | timer.stop(); |
| 98 | // TODO : Account for retries |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 99 | if (e != null) { |
| 100 | log.warn("getAndAdd failed due to {}. Will retry", e.getMessage()); |
| 101 | retryExecutor.schedule(new RetryTask(database::counterGetAndAdd, delta, future), |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 102 | DELAY_BETWEEN_RETRY_SEC, |
| 103 | TimeUnit.SECONDS); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 104 | } else { |
| 105 | future.complete(r); |
| 106 | } |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 107 | }).thenCompose(v -> future); |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | @Override |
| 111 | public CompletableFuture<Long> addAndGet(long delta) { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 112 | final MeteringAgent.Context timer = monitor.startTimer(ADD_AND_GET); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 113 | CompletableFuture<Long> result = database.counterAddAndGet(name, delta); |
| 114 | if (!retryOnFailure) { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 115 | return result |
| 116 | .whenComplete((r, e) -> timer.stop()); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | CompletableFuture<Long> future = new CompletableFuture<>(); |
| 120 | return result.whenComplete((r, e) -> { |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 121 | timer.stop(); |
| 122 | // TODO : Account for retries |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 123 | if (e != null) { |
| 124 | log.warn("addAndGet failed due to {}. Will retry", e.getMessage()); |
| 125 | retryExecutor.schedule(new RetryTask(database::counterAddAndGet, delta, future), |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame^] | 126 | DELAY_BETWEEN_RETRY_SEC, |
| 127 | TimeUnit.SECONDS); |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 128 | } else { |
| 129 | future.complete(r); |
| 130 | } |
| 131 | }).thenCompose(v -> future); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 132 | } |
Madan Jampani | f4d58f3 | 2015-06-05 17:38:22 -0700 | [diff] [blame] | 133 | |
| 134 | private class RetryTask implements Runnable { |
| 135 | |
| 136 | private final BiFunction<String, Long, CompletableFuture<Long>> function; |
| 137 | private final Long delta; |
| 138 | private final CompletableFuture<Long> result; |
| 139 | |
| 140 | public RetryTask(BiFunction<String, Long, CompletableFuture<Long>> function, |
| 141 | Long delta, |
| 142 | CompletableFuture<Long> result) { |
| 143 | this.function = function; |
| 144 | this.delta = delta; |
| 145 | this.result = result; |
| 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public void run() { |
| 150 | function.apply(name, delta).whenComplete((r, e) -> { |
| 151 | if (e == null) { |
| 152 | result.complete(r); |
| 153 | } else { |
| 154 | log.warn("{} retry failed due to {}. Will try again...", function, e.getMessage()); |
| 155 | // TODO: Exponential backoff |
| 156 | // TODO: limit retries |
| 157 | retryExecutor.schedule(this, DELAY_BETWEEN_RETRY_SEC, TimeUnit.SECONDS); |
| 158 | } |
| 159 | }); |
| 160 | } |
| 161 | } |
| 162 | } |