itm/itm-impl/src/main/java/org/opendaylight/genius/itm/recovery/impl/ItmTzInstanceRecoveryHandler.java

   1 /*
   2  * Copyright (c) 2018 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.recovery.impl;
   9
  10 import java.time.Duration;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import java.util.concurrent.atomic.AtomicInteger;
  16 import javax.inject.Inject;
  17 import javax.inject.Singleton;
  18 import org.opendaylight.genius.datastoreutils.listeners.DataTreeEventCallbackRegistrar;
  19 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
  20 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
  21 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
  22 import org.opendaylight.genius.itm.cache.DpnTepStateCache;
  23 import org.opendaylight.genius.itm.globals.ITMConstants;
  24 import org.opendaylight.genius.itm.impl.ItmUtils;
  25 import org.opendaylight.genius.utils.clustering.EntityOwnershipUtils;
  26 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
  27 import org.opendaylight.mdsal.binding.api.DataBroker;
  28 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  29 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
  30 import org.opendaylight.serviceutils.srm.ServiceRecoveryInterface;
  31 import org.opendaylight.serviceutils.srm.ServiceRecoveryRegistry;
  32 import org.opendaylight.serviceutils.tools.listener.AbstractSyncDataTreeChangeListener;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelsState;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.teps.state.DpnsTeps;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.teps.state.dpns.teps.RemoteDpns;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelList;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.StateTunnelListKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.rev160406.transport.zones.TransportZone;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.serviceutils.srm.types.rev180626.GeniusItmTz;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.common.Uint64;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 @Singleton
  46 public class ItmTzInstanceRecoveryHandler extends
  47         AbstractSyncDataTreeChangeListener<StateTunnelList> implements ServiceRecoveryInterface {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(ItmTzInstanceRecoveryHandler.class);
  50
  51     private final JobCoordinator jobCoordinator;
  52     private final DataBroker dataBroker;
  53     private final ManagedNewTransactionRunner txRunner;
  54     private final EntityOwnershipUtils entityOwnershipUtils;
  55     private final DataTreeEventCallbackRegistrar eventCallbacks;
  56     private final EntityOwnershipService entityOwnershipService;
  57     private final IInterfaceManager interfaceManager;
  58     private final DpnTepStateCache dpnTepStateCache;
  59
  60     @Inject
  61     public ItmTzInstanceRecoveryHandler(DataBroker dataBroker,
  62                                         JobCoordinator jobCoordinator,
  63                                         ServiceRecoveryRegistry serviceRecoveryRegistry,
  64                                         EntityOwnershipUtils entityOwnershipUtils,
  65                                         EntityOwnershipService entityOwnershipService,
  66                                         DataTreeEventCallbackRegistrar eventCallbacks,
  67                                         IInterfaceManager interfaceManager,
  68                                         DpnTepStateCache dpnTepStateCache) {
  69         super(dataBroker, LogicalDatastoreType.OPERATIONAL,
  70                 InstanceIdentifier.create(TunnelsState.class).child(StateTunnelList.class));
  71         this.dataBroker = dataBroker;
  72         this.jobCoordinator = jobCoordinator;
  73         this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
  74         this.entityOwnershipUtils = entityOwnershipUtils;
  75         this.entityOwnershipService = entityOwnershipService;
  76         serviceRecoveryRegistry.registerServiceRecoveryRegistry(getServiceRegistryKey(), this);
  77         this.eventCallbacks = eventCallbacks;
  78         this.interfaceManager = interfaceManager;
  79         this.dpnTepStateCache = dpnTepStateCache;
  80
  81     }
  82
  83     private String getServiceRegistryKey() {
  84         return GeniusItmTz.class.toString();
  85     }
  86
  87     @Override
  88     public void recoverService(String entityId) {
  89         if (!entityOwnershipUtils.isEntityOwner(ITMConstants.ITM_CONFIG_ENTITY, ITMConstants.ITM_CONFIG_ENTITY)) {
  90             return;
  91         }
  92         LOG.info("Trigerred recovery of ITM Instance - TZ Name {}", entityId);
  93         try {
  94             recoverTransportZone(entityId);
  95         } catch (InterruptedException e) {
  96             LOG.error("ITM instance transportzone has not recovered", e);
  97         }
  98     }
  99
 100     private void recoverTransportZone(String entityId) throws InterruptedException {
 101         //List of Internel tunnels
 102         List<String> tunnelList = new ArrayList<>();
 103         if (interfaceManager.isItmDirectTunnelsEnabled()) {
 104             Collection<DpnsTeps> dpnsTeps = dpnTepStateCache.getAllPresent();
 105             List<Uint64> listOfDpnIds = ItmUtils.getDpIdFromTransportzone(dataBroker, entityId);
 106             for (DpnsTeps dpnTep : dpnsTeps) {
 107                 List<RemoteDpns> rmtdpns = dpnTep.getRemoteDpns();
 108                 for (RemoteDpns remoteDpn : rmtdpns) {
 109                     if (listOfDpnIds.contains(remoteDpn.getDestinationDpnId())) {
 110                         tunnelList.add(remoteDpn.getTunnelName());
 111                     }
 112                 }
 113             }
 114             LOG.trace("List of tunnels to be recovered : {}", tunnelList);
 115         } else {
 116             //List of Internal tunnels
 117             tunnelList.addAll(ItmUtils.getInternalTunnelInterfaces(dataBroker));
 118         }
 119         LOG.debug("List of tunnel interfaces: {}" , tunnelList);
 120         InstanceIdentifier<TransportZone> tzII = ItmUtils.getTZInstanceIdentifier(entityId);
 121         TransportZone tz = ItmUtils.getTransportZoneFromConfigDS(entityId , dataBroker);
 122         if (tz != null) {
 123             LOG.trace("deleting transportzone instance {}", entityId);
 124             jobCoordinator.enqueueJob(entityId, () -> Collections.singletonList(
 125                 txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 126                     tx -> tx.delete(LogicalDatastoreType.CONFIGURATION, tzII))), ITMConstants.JOB_MAX_RETRIES);
 127             AtomicInteger eventCallbackCount = new AtomicInteger(0);
 128             if (!tunnelList.isEmpty()) {
 129                 tunnelList.forEach(tunnelInterface -> {
 130                     StateTunnelListKey tlKey = new StateTunnelListKey(tunnelInterface);
 131                     LOG.trace("TunnelStateKey: {} for interface: {}", tlKey, tunnelInterface);
 132                     InstanceIdentifier<StateTunnelList> stListId = ItmUtils.buildStateTunnelListId(tlKey);
 133                     eventCallbacks.onRemove(LogicalDatastoreType.OPERATIONAL, stListId, (unused) -> {
 134                         LOG.trace("on removal of {}, event callback triggered", stListId);
 135                         // recreating the transportZone
 136                         recreateTZ(entityId, tz, tzII, tunnelList.size(), eventCallbackCount);
 137                         return DataTreeEventCallbackRegistrar.NextAction.UNREGISTER;
 138                     }, Duration.ofMillis(5000), (id) -> {
 139                             LOG.trace("event callback timed out for {} tunnel interface ", tunnelInterface);
 140                             recreateTZ(entityId, tz, tzII, tunnelList.size(), eventCallbackCount); });
 141                 });
 142             } else {
 143                 LOG.trace("List of tunnels to be recovered is empty, still recreate transportzone {}",entityId);
 144                 recreateTZ(entityId, tz, tzII, tunnelList.size(), eventCallbackCount);
 145             }
 146         }
 147     }
 148
 149     //this function will recreate the transportzone instance
 150     private void recreateTZ(String entityId, TransportZone tz, InstanceIdentifier<TransportZone> tzII,
 151                             int sizeOfTunnelList, AtomicInteger registeredEvents) {
 152         registeredEvents.incrementAndGet();
 153         if (registeredEvents.intValue() == sizeOfTunnelList || sizeOfTunnelList == 0) {
 154             LOG.trace("recreating transportzone instance {}", entityId);
 155             jobCoordinator.enqueueJob(entityId, () -> Collections.singletonList(
 156                 txRunner.callWithNewWriteOnlyTransactionAndSubmit(
 157                     tx -> tx.merge(LogicalDatastoreType.CONFIGURATION, tzII, tz))),
 158                 ITMConstants.JOB_MAX_RETRIES);
 159         }
 160     }
 161 }