elanmanager/impl/src/main/java/org/opendaylight/netvirt/elan/l2gw/listeners/LocalUcastMacListener.java

   1 /*
   2  * Copyright © 2017 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netvirt.elan.l2gw.listeners;
   9
  10 import com.google.common.collect.Sets;
  11 import java.util.Collection;
  12 import java.util.Collections;
  13 import java.util.HashMap;
  14 import java.util.HashSet;
  15 import java.util.Locale;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.function.Predicate;
  19 import javax.annotation.Nullable;
  20 import javax.annotation.PostConstruct;
  21 import javax.inject.Inject;
  22 import javax.inject.Singleton;
  23 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  25 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  26 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  29 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  30 import org.opendaylight.genius.utils.batching.ResourceBatchingManager;
  31 import org.opendaylight.genius.utils.hwvtep.HwvtepHACache;
  32 import org.opendaylight.genius.utils.hwvtep.HwvtepSouthboundUtils;
  33 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  34 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
  35 import org.opendaylight.netvirt.elan.cache.ElanInstanceCache;
  36 import org.opendaylight.netvirt.elan.l2gw.ha.HwvtepHAUtil;
  37 import org.opendaylight.netvirt.elan.l2gw.ha.listeners.HAOpClusteredListener;
  38 import org.opendaylight.netvirt.elan.l2gw.utils.ElanL2GatewayUtils;
  39 import org.opendaylight.netvirt.elanmanager.utils.ElanL2GwCacheUtils;
  40 import org.opendaylight.netvirt.neutronvpn.api.l2gw.L2GatewayDevice;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalUcastMacs;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  47 import org.opendaylight.yangtools.yang.binding.DataObject;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49
  50 @Singleton
  51 public class LocalUcastMacListener extends ChildListener<Node, LocalUcastMacs, String>
  52         implements ClusteredDataTreeChangeListener<Node> {
  53
  54     public static final String NODE_CHECK = "physical";
  55
  56     private static final Predicate<InstanceIdentifier<Node>> IS_PS_NODE_IID =
  57         (iid) -> iid.firstKeyOf(Node.class).getNodeId().getValue().contains(NODE_CHECK);
  58
  59     private static final Predicate<InstanceIdentifier<Node>> IS_NOT_HA_CHILD =
  60         (iid) -> !HwvtepHACache.getInstance().isHAEnabledDevice(iid)
  61                 && !iid.firstKeyOf(Node.class).getNodeId().getValue().contains(HwvtepHAUtil.PHYSICALSWITCH);
  62
  63     private static final Predicate<InstanceIdentifier<Node>> IS_HA_CHILD =
  64         (iid) -> HwvtepHACache.getInstance().isHAEnabledDevice(iid);
  65
  66     private final ManagedNewTransactionRunner txRunner;
  67     private final ElanL2GatewayUtils elanL2GatewayUtils;
  68     private final HAOpClusteredListener haOpClusteredListener;
  69     private final JobCoordinator jobCoordinator;
  70     private final ElanInstanceCache elanInstanceCache;
  71
  72     @Inject
  73     public LocalUcastMacListener(final DataBroker dataBroker,
  74                                  final HAOpClusteredListener haOpClusteredListener,
  75                                  final ElanL2GatewayUtils elanL2GatewayUtils,
  76                                  final JobCoordinator jobCoordinator,
  77                                  final ElanInstanceCache elanInstanceCache) {
  78         super(dataBroker, false);
  79         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
  80         this.elanL2GatewayUtils = elanL2GatewayUtils;
  81         this.haOpClusteredListener = haOpClusteredListener;
  82         this.jobCoordinator = jobCoordinator;
  83         this.elanInstanceCache = elanInstanceCache;
  84     }
  85
  86     @Override
  87     @PostConstruct
  88     public void init() throws Exception {
  89         ResourceBatchingManager.getInstance().registerDefaultBatchHandlers(this.dataBroker);
  90         super.init();
  91     }
  92
  93     @Override
  94     protected boolean proceed(final InstanceIdentifier<Node> parent) {
  95         return IS_NOT_HA_CHILD.test(parent);
  96     }
  97
  98     protected String getElanName(final LocalUcastMacs mac) {
  99         return mac.getLogicalSwitchRef().getValue().firstKeyOf(LogicalSwitches.class).getHwvtepNodeName().getValue();
 100     }
 101
 102     @Override
 103     protected String getGroup(final LocalUcastMacs localUcastMacs) {
 104         return getElanName(localUcastMacs);
 105     }
 106
 107     @Override
 108     protected void onUpdate(final Map<String, Map<InstanceIdentifier, LocalUcastMacs>> updatedMacsGrouped,
 109                             final Map<String, Map<InstanceIdentifier, LocalUcastMacs>> deletedMacsGrouped) {
 110         updatedMacsGrouped.forEach((key, value) -> value.forEach(this::added));
 111         deletedMacsGrouped.forEach((key, value) -> value.forEach(this::removed));
 112     }
 113
 114     public void removed(final InstanceIdentifier<LocalUcastMacs> identifier, final LocalUcastMacs macRemoved) {
 115         String hwvtepNodeId = identifier.firstKeyOf(Node.class).getNodeId().getValue();
 116         String macAddress = macRemoved.getMacEntryKey().getValue().toLowerCase(Locale.getDefault());
 117
 118         LOG.trace("LocalUcastMacs {} removed from {}", macAddress, hwvtepNodeId);
 119
 120         ResourceBatchingManager.getInstance().delete(ResourceBatchingManager.ShardResource.CONFIG_TOPOLOGY,
 121                 identifier);
 122
 123         String elanName = getElanName(macRemoved);
 124
 125         jobCoordinator.enqueueJob(elanName + HwvtepHAUtil.L2GW_JOB_KEY ,
 126             () -> {
 127                 L2GatewayDevice elanL2GwDevice = ElanL2GwCacheUtils.getL2GatewayDeviceFromCache(elanName,
 128                         hwvtepNodeId);
 129                 if (elanL2GwDevice == null) {
 130                     LOG.warn("Could not find L2GatewayDevice for ELAN: {}, nodeID:{} from cache",
 131                             elanName, hwvtepNodeId);
 132                     return null;
 133                 }
 134
 135                 elanL2GwDevice.removeUcastLocalMac(macRemoved);
 136                 ElanInstance elanInstance = elanInstanceCache.get(elanName).orNull();
 137                 elanL2GatewayUtils.unInstallL2GwUcastMacFromL2gwDevices(elanName, elanL2GwDevice,
 138                         Collections.singletonList(new MacAddress(macAddress.toLowerCase(Locale.getDefault()))));
 139                 elanL2GatewayUtils.unInstallL2GwUcastMacFromElanDpns(elanInstance, elanL2GwDevice,
 140                         Collections.singletonList(new MacAddress(macAddress.toLowerCase(Locale.getDefault()))));
 141                 return null;
 142             });
 143     }
 144
 145     public void added(final InstanceIdentifier<LocalUcastMacs> identifier, final LocalUcastMacs macAdded) {
 146         ResourceBatchingManager.getInstance().put(ResourceBatchingManager.ShardResource.CONFIG_TOPOLOGY,
 147                 identifier, macAdded);
 148
 149         String hwvtepNodeId = identifier.firstKeyOf(Node.class).getNodeId().getValue();
 150         String macAddress = macAdded.getMacEntryKey().getValue().toLowerCase(Locale.getDefault());
 151         String elanName = getElanName(macAdded);
 152
 153         LOG.trace("LocalUcastMacs {} added to {}", macAddress, hwvtepNodeId);
 154
 155         ElanInstance elan = elanInstanceCache.get(elanName).orNull();
 156         if (elan == null) {
 157             LOG.warn("Could not find ELAN for mac {} being added", macAddress);
 158             return;
 159         }
 160         jobCoordinator.enqueueJob(elanName + HwvtepHAUtil.L2GW_JOB_KEY,
 161             () -> {
 162                 L2GatewayDevice elanL2GwDevice =
 163                         ElanL2GwCacheUtils.getL2GatewayDeviceFromCache(elanName, hwvtepNodeId);
 164                 if (elanL2GwDevice == null) {
 165                     LOG.warn("Could not find L2GatewayDevice for ELAN: {}, nodeID:{} from cache",
 166                             elanName, hwvtepNodeId);
 167                     return null;
 168                 }
 169
 170                 elanL2GwDevice.addUcastLocalMac(macAdded);
 171                 elanL2GatewayUtils.installL2GwUcastMacInElan(elan, elanL2GwDevice,
 172                         macAddress.toLowerCase(), macAdded, null);
 173                 return null;
 174             });
 175     }
 176
 177     @Override
 178     protected Map<InstanceIdentifier<LocalUcastMacs>, DataObjectModification<LocalUcastMacs>> getChildMod(
 179             final InstanceIdentifier<Node> parentIid,
 180             final DataObjectModification<Node> mod) {
 181
 182         Map<InstanceIdentifier<LocalUcastMacs>, DataObjectModification<LocalUcastMacs>> result = new HashMap<>();
 183         DataObjectModification<HwvtepGlobalAugmentation> aug = mod.getModifiedAugmentation(
 184                 HwvtepGlobalAugmentation.class);
 185         if (aug != null && getModificationType(aug) != null) {
 186             Collection<DataObjectModification<? extends DataObject>> children = aug.getModifiedChildren();
 187             children.stream()
 188                 .filter(childMod -> getModificationType(childMod) != null)
 189                 .filter(childMod -> childMod.getDataType() == LocalUcastMacs.class)
 190                 .forEach(childMod -> {
 191                     LocalUcastMacs afterMac = (LocalUcastMacs) childMod.getDataAfter();
 192                     LocalUcastMacs mac = afterMac != null ? afterMac : (LocalUcastMacs)childMod.getDataBefore();
 193                     InstanceIdentifier<LocalUcastMacs> iid = parentIid
 194                         .augmentation(HwvtepGlobalAugmentation.class)
 195                         .child(LocalUcastMacs.class, mac.getKey());
 196                     result.put(iid, (DataObjectModification<LocalUcastMacs>) childMod);
 197                 });
 198         }
 199         return result;
 200     }
 201
 202     @Override
 203     protected void onParentAdded(final DataTreeModification<Node> modification) {
 204         InstanceIdentifier<Node> nodeIid = modification.getRootPath().getRootIdentifier();
 205         if (IS_PS_NODE_IID.test(nodeIid)) {
 206             return;
 207         }
 208         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(tx -> {
 209             haOpClusteredListener.onGlobalNodeAdd(nodeIid, modification.getRootNode().getDataAfter(), tx);
 210             if (!IS_HA_CHILD.test(nodeIid)) {
 211                 LOG.trace("On parent add {}", nodeIid);
 212                 Node operNode = modification.getRootNode().getDataAfter();
 213                 Set<LocalUcastMacs> configMacs =
 214                         getMacs(tx.read(LogicalDatastoreType.CONFIGURATION, nodeIid).checkedGet().orNull());
 215                 Set<LocalUcastMacs> operMacs = getMacs(operNode);
 216                 Set<LocalUcastMacs> staleMacs = Sets.difference(configMacs, operMacs);
 217                 staleMacs.forEach(staleMac -> removed(getMacIid(nodeIid, staleMac), staleMac));
 218             }
 219         }), LOG, "Error processing added parent");
 220     }
 221
 222     InstanceIdentifier<LocalUcastMacs> getMacIid(InstanceIdentifier<Node> nodeIid, LocalUcastMacs mac) {
 223         return nodeIid.augmentation(HwvtepGlobalAugmentation.class)
 224                 .child(LocalUcastMacs.class, mac.getKey());
 225     }
 226
 227     private Set<LocalUcastMacs> getMacs(@Nullable Node node) {
 228         if (node != null) {
 229             HwvtepGlobalAugmentation augmentation = node.getAugmentation(HwvtepGlobalAugmentation.class);
 230             if (augmentation != null && augmentation.getLocalUcastMacs() != null) {
 231                 return new HashSet<>(augmentation.getLocalUcastMacs());
 232             }
 233         }
 234         return Collections.emptySet();
 235     }
 236
 237     @Override
 238     protected void onParentRemoved(InstanceIdentifier<Node> parent) {
 239         if (IS_PS_NODE_IID.test(parent)) {
 240             return;
 241         }
 242         LOG.trace("on parent removed {}", parent);
 243     }
 244
 245     @Override
 246     protected InstanceIdentifier<Node> getParentWildCardPath() {
 247         return HwvtepSouthboundUtils.createHwvtepTopologyInstanceIdentifier()
 248                 .child(Node.class);
 249     }
 250 }