openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/OFToMDSalFlowConvertor.java

   1 /*
   2  * Copyright IBM Corporation, 2013.  All rights reserved.
   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 package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor;
   9
  10 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  11 import org.opendaylight.openflowplugin.extension.api.path.ActionPath;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Instructions;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ClearActionsCase;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ClearActionsCaseBuilder;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.GoToTableCaseBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.MeterCaseBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteActionsCaseBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCaseBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.clear.actions._case.ClearActionsBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.go.to.table._case.GoToTableBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.meter._case.MeterBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.actions._case.WriteActionsBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadataBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ApplyActionsCase;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.GotoTableCase;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.MeterCase;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteActionsCase;
  39 import java.math.BigInteger;
  40 import java.util.ArrayList;
  41 import java.util.List;
  42
  43 public final class OFToMDSalFlowConvertor {
  44
  45     private OFToMDSalFlowConvertor() {
  46         // hiding implicite constructor
  47     }
  48
  49     /**
  50      * Method convert Openflow 1.3+ specific instructions to MD-SAL format
  51      * flow instruction
  52      *
  53      * @param instructions
  54      * @param ofVersion    current ofp version
  55      * @return
  56      */
  57     public static Instructions toSALInstruction(
  58             List<org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction> instructions, OpenflowVersion ofVersion) {
  59
  60         InstructionsBuilder instructionsBuilder = new InstructionsBuilder();
  61
  62         List<Instruction> salInstructionList = new ArrayList<Instruction>();
  63         int instructionTreeNodekey = 0;
  64         org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.Instruction salInstruction;
  65         for (org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction switchInst : instructions) {
  66             if (switchInst.getInstructionChoice() instanceof ApplyActionsCase) {
  67
  68                 ApplyActionsCase actionsInstruction = ((ApplyActionsCase) switchInst.getInstructionChoice());
  69                 ApplyActionsCaseBuilder applyActionsCaseBuilder = new ApplyActionsCaseBuilder();
  70                 ApplyActionsBuilder applyActionsBuilder = new ApplyActionsBuilder();
  71
  72
  73                 applyActionsBuilder.setAction(wrapActionList(ActionConvertor.toMDSalActions(actionsInstruction.getApplyActions().getAction(), ofVersion, ActionPath.FLOWSSTATISTICSUPDATE_FLOWANDSTATISTICSMAPLIST_INSTRUCTIONS_INSTRUCTION_INSTRUCTION_APPLYACTIONSCASE_APPLYACTIONS_ACTION_ACTION)));
  74
  75                 applyActionsCaseBuilder.setApplyActions(applyActionsBuilder.build());
  76                 salInstruction = applyActionsCaseBuilder.build();
  77             } else if (switchInst.getInstructionChoice() instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ClearActionsCase) {
  78
  79                 org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ClearActionsCase clearActionsCase =
  80                         ((org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ClearActionsCase) switchInst.getInstructionChoice());
  81                 ClearActionsCaseBuilder clearActionsCaseBuilder = new ClearActionsCaseBuilder();
  82                 salInstruction = clearActionsCaseBuilder.build();
  83             } else if (switchInst.getInstructionChoice() instanceof GotoTableCase) {
  84
  85                 GotoTableCase gotoTableCase = ((GotoTableCase) switchInst.getInstructionChoice());
  86
  87                 GoToTableCaseBuilder goToTableCaseBuilder = new GoToTableCaseBuilder();
  88                 GoToTableBuilder goToTableBuilder = new GoToTableBuilder();
  89                 goToTableBuilder.setTableId(gotoTableCase.getGotoTable().getTableId());
  90                 goToTableCaseBuilder.setGoToTable(goToTableBuilder.build());
  91
  92                 salInstruction = goToTableCaseBuilder.build();
  93             } else if (switchInst.getInstructionChoice() instanceof MeterCase) {
  94
  95                 MeterCase meterIdInstruction = ((MeterCase) switchInst.getInstructionChoice());
  96
  97
  98                 MeterCaseBuilder meterCaseBuilder = new MeterCaseBuilder();
  99                 MeterBuilder meterBuilder = new MeterBuilder();
 100                 meterBuilder.setMeterId(new MeterId(meterIdInstruction.getMeter().getMeterId()));
 101                 meterCaseBuilder.setMeter(meterBuilder.build());
 102
 103                 salInstruction = meterCaseBuilder.build();
 104             } else if (switchInst.getInstructionChoice() instanceof WriteActionsCase) {
 105
 106                 WriteActionsCase writeActionsCase = ((WriteActionsCase) switchInst.getInstructionChoice());
 107
 108                 WriteActionsCaseBuilder writeActionsCaseBuilder = new WriteActionsCaseBuilder();
 109                 WriteActionsBuilder writeActionsBuilder = new WriteActionsBuilder();
 110                 writeActionsBuilder.setAction(wrapActionList(ActionConvertor.toMDSalActions(writeActionsCase.getWriteActions().getAction(), ofVersion, ActionPath.FLOWSSTATISTICSUPDATE_FLOWANDSTATISTICSMAPLIST_INSTRUCTIONS_INSTRUCTION_INSTRUCTION_WRITEACTIONSCASE_WRITEACTIONS_ACTION_ACTION)));
 111                 writeActionsCaseBuilder.setWriteActions(writeActionsBuilder.build());
 112
 113                 salInstruction = writeActionsCaseBuilder.build();
 114             } else if (switchInst.getInstructionChoice() instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCase) {
 115
 116                 org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCase writeMetadataCase =
 117                         ((org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCase) switchInst.getInstructionChoice());
 118                 WriteMetadataCaseBuilder writeMetadataCaseBuilder = new WriteMetadataCaseBuilder();
 119                 WriteMetadataBuilder writeMetadataBuilder = new WriteMetadataBuilder();
 120                 writeMetadataBuilder.setMetadata(new BigInteger(writeMetadataCase.getWriteMetadata().getMetadata()));
 121                 writeMetadataBuilder.setMetadataMask(new BigInteger(writeMetadataCase.getWriteMetadata().getMetadataMask()));
 122                 writeMetadataCaseBuilder.setWriteMetadata(writeMetadataBuilder.build());
 123                 salInstruction = writeMetadataCaseBuilder.build();
 124             } else {
 125                 continue;
 126             }
 127
 128             InstructionBuilder instBuilder = new InstructionBuilder();
 129             instBuilder.setInstruction(salInstruction);
 130             instBuilder.setKey(new InstructionKey(instructionTreeNodekey));
 131             instBuilder.setOrder(instructionTreeNodekey);
 132             instructionTreeNodekey++;
 133             salInstructionList.add(instBuilder.build());
 134
 135         }
 136         instructionsBuilder.setInstruction(salInstructionList);
 137         return instructionsBuilder.build();
 138     }
 139
 140     /*
 141      * Method wrapping all the actions org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action
 142      * in org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action, to set appropriate keys
 143      * for actions.
 144      */
 145     private static List<Action> wrapActionList(List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action> actionList) {
 146         List<Action> actions = new ArrayList<>();
 147
 148         int actionKey = 0;
 149         for (org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action action : actionList) {
 150             ActionBuilder wrappedAction = new ActionBuilder();
 151             wrappedAction.setAction(action);
 152             wrappedAction.setKey(new ActionKey(actionKey));
 153             wrappedAction.setOrder(actionKey);
 154             actions.add(wrappedAction.build());
 155             actionKey++;
 156         }
 157
 158         return actions;
 159     }
 160
 161     /**
 162      * Method wraps openflow 1.0 actions list to Apply Action Instructions
 163      *
 164      * @param ofVersion current ofp version
 165      */
 166
 167     public static Instructions wrapOF10ActionsToInstruction(
 168             List<org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action> actionsList, OpenflowVersion ofVersion) {
 169         InstructionsBuilder instructionsBuilder = new InstructionsBuilder();
 170
 171         List<Instruction> salInstructionList = new ArrayList<Instruction>();
 172
 173         ApplyActionsCaseBuilder applyActionsCaseBuilder = new ApplyActionsCaseBuilder();
 174         ApplyActionsBuilder applyActionsBuilder = new ApplyActionsBuilder();
 175
 176         applyActionsBuilder.setAction(wrapActionList(ActionConvertor.toMDSalActions(actionsList, ofVersion, ActionPath.FLOWSSTATISTICSUPDATE_FLOWANDSTATISTICSMAPLIST_INSTRUCTIONS_INSTRUCTION_INSTRUCTION_WRITEACTIONSCASE_WRITEACTIONS_ACTION_ACTION)));
 177
 178         applyActionsCaseBuilder.setApplyActions(applyActionsBuilder.build());
 179
 180         InstructionBuilder instBuilder = new InstructionBuilder();
 181         instBuilder.setInstruction(applyActionsCaseBuilder.build());
 182         instBuilder.setKey(new InstructionKey(0));
 183         instBuilder.setOrder(0);
 184         salInstructionList.add(instBuilder.build());
 185
 186         instructionsBuilder.setInstruction(salInstructionList);
 187         return instructionsBuilder.build();
 188     }
 189
 190 }