Merge "Use OVSDB external-id for ports parent ref"
[genius.git] / interfacemanager / interfacemanager-impl / src / main / java / org / opendaylight / genius / interfacemanager / listeners / TerminationPointStateListener.java
1 /*
2  * Copyright (c) 2016 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.interfacemanager.listeners;
9
10 import com.google.common.util.concurrent.ListenableFuture;
11
12 import java.util.List;
13 import java.util.concurrent.Callable;
14
15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.genius.datastoreutils.AsyncClusteredDataTreeChangeListenerBase;
17 import org.opendaylight.genius.datastoreutils.DataStoreJobCoordinator;
18 import org.opendaylight.genius.interfacemanager.IfmConstants;
19 import org.opendaylight.genius.interfacemanager.InterfacemgrProvider;
20 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
21 import org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers.OvsInterfaceTopologyStateUpdateHelper;
22 import org.opendaylight.genius.interfacemanager.renderer.ovs.utilities.IfmClusterUtils;
23 import org.opendaylight.ovsdb.utils.mdsal.utils.MdsalUtils;
24 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
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.yang.binding.InstanceIdentifier;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
33
34 public class TerminationPointStateListener extends AsyncClusteredDataTreeChangeListenerBase<OvsdbTerminationPointAugmentation, TerminationPointStateListener> {
35     private static final Logger LOG = LoggerFactory.getLogger(TerminationPointStateListener.class);
36     private final DataBroker dataBroker;
37     private final MdsalUtils mdsalUtils;
38     private final SouthboundUtils southboundUtils;
39     private final InterfacemgrProvider interfaceMgrProvider;
40
41     public TerminationPointStateListener(DataBroker dataBroker,
42                                          final InterfacemgrProvider interfaceMgrProvider) {
43         super(OvsdbTerminationPointAugmentation.class, TerminationPointStateListener.class);
44         this.dataBroker = dataBroker;
45         this.mdsalUtils = new MdsalUtils(dataBroker);
46         this.southboundUtils = new SouthboundUtils(mdsalUtils);
47         this.interfaceMgrProvider = interfaceMgrProvider;
48     }
49
50     @Override
51     protected InstanceIdentifier<OvsdbTerminationPointAugmentation> getWildCardPath() {
52         return InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class)
53                 .child(Node.class).child(TerminationPoint.class).augmentation(OvsdbTerminationPointAugmentation.class).build();
54     }
55
56     @Override
57     protected TerminationPointStateListener getDataTreeChangeListener() {
58         return TerminationPointStateListener.this;
59     }
60
61     @Override
62     protected void remove(InstanceIdentifier<OvsdbTerminationPointAugmentation> identifier,
63                           OvsdbTerminationPointAugmentation tpOld) {
64         LOG.debug("Received remove DataChange Notification for ovsdb termination point {}", tpOld.getName());
65         if (tpOld.getInterfaceBfdStatus() != null) {
66             LOG.debug("Received termination point removed notification with bfd status values {}", tpOld.getName());
67             DataStoreJobCoordinator jobCoordinator = DataStoreJobCoordinator.getInstance();
68             RendererStateRemoveWorker rendererStateRemoveWorker = new RendererStateRemoveWorker(tpOld);
69             jobCoordinator.enqueueJob(tpOld.getName(), rendererStateRemoveWorker);
70         }
71     }
72
73     @Override
74     protected void update(InstanceIdentifier<OvsdbTerminationPointAugmentation> identifier,
75                           OvsdbTerminationPointAugmentation tpOld,
76                           OvsdbTerminationPointAugmentation tpNew) {
77         LOG.debug("Received Update DataChange Notification for ovsdb termination point {}", tpNew.getName());
78         if (tpNew.getInterfaceBfdStatus() != null && (tpOld == null ||
79                 !tpNew.getInterfaceBfdStatus().equals(tpOld.getInterfaceBfdStatus()))) {
80             LOG.trace("Bfd Status changed for ovsdb termination point identifier: {},  old: {}, new: {}.",
81                     identifier, tpOld, tpNew);
82             DataStoreJobCoordinator jobCoordinator = DataStoreJobCoordinator.getInstance();
83             RendererStateUpdateWorker rendererStateAddWorker = new RendererStateUpdateWorker(identifier, tpNew);
84             jobCoordinator.enqueueJob(tpNew.getName(), rendererStateAddWorker, IfmConstants.JOB_MAX_RETRIES);
85         }
86
87         IfmClusterUtils.runOnlyInLeaderNode(() -> {
88             String oldInterfaceName = SouthboundUtils.getExternalInterfaceIdValue(tpOld);
89             String newInterfaceName = SouthboundUtils.getExternalInterfaceIdValue(tpNew);
90             if (newInterfaceName != null && (oldInterfaceName == null || !oldInterfaceName.equals(newInterfaceName))) {
91                 InstanceIdentifier<Node> nodeInstanceId = identifier.firstIdentifierOf(Node.class);
92                 String dpnId = southboundUtils.getDatapathIdFromNodeInstanceId(nodeInstanceId);
93                 if (dpnId == null) {
94                     return;
95                 }
96                 String parentRefName = InterfaceManagerCommonUtils.getPortNameForInterface(dpnId, tpNew.getName());
97                 LOG.debug("Detected update to termination point {} with external ID {}, updating parent ref "
98                         + "of that interface ID to this termination point's interface-state name {}",
99                         tpNew.getName(), newInterfaceName, parentRefName);
100                 interfaceMgrProvider.updateInterfaceParentRef(newInterfaceName, parentRefName);
101             }
102         });
103     }
104
105     @Override
106     protected void add(InstanceIdentifier<OvsdbTerminationPointAugmentation> identifier,
107                        OvsdbTerminationPointAugmentation tpNew) {
108         update(identifier, null, tpNew);
109     }
110
111     private class RendererStateUpdateWorker implements Callable<List<ListenableFuture<Void>>> {
112         InstanceIdentifier<OvsdbTerminationPointAugmentation> instanceIdentifier;
113         OvsdbTerminationPointAugmentation terminationPointNew;
114
115
116         public RendererStateUpdateWorker(InstanceIdentifier<OvsdbTerminationPointAugmentation> instanceIdentifier,
117                                          OvsdbTerminationPointAugmentation tpNew) {
118             this.instanceIdentifier = instanceIdentifier;
119             this.terminationPointNew = tpNew;
120         }
121
122         @Override
123         public List<ListenableFuture<Void>> call() {
124             // If another renderer(for eg : CSS) needs to be supported, check can be performed here
125             // to call the respective helpers.
126             return OvsInterfaceTopologyStateUpdateHelper.updateTunnelState(dataBroker,
127                     terminationPointNew);
128         }
129     }
130
131     private class RendererStateRemoveWorker implements Callable<List<ListenableFuture<Void>>> {
132         OvsdbTerminationPointAugmentation terminationPointOld;
133
134
135         public RendererStateRemoveWorker(OvsdbTerminationPointAugmentation tpNew) {
136             this.terminationPointOld = tpNew;
137         }
138
139         @Override
140         public List<ListenableFuture<Void>> call() {
141             LOG.debug("Removing bfd state from cache, if any, for {}", terminationPointOld.getName());
142             InterfaceManagerCommonUtils.removeBfdStateFromCache(terminationPointOld.getName());
143             return null;
144         }
145     }
146 }