2 * Copyright (c) 2017 Intel Corporation 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.netvirt.qosservice;
10 import static java.util.Collections.emptyList;
11 import static org.opendaylight.genius.infra.Datastore.CONFIGURATION;
13 import com.google.common.base.Optional;
14 import java.math.BigInteger;
15 import java.util.ArrayList;
16 import java.util.Collection;
17 import java.util.Collections;
18 import java.util.List;
20 import java.util.concurrent.ConcurrentHashMap;
21 import java.util.concurrent.ConcurrentMap;
22 import java.util.concurrent.CopyOnWriteArraySet;
23 import java.util.concurrent.ExecutionException;
24 import java.util.concurrent.Future;
25 import javax.inject.Inject;
26 import javax.inject.Singleton;
27 import org.eclipse.jdt.annotation.NonNull;
28 import org.eclipse.jdt.annotation.Nullable;
29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
31 import org.opendaylight.genius.infra.Datastore;
32 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
33 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
34 import org.opendaylight.genius.infra.TypedWriteTransaction;
35 import org.opendaylight.genius.mdsalutil.ActionInfo;
36 import org.opendaylight.genius.mdsalutil.FlowEntity;
37 import org.opendaylight.genius.mdsalutil.InstructionInfo;
38 import org.opendaylight.genius.mdsalutil.MDSALUtil;
39 import org.opendaylight.genius.mdsalutil.MatchInfo;
40 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
41 import org.opendaylight.genius.mdsalutil.NwConstants;
42 import org.opendaylight.genius.mdsalutil.actions.ActionNxResubmit;
43 import org.opendaylight.genius.mdsalutil.actions.ActionSetFieldDscp;
44 import org.opendaylight.genius.mdsalutil.instructions.InstructionApplyActions;
45 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
46 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
47 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
48 import org.opendaylight.genius.utils.ServiceIndex;
49 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
50 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
51 import org.opendaylight.ovsdb.utils.southbound.utils.SouthboundUtils;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.BridgeInterfaceInfo;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.BridgeRefInfo;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntry;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntryKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntry;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge.ref.info.BridgeRefEntryKey;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInput;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInputBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceOutput;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeIngress;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceTypeFlowBased;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflow;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflowBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.ext.rev160613.QosNetworkExtension;
88 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.ext.rev160613.QosPortExtension;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.QosPolicy;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.qos.policy.BandwidthLimitRules;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.qos.policy.BandwidthLimitRulesBuilder;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.qos.policy.DscpmarkingRules;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
96 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
97 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
98 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
99 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
100 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
101 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
102 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
103 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
104 import org.opendaylight.yangtools.yang.common.RpcResult;
105 import org.slf4j.Logger;
106 import org.slf4j.LoggerFactory;
109 public class QosNeutronUtils {
110 private static final Logger LOG = LoggerFactory.getLogger(QosNeutronUtils.class);
112 private final ConcurrentMap<Uuid, QosPolicy> qosPolicyMap = new ConcurrentHashMap<>();
113 private final ConcurrentMap<Uuid, ConcurrentMap<Uuid, Port>> qosPortsMap = new ConcurrentHashMap<>();
114 private final ConcurrentMap<Uuid, ConcurrentMap<Uuid, Network>> qosNetworksMap = new ConcurrentHashMap<>();
115 private final CopyOnWriteArraySet<Uuid> qosServiceConfiguredPorts = new CopyOnWriteArraySet<>();
116 private final ConcurrentHashMap<Uuid, Port> neutronPortMap = new ConcurrentHashMap<>();
117 private final ConcurrentHashMap<Uuid, Network> neutronNetworkMap = new ConcurrentHashMap<>();
119 private final QosEosHandler qosEosHandler;
120 private final INeutronVpnManager neutronVpnManager;
121 private final OdlInterfaceRpcService odlInterfaceRpcService;
122 private final DataBroker dataBroker;
123 private final ManagedNewTransactionRunner txRunner;
124 private final IMdsalApiManager mdsalUtils;
125 private final JobCoordinator jobCoordinator;
128 public QosNeutronUtils(final QosEosHandler qosEosHandler, final INeutronVpnManager neutronVpnManager,
129 final OdlInterfaceRpcService odlInterfaceRpcService, final DataBroker dataBroker,
130 final IMdsalApiManager mdsalUtils, final JobCoordinator jobCoordinator) {
131 this.qosEosHandler = qosEosHandler;
132 this.neutronVpnManager = neutronVpnManager;
133 this.odlInterfaceRpcService = odlInterfaceRpcService;
134 this.dataBroker = dataBroker;
135 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
136 this.mdsalUtils = mdsalUtils;
137 this.jobCoordinator = jobCoordinator;
140 public void addToQosPolicyCache(QosPolicy qosPolicy) {
141 qosPolicyMap.put(qosPolicy.getUuid(),qosPolicy);
144 public void removeFromQosPolicyCache(QosPolicy qosPolicy) {
145 qosPolicyMap.remove(qosPolicy.getUuid());
148 public Map<Uuid, QosPolicy> getQosPolicyMap() {
152 public Collection<Port> getQosPorts(Uuid qosUuid) {
153 final ConcurrentMap<Uuid, Port> portMap = qosPortsMap.get(qosUuid);
154 return portMap != null ? portMap.values() : emptyList();
157 public void addToQosPortsCache(Uuid qosUuid, Port port) {
158 qosPortsMap.computeIfAbsent(qosUuid, key -> new ConcurrentHashMap<>()).putIfAbsent(port.getUuid(), port);
161 public void removeFromQosPortsCache(Uuid qosUuid, Port port) {
162 if (qosPortsMap.containsKey(qosUuid) && qosPortsMap.get(qosUuid).containsKey(port.getUuid())) {
163 qosPortsMap.get(qosUuid).remove(port.getUuid(), port);
167 public void addToQosNetworksCache(Uuid qosUuid, Network network) {
168 qosNetworksMap.computeIfAbsent(qosUuid, key -> new ConcurrentHashMap<>()).putIfAbsent(network.getUuid(),
172 public void removeFromQosNetworksCache(Uuid qosUuid, Network network) {
173 if (qosNetworksMap.containsKey(qosUuid) && qosNetworksMap.get(qosUuid).containsKey(network.getUuid())) {
174 qosNetworksMap.get(qosUuid).remove(network.getUuid(), network);
179 public Collection<Network> getQosNetworks(Uuid qosUuid) {
180 final ConcurrentMap<Uuid, Network> networkMap = qosNetworksMap.get(qosUuid);
181 return networkMap != null ? networkMap.values() : emptyList();
185 public List<Uuid> getSubnetIdsFromNetworkId(Uuid networkId) {
186 InstanceIdentifier<NetworkMap> networkMapId = InstanceIdentifier.builder(NetworkMaps.class)
187 .child(NetworkMap.class, new NetworkMapKey(networkId)).build();
188 Optional<NetworkMap> optionalNetworkMap = MDSALUtil.read(LogicalDatastoreType.CONFIGURATION,
189 networkMapId, dataBroker);
190 return (optionalNetworkMap.isPresent() && optionalNetworkMap.get().getSubnetIdList() != null)
191 ? optionalNetworkMap.get().getSubnetIdList() : emptyList();
195 protected List<Uuid> getPortIdsFromSubnetId(Uuid subnetId) {
196 InstanceIdentifier<Subnetmap> subnetMapId = InstanceIdentifier
197 .builder(Subnetmaps.class)
198 .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
199 Optional<Subnetmap> optionalSubnetmap = MDSALUtil.read(LogicalDatastoreType.CONFIGURATION,
200 subnetMapId,dataBroker);
201 return (optionalSubnetmap.isPresent() && optionalSubnetmap.get().getPortList() != null)
202 ? optionalSubnetmap.get().getPortList() : emptyList();
205 public void handleNeutronPortQosAdd(Port port, Uuid qosUuid) {
206 LOG.debug("Handling Port add and QoS associated: port: {} qos: {}", port.getUuid().getValue(),
209 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
211 jobCoordinator.enqueueJob("QosPort-" + port.getUuid().getValue(),
212 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx -> {
213 // handle Bandwidth Limit Rules update
214 if (qosPolicy != null && qosPolicy.getBandwidthLimitRules() != null
215 && !qosPolicy.getBandwidthLimitRules().isEmpty()) {
216 setPortBandwidthLimits(port, qosPolicy.getBandwidthLimitRules().get(0), tx);
218 // handle DSCP Mark Rules update
219 if (qosPolicy != null && qosPolicy.getDscpmarkingRules() != null
220 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
221 setPortDscpMarking(port, qosPolicy.getDscpmarkingRules().get(0));
226 public void handleQosInterfaceAdd(Port port, Uuid qosUuid) {
227 LOG.debug("Handling Port add and QoS associated: port: {} qos: {}", port.getUuid().getValue(),
230 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
232 jobCoordinator.enqueueJob("QosPort-" + port.getUuid().getValue(), () -> {
233 // handle DSCP Mark Rules update
234 if (qosPolicy != null && qosPolicy.getDscpmarkingRules() != null
235 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
236 setPortDscpMarking(port, qosPolicy.getDscpmarkingRules().get(0));
242 public void handleNeutronPortQosUpdate(Port port, Uuid qosUuidNew, Uuid qosUuidOld) {
243 LOG.debug("Handling Port QoS update: port: {} qosservice: {}", port.getUuid().getValue(),
244 qosUuidNew.getValue());
246 QosPolicy qosPolicyNew = qosPolicyMap.get(qosUuidNew);
247 QosPolicy qosPolicyOld = qosPolicyMap.get(qosUuidOld);
249 jobCoordinator.enqueueJob("QosPort-" + port.getUuid().getValue(),
250 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx -> {
251 // handle Bandwidth Limit Rules update
252 if (qosPolicyNew != null && qosPolicyNew.getBandwidthLimitRules() != null
253 && !qosPolicyNew.getBandwidthLimitRules().isEmpty()) {
254 setPortBandwidthLimits(port, qosPolicyNew.getBandwidthLimitRules().get(0), tx);
256 if (qosPolicyOld != null && qosPolicyOld.getBandwidthLimitRules() != null
257 && !qosPolicyOld.getBandwidthLimitRules().isEmpty()) {
258 BandwidthLimitRulesBuilder bwLimitBuilder = new BandwidthLimitRulesBuilder();
259 setPortBandwidthLimits(port, bwLimitBuilder
260 .setMaxBurstKbps(BigInteger.ZERO)
261 .setMaxKbps(BigInteger.ZERO).build(), tx);
264 //handle DSCP Mark Rules update
265 if (qosPolicyNew != null && qosPolicyNew.getDscpmarkingRules() != null
266 && !qosPolicyNew.getDscpmarkingRules().isEmpty()) {
267 setPortDscpMarking(port, qosPolicyNew.getDscpmarkingRules().get(0));
269 if (qosPolicyOld != null && qosPolicyOld.getDscpmarkingRules() != null
270 && !qosPolicyOld.getDscpmarkingRules().isEmpty()) {
271 unsetPortDscpMark(port);
277 public void handleNeutronPortQosRemove(Port port, Uuid qosUuid) {
278 LOG.debug("Handling Port QoS removal: port: {} qosservice: {}", port.getUuid().getValue(), qosUuid.getValue());
280 // check for network qosservice to apply
281 Network network = neutronVpnManager.getNeutronNetwork(port.getNetworkId());
282 if (network != null && network.augmentation(QosNetworkExtension.class) != null) {
283 Uuid networkQosUuid = network.augmentation(QosNetworkExtension.class).getQosPolicyId();
284 if (networkQosUuid != null) {
285 handleNeutronPortQosUpdate(port, networkQosUuid, qosUuid);
288 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
290 jobCoordinator.enqueueJob("QosPort-" + port.getUuid().getValue(),
291 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION, tx -> {
292 // handle Bandwidth Limit Rules removal
293 if (qosPolicy != null && qosPolicy.getBandwidthLimitRules() != null
294 && !qosPolicy.getBandwidthLimitRules().isEmpty()) {
295 BandwidthLimitRulesBuilder bwLimitBuilder = new BandwidthLimitRulesBuilder();
296 setPortBandwidthLimits(port, bwLimitBuilder
297 .setMaxBurstKbps(BigInteger.ZERO)
298 .setMaxKbps(BigInteger.ZERO).build(), tx);
300 // handle DSCP MArk Rules removal
301 if (qosPolicy != null && qosPolicy.getDscpmarkingRules() != null
302 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
303 unsetPortDscpMark(port);
309 public void handleNeutronPortRemove(Port port, Uuid qosUuid) {
310 LOG.debug("Handling Port removal and Qos associated: port: {} qos: {}", port.getUuid().getValue(),
312 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
314 jobCoordinator.enqueueJob("QosPort-" + port.getUuid().getValue(), () -> {
315 //check if any DSCP rule in the policy
316 if (qosPolicy != null && qosPolicy.getDscpmarkingRules() != null
317 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
318 unsetPortDscpMark(port);
324 public void handleNeutronPortRemove(Port port, Uuid qosUuid, Interface intrf) {
325 LOG.debug("Handling Port removal and Qos associated: port: {} qos: {}", port.getUuid().getValue(),
327 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
329 jobCoordinator.enqueueJob("QosPort-" + port.getUuid().getValue(), () -> {
330 if (qosPolicy != null && qosPolicy.getDscpmarkingRules() != null
331 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
332 unsetPortDscpMark(port, intrf);
339 public void handleNeutronNetworkQosUpdate(Network network, Uuid qosUuid) {
340 LOG.debug("Handling Network QoS update: net: {} qosservice: {}", network.getUuid().getValue(), qosUuid);
341 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
342 if (qosPolicy == null || (qosPolicy.getBandwidthLimitRules() == null
343 || qosPolicy.getBandwidthLimitRules().isEmpty())
344 && (qosPolicy.getDscpmarkingRules() == null
345 || qosPolicy.getDscpmarkingRules().isEmpty())) {
348 List<Uuid> subnetIds = getSubnetIdsFromNetworkId(network.getUuid());
349 for (Uuid subnetId : subnetIds) {
350 List<Uuid> portIds = getPortIdsFromSubnetId(subnetId);
351 for (Uuid portId : portIds) {
352 Port port = getNeutronPort(portId);
353 if (port != null && (port.augmentation(QosPortExtension.class) == null
354 || port.augmentation(QosPortExtension.class).getQosPolicyId() == null)) {
355 jobCoordinator.enqueueJob("QosPort-" + portId.getValue(),
356 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
357 CONFIGURATION, tx -> {
358 if (qosPolicy.getBandwidthLimitRules() != null
359 && !qosPolicy.getBandwidthLimitRules().isEmpty()) {
360 setPortBandwidthLimits(port, qosPolicy.getBandwidthLimitRules().get(0), tx);
362 if (qosPolicy.getDscpmarkingRules() != null
363 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
364 setPortDscpMarking(port, qosPolicy.getDscpmarkingRules().get(0));
372 public void handleNeutronNetworkQosRemove(Network network, Uuid qosUuid) {
373 LOG.debug("Handling Network QoS removal: net: {} qosservice: {}", network.getUuid().getValue(),
375 QosPolicy qosPolicy = qosPolicyMap.get(qosUuid);
377 List<Uuid> subnetIds = getSubnetIdsFromNetworkId(network.getUuid());
378 for (Uuid subnetId : subnetIds) {
379 List<Uuid> portIds = getPortIdsFromSubnetId(subnetId);
380 for (Uuid portId : portIds) {
381 Port port = getNeutronPort(portId);
382 if (port != null && (port.augmentation(QosPortExtension.class) == null
383 || port.augmentation(QosPortExtension.class).getQosPolicyId() == null)) {
384 jobCoordinator.enqueueJob("QosPort-" + portId.getValue(),
385 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
386 CONFIGURATION, tx -> {
387 if (qosPolicy != null && qosPolicy.getBandwidthLimitRules() != null
388 && !qosPolicy.getBandwidthLimitRules().isEmpty()) {
389 BandwidthLimitRulesBuilder bwLimitBuilder = new BandwidthLimitRulesBuilder();
390 setPortBandwidthLimits(port, bwLimitBuilder
391 .setMaxBurstKbps(BigInteger.ZERO)
392 .setMaxKbps(BigInteger.ZERO).build(), tx);
394 if (qosPolicy != null && qosPolicy.getDscpmarkingRules() != null
395 && !qosPolicy.getDscpmarkingRules().isEmpty()) {
396 unsetPortDscpMark(port);
404 public void handleNeutronNetworkQosBwRuleRemove(Network network, BandwidthLimitRules zeroBwLimitRule) {
405 LOG.debug("Handling Qos Bandwidth Rule Remove, net: {}", network.getUuid().getValue());
407 List<Uuid> subnetIds = getSubnetIdsFromNetworkId(network.getUuid());
409 for (Uuid subnetId: subnetIds) {
410 List<Uuid> portIds = getPortIdsFromSubnetId(subnetId);
411 for (Uuid portId : portIds) {
412 Port port = getNeutronPort(portId);
413 if (port != null && (port.augmentation(QosPortExtension.class) == null
414 || port.augmentation(QosPortExtension.class).getQosPolicyId() == null)) {
415 jobCoordinator.enqueueJob("QosPort-" + portId.getValue(), () -> Collections.singletonList(
416 txRunner.callWithNewWriteOnlyTransactionAndSubmit(CONFIGURATION,
417 tx -> setPortBandwidthLimits(port, zeroBwLimitRule, tx))));
423 public void handleNeutronNetworkQosDscpRuleRemove(Network network) {
424 LOG.debug("Handling Qos Dscp Rule Remove, net: {}", network.getUuid().getValue());
426 List<Uuid> subnetIds = getSubnetIdsFromNetworkId(network.getUuid());
428 for (Uuid subnetId: subnetIds) {
429 List<Uuid> portIds = getPortIdsFromSubnetId(subnetId);
430 for (Uuid portId : portIds) {
431 Port port = getNeutronPort(portId);
432 if (port != null && (port.augmentation(QosPortExtension.class) == null
433 || port.augmentation(QosPortExtension.class).getQosPolicyId() == null)) {
434 jobCoordinator.enqueueJob("QosPort-" + portId.getValue(), () -> {
435 unsetPortDscpMark(port);
443 // TODO Clean up the exception handling
444 @SuppressWarnings("checkstyle:IllegalCatch")
445 public void setPortBandwidthLimits(Port port, BandwidthLimitRules bwLimit,
446 TypedWriteTransaction<Datastore.Configuration> writeConfigTxn) {
447 if (!qosEosHandler.isQosClusterOwner()) {
448 LOG.debug("Not Qos Cluster Owner. Ignoring setting bandwidth limits");
451 BigInteger dpId = getDpnForInterface(port.getUuid().getValue());
452 if (dpId.equals(BigInteger.ZERO)) {
453 LOG.info("DPN ID for interface {} not found", port.getUuid().getValue());
457 LOG.trace("Setting bandwidth limits {} on Port {}", port.getUuid().getValue(), bwLimit);
458 OvsdbBridgeRef bridgeRefEntry = getBridgeRefEntryFromOperDS(dpId);
459 Optional<Node> bridgeNode = MDSALUtil.read(LogicalDatastoreType.OPERATIONAL,
460 bridgeRefEntry.getValue().firstIdentifierOf(Node.class), dataBroker);
461 if (!bridgeNode.isPresent()) {
462 LOG.error("bridge not found for dpn {} port {} in operational datastore", dpId, port.getUuid().getValue());
465 LOG.debug("bridgeNode {}", bridgeNode.get().getNodeId().getValue());
467 TerminationPoint tp = SouthboundUtils.getTerminationPointByExternalId(bridgeNode.get(),
468 port.getUuid().getValue());
470 LOG.debug("Skipping setting of bandwidth limit rules for subport {}",
471 port.getUuid().getValue());
474 LOG.debug("tp: {}", tp.getTpId().getValue());
475 OvsdbTerminationPointAugmentation ovsdbTp = tp.augmentation(OvsdbTerminationPointAugmentation.class);
477 OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
478 tpAugmentationBuilder.setName(ovsdbTp.getName());
479 tpAugmentationBuilder.setIngressPolicingRate(bwLimit.getMaxKbps().longValue());
480 tpAugmentationBuilder.setIngressPolicingBurst(bwLimit.getMaxBurstKbps().longValue());
482 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
483 tpBuilder.withKey(tp.key());
484 tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
486 if (writeConfigTxn != null) {
487 writeConfigTxn.merge(InstanceIdentifier
488 .create(NetworkTopology.class)
489 .child(Topology.class, new TopologyKey(SouthboundUtils.OVSDB_TOPOLOGY_ID))
490 .child(Node.class, bridgeNode.get().key())
491 .child(TerminationPoint.class, new TerminationPointKey(tp.key())), tpBuilder.build(), true);
493 MDSALUtil.syncUpdate(dataBroker, LogicalDatastoreType.CONFIGURATION, InstanceIdentifier
494 .create(NetworkTopology.class)
495 .child(Topology.class, new TopologyKey(SouthboundUtils.OVSDB_TOPOLOGY_ID))
496 .child(Node.class, bridgeNode.get().key())
497 .child(TerminationPoint.class, new TerminationPointKey(tp.key())), tpBuilder.build());
499 } catch (Exception e) {
500 if (LOG.isDebugEnabled()) {
501 LOG.debug("Failure while setting BwLimitRule {} to port {} exception ", bwLimit,
502 port.getUuid().getValue(), e);
504 LOG.error("Failure while setting BwLimitRule {} to port {}", bwLimit, port.getUuid().getValue());
510 public void setPortDscpMarking(Port port, DscpmarkingRules dscpMark) {
511 if (!qosEosHandler.isQosClusterOwner()) {
512 LOG.trace("Not Qos Cluster Owner. Ignoring setting DSCP marking");
516 BigInteger dpnId = getDpnForInterface(port.getUuid().getValue());
517 String ifName = port.getUuid().getValue();
518 Interface ifState = getInterfaceStateFromOperDS(ifName);
519 Short dscpValue = dscpMark.getDscpMark();
521 if (dpnId.equals(BigInteger.ZERO)) {
522 LOG.info("DPN ID for interface {} not found. Cannot set dscp value {} on port {}",
523 port.getUuid().getValue(), dscpMark, port.getUuid().getValue());
526 int ipVersions = getIpVersions(port);
528 if (hasIpv4Addr(ipVersions)) {
529 LOG.trace("setting ipv4 flow for port: {}, dscp: {}", ifName, dscpValue);
530 addFlow(dpnId, dscpValue, ifName, NwConstants.ETHTYPE_IPV4, ifState);
532 if (hasIpv6Addr(ipVersions)) {
533 LOG.trace("setting ipv6 flow for port: {}, dscp: {}", ifName, dscpValue);
534 addFlow(dpnId, dscpValue, ifName, NwConstants.ETHTYPE_IPV6, ifState);
537 if (qosServiceConfiguredPorts.add(port.getUuid())) {
538 // bind qos service to interface
543 public void unsetPortDscpMark(Port port) {
544 if (!qosEosHandler.isQosClusterOwner()) {
545 LOG.debug("Not Qos Cluster Owner. Ignoring unsetting DSCP marking");
549 BigInteger dpnId = getDpnForInterface(port.getUuid().getValue());
550 String ifName = port.getUuid().getValue();
552 if (dpnId.equals(BigInteger.ZERO)) {
553 LOG.debug("DPN ID for port {} not found. Cannot unset dscp value", port.getUuid().getValue());
556 LOG.trace("Removing dscp marking rule from Port {}", port.getUuid().getValue());
557 Interface intf = getInterfaceStateFromOperDS(ifName);
558 //unbind service from interface
559 unbindservice(ifName);
561 int ipVersions = getIpVersions(port);
562 if (hasIpv4Addr(ipVersions)) {
563 removeFlow(dpnId, ifName, NwConstants.ETHTYPE_IPV4, intf);
565 if (hasIpv6Addr(ipVersions)) {
566 removeFlow(dpnId, ifName, NwConstants.ETHTYPE_IPV6, intf);
568 qosServiceConfiguredPorts.remove(port.getUuid());
571 public void unsetPortDscpMark(Port port, Interface intrf) {
572 if (!qosEosHandler.isQosClusterOwner()) {
575 BigInteger dpnId = getDpIdFromInterface(intrf);
576 String ifName = port.getUuid().getValue();
578 if (dpnId.equals(BigInteger.ZERO)) {
579 LOG.error("Unable to retrieve DPN Id for interface {}. Cannot unset dscp value on port", ifName);
582 LOG.trace("Removing dscp marking rule from Port {}", port.getUuid().getValue());
583 unbindservice(ifName);
584 int ipVersions = getIpVersions(port);
585 if (hasIpv4Addr(ipVersions)) {
586 removeFlow(dpnId, ifName, NwConstants.ETHTYPE_IPV4, intrf);
588 if (hasIpv6Addr(ipVersions)) {
589 removeFlow(dpnId, ifName, NwConstants.ETHTYPE_IPV6, intrf);
591 qosServiceConfiguredPorts.remove(port.getUuid());
594 private static BigInteger getDpIdFromInterface(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
595 .interfaces.rev140508.interfaces.state.Interface ifState) {
596 String lowerLayerIf = ifState.getLowerLayerIf().get(0);
597 NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
598 return BigInteger.valueOf(MDSALUtil.getDpnIdFromPortName(nodeConnectorId));
601 public BigInteger getDpnForInterface(String ifName) {
602 BigInteger nodeId = BigInteger.ZERO;
604 GetDpidFromInterfaceInput
605 dpIdInput = new GetDpidFromInterfaceInputBuilder().setIntfName(ifName).build();
606 Future<RpcResult<GetDpidFromInterfaceOutput>>
607 dpIdOutput = odlInterfaceRpcService.getDpidFromInterface(dpIdInput);
608 RpcResult<GetDpidFromInterfaceOutput> dpIdResult = dpIdOutput.get();
609 if (dpIdResult.isSuccessful()) {
610 nodeId = dpIdResult.getResult().getDpid();
612 LOG.error("Could not retrieve DPN Id for interface {}", ifName);
614 } catch (NullPointerException | InterruptedException | ExecutionException e) {
615 if (LOG.isDebugEnabled()) {
616 LOG.debug("Exception when getting DPN for interface {} exception ", ifName, e);
618 LOG.error("Could not retrieve DPN for interface {}", ifName);
625 private BridgeEntry getBridgeEntryFromConfigDS(BigInteger dpnId) {
626 BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpnId);
627 InstanceIdentifier<BridgeEntry> bridgeEntryInstanceIdentifier = getBridgeEntryIdentifier(bridgeEntryKey);
628 LOG.debug("Trying to retrieve bridge entry from config for Id: {}", bridgeEntryInstanceIdentifier);
629 return getBridgeEntryFromConfigDS(bridgeEntryInstanceIdentifier);
633 private BridgeEntry getBridgeEntryFromConfigDS(InstanceIdentifier<BridgeEntry> bridgeEntryInstanceIdentifier) {
634 return MDSALUtil.read(LogicalDatastoreType.CONFIGURATION, bridgeEntryInstanceIdentifier, dataBroker).orNull();
638 private BridgeRefEntry getBridgeRefEntryFromOperDS(InstanceIdentifier<BridgeRefEntry> dpnBridgeEntryIid) {
639 return MDSALUtil.read(LogicalDatastoreType.OPERATIONAL, dpnBridgeEntryIid, dataBroker).orNull();
643 private OvsdbBridgeRef getBridgeRefEntryFromOperDS(BigInteger dpId) {
644 BridgeRefEntryKey bridgeRefEntryKey = new BridgeRefEntryKey(dpId);
645 InstanceIdentifier<BridgeRefEntry> bridgeRefEntryIid = getBridgeRefEntryIdentifier(bridgeRefEntryKey);
646 BridgeRefEntry bridgeRefEntry = getBridgeRefEntryFromOperDS(bridgeRefEntryIid);
647 if (bridgeRefEntry == null) {
648 // bridge ref entry will be null if the bridge is disconnected from controller.
649 // In that case, fetch bridge reference from bridge interface entry config DS
650 BridgeEntry bridgeEntry = getBridgeEntryFromConfigDS(dpId);
651 if (bridgeEntry == null) {
654 return bridgeEntry.getBridgeReference();
656 return bridgeRefEntry.getBridgeReference();
660 private static InstanceIdentifier<BridgeRefEntry> getBridgeRefEntryIdentifier(BridgeRefEntryKey bridgeRefEntryKey) {
661 return InstanceIdentifier.builder(BridgeRefInfo.class).child(BridgeRefEntry.class, bridgeRefEntryKey).build();
665 private static InstanceIdentifier<BridgeEntry> getBridgeEntryIdentifier(BridgeEntryKey bridgeEntryKey) {
666 return InstanceIdentifier.builder(BridgeInterfaceInfo.class).child(BridgeEntry.class, bridgeEntryKey).build();
669 public void removeStaleFlowEntry(Interface intrf, int ethType) {
670 List<MatchInfo> matches = new ArrayList<>();
672 BigInteger dpnId = getDpIdFromInterface(intrf);
674 Integer ifIndex = intrf.getIfIndex();
675 matches.add(new MatchMetadata(MetaDataUtil.getLportTagMetaData(ifIndex), MetaDataUtil.METADATA_MASK_LPORT_TAG));
676 FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId, NwConstants.QOS_DSCP_TABLE,
677 getQosFlowId(NwConstants.QOS_DSCP_TABLE, dpnId, ifIndex, ethType),
678 QosConstants.QOS_DEFAULT_FLOW_PRIORITY, "QoSRemoveFlow", 0, 0, NwConstants.COOKIE_QOS_TABLE,
680 mdsalUtils.removeFlow(flowEntity);
683 public void addFlow(BigInteger dpnId, Short dscpValue, String ifName, int ethType, Interface ifState) {
684 if (ifState == null) {
685 LOG.debug("Could not find the ifState for interface {}", ifName);
688 Integer ifIndex = ifState.getIfIndex();
690 List<MatchInfo> matches = new ArrayList<>();
691 matches.add(new MatchEthernetType(ethType));
692 matches.add(new MatchMetadata(MetaDataUtil.getLportTagMetaData(ifIndex), MetaDataUtil.METADATA_MASK_LPORT_TAG));
694 List<ActionInfo> actionsInfos = new ArrayList<>();
695 actionsInfos.add(new ActionSetFieldDscp(dscpValue));
696 actionsInfos.add(new ActionNxResubmit(NwConstants.LPORT_DISPATCHER_TABLE));
698 List<InstructionInfo> instructions = Collections.singletonList(new InstructionApplyActions(actionsInfos));
699 FlowEntity flowEntity = MDSALUtil.buildFlowEntity(dpnId, NwConstants.QOS_DSCP_TABLE,
700 getQosFlowId(NwConstants.QOS_DSCP_TABLE, dpnId, ifIndex, ethType),
701 QosConstants.QOS_DEFAULT_FLOW_PRIORITY, "QoSConfigFlow", 0, 0, NwConstants.COOKIE_QOS_TABLE,
702 matches, instructions);
703 mdsalUtils.installFlow(flowEntity);
706 public void removeFlow(BigInteger dpnId, String ifName, int ethType, Interface ifState) {
707 if (ifState == null) {
708 LOG.debug("Could not find the ifState for interface {}", ifName);
711 Integer ifIndex = ifState.getIfIndex();
713 mdsalUtils.removeFlow(dpnId, NwConstants.QOS_DSCP_TABLE,
714 new FlowId(getQosFlowId(NwConstants.QOS_DSCP_TABLE, dpnId, ifIndex, ethType)));
717 public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state
718 .@Nullable Interface getInterfaceStateFromOperDS(String interfaceName) {
719 return MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL,
720 createInterfaceStateInstanceIdentifier(interfaceName)).orNull();
724 public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
725 .ietf.interfaces.rev140508.interfaces.state.Interface> createInterfaceStateInstanceIdentifier(
726 String interfaceName) {
727 return InstanceIdentifier
728 .builder(InterfacesState.class)
729 .child(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
730 .ietf.interfaces.rev140508.interfaces.state.Interface.class,
731 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
732 .ietf.interfaces.rev140508.interfaces.state.InterfaceKey(
737 public void bindservice(String ifName) {
738 int priority = QosConstants.QOS_DEFAULT_FLOW_PRIORITY;
739 int instructionKey = 0;
740 List<Instruction> instructions = new ArrayList<>();
741 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.QOS_DSCP_TABLE, ++instructionKey));
742 short qosServiceIndex = ServiceIndex.getIndex(NwConstants.QOS_SERVICE_NAME, NwConstants.QOS_SERVICE_INDEX);
744 BoundServices serviceInfo = getBoundServices(
745 String.format("%s.%s", "qos", ifName), qosServiceIndex,
746 priority, NwConstants.COOKIE_QOS_TABLE, instructions);
747 MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.CONFIGURATION,
748 buildServiceId(ifName, qosServiceIndex),
752 public void unbindservice(String ifName) {
753 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, buildServiceId(ifName,
754 ServiceIndex.getIndex(NwConstants.QOS_SERVICE_NAME, NwConstants.QOS_SERVICE_INDEX)));
757 private static InstanceIdentifier<BoundServices> buildServiceId(String interfaceName, short qosServiceIndex) {
758 return InstanceIdentifier.builder(ServiceBindings.class)
759 .child(ServicesInfo.class, new ServicesInfoKey(interfaceName, ServiceModeIngress.class))
760 .child(BoundServices.class, new BoundServicesKey(qosServiceIndex)).build();
763 private static BoundServices getBoundServices(String serviceName, short qosServiceIndex, int priority,
764 BigInteger cookieQosTable, List<Instruction> instructions) {
765 StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookieQosTable)
766 .setFlowPriority(priority).setInstruction(instructions);
767 return new BoundServicesBuilder().withKey(new BoundServicesKey(qosServiceIndex)).setServiceName(serviceName)
768 .setServicePriority(qosServiceIndex).setServiceType(ServiceTypeFlowBased.class)
769 .addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
773 public static String getQosFlowId(short tableId, BigInteger dpId, int lportTag, int ethType) {
774 return new StringBuilder().append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(dpId)
775 .append(NwConstants.FLOWID_SEPARATOR).append(lportTag)
776 .append(NwConstants.FLOWID_SEPARATOR).append(ethType).toString();
779 public boolean portHasQosPolicy(Port port) {
780 LOG.trace("checking qos policy for port: {}", port.getUuid().getValue());
782 boolean isQosPolicy = port.augmentation(QosPortExtension.class) != null
783 && port.augmentation(QosPortExtension.class).getQosPolicyId() != null;
785 LOG.trace("portHasQosPolicy for port: {} return value {}", port.getUuid().getValue(), isQosPolicy);
790 public QosPolicy getQosPolicy(Port port) {
792 QosPolicy qosPolicy = null;
794 if (port.augmentation(QosPortExtension.class) != null) {
795 qosUuid = port.augmentation(QosPortExtension.class).getQosPolicyId();
797 Network network = neutronVpnManager.getNeutronNetwork(port.getNetworkId());
799 if (network.augmentation(QosNetworkExtension.class) != null) {
800 qosUuid = network.augmentation(QosNetworkExtension.class).getQosPolicyId();
804 if (qosUuid != null) {
805 qosPolicy = qosPolicyMap.get(qosUuid);
811 public boolean hasDscpMarkingRule(QosPolicy qosPolicy) {
812 if (qosPolicy != null) {
813 return qosPolicy.getDscpmarkingRules() != null && !qosPolicy.getDscpmarkingRules().isEmpty();
818 public void addToPortCache(Port port) {
819 neutronPortMap.put(port.getUuid(), port);
822 public void removeFromPortCache(Port port) {
823 neutronPortMap.remove(port.getUuid());
826 public Port getNeutronPort(Uuid portUuid) {
827 return neutronPortMap.get(portUuid);
830 public Port getNeutronPort(String portName) {
831 return getNeutronPort(new Uuid(portName));
834 public void addToNetworkCache(Network network) {
835 neutronNetworkMap.put(network.getUuid(), network);
838 public void removeFromNetworkCache(Network network) {
839 neutronNetworkMap.remove(network.getUuid());
842 public Network getNeutronNetwork(Uuid networkUuid) {
843 return neutronNetworkMap.get(networkUuid);
847 public static BigInteger getDpnIdFromLowerLayerIf(String lowerLayerIf) {
849 return new BigInteger(lowerLayerIf.substring(lowerLayerIf.indexOf(":") + 1, lowerLayerIf.lastIndexOf(":")));
850 } catch (NullPointerException e) {
856 public static String getPortNumberFromLowerLayerIf(String lowerLayerIf) {
858 return (lowerLayerIf.substring(lowerLayerIf.lastIndexOf(":") + 1));
859 } catch (NullPointerException e) {
864 public int getIpVersions(Port port) {
866 for (FixedIps fixedIp: port.getFixedIps()) {
867 if (fixedIp.getIpAddress().getIpv4Address() != null) {
868 versions |= (1 << QosConstants.IPV4_ADDR_MASK_BIT);
869 } else if (fixedIp.getIpAddress().getIpv6Address() != null) {
870 versions |= (1 << QosConstants.IPV6_ADDR_MASK_BIT);
876 public boolean hasIpv4Addr(int versions) {
877 return (versions & (1 << QosConstants.IPV4_ADDR_MASK_BIT)) != 0;
880 public boolean hasIpv6Addr(int versions) {
881 return (versions & (1 << QosConstants.IPV6_ADDR_MASK_BIT)) != 0;