Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -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 | */ |
| 16 | |
| 17 | package org.onosproject.store.primitives.resources.impl; |
| 18 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 19 | import java.util.HashMap; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 20 | import java.util.Map; |
| 21 | import java.util.NavigableMap; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 22 | import java.util.TreeMap; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 23 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 24 | import com.google.common.collect.Maps; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 25 | import io.atomix.protocols.raft.service.Commit; |
| 26 | import io.atomix.protocols.raft.service.RaftServiceExecutor; |
| 27 | import io.atomix.protocols.raft.session.RaftSession; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 28 | import org.onlab.util.KryoNamespace; |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 29 | import org.onosproject.store.primitives.TransactionId; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 30 | import org.onosproject.store.serializers.KryoNamespaces; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 31 | import org.onosproject.store.service.Serializer; |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 32 | import org.onosproject.store.service.TransactionLog; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 33 | import org.onosproject.store.service.Versioned; |
| 34 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 35 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.CEILING_ENTRY; |
| 36 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.CEILING_KEY; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 37 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.CeilingEntry; |
| 38 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.CeilingKey; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 39 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.FIRST_ENTRY; |
| 40 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.FIRST_KEY; |
| 41 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.FLOOR_ENTRY; |
| 42 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.FLOOR_KEY; |
| 43 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.FloorEntry; |
| 44 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.FloorKey; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 45 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.HIGHER_ENTRY; |
| 46 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.HIGHER_KEY; |
| 47 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.HigherEntry; |
| 48 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.HigherKey; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 49 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.LAST_ENTRY; |
| 50 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.LAST_KEY; |
| 51 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.LOWER_ENTRY; |
| 52 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.LOWER_KEY; |
| 53 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.LowerEntry; |
| 54 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.LowerKey; |
| 55 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.POLL_FIRST_ENTRY; |
| 56 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.POLL_LAST_ENTRY; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 57 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.SUB_MAP; |
| 58 | import static org.onosproject.store.primitives.resources.impl.AtomixConsistentTreeMapOperations.SubMap; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 59 | |
| 60 | /** |
| 61 | * State machine corresponding to {@link AtomixConsistentTreeMap} backed by a |
| 62 | * {@link TreeMap}. |
| 63 | */ |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 64 | public class AtomixConsistentTreeMapService extends AtomixConsistentMapService { |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 65 | |
| 66 | private static final Serializer SERIALIZER = Serializer.using(KryoNamespace.newBuilder() |
| 67 | .register(KryoNamespaces.BASIC) |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 68 | .register(AtomixConsistentMapOperations.NAMESPACE) |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 69 | .register(AtomixConsistentTreeMapOperations.NAMESPACE) |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 70 | .register(AtomixConsistentMapEvents.NAMESPACE) |
| 71 | .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID + 150) |
| 72 | .register(TransactionScope.class) |
| 73 | .register(TransactionLog.class) |
| 74 | .register(TransactionId.class) |
| 75 | .register(MapEntryValue.class) |
| 76 | .register(MapEntryValue.Type.class) |
| 77 | .register(new HashMap().keySet().getClass()) |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 78 | .register(TreeMap.class) |
| 79 | .build()); |
| 80 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 81 | @Override |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 82 | protected TreeMap<String, MapEntryValue> createMap() { |
| 83 | return Maps.newTreeMap(); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 84 | } |
| 85 | |
| 86 | @Override |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 87 | protected TreeMap<String, MapEntryValue> entries() { |
| 88 | return (TreeMap<String, MapEntryValue>) super.entries(); |
| 89 | } |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 90 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 91 | @Override |
| 92 | protected Serializer serializer() { |
| 93 | return SERIALIZER; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | @Override |
| 97 | public void configure(RaftServiceExecutor executor) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 98 | super.configure(executor); |
| 99 | executor.register(SUB_MAP, serializer()::decode, this::subMap, serializer()::encode); |
| 100 | executor.register(FIRST_KEY, (Commit<Void> c) -> firstKey(), serializer()::encode); |
| 101 | executor.register(LAST_KEY, (Commit<Void> c) -> lastKey(), serializer()::encode); |
| 102 | executor.register(FIRST_ENTRY, (Commit<Void> c) -> firstEntry(), serializer()::encode); |
| 103 | executor.register(LAST_ENTRY, (Commit<Void> c) -> lastEntry(), serializer()::encode); |
| 104 | executor.register(POLL_FIRST_ENTRY, (Commit<Void> c) -> pollFirstEntry(), serializer()::encode); |
| 105 | executor.register(POLL_LAST_ENTRY, (Commit<Void> c) -> pollLastEntry(), serializer()::encode); |
| 106 | executor.register(LOWER_ENTRY, serializer()::decode, this::lowerEntry, serializer()::encode); |
| 107 | executor.register(LOWER_KEY, serializer()::decode, this::lowerKey, serializer()::encode); |
| 108 | executor.register(FLOOR_ENTRY, serializer()::decode, this::floorEntry, serializer()::encode); |
| 109 | executor.register(FLOOR_KEY, serializer()::decode, this::floorKey, serializer()::encode); |
| 110 | executor.register(CEILING_ENTRY, serializer()::decode, this::ceilingEntry, serializer()::encode); |
| 111 | executor.register(CEILING_KEY, serializer()::decode, this::ceilingKey, serializer()::encode); |
| 112 | executor.register(HIGHER_ENTRY, serializer()::decode, this::higherEntry, serializer()::encode); |
| 113 | executor.register(HIGHER_KEY, serializer()::decode, this::higherKey, serializer()::encode); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 114 | } |
| 115 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 116 | protected NavigableMap<String, MapEntryValue> subMap( |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 117 | Commit<? extends SubMap> commit) { |
| 118 | // Do not support this until lazy communication is possible. At present |
| 119 | // it transmits up to the entire map. |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 120 | SubMap<String, MapEntryValue> subMap = commit.value(); |
| 121 | return entries().subMap(subMap.fromKey(), subMap.isInclusiveFrom(), |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 122 | subMap.toKey(), subMap.isInclusiveTo()); |
| 123 | } |
| 124 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 125 | protected String firstKey() { |
| 126 | return isEmpty() ? null : entries().firstKey(); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 127 | } |
| 128 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 129 | protected String lastKey() { |
| 130 | return isEmpty() ? null : entries().lastKey(); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | protected Map.Entry<String, Versioned<byte[]>> higherEntry(Commit<? extends HigherEntry> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 134 | return isEmpty() ? null : toVersionedEntry(entries().higherEntry(commit.value().key())); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 135 | } |
| 136 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 137 | protected Map.Entry<String, Versioned<byte[]>> firstEntry() { |
| 138 | return isEmpty() ? null : toVersionedEntry(entries().firstEntry()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 139 | } |
| 140 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 141 | protected Map.Entry<String, Versioned<byte[]>> lastEntry() { |
| 142 | return isEmpty() ? null : toVersionedEntry(entries().lastEntry()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 143 | } |
| 144 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 145 | protected Map.Entry<String, Versioned<byte[]>> pollFirstEntry() { |
| 146 | return toVersionedEntry(entries().pollFirstEntry()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 147 | } |
| 148 | |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 149 | protected Map.Entry<String, Versioned<byte[]>> pollLastEntry() { |
| 150 | return toVersionedEntry(entries().pollLastEntry()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | protected Map.Entry<String, Versioned<byte[]>> lowerEntry(Commit<? extends LowerEntry> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 154 | return toVersionedEntry(entries().lowerEntry(commit.value().key())); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | protected String lowerKey(Commit<? extends LowerKey> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 158 | return entries().lowerKey(commit.value().key()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | protected Map.Entry<String, Versioned<byte[]>> floorEntry(Commit<? extends FloorEntry> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 162 | return toVersionedEntry(entries().floorEntry(commit.value().key())); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | protected String floorKey(Commit<? extends FloorKey> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 166 | return entries().floorKey(commit.value().key()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | protected Map.Entry<String, Versioned<byte[]>> ceilingEntry(Commit<CeilingEntry> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 170 | return toVersionedEntry(entries().ceilingEntry(commit.value().key())); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | protected String ceilingKey(Commit<CeilingKey> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 174 | return entries().ceilingKey(commit.value().key()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | protected String higherKey(Commit<HigherKey> commit) { |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 178 | return entries().higherKey(commit.value().key()); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | private Map.Entry<String, Versioned<byte[]>> toVersionedEntry( |
Jordan Halterman | 71635ae | 2017-07-28 10:35:43 -0700 | [diff] [blame] | 182 | Map.Entry<String, MapEntryValue> entry) { |
| 183 | return entry == null || valueIsNull(entry.getValue()) |
| 184 | ? null : Maps.immutableEntry(entry.getKey(), toVersioned(entry.getValue())); |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | @Override |
| 188 | public void onExpire(RaftSession session) { |
| 189 | closeListener(session.sessionId().id()); |
| 190 | } |
| 191 | |
| 192 | @Override |
| 193 | public void onClose(RaftSession session) { |
| 194 | closeListener(session.sessionId().id()); |
| 195 | } |
| 196 | |
| 197 | private void closeListener(Long sessionId) { |
| 198 | listeners.remove(sessionId); |
| 199 | } |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 200 | } |