openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/util/InstructionsDeserializer.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. 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
   9 package org.opendaylight.openflowjava.protocol.impl.util;
  10
  11 import io.netty.buffer.ByteBuf;
  12
  13 import java.util.List;
  14
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderDeserializer;
  18 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageCodeKey;
  19 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstruction;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstructionBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterInstruction;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterInstructionBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstruction;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstructionBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstruction;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstructionBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstruction;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstructionBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.grouping.Action;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ApplyActions;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ClearActions;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.Experimenter;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.GotoTable;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.Meter;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteActions;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteMetadata;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.InstructionBuilder;
  40
  41 /**
  42  * Deserializes ofp_instruction (OpenFlow v1.3) structures
  43  * @author michal.polkorab
  44  * @author timotej.kubas
  45  */
  46 public class InstructionsDeserializer implements OFDeserializer<Instruction>,
  47         HeaderDeserializer<Instruction>, DeserializerRegistryInjector {
  48
  49     private static final byte WRITE_APPLY_CLEAR_ACTION_LENGTH = 8;
  50     private static final byte GOTO_TABLE_PADDING = 3;
  51     private static final byte WRITE_METADATA_PADDING = 4;
  52     private static final byte ACTIONS_RELATED_INSTRUCTION_PADDING = 4;
  53     private DeserializerRegistry registry;
  54
  55     @Override
  56     public Instruction deserialize(ByteBuf input) {
  57         InstructionBuilder builder = new InstructionBuilder();
  58         int type = input.readUnsignedShort();
  59         switch (type) {
  60         case 1:
  61             createGotoTableInstruction(builder, input);
  62             break;
  63         case 2:
  64             createMetadataInstruction(builder, input);
  65             break;
  66         case 3:
  67             builder.setType(WriteActions.class);
  68             createActionRelatedInstruction(input, builder);
  69             break;
  70         case 4:
  71             builder.setType(ApplyActions.class);
  72             createActionRelatedInstruction(input, builder);
  73             break;
  74         case 5:
  75             builder.setType(ClearActions.class);
  76             createActionRelatedInstruction(input, builder);
  77             break;
  78         case 6:
  79             builder.setType(Meter.class);
  80             input.skipBytes(EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
  81             MeterIdInstructionBuilder meterBuilder = new MeterIdInstructionBuilder();
  82             meterBuilder.setMeterId(input.readUnsignedInt());
  83             builder.addAugmentation(MeterIdInstruction.class, meterBuilder.build());
  84             break;
  85         case 65535:
  86             builder.setType(Experimenter.class);
  87             OFDeserializer<ExperimenterInstruction> deserializer = registry.getDeserializer(
  88                     new MessageCodeKey(EncodeConstants.OF13_VERSION_ID, type, ExperimenterInstruction.class));
  89             ExperimenterInstruction expInstruction = deserializer.deserialize(input);
  90             builder.addAugmentation(ExperimenterInstruction.class, expInstruction);
  91             break;
  92         default:
  93             break;
  94         }
  95         return builder.build();
  96     }
  97
  98     @Override
  99     public Instruction deserializeHeader(ByteBuf input) {
 100         InstructionBuilder builder = new InstructionBuilder();
 101         int type = input.readUnsignedShort();
 102         switch (type) {
 103         case 1:
 104             builder.setType(GotoTable.class);
 105             break;
 106         case 2:
 107             builder.setType(WriteMetadata.class);
 108             break;
 109         case 3:
 110             builder.setType(WriteActions.class);
 111             break;
 112         case 4:
 113             builder.setType(ApplyActions.class);
 114             break;
 115         case 5:
 116             builder.setType(ClearActions.class);
 117             break;
 118         case 6:
 119             builder.setType(Meter.class);
 120             break;
 121         case 65535:
 122             builder.setType(Experimenter.class);
 123             ExperimenterInstructionBuilder expBuilder = new ExperimenterInstructionBuilder();
 124             expBuilder.setExperimenter(input.readUnsignedInt());
 125             builder.addAugmentation(ExperimenterInstruction.class, expBuilder.build());
 126             break;
 127         default:
 128             break;
 129         }
 130         return builder.build();
 131     }
 132
 133     private static void createGotoTableInstruction(InstructionBuilder builder,
 134             ByteBuf input) {
 135         builder.setType(GotoTable.class);
 136         input.skipBytes(EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
 137         TableIdInstructionBuilder tableBuilder = new TableIdInstructionBuilder();
 138         tableBuilder.setTableId(input.readUnsignedByte());
 139         builder.addAugmentation(TableIdInstruction.class, tableBuilder.build());
 140         input.skipBytes(GOTO_TABLE_PADDING);
 141     }
 142
 143     private static void createMetadataInstruction(InstructionBuilder builder,
 144             ByteBuf input) {
 145         builder.setType(WriteMetadata.class);
 146         input.skipBytes(EncodeConstants.SIZE_OF_SHORT_IN_BYTES);
 147         input.skipBytes(WRITE_METADATA_PADDING);
 148         MetadataInstructionBuilder metadataBuilder = new MetadataInstructionBuilder();
 149         byte[] metadata = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 150         input.readBytes(metadata);
 151         metadataBuilder.setMetadata(metadata);
 152         byte[] metadata_mask = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 153         input.readBytes(metadata_mask);
 154         metadataBuilder.setMetadataMask(metadata_mask);
 155         builder.addAugmentation(MetadataInstruction.class, metadataBuilder.build());
 156     }
 157
 158     private void createActionRelatedInstruction(ByteBuf input, InstructionBuilder builder) {
 159         int instructionLength = input.readUnsignedShort();
 160         input.skipBytes(ACTIONS_RELATED_INSTRUCTION_PADDING);
 161         ActionsInstructionBuilder actionsBuilder = new ActionsInstructionBuilder();
 162         OFDeserializer<Action> deserializer = registry.getDeserializer(new MessageCodeKey(
 163                 EncodeConstants.OF13_VERSION_ID, EncodeConstants.EMPTY_VALUE, Action.class));
 164         List<Action> actions = DecodingUtils.deserializeList(
 165                 instructionLength - WRITE_APPLY_CLEAR_ACTION_LENGTH, input, deserializer);
 166         actionsBuilder.setAction(actions);
 167         builder.addAugmentation(ActionsInstruction.class, actionsBuilder.build());
 168     }
 169
 170     @Override
 171     public void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry) {
 172         registry = deserializerRegistry;
 173     }
 174 }