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