Java tutorial
/* * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.openflowjava.protocol.impl.util; import io.netty.buffer.ByteBuf; import java.util.ArrayList; import java.util.List; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstructionBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterInstruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterInstructionBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstructionBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstructionBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstructionBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ApplyActions; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ClearActions; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.Experimenter; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.GotoTable; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.Meter; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteActions; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteMetadata; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.InstructionBuilder; /** * Deserializes ofp_instruction (OpenFlow v1.3) structures * @author michal.polkorab * @author timotej.kubas */ public abstract class InstructionsDeserializer { private static final byte WRITE_APPLY_CLEAR_ACTION_LENGTH = 8; private static final byte EXPERIMENTER_HEADER_LENGTH = 8; private static final byte GOTO_TABLE_PADDING = 3; private static final byte WRITE_METADATA_PADDING = 4; private static final byte ACTIONS_RELATED_INSTRUCTION_PADDING = 4; /** * Creates list of instructions * @param input * @param length * @return list of ofp_instruction */ public static List<Instruction> createInstructions(ByteBuf input, int length) { List<Instruction> instructions = new ArrayList<>(); if (input.readableBytes() != 0) { int lengthOfInstructions = length; while (lengthOfInstructions > 0) { InstructionBuilder builder = new InstructionBuilder(); int type = input.readUnsignedShort(); int instructionLength = input.readUnsignedShort(); lengthOfInstructions -= instructionLength; switch (type) { case 1: createGotoTableInstruction(builder, input); break; case 2: createMetadataInstruction(builder, input); break; case 3: builder.setType(WriteActions.class); createActionRelatedInstruction(input, builder, instructionLength - WRITE_APPLY_CLEAR_ACTION_LENGTH); break; case 4: builder.setType(ApplyActions.class); createActionRelatedInstruction(input, builder, instructionLength - WRITE_APPLY_CLEAR_ACTION_LENGTH); break; case 5: builder.setType(ClearActions.class); createActionRelatedInstruction(input, builder, instructionLength - WRITE_APPLY_CLEAR_ACTION_LENGTH); break; case 6: builder.setType(Meter.class); MeterIdInstructionBuilder meterBuilder = new MeterIdInstructionBuilder(); meterBuilder.setMeterId(input.readUnsignedInt()); builder.addAugmentation(MeterIdInstruction.class, meterBuilder.build()); break; case 65535: builder.setType(Experimenter.class); ExperimenterInstructionBuilder expBuilder = new ExperimenterInstructionBuilder(); expBuilder.setExperimenter(input.readUnsignedInt()); int dataLength = instructionLength - EXPERIMENTER_HEADER_LENGTH; if (dataLength > 0) { byte[] data = new byte[dataLength]; input.readBytes(data); expBuilder.setData(data); } builder.addAugmentation(ExperimenterInstruction.class, expBuilder.build()); break; default: break; } instructions.add(builder.build()); } } return instructions; } /** * Creates instruction ids (instructions without values) * @param input * @param length * @return list of ofp_instruction without values */ public static List<Instruction> createInstructionIds(ByteBuf input, int length) { List<Instruction> instructions = new ArrayList<>(); if (input.readableBytes() != 0) { int lengthOfInstructions = length; while (lengthOfInstructions > 0) { InstructionBuilder builder = new InstructionBuilder(); int type = input.readUnsignedShort(); int instructionLength = input.readUnsignedShort(); lengthOfInstructions -= instructionLength; switch (type) { case 1: builder.setType(GotoTable.class); break; case 2: builder.setType(WriteMetadata.class); break; case 3: builder.setType(WriteActions.class); break; case 4: builder.setType(ApplyActions.class); break; case 5: builder.setType(ClearActions.class); break; case 6: builder.setType(Meter.class); break; case 65535: builder.setType(Experimenter.class); ExperimenterInstructionBuilder expBuilder = new ExperimenterInstructionBuilder(); expBuilder.setExperimenter(input.readUnsignedInt()); builder.addAugmentation(ExperimenterInstruction.class, expBuilder.build()); break; default: break; } instructions.add(builder.build()); } } return instructions; } private static void createGotoTableInstruction(InstructionBuilder builder, ByteBuf input) { builder.setType(GotoTable.class); TableIdInstructionBuilder tableBuilder = new TableIdInstructionBuilder(); tableBuilder.setTableId(input.readUnsignedByte()); builder.addAugmentation(TableIdInstruction.class, tableBuilder.build()); input.skipBytes(GOTO_TABLE_PADDING); } private static void createMetadataInstruction(InstructionBuilder builder, ByteBuf input) { input.skipBytes(WRITE_METADATA_PADDING); builder.setType(WriteMetadata.class); MetadataInstructionBuilder metadataBuilder = new MetadataInstructionBuilder(); byte[] metadata = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES]; input.readBytes(metadata); metadataBuilder.setMetadata(metadata); byte[] metadata_mask = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES]; input.readBytes(metadata_mask); metadataBuilder.setMetadataMask(metadata_mask); builder.addAugmentation(MetadataInstruction.class, metadataBuilder.build()); } private static void createActionRelatedInstruction(ByteBuf input, InstructionBuilder builder, int actionsLength) { input.skipBytes(ACTIONS_RELATED_INSTRUCTION_PADDING); ActionsInstructionBuilder actionsBuilder = new ActionsInstructionBuilder(); actionsBuilder.setAction(ActionsDeserializer.createActions(input, actionsLength)); builder.addAugmentation(ActionsInstruction.class, actionsBuilder.build()); } }