neutron/src/main/java/org/opendaylight/ovsdb/neutron/provider/OF13ProviderManager.java

   1 /*
   2  * Copyright (C) 2013 Red Hat, Inc.
   3  *
   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
   7  *
   8  * Authors : Madhu Venugopal, Brent Salisbury
   9  */
  10 package org.opendaylight.ovsdb.neutron.provider;
  11
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.Set;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.Future;
  17
  18 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  19 import org.opendaylight.controller.md.sal.common.api.data.DataModification;
  20 import org.opendaylight.controller.sal.binding.api.data.DataBrokerService;
  21 import org.opendaylight.controller.sal.core.Node;
  22 import org.opendaylight.controller.sal.utils.HexEncode;
  23 import org.opendaylight.controller.sal.utils.ServiceHelper;
  24 import org.opendaylight.controller.sal.utils.Status;
  25 import org.opendaylight.ovsdb.lib.table.Bridge;
  26 import org.opendaylight.ovsdb.lib.table.Interface;
  27 import org.opendaylight.ovsdb.neutron.AdminConfigManager;
  28 import org.opendaylight.ovsdb.neutron.IMDSALConsumer;
  29 import org.opendaylight.ovsdb.plugin.OVSDBConfigService;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  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.opendaylight.l2.types.rev130827.EtherType;
  38 import org.opendaylight.yangtools.yang.binding.DataObject;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.common.RpcResult;
  41
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
  51
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCaseBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.output.action._case.OutputActionBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  64
  65 class OF13ProviderManager extends ProviderNetworkManager {
  66     private static final Logger logger = LoggerFactory.getLogger(OF13ProviderManager.class);
  67     private DataBrokerService dataBrokerService;
  68
  69     @Override
  70     public boolean hasPerTenantTunneling() {
  71         return false;
  72     }
  73
  74     @Override
  75     public Status createTunnels(String tunnelType, String tunnelKey, Node source, Interface intf) {
  76         // TODO Auto-generated method stub
  77         return null;
  78     }
  79
  80     @Override
  81     public Status createTunnels(String tunnelType, String tunnelKey) {
  82         // TODO Auto-generated method stub
  83         return null;
  84     }
  85
  86     @Override
  87     public void initializeFlowRules(Node node) {
  88         this.initializeFlowRules(node, AdminConfigManager.getManager().getIntegrationBridgeName());
  89     }
  90
  91     private void initializeFlowRules(Node node, String bridgeName) {
  92         try {
  93             // TODO : 3 second sleep hack is to make sure the OF connection is established.
  94             // Correct fix is to check the MD-SAL inventory before proceeding and listen
  95             // to Inventory update for processing.
  96             Thread.sleep(3000);
  97         } catch (Exception e) {
  98             e.printStackTrace();
  99         }
 100         String brIntId = this.getInternalBridgeUUID(node, bridgeName);
 101         if (brIntId == null) {
 102             logger.error("Failed to initialize Flow Rules for {}", node);
 103             return;
 104         }
 105
 106         try {
 107             OVSDBConfigService ovsdbTable = (OVSDBConfigService)ServiceHelper.getGlobalInstance(OVSDBConfigService.class, this);
 108             Bridge bridge = (Bridge) ovsdbTable.getRow(node, Bridge.NAME.getName(), brIntId);
 109             Set<String> dpids = bridge.getDatapath_id();
 110             if (dpids == null || dpids.size() ==  0) return;
 111             Long dpidLong = Long.valueOf(HexEncode.stringToLong((String)dpids.toArray()[0]));
 112             writeLLDPRule(dpidLong);
 113         } catch (Exception e) {
 114             logger.error("Failed to initialize Flow Rules for "+node.toString(), e);
 115         }
 116     }
 117
 118     private void writeLLDPRule(Long dpidLong) {
 119         String nodeName = "openflow:"+dpidLong;
 120         NodeBuilder tn = createNodeBuilder(nodeName);
 121         FlowBuilder flow = new FlowBuilder();
 122         flow.setMatch(createLLDPMatch().build());
 123         flow.setInstructions(this.createSentToControllerInstructions().build());
 124         // TODO : Investigate the need for this.
 125         long flowKey = 123;
 126         FlowKey key = new FlowKey(new FlowId(Long.toString(flowKey)));
 127         flow.setBarrier(false);
 128         flow.setTableId((short)0);
 129         flow.setKey(key);
 130         flow.setFlowName("LLDP_" + nodeName);
 131         writeFlow(flow, tn);
 132     }
 133
 134     private void writeFlow(FlowBuilder flow, NodeBuilder nodeBuilder) {
 135         IMDSALConsumer mdsalConsumer = (IMDSALConsumer)ServiceHelper.getInstance(IMDSALConsumer.class, "default", this);
 136         if (mdsalConsumer == null) {
 137             logger.error("ERROR finding MDSAL Service. Its possible that writeFlow is called too soon ?");
 138             return;
 139         }
 140
 141         dataBrokerService = mdsalConsumer.getDataBrokerService();
 142
 143         if (dataBrokerService == null) {
 144             logger.error("ERROR finding reference for DataBrokerService. Please check out the MD-SAL support on the Controller.");
 145             return;
 146         }
 147         DataModification<InstanceIdentifier<?>, DataObject> modification = dataBrokerService.beginTransaction();
 148         InstanceIdentifier<Flow> path1 = InstanceIdentifier.builder(Nodes.class)
 149                 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node.class, nodeBuilder.getKey()).augmentation(FlowCapableNode.class)
 150                 .child(Table.class, new TableKey(flow.getTableId())).child(Flow.class, flow.getKey())
 151                 .build();
 152         modification.putOperationalData(nodeBuilderToInstanceId(nodeBuilder), nodeBuilder.build());
 153         modification.putOperationalData(path1, flow.build());
 154         modification.putConfigurationData(nodeBuilderToInstanceId(nodeBuilder), nodeBuilder.build());
 155         modification.putConfigurationData(path1, flow.build());
 156         Future<RpcResult<TransactionStatus>> commitFuture = modification.commit();
 157         try {
 158             RpcResult<TransactionStatus> result = commitFuture.get();
 159             TransactionStatus status = result.getResult();
 160         } catch (InterruptedException e) {
 161             logger.error(e.getMessage(), e);
 162         } catch (ExecutionException e) {
 163             logger.error(e.getMessage(), e);
 164         }
 165     }
 166
 167     private static MatchBuilder createLLDPMatch() {
 168         MatchBuilder match = new MatchBuilder();
 169         EthernetMatchBuilder eth = new EthernetMatchBuilder();
 170         EthernetTypeBuilder ethTypeBuilder = new EthernetTypeBuilder();
 171         ethTypeBuilder.setType(new EtherType(0x88CCL));
 172         eth.setEthernetType(ethTypeBuilder.build());
 173         match.setEthernetMatch(eth.build());
 174         return match;
 175     }
 176
 177     private InstructionsBuilder createSentToControllerInstructions() {
 178         List<Action> actionList = new ArrayList<Action>();
 179         ActionBuilder ab = new ActionBuilder();
 180
 181         OutputActionBuilder output = new OutputActionBuilder();
 182         output.setMaxLength(56);
 183         Uri value = new Uri("CONTROLLER");
 184         output.setOutputNodeConnector(value);
 185         ab.setAction(new OutputActionCaseBuilder().setOutputAction(output.build()).build());
 186         ab.setOrder(0);
 187         ab.setKey(new ActionKey(0));
 188         actionList.add(ab.build());
 189         // Create an Apply Action
 190         ApplyActionsBuilder aab = new ApplyActionsBuilder();
 191         aab.setAction(actionList);
 192
 193         // Wrap our Apply Action in an Instruction
 194         InstructionBuilder ib = new InstructionBuilder();
 195         ib.setInstruction(new ApplyActionsCaseBuilder().setApplyActions(aab.build()).build());
 196         ib.setOrder(0);
 197         ib.setKey(new InstructionKey(0));
 198
 199         // Put our Instruction in a list of Instructions
 200         InstructionsBuilder isb = new InstructionsBuilder();
 201         List<Instruction> instructions = new ArrayList<Instruction>();
 202         instructions.add(ib.build());
 203         isb.setInstruction(instructions);
 204         return isb;
 205     }
 206
 207     @Override
 208     public void initializeOFFlowRules(Node openflowNode) {
 209     }
 210
 211     private NodeBuilder createNodeBuilder(String nodeId) {
 212         NodeBuilder builder = new NodeBuilder();
 213         builder.setId(new NodeId(nodeId));
 214         builder.setKey(new NodeKey(builder.getId()));
 215         return builder;
 216     }
 217
 218     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> nodeBuilderToInstanceId(NodeBuilder node) {
 219         return InstanceIdentifier.builder(Nodes.class).child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node.class, node.getKey()).toInstance();
 220     }
 221 }