itm/itm-impl/src/main/java/org/opendaylight/genius/itm/confighelpers/OvsdbTepAddConfigHelper.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.genius.itm.confighelpers;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.util.ArrayList;
  12 import java.util.Collections;
  13 import java.util.List;
  14 import java.util.Objects;
  15 import org.opendaylight.genius.infra.Datastore;
  16 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  17 import org.opendaylight.genius.infra.TypedWriteTransaction;
  18 import org.opendaylight.genius.itm.globals.ITMConstants;
  19 import org.opendaylight.genius.itm.impl.ItmUtils;
  20 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.NotHostedTransportZones;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.TransportZones;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.TepsInNotHostedTransportZone;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.TepsInNotHostedTransportZoneBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.TepsInNotHostedTransportZoneKey;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.tepsinnothostedtransportzone.UnknownVteps;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.tepsinnothostedtransportzone.UnknownVtepsBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.not.hosted.transport.zones.tepsinnothostedtransportzone.UnknownVtepsKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZoneKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.Vteps;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.transport.zone.VtepsKey;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.common.Uint64;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 public final class OvsdbTepAddConfigHelper {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(OvsdbTepAddConfigHelper.class);
  46
  47     private OvsdbTepAddConfigHelper() {
  48
  49     }
  50
  51     /**
  52      * Adds the TEP into ITM configuration/operational Datastore in one of the following cases.
  53      * 1) default transport zone
  54      * 2) Configured transport zone
  55      * 3) Unhosted transport zone
  56      *
  57      * @param tepIp TEP-IP address in string
  58      * @param strDpnId bridge datapath ID in string
  59      * @param tzName transport zone name in string
  60      * @param ofTunnel boolean flag for TEP to enable/disable of-tunnel feature on it
  61      * @param dataBroker data broker handle to perform operations on config/operational datastore
  62      * @param txRunner ManagedTransactionRunner object
  63      */
  64
  65     public static List<ListenableFuture<Void>> addTepReceivedFromOvsdb(String tepIp, String strDpnId, String tzName,
  66                                                                        boolean ofTunnel, DataBroker dataBroker,
  67                                                                        ManagedNewTransactionRunner txRunner) {
  68         List<ListenableFuture<Void>> futures = new ArrayList<>();
  69         Uint64 dpnId = Uint64.ZERO;
  70
  71         if (strDpnId != null && !strDpnId.isEmpty()) {
  72             dpnId = MDSALUtil.getDpnId(strDpnId);
  73         }
  74
  75         // Get tep IP
  76         IpAddress tepIpAddress = IpAddressBuilder.getDefaultInstance(tepIp);
  77         TransportZone tzone = null;
  78
  79         // Case: TZ name is not given with OVS TEP.
  80         if (tzName == null) {
  81             tzName = ITMConstants.DEFAULT_TRANSPORT_ZONE;
  82             // add TEP into default-TZ
  83             tzone = ItmUtils.getTransportZoneFromConfigDS(tzName, dataBroker);
  84             if (tzone == null) {
  85                 // Case: default-TZ is not yet created, then add TEP into "teps-in-not-hosted-transport-zone"
  86                 LOG.trace("Adding TEP with default TZ into teps-in-not-hosted-transport-zone.");
  87                 return addUnknownTzTepIntoTepsNotHostedAndReturnFutures(tzName, tepIpAddress, dpnId, ofTunnel,
  88                         dataBroker, txRunner);
  89             }
  90             LOG.trace("Add TEP into default-transport-zone.");
  91         } else {
  92             // Case: Add TEP into corresponding TZ created from Northbound.
  93             tzone = ItmUtils.getTransportZoneFromConfigDS(tzName, dataBroker);
  94             if (tzone == null) {
  95                 // Case: TZ is not configured from Northbound, then add TEP into "teps-in-not-hosted-transport-zone"
  96                 LOG.trace("Adding TEP with unknown TZ into teps-in-not-hosted-transport-zone.");
  97                 return addUnknownTzTepIntoTepsNotHostedAndReturnFutures(tzName, tepIpAddress, dpnId, ofTunnel,
  98                         dataBroker, txRunner);
  99             } else {
 100                 LOG.trace("Add TEP into transport-zone already configured by Northbound.");
 101             }
 102         }
 103
 104
 105         final Uint64 id = dpnId;
 106         final String name = tzName;
 107         futures.add(txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.CONFIGURATION,
 108             tx -> addConfig(name, id, tepIpAddress, ofTunnel, tx)));
 109         return futures;
 110     }
 111
 112     /**
 113      * Adds the TEP into Vtep list in the subnet list in the transport zone list
 114      * from ITM configuration Datastore by merge operation with write transaction.
 115      *
 116      * @param updatedVtepList updated Vteps list object which will have new TEP for addition
 117      * @param tepIpAddress TEP IP address in IpAddress object
 118      * @param tzName transport zone name in string
 119      * @param dpid bridge datapath ID
 120      * @param ofTunnel boolean flag for TEP to enable/disable of-tunnel feature on it
 121      * @param tx TypedWriteTransaction object
 122      */
 123     public static void addVtepInITMConfigDS(List<Vteps> updatedVtepList, IpAddress tepIpAddress, String tzName,
 124                                             Uint64 dpid, boolean ofTunnel,
 125                                             TypedWriteTransaction<Datastore.Configuration> tx) {
 126         //Create TZ node path
 127         InstanceIdentifier<TransportZone> tranzportZonePath =
 128                 InstanceIdentifier.builder(TransportZones.class)
 129                         .child(TransportZone.class, new TransportZoneKey(tzName)).build();
 130
 131         // this check is needed to reuse same function from TransportZoneListener
 132         // when VTEP is moved from TepsNotHosted list to TZ configured from Northbound.
 133         if (dpid.compareTo(Uint64.ZERO) > 0) {
 134             // create vtep
 135             VtepsKey vtepkey = new VtepsKey(dpid);
 136             Vteps vtepObj =
 137                     new VtepsBuilder().setDpnId(dpid).setIpAddress(tepIpAddress).withKey(vtepkey)
 138                             .setOptionOfTunnel(ofTunnel).build();
 139
 140             // Add vtep obtained from bridge into list
 141             updatedVtepList.add(vtepObj);
 142
 143             LOG.trace("Adding TEP (TZ: {} TEP IP: {} DPID: {}, of-tunnel: {}) in ITM Config DS.", tzName,
 144                     tepIpAddress, dpid, ofTunnel);
 145         } else {
 146             // this is case when this function is called while TEPs movement from tepsNotHosted list when
 147             // corresponding TZ is configured from northbound.
 148             for (Vteps vtep: updatedVtepList) {
 149                 LOG.trace("Moving TEP (TEP IP: {} DPID: {}, of-tunnel: {})"
 150                                 + "from not-hosted-transport-zone {} into  ITM Config DS.",
 151                         vtep.getIpAddress(), vtep.getDpnId(), ofTunnel, tzName);
 152             }
 153         }
 154
 155         // create TZ node with updated subnet having new vtep
 156         TransportZone updatedTzone =
 157                 new TransportZoneBuilder().withKey(new TransportZoneKey(tzName)).setVteps(updatedVtepList)
 158                         .setZoneName(tzName).build();
 159
 160         // Update TZ in Config DS to add vtep in TZ
 161         tx.merge(tranzportZonePath, updatedTzone, true);
 162     }
 163
 164     /**
 165      * Adds the TEP into Vtep list in the subnet list in the transport zone list
 166      * from ITM operational Datastore by merge operation with write transaction.
 167      *
 168      * @param tzName transport zone name in string
 169      * @param tepIpAddress TEP IP address in IpAddress object
 170      * @param dpid bridge datapath ID
 171      * @param ofTunnel boolean flag for TEP to enable/disable of-tunnel feature on it
 172      * @param dataBroker data broker handle to perform operations on operational datastore
 173      * @param tx TypedWriteTransaction object
 174      */
 175     protected static void addUnknownTzTepIntoTepsNotHosted(String tzName, IpAddress tepIpAddress,
 176                                                            Uint64 dpid, boolean ofTunnel, DataBroker dataBroker,
 177                                                            TypedWriteTransaction<Datastore.Operational> tx) {
 178         List<UnknownVteps> vtepList;
 179         TepsInNotHostedTransportZone tepsInNotHostedTransportZone =
 180                 ItmUtils.getUnknownTransportZoneFromITMOperDS(tzName, dataBroker);
 181         if (tepsInNotHostedTransportZone == null) {
 182             LOG.trace("Unhosted TransportZone ({}) does not exist in OperDS.", tzName);
 183             vtepList = new ArrayList<>();
 184             addVtepIntoTepsNotHosted(addVtepToUnknownVtepsList(vtepList, tepIpAddress, dpid, ofTunnel), tzName, tx);
 185         } else {
 186             vtepList = tepsInNotHostedTransportZone.getUnknownVteps();
 187             if (vtepList == null || vtepList.isEmpty()) {
 188                 //  case: vtep list does not exist or it has no elements
 189                 if (vtepList == null) {
 190                     LOG.trace("Add TEP into unhosted TZ ({}) when no vtep-list in the TZ.", tzName);
 191                     vtepList = new ArrayList<>();
 192                 }
 193                 LOG.trace("Add TEP into unhosted TZ ({}) when no vtep-list in the TZ.", tzName);
 194                 addVtepIntoTepsNotHosted(addVtepToUnknownVtepsList(vtepList, tepIpAddress, dpid, ofTunnel), tzName, tx);
 195             } else {
 196                 //  case: vtep list has elements
 197                 boolean vtepFound = false;
 198                 UnknownVteps oldVtep = null;
 199
 200                 for (UnknownVteps vtep : vtepList) {
 201                     if (Objects.equals(vtep.getDpnId(), dpid)) {
 202                         vtepFound = true;
 203                         oldVtep = vtep;
 204                         break;
 205                     }
 206                 }
 207                 if (!vtepFound) {
 208                     addVtepIntoTepsNotHosted(addVtepToUnknownVtepsList(vtepList,
 209                             tepIpAddress, dpid, ofTunnel), tzName, tx);
 210                 } else {
 211                     // vtep is found, update it with tep-ip
 212                     vtepList.remove(oldVtep);
 213                     addVtepIntoTepsNotHosted(addVtepToUnknownVtepsList(vtepList,
 214                             tepIpAddress, dpid, ofTunnel), tzName, tx);
 215                 }
 216             }
 217         }
 218     }
 219
 220     /**
 221      * Adds the TEP into Unknown Vtep list under the transport zone in the TepsNotHosted list
 222      * from ITM operational Datastore by merge operation with write transaction.
 223      *
 224      * @param updatedVtepList updated UnknownVteps list object which will have new TEP for addition
 225      *                        into TepsNotHosted
 226      * @param tzName transport zone name in string
 227      * @param tx TypedWriteTransaction object
 228      */
 229     protected static void addVtepIntoTepsNotHosted(List<UnknownVteps> updatedVtepList, String tzName,
 230                                                    TypedWriteTransaction<Datastore.Operational> tx) {
 231         //Create TZ node path
 232         InstanceIdentifier<TepsInNotHostedTransportZone> tepsInNotHostedTransportZoneIid =
 233                 InstanceIdentifier.builder(NotHostedTransportZones.class)
 234                         .child(TepsInNotHostedTransportZone.class,
 235                                 new TepsInNotHostedTransportZoneKey(tzName)).build();
 236
 237         // create unknown TZ node with updated vtep list
 238         TepsInNotHostedTransportZone updatedTzone = new TepsInNotHostedTransportZoneBuilder()
 239                 .withKey(new TepsInNotHostedTransportZoneKey(tzName)).setZoneName(tzName)
 240                 .setUnknownVteps(updatedVtepList).build();
 241
 242         // Update TZ in Oper DS.
 243         tx.merge(tepsInNotHostedTransportZoneIid, updatedTzone, true);
 244     }
 245
 246     private static void addConfig(String tzName, Uint64 dpnId, IpAddress ipAdd,
 247                                   boolean ofTunnel, TypedWriteTransaction<Datastore.Configuration> tx) {
 248         List<Vteps> vtepList = new ArrayList<>();
 249
 250         LOG.trace("Add TEP in transport-zone when no vtep-list for specific subnet.");
 251         addVtepInITMConfigDS(vtepList, ipAdd, tzName, dpnId, ofTunnel, tx);
 252     }
 253
 254     private static List<ListenableFuture<Void>> addUnknownTzTepIntoTepsNotHostedAndReturnFutures(String tzName,
 255                                                          IpAddress tepIpAddress, Uint64 id, boolean ofTunnel,
 256                                                          DataBroker dataBroker, ManagedNewTransactionRunner txRunner) {
 257         return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(Datastore.OPERATIONAL,
 258             tx -> addUnknownTzTepIntoTepsNotHosted(tzName, tepIpAddress, id, ofTunnel, dataBroker, tx)));
 259     }
 260
 261     private static List<UnknownVteps> addVtepToUnknownVtepsList(List<UnknownVteps> updatedVtepList,
 262                                                                 IpAddress tepIpAddress, Uint64 dpid,
 263                                                                 boolean ofTunnel) {
 264         // create vtep
 265         UnknownVtepsKey vtepkey = new UnknownVtepsKey(dpid);
 266         UnknownVteps vtepObj =
 267                 new UnknownVtepsBuilder().setDpnId(dpid).setIpAddress(tepIpAddress).withKey(vtepkey)
 268                         .setOfTunnel(ofTunnel).build();
 269
 270         // Add vtep obtained into unknown TZ tep list
 271         updatedVtepList.add(vtepObj);
 272         LOG.trace("Adding TEP  (DPID: {}, TEP IP: {}, of-tunnel: {}) into unhosted Transport Zone"
 273                 + "inside ITM Oper DS.", dpid, tepIpAddress, ofTunnel);
 274         return updatedVtepList;
 275     }
 276 }