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.vpnservice.elan.utils;
10 import com.google.common.base.Optional;
11 import com.google.common.util.concurrent.FutureCallback;
12 import com.google.common.util.concurrent.Futures;
13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
14 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
15 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.vpnservice.elan.internal.ElanInstanceManager;
18 import com.google.common.util.concurrent.CheckedFuture;
19 import org.opendaylight.vpnservice.elan.internal.ElanServiceProvider;
20 import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceInfo;
21 import org.opendaylight.vpnservice.interfacemgr.globals.InterfaceServiceUtil;
22 import org.opendaylight.vpnservice.itm.api.IITMProvider;
23 import org.opendaylight.vpnservice.mdsalutil.*;
24 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
25 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.PushVlanActionCase;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetFieldCase;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.*;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMac;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan._interface.forwarding.entries.ElanInterfaceMacKey;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTable;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTableBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.forwarding.tables.MacTableKey;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstance;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.instances.ElanInstanceKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterface;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.interfaces.ElanInterfaceKey;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.Elan;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.ElanBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.state.ElanKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagName;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntry;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.elan.rev150602.forwarding.entries.MacEntryKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.*;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceInputBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rpcs.rev151003.GetEgressActionsForInterfaceOutput;
62 import org.opendaylight.yangtools.yang.binding.DataObject;
63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
64 import org.opendaylight.yangtools.yang.common.RpcResult;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.IfIndexesInterfaceMap;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterface;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007._if.indexes._interface.map.IfIndexInterfaceKey;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.ServicesInfo;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.ServiceBindings;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.ServiceTypeFlowBased;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.StypeOpenflow;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.StypeOpenflowBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.ServicesInfoKey;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServices;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServicesBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.servicebinding.rev151015.service.bindings.services.info.BoundServicesKey;
82 import java.math.BigInteger;
83 import java.util.ArrayList;
84 import java.util.List;
85 import java.util.concurrent.ExecutionException;
86 import java.util.concurrent.Future;
88 public class ElanUtils {
90 private static ElanServiceProvider elanServiceProvider;
91 private static final Logger logger = LoggerFactory.getLogger(ElanUtils.class);
93 public static final FutureCallback<Void> DEFAULT_CALLBACK =
94 new FutureCallback<Void>() {
95 public void onSuccess(Void result) {
96 logger.debug("Success in Datastore operation");
99 public void onFailure(Throwable error) {
100 logger.error("Error in Datastore operation", error);
104 public static Integer getUniqueId(IdManagerService idManager, String poolName, String idKey) {
105 AllocateIdInput getIdInput = new AllocateIdInputBuilder()
106 .setPoolName(poolName)
107 .setIdKey(idKey).build();
110 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
111 RpcResult<AllocateIdOutput> rpcResult = result.get();
112 if(rpcResult.isSuccessful()) {
113 return rpcResult.getResult().getIdValue().intValue();
115 logger.warn("RPC Call to Allocate Id returned with Errors {}", rpcResult.getErrors());
117 } catch (InterruptedException | ExecutionException e) {
118 logger.warn("Exception when Allocating Id",e);
123 public static void setElanServiceProvider(ElanServiceProvider elanService) {
124 elanServiceProvider = elanService;
126 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
127 ReleaseIdInput releaseIdInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
128 Future<RpcResult<Void>> result = idManager.releaseId(releaseIdInput);
131 public static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
132 InstanceIdentifier<T> path) {
134 ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
136 Optional<T> result = Optional.absent();
138 result = tx.read(datastoreType, path).get();
139 } catch (Exception e) {
140 throw new RuntimeException(e);
147 public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
148 WriteTransaction tx = broker.newWriteOnlyTransaction();
149 tx.delete(datastoreType, path);
150 Futures.addCallback(tx.submit(), DEFAULT_CALLBACK);
153 public static InstanceIdentifier<ElanInstance> getElanInstanceIdentifier(String elanName) {
154 return InstanceIdentifier.builder(ElanInstances.class)
155 .child(ElanInstance.class, new ElanInstanceKey(elanName)).build();
158 public static InstanceIdentifier<ElanInstance> getElanInstanceIdentifier() {
159 return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class).build();
162 //elan-instances config container
163 public static ElanInstance getElanInstanceByName(String elanInstanceName) {
164 DataBroker broker = elanServiceProvider.getBroker();
165 InstanceIdentifier<ElanInstance> elanIdentifierId = getElanInstanceConfigurationDataPath(elanInstanceName);
166 Optional<ElanInstance> elanInstance = read(broker, LogicalDatastoreType.CONFIGURATION, elanIdentifierId);
167 if(elanInstance.isPresent()) {
168 return elanInstance.get();
173 public static InstanceIdentifier<ElanInstance> getElanInstanceConfigurationDataPath(String elanInstanceName) {
174 return InstanceIdentifier.builder(ElanInstances.class).child(ElanInstance.class, new ElanInstanceKey(elanInstanceName)).build();
177 //elan-interfaces Config Container
178 public static ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
179 DataBroker broker = elanServiceProvider.getBroker();
180 InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
181 Optional<ElanInterface> existingElanInterface = read(broker, LogicalDatastoreType.CONFIGURATION, elanInterfaceId);
182 if(existingElanInterface.isPresent()) {
183 return existingElanInterface.get();
188 public static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
189 return InstanceIdentifier.builder(ElanInterfaces.class).child(ElanInterface.class,
190 new ElanInterfaceKey(interfaceName)).build();
193 //elan-state Operational container
194 public static Elan getElanByName(String elanInstanceName) {
195 DataBroker broker = elanServiceProvider.getBroker();
196 InstanceIdentifier<Elan> elanIdentifier = getElanInstanceOperationalDataPath(elanInstanceName);
197 Optional<Elan> elanInstance = read(broker, LogicalDatastoreType.OPERATIONAL, elanIdentifier);
198 if(elanInstance.isPresent()) {
199 return elanInstance.get();
204 public static InstanceIdentifier<Elan> getElanInstanceOperationalDataPath(String elanInstanceName) {
205 return InstanceIdentifier.builder(ElanState.class).child(Elan.class, new ElanKey(elanInstanceName)).build();
208 // grouping of forwarding-entries
209 public static MacEntry getInterfaceMacEntriesOperationalDataPath(String interfaceName, PhysAddress physAddress) {
210 DataBroker broker = elanServiceProvider.getBroker();
211 InstanceIdentifier<MacEntry> existingMacEntryId = getInterfaceMacEntriesIdentifierOperationalDataPath(interfaceName, physAddress);
212 Optional<MacEntry> existingInterfaceMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, existingMacEntryId);
213 if(existingInterfaceMacEntry.isPresent()) {
214 return existingInterfaceMacEntry.get();
219 public static MacEntry getInterfaceMacEntriesOperationalDataPathFromId(InstanceIdentifier identifier) {
220 DataBroker broker = elanServiceProvider.getBroker();
221 Optional<MacEntry> existingInterfaceMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, identifier);
222 if(existingInterfaceMacEntry.isPresent()) {
223 return existingInterfaceMacEntry.get();
228 public static InstanceIdentifier<MacEntry> getInterfaceMacEntriesIdentifierOperationalDataPath(String interfaceName, PhysAddress physAddress) {
229 return InstanceIdentifier.builder(ElanInterfaceForwardingEntries.class).child(ElanInterfaceMac.class,
230 new ElanInterfaceMacKey(interfaceName)).child(MacEntry.class, new MacEntryKey(physAddress)).build();
234 //elan-forwarding-tables Operational container
235 public static MacEntry getMacTableByElanName(String elanName, PhysAddress physAddress) {
236 DataBroker broker = elanServiceProvider.getBroker();
237 InstanceIdentifier<MacEntry> macId = getMacEntryOperationalDataPath(elanName, physAddress);
238 Optional<MacEntry> existingElanMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, macId);
239 if(existingElanMacEntry.isPresent()) {
240 return existingElanMacEntry.get();
246 public static MacEntry getMacEntryFromElanMacId(InstanceIdentifier identifier) {
247 DataBroker broker = elanServiceProvider.getBroker();
248 Optional<MacEntry> existingInterfaceMacEntry = read(broker, LogicalDatastoreType.OPERATIONAL, identifier);
249 if(existingInterfaceMacEntry.isPresent()) {
250 return existingInterfaceMacEntry.get();
255 public static InstanceIdentifier<MacEntry> getMacEntryOperationalDataPath(String elanName, PhysAddress physAddress) {
256 return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class,
257 new MacTableKey(elanName)).child(MacEntry.class, new MacEntryKey(physAddress)).build();
260 public static InstanceIdentifier<MacTable> getElanMacTableOperationalDataPath(String elanName) {
261 return InstanceIdentifier.builder(ElanForwardingTables.class).child(MacTable.class,
262 new MacTableKey(elanName)).build();
265 //elan-interface-forwarding-entries Operational container
266 public static ElanInterfaceMac getElanInterfaceMacByInterfaceName(String interfaceName) {
267 DataBroker broker = elanServiceProvider.getBroker();
268 InstanceIdentifier<ElanInterfaceMac> elanInterfaceId = getElanInterfaceMacEntriesOperationalDataPath(interfaceName);
269 Optional<ElanInterfaceMac> existingElanInterface = read(broker, LogicalDatastoreType.OPERATIONAL, elanInterfaceId);
270 if(existingElanInterface.isPresent()) {
271 return existingElanInterface.get();
276 public static InstanceIdentifier<ElanInterfaceMac> getElanInterfaceMacEntriesOperationalDataPath(String interfaceName) {
277 return InstanceIdentifier.builder(ElanInterfaceForwardingEntries.class).child(ElanInterfaceMac.class,
278 new ElanInterfaceMacKey(interfaceName)).build();
281 //elan-dpn-interfaces Operational Container
282 public static DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, BigInteger dpId) {
283 DataBroker broker = elanServiceProvider.getBroker();
284 InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName, dpId);
285 Optional<DpnInterfaces> elanDpnInterfaces = read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId);
286 if(elanDpnInterfaces.isPresent()) {
287 return elanDpnInterfaces.get();
292 public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName, BigInteger dpId) {
293 return InstanceIdentifier.builder(ElanDpnInterfaces.class).child(ElanDpnInterfacesList.class,
294 new ElanDpnInterfacesListKey(elanInstanceName)).child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
297 //elan-tag-name-map Operational Container
298 public static ElanTagName getElanInfoByElanTag(long elanTag) {
299 DataBroker broker = elanServiceProvider.getBroker();
300 InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
301 Optional<ElanTagName> existingElanInfo = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanId);
302 if(existingElanInfo.isPresent()) {
303 return existingElanInfo.get();
308 public static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
309 return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
310 new ElanTagNameKey(elanTag)).build();
313 // interface-index-tag operational container
314 public static IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
315 DataBroker broker = elanServiceProvider.getBroker();
316 InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
317 Optional<IfIndexInterface> existingInterfaceInfo = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, interfaceId);
318 if(existingInterfaceInfo.isPresent()) {
319 return existingInterfaceInfo.get();
324 public static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
325 return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
326 new IfIndexInterfaceKey((int) interfaceTag)).build();
331 public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationDataPath(String elanInstanceName) {
332 return InstanceIdentifier.builder(ElanDpnInterfaces.class).child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName)).build();
335 public static ElanDpnInterfacesList getElanDpnInterfacesList(String elanName) {
336 DataBroker broker = elanServiceProvider.getBroker();
337 InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationDataPath(elanName);
338 Optional<ElanDpnInterfacesList> existingElanDpnInterfaces = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
339 if(existingElanDpnInterfaces.isPresent()) {
340 return existingElanDpnInterfaces.get();
345 public static ElanDpnInterfaces getElanDpnInterfacesList() {
346 DataBroker broker = elanServiceProvider.getBroker();
347 InstanceIdentifier<ElanDpnInterfaces> elanDpnInterfaceId = InstanceIdentifier.builder(ElanDpnInterfaces.class).build();
348 Optional<ElanDpnInterfaces> existingElanDpnInterfaces = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
349 if(existingElanDpnInterfaces.isPresent()) {
350 return existingElanDpnInterfaces.get();
355 public static ElanForwardingTables getElanForwardingList() {
356 DataBroker broker = elanServiceProvider.getBroker();
357 InstanceIdentifier<ElanForwardingTables> elanForwardingTableId = InstanceIdentifier.builder(ElanForwardingTables.class).build();
358 Optional<ElanForwardingTables> existingElanForwardingList = ElanUtils.read(broker, LogicalDatastoreType.OPERATIONAL, elanForwardingTableId);
359 if(existingElanForwardingList.isPresent()) {
360 return existingElanForwardingList.get();
366 public static long getElanLocalBCGID(long elanTag) {
367 return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2) - 1);
370 public static long getElanRemoteBCGID(long elanTag) {
371 return ElanConstants.ELAN_GID_MIN + (((elanTag % ElanConstants.ELAN_GID_MIN) *2));
374 public static BigInteger getElanMetadataLabel(long elanTag) {
375 return (BigInteger.valueOf(elanTag)).shiftLeft(24);
378 public static BigInteger getElanMetadataLabel(long elanTag, int lportTag) {
379 return getElanMetadataLabel(elanTag).or(MetaDataUtil.getLportTagMetaData(lportTag));
382 public static BigInteger getElanMetadataMask() {
383 return MetaDataUtil.METADATA_MASK_SERVICE.or(MetaDataUtil.METADATA_MASK_LPORT_TAG);
386 public static void setupMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout,
388 IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
389 DataBroker broker = elanServiceProvider.getBroker();
390 IITMProvider itmManager = elanServiceProvider.getItmManager();
391 synchronized (macAddress) {
392 logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation.");
393 setupKnownSmacFlow(elanInfo, interfaceInfo, macTimeout, macAddress, mdsalApiManager);
394 setupTermDmacFlows(interfaceInfo, itmManager);
395 setupOrigDmacFlows(elanInfo, interfaceInfo, macAddress, mdsalApiManager, broker);
399 public static void setupDMacFlowonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId,
401 synchronized (macAddress) {
402 logger.info("Acquired lock for mac : " + macAddress + "Proceeding with install operation.");
403 setupOrigDmacFlowsonRemoteDpn(elanInfo, interfaceInfo, dstDpId, macAddress);
408 private static void setupKnownSmacFlow(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout,
409 String macAddress, IMdsalApiManager mdsalApiManager) {
410 FlowEntity flowEntity = getKnownSmacFlowEntity(elanInfo, interfaceInfo, macTimeout, macAddress);
411 mdsalApiManager.installFlow(flowEntity);
412 if (logger.isDebugEnabled()) {
413 logger.debug("Known Smac flow entry created for elan Name:{}, logical Interface port:{} and mac address:{}", elanInfo.getElanInstanceName(), elanInfo.getDescription(), macAddress);
417 private static FlowEntity getKnownSmacFlowEntity(ElanInstance elanInfo, InterfaceInfo interfaceInfo, long macTimeout, String macAddress) {
418 BigInteger dpId = interfaceInfo.getDpId();
419 int lportTag = interfaceInfo.getInterfaceTag();
420 long elanTag = elanInfo.getElanTag();
421 // Matching metadata and eth_src fields
422 List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
423 mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
424 ElanUtils.getElanMetadataLabel(elanInfo.getElanTag(), lportTag),
425 ElanUtils.getElanMetadataMask() }));
426 mkMatches.add(new MatchInfo(MatchFieldType.eth_src, new String[] { macAddress }));
427 List<InstructionInfo> mkInstructions = new ArrayList<InstructionInfo>();
428 mkInstructions.add(new InstructionInfo(InstructionType.goto_table, new long[] { ElanConstants.ELAN_DMAC_TABLE }));
430 FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, ElanConstants.ELAN_SMAC_TABLE,
431 getKnownDynamicmacFlowRef(ElanConstants.ELAN_SMAC_TABLE, dpId, lportTag, macAddress, elanTag),
432 20, elanInfo.getDescription(), (int)macTimeout, 0, ElanConstants.COOKIE_ELAN_KNOWN_SMAC.add(BigInteger.valueOf(elanTag)),
433 mkMatches, mkInstructions);
434 flowEntity.setStrictFlag(true);
435 flowEntity.setSendFlowRemFlag(macTimeout != 0); //If Mac timeout is 0, the flow wont be deleted automatically, so no need to get notified
439 private static void setupTermDmacFlows(InterfaceInfo interfaceInfo, IITMProvider itmManager) {
440 BigInteger dpId = interfaceInfo.getDpId();
441 long lportGroupId = interfaceInfo.getGroupId();
442 int lportTag = interfaceInfo.getInterfaceTag();
443 List <ActionInfo> actionsInfos = new ArrayList <ActionInfo> ();
444 actionsInfos = getEgressActionsForInterface(interfaceInfo.getInterfaceName());
446 //FIXME [ELANBE] ITM Service API to invoke Terminating Service
447 //itmManager.createTerminatingServiceActions(dpId, lportTag, actionsInfos);
448 if (logger.isDebugEnabled()) {
449 logger.debug("Terminating service table flow entry created on dpn:{} for logical Interface port:{}", dpId, interfaceInfo.getPortName());
453 public static List<ActionInfo> getEgressActionsForInterface(String ifName) {
454 List<ActionInfo> listActionInfo = new ArrayList<ActionInfo>();
456 Future<RpcResult<GetEgressActionsForInterfaceOutput>> result =
457 elanServiceProvider.getInterfaceManagerRpcService().getEgressActionsForInterface(
458 new GetEgressActionsForInterfaceInputBuilder().setIntfName(ifName).build());
459 RpcResult<GetEgressActionsForInterfaceOutput> rpcResult = result.get();
460 if(!rpcResult.isSuccessful()) {
461 logger.warn("RPC Call to Get egress actions for interface {} returned with Errors {}", ifName, rpcResult.getErrors());
463 List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> actions =
464 rpcResult.getResult().getAction();
465 for (Action action : actions) {
466 org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action actionClass = action.getAction();
467 if (actionClass instanceof OutputActionCase) {
468 listActionInfo.add(new ActionInfo(ActionType.output,
469 new String[] {((OutputActionCase)actionClass).getOutputAction()
470 .getOutputNodeConnector().getValue()}));
471 } else if (actionClass instanceof PushVlanActionCase) {
472 listActionInfo.add(new ActionInfo(ActionType.push_vlan, new String[] {}));
473 } else if (actionClass instanceof SetFieldCase) {
474 if (((SetFieldCase)actionClass).getSetField().getVlanMatch() != null) {
475 int vlanVid = ((SetFieldCase)actionClass).getSetField().getVlanMatch().getVlanId().getVlanId().getValue();
476 listActionInfo.add(new ActionInfo(ActionType.set_field_vlan_vid,
477 new String[] { Long.toString(vlanVid) }));
482 } catch (InterruptedException | ExecutionException e) {
483 logger.warn("Exception when egress actions for interface {}", ifName, e);
485 return listActionInfo;
488 private static void setupOrigDmacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress,
489 IMdsalApiManager mdsalApiManager, DataBroker broker) {
490 BigInteger dpId = interfaceInfo.getDpId();
491 String ifName = interfaceInfo.getInterfaceName();
492 long ifTag = interfaceInfo.getInterfaceTag();
493 long groupId = interfaceInfo.getGroupId();
494 String elanInstanceName = elanInfo.getElanInstanceName();
495 List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
496 if(remoteFEs != null) {
497 for (DpnInterfaces remoteFE : remoteFEs) {
498 Long elanTag = elanInfo.getElanTag();
499 if (remoteFE.getDpId().equals(dpId)) {
500 // On the local FE set up a direct output flow
501 setupLocalDmacFlow(elanTag, dpId, ifName, macAddress, elanInstanceName, mdsalApiManager, ifTag);
502 if (logger.isDebugEnabled()) {
503 logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpId);
506 if (isDpnPresent(remoteFE.getDpId())) {
507 // Check for the Remote DPN present in Inventory Manager
508 setupRemoteDmacFlow(remoteFE.getDpId(), dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName);
509 if (logger.isDebugEnabled()) {
510 logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId());
518 private static void setupOrigDmacFlowsonRemoteDpn(ElanInstance elanInfo, InterfaceInfo interfaceInfo, BigInteger dstDpId, String macAddress) {
519 BigInteger dpId = interfaceInfo.getDpId();
520 String elanInstanceName = elanInfo.getElanInstanceName();
521 List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
522 for(DpnInterfaces remoteFE: remoteFEs) {
523 Long elanTag = elanInfo.getElanTag();
524 if (remoteFE.getDpId().equals(dstDpId)) {
525 // Check for the Remote DPN present in Inventory Manager
526 setupRemoteDmacFlow(dstDpId, dpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress, elanInstanceName);
527 if (logger.isDebugEnabled()) {
528 logger.debug("Dmac flow entry created for elan Name:{}, logical port Name:{} and mac address {} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, remoteFE.getDpId());
536 @SuppressWarnings("unchecked")
537 public static List<DpnInterfaces> getInvolvedDpnsInElan(String elanName) {
538 List<DpnInterfaces> dpns = ElanInstanceManager.getElanInstanceManager().getElanDPNByName(elanName);
542 private static void setupLocalDmacFlow(long elanTag, BigInteger dpId, String ifName, String macAddress,
543 String displayName, IMdsalApiManager mdsalApiManager, long ifTag) {
544 FlowEntity flowEntity = getLocalDmacFlowEntry(elanTag, dpId, ifName, macAddress, displayName, ifTag);
545 mdsalApiManager.installFlow(flowEntity);
549 public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, long lporTag, String macAddress, long elanTag) {
550 return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(lporTag).append(macAddress).toString();
553 public static String getKnownDynamicmacFlowRef(short tableId, BigInteger dpId, BigInteger remoteDpId, String macAddress, long elanTag) {
554 return new StringBuffer().append(tableId).append(elanTag).append(dpId).append(remoteDpId).append(macAddress).toString();
557 public static FlowEntity getLocalDmacFlowEntry(long elanTag, BigInteger dpId, String ifName, String macAddress,
558 String displayName, long ifTag) {
559 List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
560 mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
561 ElanUtils.getElanMetadataLabel(elanTag),
562 MetaDataUtil.METADATA_MASK_SERVICE }));
563 mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress }));
565 List<InstructionInfo> mkInstructions = new ArrayList<InstructionInfo>();
566 List <ActionInfo> actionsInfos = new ArrayList <ActionInfo> ();
567 actionsInfos.addAll(getEgressActionsForInterface(ifName));
568 mkInstructions.add(new InstructionInfo(InstructionType.write_actions, actionsInfos));
570 FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpId, ElanConstants.ELAN_DMAC_TABLE,
571 getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, dpId, ifTag, macAddress, elanTag),
572 20, displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)),
573 mkMatches, mkInstructions);
577 public static void setupRemoteDmacFlow(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag, String macAddress,
578 String displayName) {
579 IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
580 FlowEntity flowEntity = getRemoteDmacFlowEntry(srcDpId, destDpId, lportTag, elanTag, macAddress, displayName);
581 mdsalApiManager.installFlow(flowEntity);
584 public static FlowEntity getRemoteDmacFlowEntry(BigInteger srcDpId, BigInteger destDpId, int lportTag, long elanTag,
585 String macAddress, String displayName) {
586 IITMProvider itmManager = elanServiceProvider.getItmManager();
587 List<MatchInfo> mkMatches = new ArrayList<MatchInfo>();
588 mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[]{
589 ElanUtils.getElanMetadataLabel(elanTag),
590 MetaDataUtil.METADATA_MASK_SERVICE }));
591 mkMatches.add(new MatchInfo(MatchFieldType.eth_dst, new String[] { macAddress }));
593 List<InstructionInfo> mkInstructions = new ArrayList<InstructionInfo>();
594 //List of ActionInfo for the provided Source and Destination DPIDs
596 //FIXME [ELANBE] Removing ITM API for now, will need this for multi dpn.
597 //List<ActionInfo> actionsInfos = itmManager.ITMIngressGetActions(srcDpId, destDpId, lportTag);
598 //mkInstructions.add(new InstructionInfo(InstructionType.write_actions, actionsInfos));
599 } catch (Exception e) {
600 logger.error("Interface Not Found exception");
603 FlowEntity flowEntity = MDSALUtil.buildFlowEntity(srcDpId, ElanConstants.ELAN_DMAC_TABLE,
604 getKnownDynamicmacFlowRef(ElanConstants.ELAN_DMAC_TABLE, srcDpId, destDpId, macAddress, elanTag),
605 20, displayName, 0, 0, ElanConstants.COOKIE_ELAN_KNOWN_DMAC.add(BigInteger.valueOf(elanTag)),
606 mkMatches, mkInstructions);
610 public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, MacEntry macEntry) {
611 if (elanInfo == null || interfaceInfo == null) {
614 String macAddress = macEntry.getMacAddress().getValue();
615 synchronized (macAddress) {
616 logger.info("Acquired lock for mac : " + macAddress + "Proceeding with remove operation.");
617 deleteMacFlows(elanInfo, interfaceInfo, macAddress, true);
621 public static void deleteMacFlows(ElanInstance elanInfo, InterfaceInfo interfaceInfo, String macAddress, boolean deleteSmac) {
622 String elanInstanceName = elanInfo.getElanInstanceName();
623 String ifName = interfaceInfo.getInterfaceName();
624 long ifTag = interfaceInfo.getInterfaceTag();
625 List<DpnInterfaces> remoteFEs = getInvolvedDpnsInElan(elanInstanceName);
626 IMdsalApiManager mdsalApiManager = elanServiceProvider.getMdsalManager();
627 IITMProvider itmManager = elanServiceProvider.getItmManager();
628 BigInteger srcdpId = interfaceInfo.getDpId();
629 String displayName = elanInstanceName;
630 long groupId = interfaceInfo.getGroupId();
631 for (DpnInterfaces dpnInterface: remoteFEs) {
632 Long elanTag = elanInfo.getElanTag();
633 if (dpnInterface.getDpId().equals(srcdpId)) {
635 mdsalApiManager.removeFlow(getKnownSmacFlowEntity(elanInfo, interfaceInfo, 0, macAddress));
637 mdsalApiManager.removeFlow(getLocalDmacFlowEntry(elanTag, dpnInterface.getDpId(), ifName, macAddress, displayName, ifTag));
639 //FIXME [ELANBE] Removing ITM API for now, will need this for multi dpn.
640 //itmManager.removeTerminatingServiceAction(dpnInterface.getDpId(), interfaceInfo.getInterfaceTag());
641 if (logger.isDebugEnabled()) {
642 logger.debug("All the required flows deleted for elan:{}, logical Interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpnInterface.getDpId());
644 } else if (isDpnPresent(dpnInterface.getDpId())) {
645 mdsalApiManager.removeFlow(
646 getRemoteDmacFlowEntry(dpnInterface.getDpId(), srcdpId, interfaceInfo.getInterfaceTag(), elanTag, macAddress,
648 if (logger.isDebugEnabled()) {
649 logger.debug("Dmac flow entry deleted for elan:{}, logical interface port:{} and mac address:{} on dpn:{}", elanInstanceName, interfaceInfo.getPortName(), macAddress, dpnInterface.getDpId());
655 public static void UpdateOperationalDataStore(DataBroker broker, IdManagerService idManager, ElanInstance elanInstanceAdded) {
656 String elanInstanceName = elanInstanceAdded.getElanInstanceName();
657 long elanTag = ElanUtils.getUniqueId(idManager, ElanConstants.ELAN_ID_POOL_NAME, elanInstanceName);
658 Elan elanInfo = new ElanBuilder().setName(elanInstanceName).setKey(new ElanKey(elanInstanceName)).build();
659 //Add the ElanState in the elan-state operational data-store
660 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInstanceOperationalDataPath(elanInstanceName), elanInfo);
661 //Add the ElanMacTable in the elan-mac-table operational data-store
662 MacTable elanMacTable = new MacTableBuilder().setKey(new MacTableKey(elanInstanceName)).build();
663 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanMacTableOperationalDataPath(elanInstanceName), elanMacTable);
664 ElanTagName elanTagName = new ElanTagNameBuilder().setElanTag(elanTag).setKey(new ElanTagNameKey(elanTag)).setName(elanInstanceName).build();
665 //Add the ElanTag to ElanName in the elan-tag-name Operational data-store
666 MDSALUtil.syncWrite(broker, LogicalDatastoreType.OPERATIONAL, ElanUtils.getElanInfoEntriesOperationalDataPath(elanTag), elanTagName);
667 ElanInstance elanInstanceWithTag = new ElanInstanceBuilder().setElanInstanceName(elanInstanceName).setDescription(elanInstanceAdded.getDescription()).setMacTimeout(elanInstanceAdded
668 .getMacTimeout() == null ? ElanConstants.DEFAULT_MAC_TIME_OUT : elanInstanceAdded.getMacTimeout()).setKey(elanInstanceAdded.getKey()).setElanTag(elanTag).build();
669 MDSALUtil.syncUpdate(broker, LogicalDatastoreType.CONFIGURATION, getElanInstanceIdentifier(elanInstanceName), elanInstanceWithTag);
672 public static boolean isDpnPresent(BigInteger dpnId) {
673 DataBroker broker = elanServiceProvider.getBroker();
674 boolean isPresent = false;
675 String dpn = String.format("%s:%s", "openflow",dpnId);
676 NodeId nodeId = new NodeId(dpn);
677 InstanceIdentifier<Node> node = InstanceIdentifier.builder(Nodes.class).child(Node.class, new NodeKey(nodeId)).build();
678 Optional<Node> nodePresent = read(broker, LogicalDatastoreType.OPERATIONAL, node);
679 if(nodePresent.isPresent()) {
685 public static ServicesInfo getServiceInfo(String elanInstanceName, long elanTag, String interfaceName) {
686 int priority = ElanConstants.ELAN_SERVICE_PRIORITY;
687 int instructionKey = 0;
688 List<Instruction> instructions = new ArrayList<Instruction>();
689 instructions.add(MDSALUtil.buildAndGetWriteMetadaInstruction(ElanUtils.getElanMetadataLabel(elanTag), MetaDataUtil.METADATA_MASK_SERVICE, ++instructionKey));
690 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(ElanConstants.ELAN_SMAC_TABLE, ++instructionKey));
692 ServicesInfo serviceInfo = InterfaceServiceUtil.buildServiceInfo(String.format("%s.%s", elanInstanceName, interfaceName), ElanConstants.ELAN_SERVICE_INDEX,
693 priority, ElanConstants.COOKIE_ELAN_INGRESS_TABLE, instructions);
697 public static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType,
698 InstanceIdentifier<T> path, FutureCallback<Void> callback) {
699 WriteTransaction tx = broker.newWriteOnlyTransaction();
700 tx.delete(datastoreType, path);
701 Futures.addCallback(tx.submit(), callback);
704 public static <T extends DataObject> void syncWrite(DataBroker broker, LogicalDatastoreType datastoreType,
705 InstanceIdentifier<T> path, T data) {
706 WriteTransaction tx = broker.newWriteOnlyTransaction();
707 tx.put(datastoreType, path, data, true);
708 CheckedFuture<Void, TransactionCommitFailedException> futures = tx.submit();
711 } catch (InterruptedException | ExecutionException e) {
712 logger.error("Error writing to datastore (path, data) : ({}, {})", path, data);
713 throw new RuntimeException(e.getMessage());
718 public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
719 BigInteger cookie, List<Instruction> instructions) {
720 StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority).setInstruction(instructions);
721 return new BoundServicesBuilder().setKey(new BoundServicesKey(servicePriority))
722 .setServiceName(serviceName).setServicePriority(servicePriority)
723 .setServiceType(ServiceTypeFlowBased.class).addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
726 public static InstanceIdentifier<BoundServices> buildServiceId(String vpnInterfaceName, short serviceIndex) {
727 return InstanceIdentifier.builder(ServiceBindings.class).child(ServicesInfo.class, new ServicesInfoKey(vpnInterfaceName))
728 .child(BoundServices.class, new BoundServicesKey(serviceIndex)).build();