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 InstanceIdentifier<LocalUcastMacs> childIid,
 104                               final LocalUcastMacs localUcastMacs) {
 105         return getElanName(localUcastMacs);
 106     }
 107
 108     @Override
 109     protected void onUpdate(final Map<String, Map<InstanceIdentifier, LocalUcastMacs>> updatedMacsGrouped,
 110                             final Map<String, Map<InstanceIdentifier, LocalUcastMacs>> deletedMacsGrouped) {
 111         updatedMacsGrouped.forEach((key, value) -> value.forEach(this::added));
 112         deletedMacsGrouped.forEach((key, value) -> value.forEach(this::removed));
 113     }
 114
 115     public void removed(final InstanceIdentifier<LocalUcastMacs> identifier, final LocalUcastMacs macRemoved) {
 116         String hwvtepNodeId = identifier.firstKeyOf(Node.class).getNodeId().getValue();
 117         String macAddress = macRemoved.getMacEntryKey().getValue().toLowerCase(Locale.getDefault());
 118
 119         LOG.trace("LocalUcastMacs {} removed from {}", macAddress, hwvtepNodeId);
 120
 121         ResourceBatchingManager.getInstance().delete(ResourceBatchingManager.ShardResource.CONFIG_TOPOLOGY,
 122                 identifier);
 123
 124         String elanName = getElanName(macRemoved);
 125
 126         jobCoordinator.enqueueJob(elanName + HwvtepHAUtil.L2GW_JOB_KEY ,
 127             () -> {
 128                 L2GatewayDevice elanL2GwDevice = ElanL2GwCacheUtils.getL2GatewayDeviceFromCache(elanName,
 129                         hwvtepNodeId);
 130                 if (elanL2GwDevice == null) {
 131                     LOG.warn("Could not find L2GatewayDevice for ELAN: {}, nodeID:{} from cache",
 132                             elanName, hwvtepNodeId);
 133                     return null;
 134                 }
 135
 136                 elanL2GwDevice.removeUcastLocalMac(macRemoved);
 137                 ElanInstance elanInstance = elanInstanceCache.get(elanName).orNull();
 138                 elanL2GatewayUtils.unInstallL2GwUcastMacFromL2gwDevices(elanName, elanL2GwDevice,
 139                         Collections.singletonList(new MacAddress(macAddress.toLowerCase(Locale.getDefault()))));
 140                 elanL2GatewayUtils.unInstallL2GwUcastMacFromElanDpns(elanInstance, elanL2GwDevice,
 141                         Collections.singletonList(new MacAddress(macAddress.toLowerCase(Locale.getDefault()))));
 142                 return null;
 143             });
 144     }
 145
 146     public void added(final InstanceIdentifier<LocalUcastMacs> identifier, final LocalUcastMacs macAdded) {
 147         ResourceBatchingManager.getInstance().put(ResourceBatchingManager.ShardResource.CONFIG_TOPOLOGY,
 148                 identifier, macAdded);
 149
 150         String hwvtepNodeId = identifier.firstKeyOf(Node.class).getNodeId().getValue();
 151         String macAddress = macAdded.getMacEntryKey().getValue().toLowerCase(Locale.getDefault());
 152         String elanName = getElanName(macAdded);
 153
 154         LOG.trace("LocalUcastMacs {} added to {}", macAddress, hwvtepNodeId);
 155
 156         ElanInstance elan = elanInstanceCache.get(elanName).orNull();
 157         if (elan == null) {
 158             LOG.warn("Could not find ELAN for mac {} being added", macAddress);
 159             return;
 160         }
 161         jobCoordinator.enqueueJob(elanName + HwvtepHAUtil.L2GW_JOB_KEY,
 162             () -> {
 163                 L2GatewayDevice elanL2GwDevice =
 164                         ElanL2GwCacheUtils.getL2GatewayDeviceFromCache(elanName, hwvtepNodeId);
 165                 if (elanL2GwDevice == null) {
 166                     LOG.warn("Could not find L2GatewayDevice for ELAN: {}, nodeID:{} from cache",
 167                             elanName, hwvtepNodeId);
 168                     return null;
 169                 }
 170
 171                 elanL2GwDevice.addUcastLocalMac(macAdded);
 172                 elanL2GatewayUtils.installL2GwUcastMacInElan(elan, elanL2GwDevice,
 173                         macAddress.toLowerCase(), macAdded, null);
 174                 return null;
 175             });
 176     }
 177
 178     @Override
 179     protected Map<InstanceIdentifier<LocalUcastMacs>, DataObjectModification<LocalUcastMacs>> getChildMod(
 180             final InstanceIdentifier<Node> parentIid,
 181             final DataObjectModification<Node> mod) {
 182
 183         Map<InstanceIdentifier<LocalUcastMacs>, DataObjectModification<LocalUcastMacs>> result = new HashMap<>();
 184         DataObjectModification<HwvtepGlobalAugmentation> aug = mod.getModifiedAugmentation(
 185                 HwvtepGlobalAugmentation.class);
 186         if (aug != null && getModificationType(aug) != null) {
 187             Collection<DataObjectModification<? extends DataObject>> children = aug.getModifiedChildren();
 188             children.stream()
 189                 .filter(childMod -> getModificationType(childMod) != null)
 190                 .filter(childMod -> childMod.getDataType() == LocalUcastMacs.class)
 191                 .forEach(childMod -> {
 192                     LocalUcastMacs afterMac = (LocalUcastMacs) childMod.getDataAfter();
 193                     LocalUcastMacs mac = afterMac != null ? afterMac : (LocalUcastMacs)childMod.getDataBefore();
 194                     InstanceIdentifier<LocalUcastMacs> iid = parentIid
 195                         .augmentation(HwvtepGlobalAugmentation.class)
 196                         .child(LocalUcastMacs.class, mac.getKey());
 197                     result.put(iid, (DataObjectModification<LocalUcastMacs>) childMod);
 198                 });
 199         }
 200         return result;
 201     }
 202
 203     @Override
 204     protected void onParentAdded(final DataTreeModification<Node> modification) {
 205         InstanceIdentifier<Node> nodeIid = modification.getRootPath().getRootIdentifier();
 206         if (IS_PS_NODE_IID.test(nodeIid)) {
 207             return;
 208         }
 209         ListenableFutures.addErrorLogging(txRunner.callWithNewReadWriteTransactionAndSubmit(tx -> {
 210             haOpClusteredListener.onGlobalNodeAdd(nodeIid, modification.getRootNode().getDataAfter(), tx);
 211             if (!IS_HA_CHILD.test(nodeIid)) {
 212                 LOG.trace("On parent add {}", nodeIid);
 213                 Node operNode = modification.getRootNode().getDataAfter();
 214                 Set<LocalUcastMacs> configMacs =
 215                         getMacs(tx.read(LogicalDatastoreType.CONFIGURATION, nodeIid).checkedGet().orNull());
 216                 Set<LocalUcastMacs> operMacs = getMacs(operNode);
 217                 Set<LocalUcastMacs> staleMacs = Sets.difference(configMacs, operMacs);
 218                 staleMacs.forEach(staleMac -> removed(getMacIid(nodeIid, staleMac), staleMac));
 219             }
 220         }), LOG, "Error processing added parent");
 221     }
 222
 223     InstanceIdentifier<LocalUcastMacs> getMacIid(InstanceIdentifier<Node> nodeIid, LocalUcastMacs mac) {
 224         return nodeIid.augmentation(HwvtepGlobalAugmentation.class)
 225                 .child(LocalUcastMacs.class, mac.getKey());
 226     }
 227
 228     private Set<LocalUcastMacs> getMacs(@Nullable Node node) {
 229         if (node != null) {
 230             HwvtepGlobalAugmentation augmentation = node.getAugmentation(HwvtepGlobalAugmentation.class);
 231             if (augmentation != null && augmentation.getLocalUcastMacs() != null) {
 232                 return new HashSet<>(augmentation.getLocalUcastMacs());
 233             }
 234         }
 235         return Collections.emptySet();
 236     }
 237
 238     @Override
 239     protected void onParentRemoved(InstanceIdentifier<Node> parent) {
 240         if (IS_PS_NODE_IID.test(parent)) {
 241             return;
 242         }
 243         LOG.trace("on parent removed {}", parent);
 244     }
 245
 246     @Override
 247     protected InstanceIdentifier<Node> getParentWildCardPath() {
 248         return HwvtepSouthboundUtils.createHwvtepTopologyInstanceIdentifier()
 249                 .child(Node.class);
 250     }
 251 }