Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present 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.resource.impl; |
| 17 | |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 18 | import org.onosproject.net.resource.DiscreteResource; |
| 19 | import org.onosproject.net.resource.DiscreteResourceId; |
| 20 | import org.onosproject.net.resource.Resource; |
Naoki Shiota | bd1974c | 2016-04-29 18:44:17 -0700 | [diff] [blame] | 21 | import org.onosproject.net.resource.ResourceConsumerId; |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 22 | import org.onosproject.store.service.TransactionContext; |
| 23 | import org.onosproject.store.service.TransactionalMap; |
| 24 | import org.slf4j.Logger; |
| 25 | import org.slf4j.LoggerFactory; |
| 26 | |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 27 | import java.util.Optional; |
Sho SHIMIZU | 34847b7 | 2016-06-07 14:31:54 -0700 | [diff] [blame] | 28 | import java.util.Set; |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 29 | |
| 30 | import static org.onosproject.store.resource.impl.ConsistentResourceStore.SERIALIZER; |
| 31 | |
Sho SHIMIZU | 7ecf5ea | 2016-05-13 15:28:59 -0700 | [diff] [blame] | 32 | class TransactionalDiscreteResourceSubStore { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 33 | private final Logger log = LoggerFactory.getLogger(getClass()); |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 34 | private final TransactionalMap<DiscreteResourceId, DiscreteResources> childMap; |
Naoki Shiota | bd1974c | 2016-04-29 18:44:17 -0700 | [diff] [blame] | 35 | private final TransactionalMap<DiscreteResourceId, ResourceConsumerId> consumers; |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 36 | |
Sho SHIMIZU | 7ecf5ea | 2016-05-13 15:28:59 -0700 | [diff] [blame] | 37 | TransactionalDiscreteResourceSubStore(TransactionContext tx) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 38 | this.childMap = tx.getTransactionalMap(MapNames.DISCRETE_CHILD_MAP, SERIALIZER); |
| 39 | this.consumers = tx.getTransactionalMap(MapNames.DISCRETE_CONSUMER_MAP, SERIALIZER); |
| 40 | } |
| 41 | |
| 42 | // check the existence in the set: O(1) operation |
Sho SHIMIZU | a81141b | 2016-05-11 08:05:45 -0700 | [diff] [blame] | 43 | Optional<DiscreteResource> lookup(DiscreteResourceId id) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 44 | if (!id.parent().isPresent()) { |
| 45 | return Optional.of(Resource.ROOT); |
| 46 | } |
| 47 | |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 48 | DiscreteResources values = childMap.get(id.parent().get()); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 49 | if (values == null) { |
| 50 | return Optional.empty(); |
| 51 | } |
| 52 | |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 53 | return values.lookup(id); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 54 | } |
| 55 | |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 56 | boolean register(DiscreteResourceId parent, Set<DiscreteResource> resources) { |
Sho SHIMIZU | 1bf46b1 | 2016-05-06 15:42:29 -0700 | [diff] [blame] | 57 | // short-circuit: receiving empty resource is regarded as success |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 58 | if (resources.isEmpty()) { |
Sho SHIMIZU | 1bf46b1 | 2016-05-06 15:42:29 -0700 | [diff] [blame] | 59 | return true; |
| 60 | } |
| 61 | |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 62 | DiscreteResources requested = DiscreteResources.of(resources); |
| 63 | DiscreteResources oldValues = childMap.putIfAbsent(parent, requested); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 64 | if (oldValues == null) { |
| 65 | return true; |
| 66 | } |
| 67 | |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 68 | DiscreteResources addedValues = requested.difference(oldValues); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 69 | // no new value, then no-op |
| 70 | if (addedValues.isEmpty()) { |
| 71 | // don't write to map because all values are already stored |
| 72 | return true; |
| 73 | } |
| 74 | |
Sho SHIMIZU | b85000d | 2016-05-17 14:00:05 -0700 | [diff] [blame] | 75 | DiscreteResources newValues = oldValues.add(addedValues); |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 76 | return childMap.replace(parent, oldValues, newValues); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 77 | } |
| 78 | |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 79 | boolean unregister(DiscreteResourceId parent, Set<DiscreteResource> resources) { |
Sho SHIMIZU | 1bf46b1 | 2016-05-06 15:42:29 -0700 | [diff] [blame] | 80 | // short-circuit: receiving empty resource is regarded as success |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 81 | if (resources.isEmpty()) { |
Sho SHIMIZU | 1bf46b1 | 2016-05-06 15:42:29 -0700 | [diff] [blame] | 82 | return true; |
| 83 | } |
| 84 | |
Sho SHIMIZU | c7ffdfe | 2016-05-06 18:38:41 -0700 | [diff] [blame] | 85 | // even if one of the resources is allocated to a consumer, |
| 86 | // all unregistrations are regarded as failure |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 87 | boolean allocated = resources.stream().anyMatch(x -> isAllocated(x.id())); |
Sho SHIMIZU | c7ffdfe | 2016-05-06 18:38:41 -0700 | [diff] [blame] | 88 | if (allocated) { |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 89 | log.warn("Failed to unregister {}: allocation exists", parent); |
Sho SHIMIZU | c7ffdfe | 2016-05-06 18:38:41 -0700 | [diff] [blame] | 90 | return false; |
| 91 | } |
| 92 | |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 93 | DiscreteResources oldValues = childMap.putIfAbsent(parent, DiscreteResources.empty()); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 94 | if (oldValues == null) { |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 95 | log.trace("No-Op removing values. key {} did not exist", parent); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 96 | return true; |
| 97 | } |
| 98 | |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 99 | if (!oldValues.containsAny(resources)) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 100 | // don't write map because none of the values are stored |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 101 | log.trace("No-Op removing values. key {} did not contain {}", parent, resources); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 102 | return true; |
| 103 | } |
| 104 | |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 105 | DiscreteResources requested = DiscreteResources.of(resources); |
Sho SHIMIZU | 7a6cfdd | 2016-06-07 15:38:05 -0700 | [diff] [blame] | 106 | DiscreteResources newValues = oldValues.difference(requested); |
Sho SHIMIZU | 0b4e9dd | 2016-06-28 17:42:05 -0700 | [diff] [blame] | 107 | return childMap.replace(parent, oldValues, newValues); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 108 | } |
| 109 | |
Sho SHIMIZU | d82dc5b | 2016-05-13 13:50:29 -0700 | [diff] [blame] | 110 | private boolean isAllocated(DiscreteResourceId id) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 111 | return consumers.get(id) != null; |
| 112 | } |
| 113 | |
Naoki Shiota | bd1974c | 2016-04-29 18:44:17 -0700 | [diff] [blame] | 114 | boolean allocate(ResourceConsumerId consumerId, DiscreteResource resource) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 115 | // if the resource is not registered, then abort |
Sho SHIMIZU | a81141b | 2016-05-11 08:05:45 -0700 | [diff] [blame] | 116 | Optional<DiscreteResource> lookedUp = lookup(resource.id()); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 117 | if (!lookedUp.isPresent()) { |
| 118 | return false; |
| 119 | } |
| 120 | |
Naoki Shiota | bd1974c | 2016-04-29 18:44:17 -0700 | [diff] [blame] | 121 | ResourceConsumerId oldValue = consumers.put(resource.id(), consumerId); |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 122 | return oldValue == null; |
| 123 | } |
| 124 | |
Naoki Shiota | bd1974c | 2016-04-29 18:44:17 -0700 | [diff] [blame] | 125 | boolean release(DiscreteResource resource, ResourceConsumerId consumerId) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 126 | // if this single release fails (because the resource is allocated to another consumer) |
| 127 | // the whole release fails |
Naoki Shiota | bd1974c | 2016-04-29 18:44:17 -0700 | [diff] [blame] | 128 | if (!consumers.remove(resource.id(), consumerId)) { |
Sho SHIMIZU | 22fb283 | 2016-05-06 11:44:03 -0700 | [diff] [blame] | 129 | return false; |
| 130 | } |
| 131 | |
| 132 | return true; |
| 133 | } |
| 134 | } |