2 * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.genius.interfacemanager.commons;
10 import com.google.common.base.Optional;
11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
12 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
14 import org.opendaylight.genius.interfacemanager.IfmConstants;
15 import org.opendaylight.genius.interfacemanager.IfmUtil;
16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.Tunnels;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.*;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntry;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntryKey;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info._interface.parent.entry.InterfaceChildEntry;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info._interface.parent.entry.InterfaceChildEntryKey;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntryKey;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntryBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.bridge.entry.BridgeInterfaceEntryKey;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntry;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryKey;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.tunnel.instance._interface.map.TunnelInstanceInterface;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.tunnel.instance._interface.map.TunnelInstanceInterfaceBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.tunnel.instance._interface.map.TunnelInstanceInterfaceKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
47 import java.math.BigInteger;
49 public class InterfaceMetaUtils {
50 private static final Logger LOG = LoggerFactory.getLogger(InterfaceMetaUtils.class);
51 public static InstanceIdentifier<BridgeRefEntry> getBridgeRefEntryIdentifier(BridgeRefEntryKey bridgeRefEntryKey) {
52 InstanceIdentifier.InstanceIdentifierBuilder<BridgeRefEntry> bridgeRefEntryInstanceIdentifierBuilder =
53 InstanceIdentifier.builder(BridgeRefInfo.class)
54 .child(BridgeRefEntry.class, bridgeRefEntryKey);
55 return bridgeRefEntryInstanceIdentifierBuilder.build();
58 public static BridgeRefEntry getBridgeRefEntryFromOperDS(InstanceIdentifier<BridgeRefEntry> dpnBridgeEntryIid,
59 DataBroker dataBroker) {
60 Optional<BridgeRefEntry> bridgeRefEntryOptional =
61 IfmUtil.read(LogicalDatastoreType.OPERATIONAL, dpnBridgeEntryIid, dataBroker);
62 if (!bridgeRefEntryOptional.isPresent()) {
65 return bridgeRefEntryOptional.get();
68 public static BridgeRefEntry getBridgeReferenceForInterface(Interface interfaceInfo,
69 DataBroker dataBroker) {
70 ParentRefs parentRefs = interfaceInfo.getAugmentation(ParentRefs.class);
71 BigInteger dpn = parentRefs.getDatapathNodeIdentifier();
72 BridgeRefEntryKey BridgeRefEntryKey = new BridgeRefEntryKey(dpn);
73 InstanceIdentifier<BridgeRefEntry> dpnBridgeEntryIid = getBridgeRefEntryIdentifier(BridgeRefEntryKey);
74 BridgeRefEntry bridgeRefEntry = getBridgeRefEntryFromOperDS(dpnBridgeEntryIid, dataBroker);
75 return bridgeRefEntry;
78 public static boolean bridgeExists(BridgeRefEntry bridgeRefEntry,
79 DataBroker dataBroker) {
80 if (bridgeRefEntry != null && bridgeRefEntry.getBridgeReference() != null) {
81 InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid =
82 (InstanceIdentifier<OvsdbBridgeAugmentation>) bridgeRefEntry.getBridgeReference().getValue();
83 Optional<OvsdbBridgeAugmentation> bridgeNodeOptional =
84 IfmUtil.read(LogicalDatastoreType.OPERATIONAL, bridgeIid, dataBroker);
85 if (bridgeNodeOptional.isPresent()) {
91 public static InstanceIdentifier<BridgeEntry> getBridgeEntryIdentifier(BridgeEntryKey bridgeEntryKey) {
92 InstanceIdentifier.InstanceIdentifierBuilder<BridgeEntry> bridgeEntryIdBuilder =
93 InstanceIdentifier.builder(BridgeInterfaceInfo.class).child(BridgeEntry.class, bridgeEntryKey);
94 return bridgeEntryIdBuilder.build();
97 public static BridgeEntry getBridgeEntryFromConfigDS(BigInteger dpnId,
98 DataBroker dataBroker) {
99 BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpnId);
100 InstanceIdentifier<BridgeEntry> bridgeEntryInstanceIdentifier =
101 InterfaceMetaUtils.getBridgeEntryIdentifier(bridgeEntryKey);
102 LOG.debug("Trying to retrieve bridge entry from config for Id: {}", bridgeEntryInstanceIdentifier);
103 return getBridgeEntryFromConfigDS(bridgeEntryInstanceIdentifier,
107 public static BridgeEntry getBridgeEntryFromConfigDS(InstanceIdentifier<BridgeEntry> bridgeEntryInstanceIdentifier,
108 DataBroker dataBroker) {
109 Optional<BridgeEntry> bridgeEntryOptional =
110 IfmUtil.read(LogicalDatastoreType.CONFIGURATION, bridgeEntryInstanceIdentifier, dataBroker);
111 if (!bridgeEntryOptional.isPresent()) {
114 return bridgeEntryOptional.get();
117 public static InstanceIdentifier<BridgeInterfaceEntry> getBridgeInterfaceEntryIdentifier(BridgeEntryKey bridgeEntryKey,
118 BridgeInterfaceEntryKey bridgeInterfaceEntryKey) {
119 return InstanceIdentifier.builder(BridgeInterfaceInfo.class)
120 .child(BridgeEntry.class, bridgeEntryKey)
121 .child(BridgeInterfaceEntry.class, bridgeInterfaceEntryKey).build();
125 public static BridgeInterfaceEntry getBridgeInterfaceEntryFromConfigDS(
126 InstanceIdentifier<BridgeInterfaceEntry> bridgeInterfaceEntryInstanceIdentifier, DataBroker dataBroker) {
127 Optional<BridgeInterfaceEntry> bridgeInterfaceEntryOptional =
128 IfmUtil.read(LogicalDatastoreType.CONFIGURATION, bridgeInterfaceEntryInstanceIdentifier, dataBroker);
129 if (!bridgeInterfaceEntryOptional.isPresent()) {
132 return bridgeInterfaceEntryOptional.get();
136 public static void createBridgeInterfaceEntryInConfigDS(BridgeEntryKey bridgeEntryKey,
137 BridgeInterfaceEntryKey bridgeInterfaceEntryKey,
138 String childInterface,
139 WriteTransaction t) {
140 InstanceIdentifier<BridgeInterfaceEntry> bridgeInterfaceEntryIid =
141 InterfaceMetaUtils.getBridgeInterfaceEntryIdentifier(bridgeEntryKey, bridgeInterfaceEntryKey);
142 BridgeInterfaceEntryBuilder entryBuilder = new BridgeInterfaceEntryBuilder().setKey(bridgeInterfaceEntryKey)
143 .setInterfaceName(childInterface);
144 t.put(LogicalDatastoreType.CONFIGURATION, bridgeInterfaceEntryIid, entryBuilder.build(), true);
147 public static InstanceIdentifier<InterfaceParentEntry> getInterfaceParentEntryIdentifier(
148 InterfaceParentEntryKey interfaceParentEntryKey) {
149 InstanceIdentifier.InstanceIdentifierBuilder<InterfaceParentEntry> intfIdBuilder =
150 InstanceIdentifier.builder(InterfaceChildInfo.class)
151 .child(InterfaceParentEntry.class, interfaceParentEntryKey);
152 return intfIdBuilder.build();
155 public static InstanceIdentifier<InterfaceChildEntry> getInterfaceChildEntryIdentifier(
156 InterfaceParentEntryKey interfaceParentEntryKey, InterfaceChildEntryKey interfaceChildEntryKey) {
157 InstanceIdentifier.InstanceIdentifierBuilder<InterfaceChildEntry> intfIdBuilder =
158 InstanceIdentifier.builder(InterfaceChildInfo.class)
159 .child(InterfaceParentEntry.class, interfaceParentEntryKey)
160 .child(InterfaceChildEntry.class, interfaceChildEntryKey);
161 return intfIdBuilder.build();
164 public static InterfaceParentEntry getInterfaceParentEntryFromConfigDS(
165 InterfaceParentEntryKey interfaceParentEntryKey, DataBroker dataBroker) {
166 InstanceIdentifier<InterfaceParentEntry> intfParentIid =
167 getInterfaceParentEntryIdentifier(interfaceParentEntryKey);
169 return getInterfaceParentEntryFromConfigDS(intfParentIid, dataBroker);
172 public static InterfaceParentEntry getInterfaceParentEntryFromConfigDS(
173 InstanceIdentifier<InterfaceParentEntry> intfId, DataBroker dataBroker) {
174 Optional<InterfaceParentEntry> interfaceParentEntryOptional =
175 IfmUtil.read(LogicalDatastoreType.CONFIGURATION, intfId, dataBroker);
176 if (!interfaceParentEntryOptional.isPresent()) {
179 return interfaceParentEntryOptional.get();
182 public static InterfaceChildEntry getInterfaceChildEntryFromConfigDS(InterfaceParentEntryKey interfaceParentEntryKey,
183 InterfaceChildEntryKey interfaceChildEntryKey,
184 DataBroker dataBroker) {
185 InstanceIdentifier<InterfaceChildEntry> intfChildIid =
186 getInterfaceChildEntryIdentifier(interfaceParentEntryKey, interfaceChildEntryKey);
188 return getInterfaceChildEntryFromConfigDS(intfChildIid, dataBroker);
191 public static InterfaceChildEntry getInterfaceChildEntryFromConfigDS(
192 InstanceIdentifier<InterfaceChildEntry> intfChildIid, DataBroker dataBroker) {
193 Optional<InterfaceChildEntry> interfaceChildEntryOptional =
194 IfmUtil.read(LogicalDatastoreType.CONFIGURATION, intfChildIid, dataBroker);
195 if (!interfaceChildEntryOptional.isPresent()) {
198 return interfaceChildEntryOptional.get();
201 public static void createLportTagInterfaceMap(WriteTransaction t, String infName, Integer ifIndex) {
202 LOG.debug("creating lport tag to interface map for {}",infName);
203 InstanceIdentifier<IfIndexInterface> id = InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class, new IfIndexInterfaceKey(ifIndex)).build();
204 IfIndexInterface ifIndexInterface = new IfIndexInterfaceBuilder().setIfIndex(ifIndex).setKey(new IfIndexInterfaceKey(ifIndex)).setInterfaceName(infName).build();
205 t.put(LogicalDatastoreType.OPERATIONAL, id, ifIndexInterface, true);
208 public static void removeLportTagInterfaceMap(WriteTransaction t, IdManagerService idManager, DataBroker broker, String infName, Integer ifIndex) {
209 InstanceIdentifier<IfIndexInterface> id = InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class, new IfIndexInterfaceKey(ifIndex)).build();
210 Optional<IfIndexInterface> ifIndexesInterface = IfmUtil.read(LogicalDatastoreType.OPERATIONAL, id, broker);
211 if(ifIndexesInterface.isPresent()) {
212 LOG.debug("removing lport tag to interface map for {}",infName);
213 t.delete(LogicalDatastoreType.OPERATIONAL, id);
215 IfmUtil.releaseId(idManager, IfmConstants.IFM_IDPOOL_NAME, infName);
218 public static void createBridgeRefEntry(BigInteger dpnId, InstanceIdentifier<?> bridgeIid,
219 WriteTransaction tx){
220 LOG.debug("Creating bridge ref entry for dpn: {} bridge: {}",
222 BridgeRefEntryKey bridgeRefEntryKey = new BridgeRefEntryKey(dpnId);
223 InstanceIdentifier<BridgeRefEntry> bridgeEntryId =
224 InterfaceMetaUtils.getBridgeRefEntryIdentifier(bridgeRefEntryKey);
225 BridgeRefEntryBuilder tunnelDpnBridgeEntryBuilder =
226 new BridgeRefEntryBuilder().setKey(bridgeRefEntryKey).setDpid(dpnId)
227 .setBridgeReference(new OvsdbBridgeRef(bridgeIid));
228 tx.put(LogicalDatastoreType.OPERATIONAL, bridgeEntryId, tunnelDpnBridgeEntryBuilder.build(), true);
230 public static void deleteBridgeRefEntry(BigInteger dpnId,
231 WriteTransaction tx) {
232 LOG.debug("Deleting bridge ref entry for dpn: {}",
234 BridgeRefEntryKey bridgeRefEntryKey = new BridgeRefEntryKey(dpnId);
235 InstanceIdentifier<BridgeRefEntry> bridgeEntryId =
236 InterfaceMetaUtils.getBridgeRefEntryIdentifier(bridgeRefEntryKey);
237 tx.delete(LogicalDatastoreType.OPERATIONAL, bridgeEntryId);
240 public static void createTunnelToInterfaceMap(String tunnelInstanceId,
242 WriteTransaction transaction) {
243 LOG.debug("creating tunnel instance identifier to interface map for {}",infName);
244 InstanceIdentifier<TunnelInstanceInterface> id = InstanceIdentifier.builder(TunnelInstanceInterfaceMap.class).
245 child(TunnelInstanceInterface.class, new TunnelInstanceInterfaceKey(tunnelInstanceId)).build();
246 TunnelInstanceInterface tunnelInstanceInterface = new TunnelInstanceInterfaceBuilder().
247 setTunnelInstanceIdentifier(tunnelInstanceId).setKey(new TunnelInstanceInterfaceKey(tunnelInstanceId)).setInterfaceName(infName).build();
248 transaction.put(LogicalDatastoreType.OPERATIONAL, id, tunnelInstanceInterface, true);
252 public static void createTunnelToInterfaceMap(String infName, InstanceIdentifier<Node> nodeId,
253 WriteTransaction transaction,
255 InstanceIdentifier<Tunnels> tunnelsInstanceIdentifier = org.opendaylight.genius.interfacemanager.renderer.hwvtep.utilities.SouthboundUtils.
256 createTunnelsInstanceIdentifier(nodeId,
257 ifTunnel.getTunnelSource(), ifTunnel.getTunnelDestination());
258 createTunnelToInterfaceMap(tunnelsInstanceIdentifier.toString(), infName, transaction);
261 public static void removeTunnelToInterfaceMap(InstanceIdentifier<Node> nodeId,
262 WriteTransaction transaction,
264 InstanceIdentifier<Tunnels> tunnelsInstanceIdentifier = org.opendaylight.genius.interfacemanager.renderer.hwvtep.utilities.SouthboundUtils.
265 createTunnelsInstanceIdentifier(nodeId,
266 ifTunnel.getTunnelSource(), ifTunnel.getTunnelDestination());
267 transaction.delete(LogicalDatastoreType.OPERATIONAL, tunnelsInstanceIdentifier);
270 public static String getInterfaceForTunnelInstanceIdentifier(String tunnelInstanceId,
271 DataBroker dataBroker) {
272 InstanceIdentifier<TunnelInstanceInterface> id = InstanceIdentifier.builder(TunnelInstanceInterfaceMap.class).
273 child(TunnelInstanceInterface.class, new TunnelInstanceInterfaceKey(tunnelInstanceId)).build();
274 Optional<TunnelInstanceInterface> tunnelInstanceInterfaceOptional = IfmUtil.read(LogicalDatastoreType.OPERATIONAL, id, dataBroker);
275 if(tunnelInstanceInterfaceOptional.isPresent()){
276 return tunnelInstanceInterfaceOptional.get().getInterfaceName();