2 * Copyright (c) 2016, 2017 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;
10 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
11 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.GRE_TRUNK_INTERFACE;
12 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE;
13 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.MPLS_OVER_GRE;
14 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VLAN_INTERFACE;
15 import static org.opendaylight.genius.interfacemanager.globals.InterfaceInfo.InterfaceType.VXLAN_TRUNK_INTERFACE;
16 import static org.opendaylight.mdsal.binding.api.WriteTransaction.CREATE_MISSING_PARENTS;
18 import com.google.common.collect.ImmutableMap;
19 import com.google.common.util.concurrent.ListenableFuture;
20 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
21 import java.util.ArrayList;
22 import java.util.Collections;
23 import java.util.List;
24 import java.util.Optional;
25 import java.util.concurrent.ExecutionException;
26 import java.util.concurrent.Future;
27 import java.util.regex.Pattern;
28 import org.apache.commons.lang3.BooleanUtils;
29 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
30 import org.opendaylight.genius.infra.Datastore.Configuration;
31 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
32 import org.opendaylight.genius.infra.TypedWriteTransaction;
33 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
34 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
35 import org.opendaylight.genius.interfacemanager.globals.VlanInterfaceInfo;
36 import org.opendaylight.genius.mdsalutil.ActionInfo;
37 import org.opendaylight.genius.mdsalutil.MDSALUtil;
38 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
39 import org.opendaylight.genius.mdsalutil.NwConstants;
40 import org.opendaylight.genius.mdsalutil.actions.ActionGroup;
41 import org.opendaylight.genius.mdsalutil.actions.ActionNxResubmit;
42 import org.opendaylight.genius.mdsalutil.actions.ActionOutput;
43 import org.opendaylight.genius.mdsalutil.actions.ActionPushVlan;
44 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
45 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldTunnelId;
46 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldVlanVid;
47 import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelDestinationIp;
48 import org.opendaylight.genius.mdsalutil.actions.ActionSetTunnelSourceIp;
49 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
50 import org.opendaylight.mdsal.binding.api.DataBroker;
51 import org.opendaylight.mdsal.binding.api.ReadTransaction;
52 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev170119.L2vlan;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev170119.Tunnel;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdPools;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPool;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.id.pools.IdPoolKey;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan.L2vlanMode;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefs;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.ParentRefsBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeBase;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeGre;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeLogicalGroup;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeMplsOverGre;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlan;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.TunnelTypeVxlanGpe;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg6;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
97 import org.opendaylight.yangtools.yang.binding.DataObject;
98 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
99 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
100 import org.opendaylight.yangtools.yang.common.RpcResult;
101 import org.opendaylight.yangtools.yang.common.Uint64;
102 import org.slf4j.Logger;
103 import org.slf4j.LoggerFactory;
105 public final class IfmUtil {
106 private static final Logger LOG = LoggerFactory.getLogger(IfmUtil.class);
107 private static final Pattern GENERATE_MAC_PATTERN = Pattern.compile("(.{2})");
108 private static final int INVALID_ID = 0;
111 throw new IllegalStateException("Utility class");
114 private static final ImmutableMap<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType>
115 TUNNEL_TYPE_MAP = new ImmutableMap.Builder<Class<? extends TunnelTypeBase>, InterfaceInfo.InterfaceType>()
116 .put(TunnelTypeGre.class, GRE_TRUNK_INTERFACE).put(TunnelTypeMplsOverGre.class, MPLS_OVER_GRE)
117 .put(TunnelTypeVxlan.class, VXLAN_TRUNK_INTERFACE).put(TunnelTypeVxlanGpe.class, VXLAN_TRUNK_INTERFACE)
118 .put(TunnelTypeLogicalGroup.class, LOGICAL_GROUP_INTERFACE)
121 public static Uint64 getDpnFromNodeConnectorId(NodeConnectorId portId) {
122 return Uint64.valueOf(getDpnStringFromNodeConnectorId(portId));
125 public static String getDpnStringFromNodeConnectorId(NodeConnectorId portId) {
127 * NodeConnectorId is of form 'openflow:dpnid:portnum'
129 return portId.getValue().split(IfmConstants.OF_URI_SEPARATOR)[1];
132 public static Uint64 getDpnFromInterface(
133 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
134 .ietf.interfaces.rev140508.interfaces.state.Interface ifState) {
135 NodeConnectorId ncId = getNodeConnectorIdFromInterface(ifState);
137 return getDpnFromNodeConnectorId(ncId);
142 public static String getPortNoFromNodeConnectorId(NodeConnectorId portId) {
144 * NodeConnectorId is of form 'openflow:dpnid:portnum'
146 String[] split = portId.getValue().split(IfmConstants.OF_URI_SEPARATOR);
150 public static Long getPortNumberFromNodeConnectorId(NodeConnectorId portId) {
151 String portNo = getPortNoFromNodeConnectorId(portId);
153 return Long.valueOf(portNo);
154 } catch (NumberFormatException ex) {
155 LOG.trace("Unable to retrieve port number from nodeconnector id for {}", portId);
157 return IfmConstants.INVALID_PORT_NO;
160 public static NodeId buildDpnNodeId(Uint64 dpnId) {
161 return new NodeId(IfmConstants.OF_URI_PREFIX + dpnId);
164 public static InstanceIdentifier<Interface> buildId(String interfaceName) {
165 // TODO Make this generic and move to AbstractDataChangeListener or
167 InstanceIdentifierBuilder<Interface> idBuilder = InstanceIdentifier.builder(Interfaces.class)
168 .child(Interface.class, new InterfaceKey(interfaceName));
169 return idBuilder.build();
172 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn
173 .ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface> buildStateInterfaceId(
174 String interfaceName) {
175 InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn
176 .ietf.params.xml.ns.yang.ietf.interfaces.rev140508
177 .interfaces.state.Interface> idBuilder = InstanceIdentifier
178 .builder(InterfacesState.class)
179 .child(org.opendaylight.yang.gen.v1.urn
180 .ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.class,
181 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
182 .ietf.interfaces.rev140508.interfaces.state.InterfaceKey(
184 return idBuilder.build();
187 public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
188 .ietf.interfaces.rev140508.interfaces.state.InterfaceKey getStateInterfaceKeyFromName(
190 return new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
191 .ietf.interfaces.rev140508.interfaces.state.InterfaceKey(
195 public static InstanceIdentifier<IdPool> getPoolId(String poolName) {
196 return InstanceIdentifier.builder(IdPools.class).child(IdPool.class, new IdPoolKey(poolName)).build();
199 public static long getGroupId(int ifIndex, InterfaceInfo.InterfaceType infType) {
200 if (infType == LOGICAL_GROUP_INTERFACE) {
201 return getLogicalTunnelSelectGroupId(ifIndex);
207 * Synchronous blocking read from data store.
210 * {@link SingleTransactionDataBroker#syncReadOptional(DataBroker, LogicalDatastoreType, InstanceIdentifier)}
214 public static <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
215 InstanceIdentifier<T> path, DataBroker broker) {
216 try (ReadTransaction tx = broker.newReadOnlyTransaction()) {
217 return tx.read(datastoreType, path).get();
218 } catch (InterruptedException | ExecutionException e) {
219 LOG.error("Cannot read identifier", e);
220 throw new RuntimeException(e);
224 public static List<Action> getEgressActionsForInterface(String interfaceName, Long tunnelKey, Integer actionKey,
225 InterfaceManagerCommonUtils interfaceUtils, Boolean isDefaultEgress) {
226 List<ActionInfo> listActionInfo = getEgressActionInfosForInterface(interfaceName, tunnelKey,
227 actionKey == null ? 0 : actionKey, interfaceUtils, isDefaultEgress);
228 List<Action> actionsList = new ArrayList<>();
229 for (ActionInfo actionInfo : listActionInfo) {
230 actionsList.add(actionInfo.buildAction());
235 public static List<Instruction> getEgressInstructionsForInterface(String interfaceName, Long tunnelKey,
236 InterfaceManagerCommonUtils interfaceUtils, Boolean isDefaultEgress) {
237 List<Instruction> instructions = new ArrayList<>();
238 List<Action> actionList = MDSALUtil.buildActions(
239 getEgressActionInfosForInterface(interfaceName, tunnelKey, 0, interfaceUtils, isDefaultEgress));
240 instructions.add(MDSALUtil.buildApplyActionsInstruction(actionList));
244 public static List<Instruction> getEgressInstructionsForInterface(Interface interfaceInfo, String portNo,
245 Long tunnelKey, boolean isDefaultEgress,
246 int ifIndex, long groupId) {
247 List<Instruction> instructions = new ArrayList<>();
248 InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
249 List<Action> actionList = MDSALUtil.buildActions(
250 getEgressActionInfosForInterface(interfaceInfo, portNo, ifaceType, tunnelKey, 0,
251 isDefaultEgress, ifIndex, groupId));
252 instructions.add(MDSALUtil.buildApplyActionsInstruction(actionList));
256 public static List<ActionInfo> getEgressActionInfosForInterface(String interfaceName, int actionKeyStart,
257 InterfaceManagerCommonUtils interfaceUtils, Boolean isDefaultEgress) {
258 return getEgressActionInfosForInterface(interfaceName, null, actionKeyStart, interfaceUtils, isDefaultEgress);
262 * Returns a list of Actions to be taken when sending a packet over an
265 * @param interfaceName
266 * name of the interface
269 * @param actionKeyStart
271 * @param interfaceUtils
272 * InterfaceManagerCommonUtils
273 * @return list of actions
275 public static List<ActionInfo> getEgressActionInfosForInterface(String interfaceName, Long tunnelKey,
276 int actionKeyStart, InterfaceManagerCommonUtils interfaceUtils, Boolean isDefaultEgress) {
277 Interface interfaceInfo = interfaceUtils.getInterfaceFromConfigDS(new InterfaceKey(interfaceName));
278 if (interfaceInfo == null) {
279 throw new NullPointerException("Interface information not present in config DS for " + interfaceName);
281 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
282 .ietf.interfaces.rev140508.interfaces.state.Interface ifState =
283 interfaceUtils.getInterfaceState(interfaceName);
284 if (ifState == null) {
285 throw new NullPointerException("Interface information not present in oper DS for " + interfaceName);
287 String lowerLayerIf = ifState.getLowerLayerIf().get(0);
288 NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
289 String portNo = IfmUtil.getPortNoFromNodeConnectorId(nodeConnectorId);
291 InterfaceInfo.InterfaceType ifaceType = getInterfaceType(interfaceInfo);
292 return getEgressActionInfosForInterface(interfaceInfo, portNo, ifaceType, tunnelKey, actionKeyStart,
293 isDefaultEgress, ifState.getIfIndex(), 0);
297 * Returns the list of egress actions for a given interface.
299 * @param interfaceInfo the interface to look up
300 * @param portNo port number
301 * @param ifaceType the type of the interface
302 * @param tunnelKey the tunnel key
303 * @param actionKeyStart the start for the first key assigned for the new actions
304 * @param isDefaultEgress if it is the default egress
305 * @param ifIndex interface index
306 * @param groupId group Id
307 * @return list of actions for the interface
309 // The following suppression is for javac, not for checkstyle
310 @SuppressWarnings("fallthrough")
311 @SuppressFBWarnings("SF_SWITCH_FALLTHROUGH")
312 public static List<ActionInfo> getEgressActionInfosForInterface(Interface interfaceInfo, String portNo,
313 InterfaceInfo.InterfaceType ifaceType, Long tunnelKey, int actionKeyStart, boolean isDefaultEgress,
314 int ifIndex, long groupId) {
315 List<ActionInfo> result = new ArrayList<>();
319 case GRE_TRUNK_INTERFACE:
320 if (!isDefaultEgress) {
321 // TODO tunnel_id to encode GRE key, once it is supported
322 // Until then, tunnel_id should be "cleaned", otherwise it
323 // stores the value coming from a VXLAN tunnel
324 if (tunnelKey == null) {
329 case VXLAN_TRUNK_INTERFACE:
330 if (!isDefaultEgress) {
331 if (tunnelKey != null) {
332 result.add(new ActionSetFieldTunnelId(actionKeyStart++, Uint64.valueOf(tunnelKey)));
335 // For OF Tunnels default egress actions need to set tunnelIps
336 IfTunnel ifTunnel = interfaceInfo.augmentation(IfTunnel.class);
337 if (BooleanUtils.isTrue(ifTunnel.isTunnelRemoteIpFlow()
338 && ifTunnel.getTunnelDestination() != null)) {
339 result.add(new ActionSetTunnelDestinationIp(actionKeyStart++, ifTunnel.getTunnelDestination()));
341 if (BooleanUtils.isTrue(ifTunnel.isTunnelSourceIpFlow()
342 && ifTunnel.getTunnelSource() != null)) {
343 result.add(new ActionSetTunnelSourceIp(actionKeyStart++, ifTunnel.getTunnelSource()));
348 if (isDefaultEgress) {
349 IfL2vlan vlanIface = interfaceInfo.augmentation(IfL2vlan.class);
350 LOG.trace("get egress actions for l2vlan interface: {}", vlanIface);
351 boolean isVlanTransparent = false;
353 if (vlanIface != null) {
354 vlanVid = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().toJava();
355 isVlanTransparent = vlanIface.getL2vlanMode() == IfL2vlan.L2vlanMode.Transparent;
357 if (vlanVid != 0 && !isVlanTransparent) {
358 result.add(new ActionPushVlan(actionKeyStart++));
359 result.add(new ActionSetFieldVlanVid(actionKeyStart++, vlanVid));
361 result.add(new ActionOutput(actionKeyStart++, new Uri(portNo)));
363 addEgressActionInfosForInterface(ifIndex, actionKeyStart, result);
366 case LOGICAL_GROUP_INTERFACE:
367 if (isDefaultEgress) {
368 result.add(new ActionGroup(groupId));
370 addEgressActionInfosForInterface(ifIndex, actionKeyStart, result);
375 LOG.warn("Interface Type {} not handled yet", ifaceType);
381 public static void addEgressActionInfosForInterface(int ifIndex, int actionKeyStart, List<ActionInfo> result) {
382 long regValue = MetaDataUtil.getReg6ValueForLPortDispatcher(ifIndex, NwConstants.DEFAULT_SERVICE_INDEX);
383 result.add(new ActionRegLoad(actionKeyStart++, NxmNxReg6.class, IfmConstants.REG6_START_INDEX,
384 IfmConstants.REG6_END_INDEX, regValue));
385 result.add(new ActionNxResubmit(actionKeyStart, NwConstants.EGRESS_LPORT_DISPATCHER_TABLE));
388 public static NodeId getNodeIdFromNodeConnectorId(NodeConnectorId ncId) {
389 return new NodeId(ncId.getValue().substring(0, ncId.getValue().lastIndexOf(':')));
392 public static Uint64[] mergeOpenflowMetadataWriteInstructions(List<Instruction> instructions) {
393 Uint64 metadata = Uint64.ZERO;
394 Uint64 metadataMask = Uint64.ZERO;
395 if (instructions != null && !instructions.isEmpty()) {
396 // check if metadata write instruction is present
397 for (Instruction instruction : instructions) {
398 org.opendaylight.yang.gen.v1.urn.opendaylight.flow
399 .types.rev131026.instruction.Instruction actualInstruction = instruction
401 if (actualInstruction instanceof WriteMetadataCase) {
402 WriteMetadataCase writeMetaDataInstruction = (WriteMetadataCase) actualInstruction;
403 WriteMetadata availableMetaData = writeMetaDataInstruction.getWriteMetadata();
404 metadata = Uint64.fromLongBits(metadata.longValue() | availableMetaData.getMetadata().longValue());
405 metadataMask = Uint64.fromLongBits(metadataMask.longValue()
406 | availableMetaData.getMetadataMask().longValue());
410 return new Uint64[] { metadata, metadataMask };
413 public static Integer allocateId(IdManagerService idManager, String poolName, String idKey) {
414 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
416 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
417 RpcResult<AllocateIdOutput> rpcResult = result.get();
418 if (rpcResult.isSuccessful()) {
419 return rpcResult.getResult().getIdValue().intValue();
421 LOG.warn("RPC Call to Get Unique Id returned with Errors {}", rpcResult.getErrors());
423 } catch (InterruptedException | ExecutionException e) {
424 LOG.warn("Exception when getting Unique Id", e);
429 public static void releaseId(IdManagerService idManager, String poolName, String idKey) {
430 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
432 ListenableFuture<RpcResult<ReleaseIdOutput>> result = idManager.releaseId(idInput);
433 RpcResult<ReleaseIdOutput> rpcResult = result.get();
434 if (!rpcResult.isSuccessful()) {
435 LOG.warn("RPC Call to release Id with Key {} returned with Errors {}", idKey, rpcResult.getErrors());
437 } catch (InterruptedException | ExecutionException e) {
438 LOG.warn("Exception when releasing Id for key {}", idKey, e);
442 public static Uint64 getDpnId(DatapathId datapathId) {
443 if (datapathId != null) {
444 // Adding logs for a random issue spotted during datapath id
446 String dpIdStr = datapathId.getValue().replace(":", "");
447 return Uint64.valueOf(dpIdStr, 16);
452 public static NodeConnectorId getNodeConnectorIdFromInterface(
453 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
454 .ietf.interfaces.rev140508.interfaces.state.Interface ifState) {
455 if (ifState != null) {
456 List<String> ofportIds = ifState.getLowerLayerIf();
457 return new NodeConnectorId(ofportIds.get(0));
462 public static InterfaceInfo.InterfaceType getInterfaceType(Interface iface) {
463 InterfaceInfo.InterfaceType interfaceType = org.opendaylight
464 .genius.interfacemanager.globals.InterfaceInfo.InterfaceType.UNKNOWN_INTERFACE;
465 Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
466 .ietf.interfaces.rev140508.InterfaceType> ifType = iface
469 if (ifType.isAssignableFrom(L2vlan.class)) {
470 interfaceType = VLAN_INTERFACE;
471 } else if (ifType.isAssignableFrom(Tunnel.class)) {
472 IfTunnel ifTunnel = iface.augmentation(IfTunnel.class);
473 Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight
474 .genius.interfacemanager.rev160406.TunnelTypeBase> tunnelType = ifTunnel
475 .getTunnelInterfaceType();
476 interfaceType = tunnelType.isAssignableFrom(TunnelTypeLogicalGroup.class)
477 ? InterfaceInfo.InterfaceType.LOGICAL_GROUP_INTERFACE : TUNNEL_TYPE_MAP.get(tunnelType);
479 return interfaceType;
482 public static VlanInterfaceInfo getVlanInterfaceInfo(Interface iface, Uint64 dpId) {
484 String portName = null;
485 IfL2vlan vlanIface = iface.augmentation(IfL2vlan.class);
486 ParentRefs parentRefs = iface.augmentation(ParentRefs.class);
487 if (parentRefs != null && parentRefs.getParentInterface() != null) {
488 portName = parentRefs.getParentInterface();
490 LOG.warn("Portname set to null since parentRef is Null");
492 VlanInterfaceInfo vlanInterfaceInfo = new VlanInterfaceInfo(dpId, portName, vlanId);
494 if (vlanIface != null) {
495 vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
496 L2vlanMode l2VlanMode = vlanIface.getL2vlanMode();
498 if (l2VlanMode == L2vlanMode.Transparent) {
499 vlanInterfaceInfo.setVlanTransparent(true);
501 if (l2VlanMode == L2vlanMode.NativeUntagged) {
502 vlanInterfaceInfo.setUntaggedVlan(true);
504 vlanInterfaceInfo.setVlanId(vlanId);
507 return vlanInterfaceInfo;
510 public static Uint64 getDeadBeefBytesForMac() {
511 final long raw = IfmConstants.DEAD_BEEF_MAC_PREFIX.longValue() & 0xFFFFFFFFL;
512 return Uint64.fromLongBits(raw << 16);
515 public static Uint64 fillPortNumberToMac(long portNumber) {
516 return Uint64.fromLongBits(portNumber & 0xFFFF);
519 public static String generateMacAddress(long portNo) {
520 final long raw = getDeadBeefBytesForMac().longValue() | fillPortNumberToMac(portNo).longValue();
521 return GENERATE_MAC_PATTERN.matcher(Long.toUnsignedString(raw))
522 .replaceAll("$1" + IfmConstants.MAC_SEPARATOR)
523 .substring(0, IfmConstants.MAC_STRING_LENGTH);
526 public static PhysAddress getPhyAddress(long portNo, FlowCapableNodeConnector flowCapableNodeConnector) {
527 String southboundMacAddress = flowCapableNodeConnector.getHardwareAddress().getValue();
528 if (IfmConstants.INVALID_MAC.equals(southboundMacAddress)) {
529 LOG.debug("Invalid MAC Address received for {}, generating MAC Address",
530 flowCapableNodeConnector.getName());
531 southboundMacAddress = generateMacAddress(portNo);
533 return new PhysAddress(southboundMacAddress);
536 public static void updateInterfaceParentRef(TypedWriteTransaction<Configuration> tx, String interfaceName,
537 String parentInterface) {
538 InstanceIdentifier<ParentRefs> parentRefIdentifier = InstanceIdentifier.builder(Interfaces.class)
539 .child(Interface.class, new InterfaceKey(interfaceName)).augmentation(ParentRefs.class).build();
540 ParentRefs parentRefs = new ParentRefsBuilder().setParentInterface(parentInterface).build();
541 tx.merge(parentRefIdentifier, parentRefs);
543 "Updating parentRefInterface for interfaceName {}. "
544 + "interfaceKey {}, with parentRef augmentation pointing to {}",
545 interfaceName, new InterfaceKey(interfaceName), parentInterface);
548 public static InstanceIdentifier<BoundServices> buildBoundServicesIId(short servicePriority, String interfaceName,
549 Class<? extends ServiceModeBase> serviceMode) {
550 return InstanceIdentifier.builder(ServiceBindings.class)
551 .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, serviceMode))
552 .child(BoundServices.class, new BoundServicesKey(servicePriority)).build();
555 public static void bindService(TypedWriteTransaction<Configuration> tx, String interfaceName,
556 BoundServices serviceInfo, Class<? extends ServiceModeBase> serviceMode) {
557 LOG.info("Binding Service {} for : {}", serviceInfo.getServiceName(), interfaceName);
558 InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier = buildBoundServicesIId(
559 serviceInfo.getServicePriority().toJava(), interfaceName, serviceMode);
560 tx.put(boundServicesInstanceIdentifier, serviceInfo, CREATE_MISSING_PARENTS);
563 public static void unbindService(ManagedNewTransactionRunner txRunner, JobCoordinator coordinator,
564 String interfaceName, InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier) {
565 coordinator.enqueueJob(interfaceName, () -> Collections.singletonList(
566 txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
567 tx -> unbindService(tx, interfaceName, boundServicesInstanceIdentifier))));
570 public static void unbindService(TypedWriteTransaction<Configuration> tx, String interfaceName,
571 InstanceIdentifier<BoundServices> boundServicesInstanceIdentifier) {
572 LOG.info("Unbinding Service from : {}", interfaceName);
573 tx.delete(boundServicesInstanceIdentifier);
576 public static long getLogicalTunnelSelectGroupId(int lportTag) {
577 return org.opendaylight.genius.interfacemanager.globals.IfmConstants.VXLAN_GROUPID_MIN + lportTag;