Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -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 | */ |
Thomas Vachuska | c97aa61 | 2015-06-23 16:00:18 -0700 | [diff] [blame] | 16 | package org.onosproject.store.trivial; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | 3c58e96 | 2015-04-28 23:21:51 -0700 | [diff] [blame] | 18 | import com.google.common.collect.Lists; |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 19 | import com.google.common.collect.Maps; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.net.intent.Intent; |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 21 | import org.onosproject.net.intent.IntentData; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 22 | import org.onosproject.net.intent.IntentEvent; |
Brian O'Connor | 7775bda | 2015-02-06 15:01:18 -0800 | [diff] [blame] | 23 | import org.onosproject.net.intent.IntentState; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 24 | import org.onosproject.net.intent.IntentStore; |
| 25 | import org.onosproject.net.intent.IntentStoreDelegate; |
Ray Milkey | 5b3717e | 2015-02-05 11:44:08 -0800 | [diff] [blame] | 26 | import org.onosproject.net.intent.Key; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 27 | import org.onosproject.store.AbstractStore; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 28 | import org.osgi.service.component.annotations.Activate; |
| 29 | import org.osgi.service.component.annotations.Component; |
| 30 | import org.osgi.service.component.annotations.Deactivate; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 31 | import org.slf4j.Logger; |
| 32 | |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 33 | import java.util.List; |
| 34 | import java.util.Map; |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 35 | import java.util.stream.Collectors; |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 36 | |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 37 | import static com.google.common.base.Preconditions.checkNotNull; |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 38 | import static org.onosproject.net.intent.IntentState.PURGE_REQ; |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 39 | import static org.slf4j.LoggerFactory.getLogger; |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 40 | |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 41 | /** |
| 42 | * Simple single-instance implementation of the intent store. |
| 43 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 44 | @Component(immediate = true, service = IntentStore.class) |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 45 | public class SimpleIntentStore |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 46 | extends AbstractStore<IntentEvent, IntentStoreDelegate> |
| 47 | implements IntentStore { |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 48 | |
| 49 | private final Logger log = getLogger(getClass()); |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 50 | |
Ray Milkey | 5b3717e | 2015-02-05 11:44:08 -0800 | [diff] [blame] | 51 | private final Map<Key, IntentData> current = Maps.newConcurrentMap(); |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 52 | private final Map<Key, IntentData> pending = Maps.newConcurrentMap(); |
| 53 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 54 | @Activate |
| 55 | public void activate() { |
| 56 | log.info("Started"); |
| 57 | } |
| 58 | |
| 59 | @Deactivate |
| 60 | public void deactivate() { |
| 61 | log.info("Stopped"); |
| 62 | } |
| 63 | |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 64 | @Override |
| 65 | public long getIntentCount() { |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 66 | return current.size(); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 67 | } |
| 68 | |
| 69 | @Override |
| 70 | public Iterable<Intent> getIntents() { |
Brian O'Connor | b499b35 | 2015-02-03 16:46:15 -0800 | [diff] [blame] | 71 | return current.values().stream() |
| 72 | .map(IntentData::intent) |
| 73 | .collect(Collectors.toList()); |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 74 | } |
| 75 | |
| 76 | @Override |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 77 | public Iterable<IntentData> getIntentData(boolean localOnly, long olderThan) { |
| 78 | if (localOnly || olderThan > 0) { |
| 79 | long older = System.nanoTime() - olderThan * 1_000_000; //convert ms to ns |
| 80 | final SystemClockTimestamp time = new SystemClockTimestamp(older); |
Brian O'Connor | eba4e34 | 2015-04-30 22:50:13 -0700 | [diff] [blame] | 81 | return current.values().stream() |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 82 | .filter(data -> data.version().isOlderThan(time) && |
| 83 | (!localOnly || isMaster(data.key()))) |
Brian O'Connor | 3c58e96 | 2015-04-28 23:21:51 -0700 | [diff] [blame] | 84 | .collect(Collectors.toList()); |
| 85 | } |
| 86 | return Lists.newArrayList(current.values()); |
| 87 | } |
| 88 | |
| 89 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 90 | public IntentState getIntentState(Key intentKey) { |
| 91 | IntentData data = current.get(intentKey); |
| 92 | return (data != null) ? data.state() : null; |
Brian O'Connor | 7775bda | 2015-02-06 15:01:18 -0800 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | @Override |
Ray Milkey | f9af43c | 2015-02-09 16:45:48 -0800 | [diff] [blame] | 96 | public List<Intent> getInstallableIntents(Key intentKey) { |
| 97 | IntentData data = current.get(intentKey); |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 98 | if (data != null) { |
| 99 | return data.installables(); |
| 100 | } |
| 101 | return null; |
| 102 | } |
| 103 | |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 104 | @Override |
Brian O'Connor | 03406a4 | 2015-02-03 17:28:57 -0800 | [diff] [blame] | 105 | public void write(IntentData newData) { |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 106 | checkNotNull(newData); |
| 107 | |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 108 | synchronized (this) { |
| 109 | // TODO this could be refactored/cleaned up |
| 110 | IntentData currentData = current.get(newData.key()); |
| 111 | IntentData pendingData = pending.get(newData.key()); |
| 112 | |
Jonathan Hart | 72175c2 | 2015-03-24 18:55:58 -0700 | [diff] [blame] | 113 | if (IntentData.isUpdateAcceptable(currentData, newData)) { |
Ray Milkey | 77a455f | 2015-03-27 10:08:17 -0700 | [diff] [blame] | 114 | if (pendingData != null) { |
| 115 | if (pendingData.state() == PURGE_REQ) { |
| 116 | current.remove(newData.key(), newData); |
| 117 | } else { |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 118 | current.put(newData.key(), IntentData.copy(newData)); |
Ray Milkey | 77a455f | 2015-03-27 10:08:17 -0700 | [diff] [blame] | 119 | } |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 120 | |
Ray Milkey | 77a455f | 2015-03-27 10:08:17 -0700 | [diff] [blame] | 121 | if (pendingData.version().compareTo(newData.version()) <= 0) { |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 122 | // pendingData version is less than or equal to newData's |
| 123 | // Note: a new update for this key could be pending (it's version will be greater) |
Ray Milkey | 77a455f | 2015-03-27 10:08:17 -0700 | [diff] [blame] | 124 | pending.remove(newData.key()); |
| 125 | } |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 126 | } |
Sho SHIMIZU | 96b39e2 | 2016-01-15 17:35:04 -0800 | [diff] [blame] | 127 | IntentEvent.getEvent(newData).ifPresent(this::notifyDelegate); |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 128 | } |
Brian O'Connor | 03406a4 | 2015-02-03 17:28:57 -0800 | [diff] [blame] | 129 | } |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 130 | } |
| 131 | |
Brian O'Connor | 03406a4 | 2015-02-03 17:28:57 -0800 | [diff] [blame] | 132 | @Override |
| 133 | public void batchWrite(Iterable<IntentData> updates) { |
| 134 | for (IntentData data : updates) { |
| 135 | write(data); |
| 136 | } |
| 137 | } |
| 138 | |
Brian O'Connor | 7775bda | 2015-02-06 15:01:18 -0800 | [diff] [blame] | 139 | @Override |
| 140 | public Intent getIntent(Key key) { |
| 141 | IntentData data = current.get(key); |
| 142 | return (data != null) ? data.intent() : null; |
| 143 | } |
| 144 | |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 145 | @Override |
| 146 | public IntentData getIntentData(Key key) { |
Jonathan Hart | 0d18df3 | 2015-03-21 08:42:59 -0700 | [diff] [blame] | 147 | IntentData currentData = current.get(key); |
| 148 | if (currentData == null) { |
| 149 | return null; |
| 150 | } |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 151 | return IntentData.copy(currentData); |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 152 | } |
Brian O'Connor | 03406a4 | 2015-02-03 17:28:57 -0800 | [diff] [blame] | 153 | |
| 154 | @Override |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 155 | public void addPending(IntentData data) { |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 156 | if (data.version() == null) { // recompiled intents will already have a version |
Sho SHIMIZU | 2f26fb2 | 2016-01-19 14:04:46 -0800 | [diff] [blame] | 157 | data = new IntentData(data.intent(), data.state(), new SystemClockTimestamp()); |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 158 | } |
| 159 | synchronized (this) { |
| 160 | IntentData existingData = pending.get(data.key()); |
| 161 | if (existingData == null || |
| 162 | // existing version is strictly less than data's version |
| 163 | // Note: if they are equal, we already have the update |
| 164 | // TODO maybe we should still make this <= to be safe? |
| 165 | existingData.version().compareTo(data.version()) < 0) { |
| 166 | pending.put(data.key(), data); |
| 167 | checkNotNull(delegate, "Store delegate is not set") |
Yuta HIGUCHI | 4f8a377 | 2017-05-16 20:23:49 -0700 | [diff] [blame] | 168 | .process(IntentData.copy(data)); |
Sho SHIMIZU | 96b39e2 | 2016-01-15 17:35:04 -0800 | [diff] [blame] | 169 | IntentEvent.getEvent(data).ifPresent(this::notifyDelegate); |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 170 | } else { |
| 171 | log.debug("IntentData {} is older than existing: {}", |
| 172 | data, existingData); |
| 173 | } |
| 174 | //TODO consider also checking the current map at this point |
| 175 | } |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 176 | } |
Brian O'Connor | cff0332 | 2015-02-03 15:28:59 -0800 | [diff] [blame] | 177 | |
Jonathan Hart | 6a8fd1d | 2015-02-25 15:44:37 -0800 | [diff] [blame] | 178 | @Override |
| 179 | public boolean isMaster(Key intentKey) { |
| 180 | return true; |
| 181 | } |
| 182 | |
| 183 | @Override |
| 184 | public Iterable<Intent> getPending() { |
| 185 | return pending.values().stream() |
| 186 | .map(IntentData::intent) |
| 187 | .collect(Collectors.toList()); |
| 188 | } |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 189 | |
| 190 | @Override |
| 191 | public Iterable<IntentData> getPendingData() { |
| 192 | return Lists.newArrayList(pending.values()); |
| 193 | } |
| 194 | |
| 195 | @Override |
Brian O'Connor | c590ebb | 2016-12-08 18:16:41 -0800 | [diff] [blame] | 196 | public IntentData getPendingData(Key intentKey) { |
| 197 | return pending.get(intentKey); |
| 198 | } |
| 199 | |
| 200 | @Override |
Brian O'Connor | a6c9b5c | 2015-04-29 22:38:29 -0700 | [diff] [blame] | 201 | public Iterable<IntentData> getPendingData(boolean localOnly, long olderThan) { |
| 202 | long older = System.nanoTime() - olderThan * 1_000_000; //convert ms to ns |
| 203 | final SystemClockTimestamp time = new SystemClockTimestamp(older); |
| 204 | return pending.values().stream() |
| 205 | .filter(data -> data.version().isOlderThan(time) && |
| 206 | (!localOnly || isMaster(data.key()))) |
| 207 | .collect(Collectors.toList()); |
| 208 | } |
Brian O'Connor | 66630c8 | 2014-10-02 21:08:19 -0700 | [diff] [blame] | 209 | } |