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 java.math.BigInteger;
  11 import java.util.ArrayList;
  12 import java.util.List;
  13
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Instructions;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ClearActionsCaseBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.GoToTableCaseBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.MeterCaseBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteActionsCaseBuilder;
  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.meter.types.rev130918.MeterId;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstruction;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstruction;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstruction;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstruction;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.ActionsList;
  39
  40 public class OFToMDSalFlowConvertor {
  41
  42     /**
  43      * Method convert Openflow 1.3+ specific instructions to MD-SAL format
  44      * flow instruction
  45      * Note: MD-SAL won't augment this data directly to the data store,
  46      * so key setting is not required. If user wants to augment this data
  47      * directly to the data store, key setting is required for each instructions.
  48      * @param instructions
  49      * @return
  50      */
  51     public static Instructions toSALInstruction(
  52             List<org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.Instructions> instructions) {
  53
  54         InstructionsBuilder instructionsBuilder = new InstructionsBuilder();
  55
  56         List<Instruction> salInstructionList = new ArrayList<Instruction>();
  57
  58         for(org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.Instructions switchInst : instructions){
  59             if(switchInst instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ApplyActions){
  60
  61                 ActionsInstruction actionsInstruction = (ActionsInstruction)switchInst.getAugmentation(ActionsInstruction.class);
  62                 ApplyActionsCaseBuilder applyActionsCaseBuilder = new ApplyActionsCaseBuilder();
  63                 ApplyActionsBuilder applyActionsBuilder = new ApplyActionsBuilder();
  64
  65
  66                 applyActionsBuilder.setAction(
  67                             wrapActionList(
  68                                     ActionConvertor.toMDSalActions(actionsInstruction.getActionsList()
  69                                             )
  70                                             ));
  71
  72                 applyActionsCaseBuilder.setApplyActions(applyActionsBuilder.build());
  73
  74                 InstructionBuilder instBuilder = new InstructionBuilder();
  75                 instBuilder.setInstruction(applyActionsCaseBuilder.build());
  76                 salInstructionList.add(instBuilder.build());
  77             }else if(switchInst instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ClearActions){
  78                 InstructionBuilder instBuilder = new InstructionBuilder();
  79
  80                 ClearActionsCaseBuilder clearActionsCaseBuilder = new ClearActionsCaseBuilder();
  81                 ClearActionsBuilder clearActionsBuilder = new ClearActionsBuilder();
  82                 clearActionsCaseBuilder.setClearActions(clearActionsBuilder.build());
  83
  84                 instBuilder.setInstruction(clearActionsCaseBuilder.build());
  85                 salInstructionList.add(instBuilder.build());
  86             }else if(switchInst instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.GotoTable){
  87
  88                 TableIdInstruction tableIdInstruction = (TableIdInstruction)switchInst.getAugmentation(TableIdInstruction.class);
  89
  90                 GoToTableCaseBuilder goToTableCaseBuilder = new GoToTableCaseBuilder();
  91                 GoToTableBuilder goToTableBuilder = new GoToTableBuilder();
  92                 goToTableBuilder.setTableId(tableIdInstruction.getTableId());
  93                 goToTableCaseBuilder.setGoToTable(goToTableBuilder.build());
  94
  95                 InstructionBuilder instBuilder = new InstructionBuilder();
  96                 instBuilder.setInstruction(goToTableCaseBuilder.build());
  97                 salInstructionList.add(instBuilder.build());
  98             }else if(switchInst instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.Meter){
  99
 100                 MeterIdInstruction meterIdInstruction = (MeterIdInstruction) switchInst.getAugmentation(MeterIdInstruction.class);
 101
 102                 InstructionBuilder instBuilder = new InstructionBuilder();
 103
 104                 MeterCaseBuilder meterCaseBuilder = new MeterCaseBuilder();
 105                 MeterBuilder meterBuilder = new MeterBuilder();
 106                 meterBuilder.setMeterId(new MeterId(meterIdInstruction.getMeterId()));
 107                 meterCaseBuilder.setMeter(meterBuilder.build());
 108
 109                 instBuilder.setInstruction(meterCaseBuilder.build());
 110                 salInstructionList.add(instBuilder.build());
 111             }else if(switchInst instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteActions){
 112
 113                 ActionsInstruction actionsInstruction = (ActionsInstruction)switchInst.getAugmentation(ActionsInstruction.class);
 114
 115                 WriteActionsCaseBuilder writeActionsCaseBuilder = new WriteActionsCaseBuilder();
 116                 WriteActionsBuilder writeActionsBuilder = new WriteActionsBuilder();
 117                 writeActionsBuilder.setAction(wrapActionList(ActionConvertor.toMDSalActions(actionsInstruction.getActionsList())));
 118                 writeActionsCaseBuilder.setWriteActions(writeActionsBuilder.build());
 119
 120                 InstructionBuilder instBuilder = new InstructionBuilder();
 121                 instBuilder.setInstruction(writeActionsCaseBuilder.build());
 122                 salInstructionList.add(instBuilder.build());
 123
 124             }else if(switchInst instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteMetadata){
 125
 126                 MetadataInstruction metadataInstruction = (MetadataInstruction)switchInst.getAugmentation(MetadataInstruction.class);
 127
 128                 WriteMetadataCaseBuilder writeMetadataCaseBuilder = new WriteMetadataCaseBuilder();
 129                 WriteMetadataBuilder writeMetadataBuilder = new WriteMetadataBuilder();
 130                 writeMetadataBuilder.setMetadata(new BigInteger(1, metadataInstruction.getMetadata()));
 131                 writeMetadataBuilder.setMetadataMask(new BigInteger(1, metadataInstruction.getMetadataMask()));
 132                 writeMetadataCaseBuilder.setWriteMetadata(writeMetadataBuilder.build());
 133
 134                 InstructionBuilder instBuilder = new InstructionBuilder();
 135                 instBuilder.setInstruction(writeMetadataCaseBuilder.build());
 136                 salInstructionList.add(instBuilder.build());
 137             }
 138         }
 139         instructionsBuilder.setInstruction(salInstructionList);
 140         return instructionsBuilder.build();
 141     }
 142
 143     /*
 144      * Method wrapping all the actions org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action
 145      * in org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action, to set appropriate keys
 146      * for actions.
 147      */
 148     private static List<Action> wrapActionList(List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action> actionList){
 149         List<Action> actions = new ArrayList<>();
 150
 151         int actionKey = 0;
 152         for (org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action action : actionList){
 153             ActionBuilder wrappedAction = new ActionBuilder();
 154             wrappedAction.setAction(action);
 155             wrappedAction.setKey(new ActionKey(actionKey));
 156             wrappedAction.setOrder(actionKey);
 157             actions.add(wrappedAction.build());
 158             actionKey++;
 159         }
 160
 161         return actions;
 162     }
 163
 164     /**
 165      * Method wraps openflow 1.0 actions list to Apply Action Instructions
 166      */
 167
 168     public static Instructions wrapOF10ActionsToInstruction(List<ActionsList> actionsList) {
 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(
 177                     wrapActionList(
 178                                 ActionConvertor.toMDSalActions(actionsList
 179                                         )
 180                             ));
 181
 182         applyActionsCaseBuilder.setApplyActions(applyActionsBuilder.build());
 183
 184         InstructionBuilder instBuilder = new InstructionBuilder();
 185         instBuilder.setInstruction(applyActionsCaseBuilder.build());
 186         salInstructionList.add(instBuilder.build());
 187
 188         instructionsBuilder.setInstruction(salInstructionList);
 189         return instructionsBuilder.build();
 190     }
 191
 192 }