| /* |
| * Copyright 2015-present Open Networking Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.store.host.impl; |
| |
| import com.google.common.cache.Cache; |
| import com.google.common.cache.CacheBuilder; |
| import com.google.common.cache.RemovalNotification; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.common.collect.Sets; |
| |
| import org.apache.felix.scr.annotations.Activate; |
| import org.apache.felix.scr.annotations.Component; |
| import org.apache.felix.scr.annotations.Deactivate; |
| import org.apache.felix.scr.annotations.Reference; |
| import org.apache.felix.scr.annotations.ReferenceCardinality; |
| import org.apache.felix.scr.annotations.Service; |
| import org.onlab.packet.IpAddress; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.VlanId; |
| import org.onlab.util.KryoNamespace; |
| import org.onosproject.net.Annotations; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.DefaultAnnotations; |
| import org.onosproject.net.DefaultHost; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.Host; |
| import org.onosproject.net.HostId; |
| import org.onosproject.net.HostLocation; |
| import org.onosproject.net.host.HostDescription; |
| import org.onosproject.net.host.HostEvent; |
| import org.onosproject.net.host.HostStore; |
| import org.onosproject.net.host.HostStoreDelegate; |
| import org.onosproject.net.provider.ProviderId; |
| import org.onosproject.store.AbstractStore; |
| import org.onosproject.store.serializers.KryoNamespaces; |
| import org.onosproject.store.service.ConsistentMap; |
| import org.onosproject.store.service.MapEvent; |
| import org.onosproject.store.service.MapEventListener; |
| import org.onosproject.store.service.Serializer; |
| import org.onosproject.store.service.StorageService; |
| import org.onosproject.store.service.DistributedPrimitive.Status; |
| import org.onosproject.store.service.Versioned; |
| import org.slf4j.Logger; |
| |
| import java.util.Collection; |
| import java.util.HashSet; |
| import java.util.Iterator; |
| import java.util.Map; |
| import java.util.Objects; |
| import java.util.Set; |
| import java.util.concurrent.ConcurrentHashMap; |
| import java.util.concurrent.Executor; |
| import java.util.concurrent.Executors; |
| import java.util.concurrent.ScheduledExecutorService; |
| import java.util.concurrent.TimeUnit; |
| import java.util.function.Consumer; |
| import java.util.function.Predicate; |
| import java.util.stream.Collectors; |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static com.google.common.base.Preconditions.checkState; |
| import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| import static org.onlab.util.Tools.groupedThreads; |
| import static org.onosproject.net.DefaultAnnotations.merge; |
| import static org.onosproject.net.host.HostEvent.Type.*; |
| import static org.slf4j.LoggerFactory.getLogger; |
| |
| /** |
| * Manages the inventory of hosts using a {@code EventuallyConsistentMap}. |
| */ |
| @Component(immediate = true) |
| @Service |
| public class DistributedHostStore |
| extends AbstractStore<HostEvent, HostStoreDelegate> |
| implements HostStore { |
| |
| private final Logger log = getLogger(getClass()); |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected StorageService storageService; |
| |
| private ConsistentMap<HostId, DefaultHost> hostsConsistentMap; |
| private Map<HostId, DefaultHost> hosts; |
| private Map<IpAddress, Set<Host>> hostsByIp; |
| private MapEventListener<HostId, DefaultHost> hostLocationTracker = |
| new HostLocationTracker(); |
| |
| private ConsistentMap<MacAddress, PendingHostLocation> pendingHostsConsistentMap; |
| private Map<MacAddress, PendingHostLocation> pendingHosts; |
| private MapEventListener<MacAddress, PendingHostLocation> pendingHostListener = |
| new PendingHostListener(); |
| |
| private ScheduledExecutorService executor; |
| |
| private Consumer<Status> statusChangeListener; |
| |
| // TODO make this configurable |
| private static final int PROBE_TIMEOUT_MS = 3000; |
| |
| private Cache<MacAddress, PendingHostLocation> pendingHostsCache = CacheBuilder.newBuilder() |
| .expireAfterWrite(PROBE_TIMEOUT_MS, TimeUnit.MILLISECONDS) |
| .removalListener((RemovalNotification<MacAddress, PendingHostLocation> notification) -> { |
| switch (notification.getCause()) { |
| case EXPIRED: |
| PendingHostLocation expired = notification.getValue(); |
| if (expired != null) { |
| if (timeoutPendingHostLocation(notification.getKey())) { |
| log.info("Evict {} from pendingHosts due to probe timeout", notification.getValue()); |
| } |
| } |
| break; |
| case EXPLICIT: |
| break; |
| default: |
| log.warn("Remove {} from pendingHostLocations for unexpected reason {}", |
| notification.getKey(), notification.getCause()); |
| } |
| }).build(); |
| |
| private ScheduledExecutorService cacheCleaner = Executors.newSingleThreadScheduledExecutor(); |
| |
| @Activate |
| public void activate() { |
| KryoNamespace.Builder hostSerializer = KryoNamespace.newBuilder() |
| .register(KryoNamespaces.API); |
| hostsConsistentMap = storageService.<HostId, DefaultHost>consistentMapBuilder() |
| .withName("onos-hosts") |
| .withRelaxedReadConsistency() |
| .withSerializer(Serializer.using(hostSerializer.build())) |
| .build(); |
| hostsConsistentMap.addListener(hostLocationTracker); |
| hosts = hostsConsistentMap.asJavaMap(); |
| |
| KryoNamespace.Builder pendingHostSerializer = KryoNamespace.newBuilder() |
| .register(KryoNamespaces.API) |
| .register(PendingHostLocation.class); |
| pendingHostsConsistentMap = storageService.<MacAddress, PendingHostLocation>consistentMapBuilder() |
| .withName("onos-hosts-pending") |
| .withRelaxedReadConsistency() |
| .withSerializer(Serializer.using(pendingHostSerializer.build())) |
| .build(); |
| pendingHostsConsistentMap.addListener(pendingHostListener); |
| pendingHosts = pendingHostsConsistentMap.asJavaMap(); |
| |
| cacheCleaner.scheduleAtFixedRate(pendingHostsCache::cleanUp, 0, |
| PROBE_TIMEOUT_MS, TimeUnit.MILLISECONDS); |
| |
| executor = newSingleThreadScheduledExecutor(groupedThreads("onos/hosts", "store", log)); |
| statusChangeListener = status -> { |
| if (status == Status.ACTIVE) { |
| executor.execute(this::loadHostsByIp); |
| } |
| }; |
| hostsConsistentMap.addStatusChangeListener(statusChangeListener); |
| loadHostsByIp(); |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| hostsConsistentMap.removeListener(hostLocationTracker); |
| |
| cacheCleaner.shutdown(); |
| |
| log.info("Stopped"); |
| } |
| |
| private void loadHostsByIp() { |
| hostsByIp = new ConcurrentHashMap<IpAddress, Set<Host>>(); |
| hostsConsistentMap.asJavaMap().values().forEach(host -> { |
| host.ipAddresses().forEach(ip -> { |
| Set<Host> existingHosts = hostsByIp.get(ip); |
| if (existingHosts == null) { |
| hostsByIp.put(ip, addHosts(host)); |
| } else { |
| existingHosts.add(host); |
| } |
| }); |
| }); |
| } |
| |
| private boolean shouldUpdate(DefaultHost existingHost, |
| ProviderId providerId, |
| HostDescription hostDescription, |
| boolean replaceIPs) { |
| if (existingHost == null) { |
| return true; |
| } |
| |
| // Avoid overriding configured host with learnt host |
| if (existingHost.configured() && !hostDescription.configured()) { |
| return false; |
| } |
| |
| if (!Objects.equals(existingHost.providerId(), providerId) || |
| !Objects.equals(existingHost.mac(), hostDescription.hwAddress()) || |
| !Objects.equals(existingHost.vlan(), hostDescription.vlan()) || |
| !Objects.equals(existingHost.locations(), hostDescription.locations())) { |
| return true; |
| } |
| |
| if (replaceIPs) { |
| if (!Objects.equals(hostDescription.ipAddress(), |
| existingHost.ipAddresses())) { |
| return true; |
| } |
| } else { |
| if (!existingHost.ipAddresses().containsAll(hostDescription.ipAddress())) { |
| return true; |
| } |
| } |
| |
| // check to see if any of the annotations provided by hostDescription |
| // differ from those in the existing host |
| return hostDescription.annotations().keys().stream() |
| .anyMatch(k -> !Objects.equals(hostDescription.annotations().value(k), |
| existingHost.annotations().value(k))); |
| |
| |
| } |
| |
| // TODO No longer need to return HostEvent |
| @Override |
| public HostEvent createOrUpdateHost(ProviderId providerId, |
| HostId hostId, |
| HostDescription hostDescription, |
| boolean replaceIPs) { |
| hostsConsistentMap.computeIf(hostId, |
| existingHost -> shouldUpdate(existingHost, providerId, |
| hostDescription, replaceIPs), |
| (id, existingHost) -> { |
| |
| final Set<IpAddress> addresses; |
| if (existingHost == null || replaceIPs) { |
| addresses = ImmutableSet.copyOf(hostDescription.ipAddress()); |
| } else { |
| addresses = Sets.newHashSet(existingHost.ipAddresses()); |
| addresses.addAll(hostDescription.ipAddress()); |
| } |
| |
| final Annotations annotations; |
| if (existingHost != null) { |
| annotations = merge((DefaultAnnotations) existingHost.annotations(), |
| hostDescription.annotations()); |
| } else { |
| annotations = hostDescription.annotations(); |
| } |
| |
| return new DefaultHost(providerId, |
| hostId, |
| hostDescription.hwAddress(), |
| hostDescription.vlan(), |
| hostDescription.locations(), |
| addresses, |
| hostDescription.configured(), |
| annotations); |
| }); |
| return null; |
| } |
| |
| // TODO No longer need to return HostEvent |
| @Override |
| public HostEvent removeHost(HostId hostId) { |
| hosts.remove(hostId); |
| return null; |
| } |
| |
| // TODO No longer need to return HostEvent |
| @Override |
| public HostEvent removeIp(HostId hostId, IpAddress ipAddress) { |
| hosts.compute(hostId, (id, existingHost) -> { |
| if (existingHost != null) { |
| checkState(Objects.equals(hostId.mac(), existingHost.mac()), |
| "Existing and new MAC addresses differ."); |
| checkState(Objects.equals(hostId.vlanId(), existingHost.vlan()), |
| "Existing and new VLANs differ."); |
| |
| Set<IpAddress> addresses = existingHost.ipAddresses(); |
| if (addresses != null && addresses.contains(ipAddress)) { |
| addresses = new HashSet<>(existingHost.ipAddresses()); |
| addresses.remove(ipAddress); |
| removeIpFromHostsByIp(existingHost, ipAddress); |
| return new DefaultHost(existingHost.providerId(), |
| hostId, |
| existingHost.mac(), |
| existingHost.vlan(), |
| existingHost.locations(), |
| ImmutableSet.copyOf(addresses), |
| existingHost.configured(), |
| existingHost.annotations()); |
| } else { |
| return existingHost; |
| } |
| } |
| return null; |
| }); |
| return null; |
| } |
| |
| @Override |
| public void removeLocation(HostId hostId, HostLocation location) { |
| hosts.compute(hostId, (id, existingHost) -> { |
| if (existingHost != null) { |
| checkState(Objects.equals(hostId.mac(), existingHost.mac()), |
| "Existing and new MAC addresses differ."); |
| checkState(Objects.equals(hostId.vlanId(), existingHost.vlan()), |
| "Existing and new VLANs differ."); |
| |
| Set<HostLocation> locations = new HashSet<>(existingHost.locations()); |
| locations.remove(location); |
| |
| // Remove entire host if we are removing the last location |
| return locations.isEmpty() ? null : |
| new DefaultHost(existingHost.providerId(), |
| hostId, existingHost.mac(), existingHost.vlan(), |
| locations, existingHost.ipAddresses(), |
| existingHost.configured(), existingHost.annotations()); |
| } |
| return null; |
| }); |
| } |
| |
| @Override |
| public int getHostCount() { |
| return hosts.size(); |
| } |
| |
| @Override |
| public Iterable<Host> getHosts() { |
| return ImmutableSet.copyOf(hosts.values()); |
| } |
| |
| @Override |
| public Host getHost(HostId hostId) { |
| return hosts.get(hostId); |
| } |
| |
| @Override |
| public Set<Host> getHosts(VlanId vlanId) { |
| return filter(hosts.values(), host -> Objects.equals(host.vlan(), vlanId)); |
| } |
| |
| @Override |
| public Set<Host> getHosts(MacAddress mac) { |
| return filter(hosts.values(), host -> Objects.equals(host.mac(), mac)); |
| } |
| |
| @Override |
| public Set<Host> getHosts(IpAddress ip) { |
| Set<Host> hosts = hostsByIp.get(ip); |
| return hosts != null ? ImmutableSet.copyOf(hosts) : ImmutableSet.of(); |
| } |
| |
| @Override |
| public Set<Host> getConnectedHosts(ConnectPoint connectPoint) { |
| Set<Host> filtered = hosts.entrySet().stream() |
| .filter(entry -> entry.getValue().locations().contains(connectPoint)) |
| .map(Map.Entry::getValue) |
| .collect(Collectors.toSet()); |
| return ImmutableSet.copyOf(filtered); |
| } |
| |
| @Override |
| public Set<Host> getConnectedHosts(DeviceId deviceId) { |
| Set<Host> filtered = hosts.entrySet().stream() |
| .filter(entry -> entry.getValue().locations().stream() |
| .map(HostLocation::deviceId).anyMatch(dpid -> dpid.equals(deviceId))) |
| .map(Map.Entry::getValue) |
| .collect(Collectors.toSet()); |
| return ImmutableSet.copyOf(filtered); |
| } |
| |
| @Override |
| public MacAddress addPendingHostLocation(HostId hostId, HostLocation hostLocation) { |
| // Use ONLab OUI (3 bytes) + atomic counter (3 bytes) as the source MAC of the probe |
| long nextIndex = storageService.getAtomicCounter("onos-hosts-probe-index").getAndIncrement(); |
| MacAddress probeMac = MacAddress.valueOf(MacAddress.NONE.toLong() + nextIndex); |
| PendingHostLocation phl = new PendingHostLocation(hostId, hostLocation); |
| |
| pendingHostsCache.put(probeMac, phl); |
| pendingHosts.put(probeMac, phl); |
| |
| return probeMac; |
| } |
| |
| @Override |
| public void removePendingHostLocation(MacAddress probeMac) { |
| pendingHostsCache.invalidate(probeMac); |
| pendingHosts.remove(probeMac); |
| } |
| |
| private boolean timeoutPendingHostLocation(MacAddress probeMac) { |
| PendingHostLocation phl = pendingHosts.computeIfPresent(probeMac, (k, v) -> { |
| v.setExpired(true); |
| return v; |
| }); |
| return phl != null; |
| } |
| |
| private Set<Host> filter(Collection<DefaultHost> collection, Predicate<DefaultHost> predicate) { |
| return collection.stream().filter(predicate).collect(Collectors.toSet()); |
| } |
| |
| private Set<Host> addHosts(Host host) { |
| Set<Host> hosts = Sets.newConcurrentHashSet(); |
| hosts.add(host); |
| return hosts; |
| } |
| |
| private Set<Host> updateHosts(Set<Host> existingHosts, Host host) { |
| Iterator<Host> iterator = existingHosts.iterator(); |
| while (iterator.hasNext()) { |
| Host existingHost = iterator.next(); |
| if (existingHost.id().equals(host.id())) { |
| iterator.remove(); |
| } |
| } |
| existingHosts.add(host); |
| return existingHosts; |
| } |
| |
| private Set<Host> removeHosts(Set<Host> existingHosts, Host host) { |
| if (existingHosts != null) { |
| Iterator<Host> iterator = existingHosts.iterator(); |
| while (iterator.hasNext()) { |
| Host existingHost = iterator.next(); |
| if (existingHost.id().equals(host.id())) { |
| iterator.remove(); |
| } |
| } |
| } |
| |
| if (existingHosts.isEmpty()) { |
| return null; |
| } |
| return existingHosts; |
| } |
| |
| private void updateHostsByIp(DefaultHost host) { |
| host.ipAddresses().forEach(ip -> { |
| hostsByIp.compute(ip, (k, v) -> v == null ? addHosts(host) |
| : updateHosts(v, host)); |
| }); |
| } |
| |
| private void removeHostsByIp(DefaultHost host) { |
| host.ipAddresses().forEach(ip -> { |
| hostsByIp.computeIfPresent(ip, (k, v) -> removeHosts(v, host)); |
| }); |
| } |
| |
| private void removeIpFromHostsByIp(DefaultHost host, IpAddress ip) { |
| hostsByIp.computeIfPresent(ip, (k, v) -> removeHosts(v, host)); |
| } |
| |
| private class HostLocationTracker implements MapEventListener<HostId, DefaultHost> { |
| @Override |
| public void event(MapEvent<HostId, DefaultHost> event) { |
| DefaultHost host = checkNotNull(event.value().value()); |
| switch (event.type()) { |
| case INSERT: |
| updateHostsByIp(host); |
| notifyDelegate(new HostEvent(HOST_ADDED, host)); |
| break; |
| case UPDATE: |
| updateHostsByIp(host); |
| DefaultHost prevHost = checkNotNull(event.oldValue().value()); |
| if (!Objects.equals(prevHost.locations(), host.locations())) { |
| notifyDelegate(new HostEvent(HOST_MOVED, host, prevHost)); |
| } else if (!Objects.equals(prevHost, host)) { |
| notifyDelegate(new HostEvent(HOST_UPDATED, host, prevHost)); |
| } |
| break; |
| case REMOVE: |
| removeHostsByIp(host); |
| notifyDelegate(new HostEvent(HOST_REMOVED, host)); |
| break; |
| default: |
| log.warn("Unknown map event type: {}", event.type()); |
| } |
| } |
| } |
| |
| private class PendingHostListener implements MapEventListener<MacAddress, PendingHostLocation> { |
| @Override |
| public void event(MapEvent<MacAddress, PendingHostLocation> event) { |
| Versioned<PendingHostLocation> newValue = event.newValue(); |
| switch (event.type()) { |
| case INSERT: |
| break; |
| case UPDATE: |
| if (newValue.value().expired()) { |
| Executor locationRemover = Executors.newSingleThreadScheduledExecutor(); |
| locationRemover.execute(() -> { |
| pendingHosts.remove(event.key()); |
| removeLocation(newValue.value().hostId(), newValue.value().location()); |
| }); |
| } |
| break; |
| case REMOVE: |
| break; |
| default: |
| log.warn("Unknown map event type: {}", event.type()); |
| } |
| } |
| } |
| } |