elanmanager/impl/src/main/java/org/opendaylight/netvirt/elan/l2gw/ha/commands/MergeCommand.java

   1 /*
   2  * Copyright (c) 2016, 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.ha.commands;
   9
  10 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.OPERATIONAL;
  11 import static org.opendaylight.netvirt.elan.l2gw.ha.HwvtepHAUtil.isEmptyList;
  12
  13 import java.io.Serializable;
  14 import java.util.ArrayList;
  15 import java.util.Collections;
  16 import java.util.Comparator;
  17 import java.util.List;
  18 import java.util.Objects;
  19 import java.util.stream.Collectors;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.netvirt.elan.l2gw.ha.HwvtepHAUtil;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.locator.set.attributes.LocatorSet;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  30 import org.opendaylight.yangtools.concepts.Builder;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.binding.Identifier;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37
  38
  39
  40 public abstract class MergeCommand<T extends DataObject, Y extends Builder, Z extends DataObject>
  41         extends BaseCommand<T> implements IMergeCommand<T, Y, Z> {
  42
  43     private static final Logger LOG = LoggerFactory.getLogger(MergeCommand.class);
  44
  45     public List<T> transformOpData(List<T> existingData, List<T> src, InstanceIdentifier<Node> nodePath) {
  46         if (isEmptyList(src)) {
  47             return new ArrayList<>();
  48         }
  49         List<T> added = diffOf(src, existingData);//do not add existing data again
  50         return transform(nodePath, added);
  51     }
  52
  53     public List<T> transformConfigData(List<T> updatedSrc, InstanceIdentifier<Node> nodePath) {
  54         if (isEmptyList(updatedSrc)) {
  55             return new ArrayList<>();//what difference returning null makes ?
  56         }
  57         return transform(nodePath, updatedSrc);
  58     }
  59
  60     @NonNull
  61     public List<T> diffByKey(List<T> updated, final List<T> original) {
  62         if (updated == null) {
  63             return new ArrayList<>();
  64         }
  65         if (original == null) {
  66             return new ArrayList<>(updated);
  67         }
  68
  69         List<T> result = new ArrayList<>();
  70         for (T ele : updated) {
  71             boolean present = false;
  72             for (T orig : original) {
  73                 if (Objects.equals(getKey(ele), getKey(orig))) {
  74                     present = true;
  75                     break;
  76                 }
  77             }
  78             if (!present) {
  79                 result.add(ele);
  80             }
  81         }
  82         return result;
  83     }
  84
  85     //TODO validate the perf of the following against direct setting of the data in dst node
  86     public void transformUpdate(List<T> existing,
  87                                 List<T> updated,
  88                                 List<T> orig,
  89                                 InstanceIdentifier<Node> nodePath,
  90                                 LogicalDatastoreType datastoreType,
  91                                 ReadWriteTransaction tx) {
  92
  93         if (updated == null) {
  94             updated = new ArrayList<>();
  95         }
  96         if (orig == null) {
  97             orig = new ArrayList<>();
  98         }
  99         List<T> added   = new ArrayList<>(updated);
 100
 101         added.removeAll(orig);
 102         added = diffOf(added, existing);//do not add the existing data again
 103         if (added.size() > 0) {
 104             for (T addedItem : added) {
 105                 InstanceIdentifier<T> transformedId = generateId(nodePath, addedItem);
 106                 T transformedItem = transform(nodePath, addedItem);
 107                 String nodeId = transformedId.firstKeyOf(Node.class).getNodeId().getValue();
 108                 LOG.trace("adding {} {} {}", getDescription(), nodeId, getKey(transformedItem));
 109                 tx.put(datastoreType, transformedId, transformedItem, WriteTransaction.CREATE_MISSING_PARENTS);
 110             }
 111         }
 112         List<T> removed = new ArrayList<>(orig);
 113         removed = diffByKey(removed, updated);
 114
 115         List<T> removedTransformed  = new ArrayList<>();
 116         for (T ele : removed) {
 117             removedTransformed.add(transform(nodePath, ele));
 118         }
 119
 120         List<T> skip = diffByKey(removedTransformed, existing);//skip the ones which are not present in cfg ds
 121         removedTransformed = diffByKey(removedTransformed, skip);
 122         if (removedTransformed.size() > 0) {
 123             for (T removedItem : removedTransformed) {
 124                 InstanceIdentifier<T> transformedId = generateId(nodePath, removedItem);
 125                 String nodeId = transformedId.firstKeyOf(Node.class).getNodeId().getValue();
 126                 LOG.trace("removing {} {} {}",getDescription(), nodeId, getKey(removedItem));
 127                 tx.delete(datastoreType, transformedId);
 128             }
 129         }
 130     }
 131
 132     public List<T> transform(InstanceIdentifier<Node> nodePath, List<T> list) {
 133         if (list != null) {
 134             return list.stream().map(t -> transform(nodePath, t)).collect(Collectors.toList());
 135         }
 136         return new ArrayList<>();
 137     }
 138
 139     public abstract T transform(InstanceIdentifier<Node> nodePath, T objT);
 140
 141     List<T> getDataSafe(Z existingData) {
 142         if (existingData == null) {
 143             return Collections.EMPTY_LIST;
 144         }
 145         List<T> result = getData(existingData);
 146         if (result == null) {
 147             return Collections.EMPTY_LIST;
 148         }
 149         return result;
 150     }
 151
 152     @Override
 153     public void mergeOperationalData(Y dst,
 154                                      Z existingData,
 155                                      Z src,
 156                                      InstanceIdentifier<Node> nodePath) {
 157         List<T> origDstData = getDataSafe(existingData);
 158         List<T> srcData = getDataSafe(src);
 159         List<T> data = transformOpData(origDstData, srcData, nodePath);
 160         setData(dst, data);
 161         if (!isEmptyList(data)) {
 162             String nodeId = nodePath.firstKeyOf(Node.class).getNodeId().getValue();
 163             LOG.trace("merging op {} to {} size {}",getDescription(), nodeId, data.size());
 164         }
 165     }
 166
 167     @Override
 168     public void mergeConfigData(Y dst,
 169                                 Z src,
 170                                 InstanceIdentifier<Node> nodePath) {
 171         List<T> data        = getDataSafe(src);
 172         List<T> transformed = transformConfigData(data, nodePath);
 173         setData(dst, transformed);
 174         if (!isEmptyList(data)) {
 175             String nodeId = nodePath.firstKeyOf(Node.class).getNodeId().getValue();
 176             LOG.trace("copying config {} to {} size {}",getDescription(), nodeId, data.size());
 177         }
 178     }
 179
 180     @Override
 181     public void mergeOpUpdate(Z origDst,
 182                               Z updatedSrc,
 183                               Z origSrc,
 184                               InstanceIdentifier<Node> nodePath,
 185                               ReadWriteTransaction tx) {
 186         List<T> updatedData     = getData(updatedSrc);
 187         List<T> origData        = getData(origSrc);
 188         List<T> existingData    = getData(origDst);
 189         transformUpdate(existingData, updatedData, origData, nodePath, OPERATIONAL, tx);
 190     }
 191
 192     boolean areSameSize(@Nullable List objA, @Nullable List objB) {
 193         if (HwvtepHAUtil.isEmptyList(objA) && HwvtepHAUtil.isEmptyList(objB)) {
 194             return true;
 195         }
 196         if (!HwvtepHAUtil.isEmptyList(objA) && !HwvtepHAUtil.isEmptyList(objB)) {
 197             return objA.size() == objB.size();
 198         }
 199         return false;
 200     }
 201
 202
 203     static LocatorSetComparator locatorSetComparator = new LocatorSetComparator();
 204
 205     static class LocatorSetComparator implements Comparator<LocatorSet>, Serializable {
 206         private static final long serialVersionUID = 1L;
 207
 208         @Override
 209         public int compare(final LocatorSet updatedLocatorSet, final LocatorSet origLocatorSet) {
 210             InstanceIdentifier<?> updatedLocatorRefIndentifier = updatedLocatorSet.getLocatorRef().getValue();
 211             TpId updatedLocatorSetTpId = updatedLocatorRefIndentifier.firstKeyOf(TerminationPoint.class).getTpId();
 212
 213             InstanceIdentifier<?> origLocatorRefIndentifier = origLocatorSet.getLocatorRef().getValue();
 214             TpId origLocatorSetTpId = origLocatorRefIndentifier.firstKeyOf(TerminationPoint.class).getTpId();
 215
 216             if (updatedLocatorSetTpId.equals(origLocatorSetTpId)) {
 217                 return 0;
 218             }
 219             return 1;
 220         }
 221     }
 222
 223     @Nullable
 224     public abstract List<T> getData(Z node);
 225
 226     public abstract void setData(Y builder, List<T> data);
 227
 228     public abstract InstanceIdentifier<T> generateId(InstanceIdentifier<Node> id, T node);
 229
 230     public abstract Identifier getKey(T data);
 231
 232     public abstract String getDescription();
 233
 234     public abstract T withoutUuid(T data);
 235 }