2 * Copyright (c) 2014, 2015 Red Hat, Inc. 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
9 package org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13;
11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
12 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
13 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
15 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
16 import org.opendaylight.ovsdb.openstack.netvirt.api.Southbound;
17 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
18 import org.opendaylight.ovsdb.openstack.netvirt.providers.NetvirtProvidersProvider;
19 import org.opendaylight.ovsdb.utils.mdsal.openflow.InstructionUtils;
20 import org.opendaylight.ovsdb.utils.servicehelper.ServiceHelper;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
40 import com.google.common.base.Optional;
41 import com.google.common.collect.Lists;
42 import com.google.common.util.concurrent.CheckedFuture;
44 import java.util.List;
45 import java.util.concurrent.ExecutionException;
47 import org.osgi.framework.ServiceReference;
48 import org.slf4j.Logger;
49 import org.slf4j.LoggerFactory;
52 * Any ServiceInstance class that extends AbstractServiceInstance to be a part of the pipeline
53 * have 2 basic requirements : <br>
54 * 1. Program a default pipeline flow to take any unmatched traffic to the next table in the pipeline. <br>
55 * 2. Get Pipeline Instructions from AbstractServiceInstance (using getMutablePipelineInstructionBuilder) and
56 * use it in any matching flows that needs to be further processed by next service in the pipeline.
59 public abstract class AbstractServiceInstance {
60 public static final String SERVICE_PROPERTY ="serviceProperty";
61 private static final Logger LOG = LoggerFactory.getLogger(AbstractServiceInstance.class);
62 public static final String OPENFLOW = "openflow:";
63 private DataBroker dataBroker = null;
64 // OSGi Services that we are dependent on.
65 private volatile PipelineOrchestrator orchestrator;
66 private volatile Southbound southbound;
68 // Concrete Service that this AbstractServiceInstance represents
69 private Service service;
71 public AbstractServiceInstance (Service service) {
72 this.service = service;
73 this.dataBroker = NetvirtProvidersProvider.getDataBroker();
76 protected void setDependencies(final ServiceReference ref, AbstractServiceInstance serviceInstance) {
78 (PipelineOrchestrator) ServiceHelper.getGlobalInstance(PipelineOrchestrator.class, serviceInstance);
79 orchestrator.registerService(ref, serviceInstance);
81 (Southbound) ServiceHelper.getGlobalInstance(Southbound.class, serviceInstance);
84 public boolean isBridgeInPipeline (Node node){
85 String bridgeName = southbound.getBridgeName(node);
86 return bridgeName != null && Constants.INTEGRATION_BRIDGE.equals(bridgeName);
89 public short getTable() {
90 return service.getTable();
93 public Service getService() {
97 public void setService(Service service) {
98 this.service = service;
101 public NodeBuilder createNodeBuilder(String nodeId) {
102 NodeBuilder builder = new NodeBuilder();
103 builder.setId(new NodeId(nodeId));
104 builder.setKey(new NodeKey(builder.getId()));
108 private static InstanceIdentifier<Flow> createFlowPath(FlowBuilder flowBuilder, NodeBuilder nodeBuilder) {
109 return InstanceIdentifier.builder(Nodes.class)
110 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node.class,
111 nodeBuilder.getKey())
112 .augmentation(FlowCapableNode.class)
113 .child(Table.class, new TableKey(flowBuilder.getTableId()))
114 .child(Flow.class, flowBuilder.getKey()).build();
117 private static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node>
118 createNodePath(NodeBuilder nodeBuilder) {
119 return InstanceIdentifier.builder(Nodes.class)
120 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node.class,
121 nodeBuilder.getKey()).build();
125 * This method returns the required Pipeline Instructions to by used by any matching flows that need
126 * to be further processed by next service in the pipeline.
128 * Important to note that this is a convenience method which returns a mutable instructionBuilder which
129 * needs to be further adjusted by the concrete ServiceInstance class such as setting the Instruction Order, etc.
130 * @return Newly created InstructionBuilder to be used along with other instructions on the main flow
132 protected final InstructionBuilder getMutablePipelineInstructionBuilder() {
133 Service nextService = orchestrator.getNextServiceInPipeline(service);
134 if (nextService != null) {
135 return InstructionUtils.createGotoTableInstructions(new InstructionBuilder(), nextService.getTable());
137 return InstructionUtils.createDropInstructions(new InstructionBuilder());
141 protected void writeFlow(FlowBuilder flowBuilder, NodeBuilder nodeBuilder) {
142 LOG.debug("writeFlow: flowBuilder: {}, nodeBuilder: {}",
143 flowBuilder.build(), nodeBuilder.build());
144 WriteTransaction modification = dataBroker.newWriteOnlyTransaction();
145 modification.put(LogicalDatastoreType.CONFIGURATION, createNodePath(nodeBuilder),
146 nodeBuilder.build(), true /*createMissingParents*/);
147 modification.put(LogicalDatastoreType.CONFIGURATION, createFlowPath(flowBuilder, nodeBuilder),
148 flowBuilder.build(), true /*createMissingParents*/);
150 CheckedFuture<Void, TransactionCommitFailedException> commitFuture = modification.submit();
152 commitFuture.get(); // TODO: Make it async (See bug 1362)
153 LOG.debug("Transaction success for write of Flow {}", flowBuilder.getFlowName());
154 } catch (Exception e) {
155 LOG.error(e.getMessage(), e);
156 modification.cancel();
160 protected void removeFlow(FlowBuilder flowBuilder, NodeBuilder nodeBuilder) {
161 WriteTransaction modification = dataBroker.newWriteOnlyTransaction();
162 modification.delete(LogicalDatastoreType.CONFIGURATION, createFlowPath(flowBuilder, nodeBuilder));
164 CheckedFuture<Void, TransactionCommitFailedException> commitFuture = modification.submit();
166 commitFuture.get(); // TODO: Make it async (See bug 1362)
167 LOG.debug("Transaction success for deletion of Flow {}", flowBuilder.getFlowName());
168 } catch (Exception e) {
169 LOG.error(e.getMessage(), e);
170 modification.cancel();
174 public Flow getFlow(FlowBuilder flowBuilder, NodeBuilder nodeBuilder) {
175 ReadOnlyTransaction readTx = dataBroker.newReadOnlyTransaction();
177 Optional<Flow> data =
178 readTx.read(LogicalDatastoreType.CONFIGURATION, createFlowPath(flowBuilder, nodeBuilder)).get();
179 if (data.isPresent()) {
182 } catch (InterruptedException|ExecutionException e) {
183 LOG.error(e.getMessage(), e);
186 LOG.debug("Cannot find data for Flow {}", flowBuilder.getFlowName());
190 public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node
191 getOpenFlowNode(String nodeId) {
193 ReadOnlyTransaction readTx = dataBroker.newReadOnlyTransaction();
195 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> data =
196 readTx.read(LogicalDatastoreType.OPERATIONAL, createNodePath(createNodeBuilder(nodeId))).get();
197 if (data.isPresent()) {
200 } catch (InterruptedException|ExecutionException e) {
201 LOG.error(e.getMessage(), e);
204 LOG.debug("Cannot find data for Node {}", nodeId);
208 private long getDpid(Node node) {
209 long dpid = southbound.getDataPathId(node);
211 LOG.warn("getDpid: dpid not found: {}", node);
217 * Program Default Pipeline Flow.
219 * @param node on which the default pipeline flow is programmed.
221 protected void programDefaultPipelineRule(Node node) {
222 if (!isBridgeInPipeline(node)) {
223 //LOG.trace("Bridge is not in pipeline {} ", node);
226 MatchBuilder matchBuilder = new MatchBuilder();
227 FlowBuilder flowBuilder = new FlowBuilder();
228 long dpid = getDpid(node);
230 LOG.info("could not find dpid: {}", node.getNodeId());
233 String nodeName = OPENFLOW + getDpid(node);
234 NodeBuilder nodeBuilder = createNodeBuilder(nodeName);
236 // Create the OF Actions and Instructions
237 InstructionsBuilder isb = new InstructionsBuilder();
239 // Instructions List Stores Individual Instructions
240 List<Instruction> instructions = Lists.newArrayList();
242 // Call the InstructionBuilder Methods Containing Actions
243 InstructionBuilder ib = this.getMutablePipelineInstructionBuilder();
245 ib.setKey(new InstructionKey(0));
246 instructions.add(ib.build());
248 // Add InstructionBuilder to the Instruction(s)Builder List
249 isb.setInstruction(instructions);
251 // Add InstructionsBuilder to FlowBuilder
252 flowBuilder.setInstructions(isb.build());
254 String flowId = "DEFAULT_PIPELINE_FLOW_"+service.getTable();
255 flowBuilder.setId(new FlowId(flowId));
256 FlowKey key = new FlowKey(new FlowId(flowId));
257 flowBuilder.setMatch(matchBuilder.build());
258 flowBuilder.setPriority(0);
259 flowBuilder.setBarrier(true);
260 flowBuilder.setTableId(service.getTable());
261 flowBuilder.setKey(key);
262 flowBuilder.setFlowName(flowId);
263 flowBuilder.setHardTimeout(0);
264 flowBuilder.setIdleTimeout(0);
265 writeFlow(flowBuilder, nodeBuilder);