hwvtepsouthbound/hwvtepsouthbound-impl/src/main/java/org/opendaylight/ovsdb/hwvtepsouthbound/HwvtepSouthboundUtil.java

   1 /*
   2  * Copyright (c) 2015, 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
   9 package org.opendaylight.ovsdb.hwvtepsouthbound;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.CheckedFuture;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  16 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  19 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalRef;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalSwitchAttributes;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.ConnectionInfo;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  30 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.binding.Identifiable;
  33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 import com.google.common.base.Optional;
  39 import com.google.common.base.Preconditions;
  40 import com.google.common.util.concurrent.CheckedFuture;
  41
  42 import java.util.Collection;
  43 import java.util.List;
  44 import java.util.Map;
  45 import java.util.Objects;
  46 import java.util.concurrent.ConcurrentHashMap;
  47
  48 public class HwvtepSouthboundUtil {
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(HwvtepSouthboundUtil.class);
  51     private static final String SCHEMA_VERSION_MISMATCH =
  52             "{} column for {} table is not supported by this version of the {} schema: {}";
  53
  54     private static InstanceIdentifierCodec instanceIdentifierCodec;
  55
  56     private HwvtepSouthboundUtil() {
  57         // Prevent instantiating a utility class
  58     }
  59
  60     public static void setInstanceIdentifierCodec(InstanceIdentifierCodec iidc) {
  61         instanceIdentifierCodec = iidc;
  62     }
  63
  64     public static InstanceIdentifierCodec getInstanceIdentifierCodec() {
  65         return instanceIdentifierCodec;
  66     }
  67
  68     public static String serializeInstanceIdentifier(InstanceIdentifier<?> iid) {
  69         return instanceIdentifierCodec.serialize(iid);
  70     }
  71
  72     public static InstanceIdentifier<?> deserializeInstanceIdentifier(String iidString) {
  73         InstanceIdentifier<?> result = null;
  74         try {
  75             result = instanceIdentifierCodec.bindingDeserializer(iidString);
  76         } catch (DeserializationException e) {
  77             LOG.warn("Unable to deserialize iidString", e);
  78         }
  79         return result;
  80     }
  81
  82     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> Optional<D> readNode(
  83                     ReadWriteTransaction transaction, final InstanceIdentifier<D> connectionIid) {
  84         Optional<D> node = Optional.absent();
  85         try {
  86             node = transaction.read(LogicalDatastoreType.OPERATIONAL, connectionIid).checkedGet();
  87         } catch (final ReadFailedException e) {
  88             LOG.warn("Read Operational/DS for Node failed! {}", connectionIid, e);
  89         }
  90         return node;
  91     }
  92
  93     public static Optional<HwvtepGlobalAugmentation> getManagingNode(DataBroker db,
  94                     HwvtepPhysicalSwitchAttributes pNode) {
  95         Preconditions.checkNotNull(pNode);
  96         Optional<HwvtepGlobalAugmentation> result = null;
  97         HwvtepGlobalRef ref = pNode.getManagedBy();
  98         if (ref != null && ref.getValue() != null) {
  99             result = getManagingNode(db, ref);
 100         } else {
 101             LOG.warn("Cannot find client for PhysicalSwitch without a specified ManagedBy {}", pNode);
 102             return Optional.absent();
 103         }
 104         if (!result.isPresent()) {
 105             LOG.warn("Failed to find managing node for PhysicalSwitch {}", pNode);
 106         }
 107         return result;
 108     }
 109
 110     public static Optional<HwvtepGlobalAugmentation> getManagingNode(DataBroker db, HwvtepGlobalRef ref) {
 111         try {
 112             ReadOnlyTransaction transaction = db.newReadOnlyTransaction();
 113             @SuppressWarnings("unchecked")
 114             // Note: erasure makes this safe in combination with the typecheck
 115             // below
 116             InstanceIdentifier<Node> path = (InstanceIdentifier<Node>) ref.getValue();
 117
 118             CheckedFuture<Optional<Node>, ReadFailedException> nf =
 119                             transaction.read(LogicalDatastoreType.OPERATIONAL, path);
 120             transaction.close();
 121             Optional<Node> optional = nf.get();
 122             if (optional != null && optional.isPresent()) {
 123                 HwvtepGlobalAugmentation hwvtepNode = null;
 124                 Node node = optional.get();
 125                 if (node instanceof HwvtepGlobalAugmentation) {
 126                     hwvtepNode = (HwvtepGlobalAugmentation) node;
 127                 } else if (node != null) {
 128                     hwvtepNode = node.getAugmentation(HwvtepGlobalAugmentation.class);
 129                 }
 130                 if (hwvtepNode != null) {
 131                     return Optional.of(hwvtepNode);
 132                 } else {
 133                     LOG.warn("Hwvtep switch claims to be managed by {} but " + "that HwvtepNode does not exist",
 134                                     ref.getValue());
 135                     return Optional.absent();
 136                 }
 137             } else {
 138                 LOG.warn("Mysteriously got back a thing which is *not* a topology Node: {}", optional);
 139                 return Optional.absent();
 140             }
 141         } catch (Exception e) {
 142             LOG.warn("Failed to get HwvtepNode {}", ref, e);
 143             return Optional.absent();
 144         }
 145     }
 146     public static String connectionInfoToString(final ConnectionInfo connectionInfo) {
 147         return String.valueOf(
 148                 connectionInfo.getRemoteIp().getValue()) + ":" + connectionInfo.getRemotePort().getValue();
 149     }
 150
 151
 152     public static void schemaMismatchLog(String column, String table, SchemaVersionMismatchException ex) {
 153         LOG.debug(SCHEMA_VERSION_MISMATCH, column, table, "hw_vtep", ex.getMessage());
 154     }
 155
 156     public static <KeyType, D> void updateData(Map<Class<? extends Identifiable>, Map<KeyType, D>> map,
 157                                                Class<? extends Identifiable> cls, KeyType key, D data) {
 158         if (key == null) {
 159             return;
 160         }
 161         if (!map.containsKey(cls)) {
 162             map.put(cls, new ConcurrentHashMap<>());
 163         }
 164         map.get(cls).put(key, data);
 165     }
 166
 167     public static <KeyType, D> D getData(Map<Class<? extends Identifiable>, Map<KeyType, D>> map,
 168                                          Class<? extends Identifiable> cls, KeyType key) {
 169         if (key == null) {
 170             return null;
 171         }
 172         if (map.containsKey(cls)) {
 173             return map.get(cls).get(key);
 174         }
 175         return null;
 176     }
 177
 178     public static <KeyType, D> boolean containsKey(Map<Class<? extends Identifiable>, Map<KeyType, D>> map,
 179                                                    Class<? extends Identifiable> cls, KeyType key) {
 180         if (key == null) {
 181             return false;
 182         }
 183         if (map.containsKey(cls)) {
 184             return map.get(cls).containsKey(key);
 185         }
 186         return false;
 187     }
 188
 189     public static <KeyType, D> void clearData(Map<Class<? extends Identifiable>, Map<KeyType, D>> map,
 190                                               Class<? extends Identifiable> cls, KeyType key) {
 191         if (key == null) {
 192             return;
 193         }
 194         if (map.containsKey(cls)) {
 195             map.get(cls).remove(key);
 196         }
 197     }
 198
 199     public static <T> boolean isEmpty(Collection<T> list) {
 200         return list == null || list.isEmpty();
 201     }
 202
 203     public static boolean isEmptyMap(Map map) {
 204         return map == null || map.isEmpty();
 205     }
 206
 207     public static InstanceIdentifier<Node> getGlobalNodeIid(final InstanceIdentifier<Node> physicalNodeIid) {
 208         String nodeId = physicalNodeIid.firstKeyOf(Node.class).getNodeId().getValue();
 209         int physicalSwitchIndex = nodeId.indexOf(HwvtepSouthboundConstants.PSWITCH_URI_PREFIX);
 210         if (physicalSwitchIndex > 0) {
 211             nodeId = nodeId.substring(0, physicalSwitchIndex - 1);
 212         } else {
 213             return null;
 214         }
 215         return physicalNodeIid.firstIdentifierOf(Topology.class).child(Node.class , new NodeKey(new NodeId(nodeId)));
 216     }
 217 }