openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/serialization/factories/OF10StatsRequestInputFactory.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.serialization.factories;
  10
  11 import io.netty.buffer.ByteBuf;
  12
  13 import java.util.HashMap;
  14 import java.util.Map;
  15
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
  18 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
  19 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  20 import org.opendaylight.openflowjava.protocol.impl.util.ByteBufUtils;
  21 import org.opendaylight.openflowjava.protocol.impl.util.EncodeConstants;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.v10.grouping.MatchV10;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.MultipartRequestBody;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortStatsCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestQueueCase;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableCase;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.aggregate._case.MultipartRequestAggregate;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.experimenter._case.MultipartRequestExperimenter;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlow;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.port.stats._case.MultipartRequestPortStats;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.queue._case.MultipartRequestQueue;
  39
  40 /**
  41  * Translates StatsRequest messages
  42  * @author michal.polkorab
  43  */
  44 public class OF10StatsRequestInputFactory implements OFSerializer<MultipartRequestInput>, SerializerRegistryInjector {
  45
  46     private static final byte MESSAGE_TYPE = 16;
  47     private static final byte FLOW_BODY_LENGTH = 44;
  48     private static final byte AGGREGATE_BODY_LENGTH = 44;
  49     private static final byte PORT_STATS_BODY_LENGTH = 8;
  50     private static final byte QUEUE_BODY_LENGTH = 8;
  51     private static final byte EXPERIMENTER_BODY_LENGTH = 4;
  52     private static final byte PADDING_IN_MULTIPART_REQUEST_FLOW_BODY = 1;
  53     private static final byte PADDING_IN_MULTIPART_REQUEST_AGGREGATE_BODY = 1;
  54     private static final byte PADDING_IN_MULTIPART_REQUEST_PORT_BODY = 6;
  55     private static final byte PADING_IN_QUEUE_BODY = 2;
  56
  57     private SerializerRegistry registry;
  58
  59     @Override
  60     public void serialize(MultipartRequestInput message, ByteBuf outBuffer) {
  61         ByteBufUtils.writeOFHeader(MESSAGE_TYPE, message, outBuffer, EncodeConstants.OFHEADER_SIZE);
  62         outBuffer.writeShort(message.getType().getIntValue());
  63         outBuffer.writeShort(createMultipartRequestFlagsBitmask(message.getFlags()));
  64         if (message.getMultipartRequestBody() instanceof MultipartRequestDescCase) {
  65             serializeDescBody(message.getMultipartRequestBody(), outBuffer);
  66         } else if (message.getMultipartRequestBody() instanceof MultipartRequestFlowCase) {
  67             serializeFlowBody(message.getMultipartRequestBody(), outBuffer);
  68         } else if (message.getMultipartRequestBody() instanceof MultipartRequestAggregateCase) {
  69             serializeAggregateBody(message.getMultipartRequestBody(), outBuffer);
  70         } else if (message.getMultipartRequestBody() instanceof MultipartRequestTableCase) {
  71             serializeTableBody(message.getMultipartRequestBody(), outBuffer);
  72         } else if (message.getMultipartRequestBody() instanceof MultipartRequestPortStatsCase) {
  73             serializePortBody(message.getMultipartRequestBody(), outBuffer);
  74         } else if (message.getMultipartRequestBody() instanceof MultipartRequestQueueCase) {
  75             serializeQueueBody(message.getMultipartRequestBody(), outBuffer);
  76         } else if (message.getMultipartRequestBody() instanceof MultipartRequestExperimenterCase) {
  77             serializeExperimenterBody(message.getMultipartRequestBody(), outBuffer);
  78         }
  79         ByteBufUtils.updateOFHeaderLength(outBuffer);
  80     }
  81
  82     /**
  83      *
  84      * @param message
  85      * @return length of MultipartRequestMessage
  86      */
  87     public int computeBodyLength(MultipartRequestInput message) {
  88         int length = 0;
  89         MultipartType type = message.getType();
  90         if (type.equals(MultipartType.OFPMPFLOW)) {
  91             length += FLOW_BODY_LENGTH;
  92         } else if (type.equals(MultipartType.OFPMPAGGREGATE)) {
  93             length += AGGREGATE_BODY_LENGTH;
  94         } else if (type.equals(MultipartType.OFPMPPORTSTATS)) {
  95             length += PORT_STATS_BODY_LENGTH;
  96         } else if (type.equals(MultipartType.OFPMPQUEUE)) {
  97             length += QUEUE_BODY_LENGTH;
  98         } else if (type.equals(MultipartType.OFPMPEXPERIMENTER)) {
  99             MultipartRequestExperimenterCase bodyCase = (MultipartRequestExperimenterCase) message.getMultipartRequestBody();
 100             MultipartRequestExperimenter body = bodyCase.getMultipartRequestExperimenter();
 101             length += EXPERIMENTER_BODY_LENGTH;
 102             if (body.getData() != null) {
 103                 length += body.getData().length;
 104             }
 105         }
 106         return length;
 107     }
 108
 109     private static int createMultipartRequestFlagsBitmask(MultipartRequestFlags flags) {
 110         int multipartRequestFlagsBitmask = 0;
 111         Map<Integer, Boolean> multipartRequestFlagsMap = new HashMap<>();
 112         multipartRequestFlagsMap.put(0, flags.isOFPMPFREQMORE());
 113         multipartRequestFlagsBitmask = ByteBufUtils.fillBitMaskFromMap(multipartRequestFlagsMap);
 114         return multipartRequestFlagsBitmask;
 115     }
 116
 117     /**
 118      * @param multipartRequestBody
 119      * @param output
 120      */
 121     private void serializeDescBody(MultipartRequestBody multipartRequestBody,
 122             ByteBuf output) {
 123         // The body of MultiPartRequestDesc is empty
 124     }
 125
 126     /**
 127      * @param multipartRequestBody
 128      * @param out
 129      */
 130     private void serializeTableBody(MultipartRequestBody multipartRequestBody,
 131             ByteBuf out) {
 132      // The body of MultiPartTable is empty
 133     }
 134
 135     private void serializeFlowBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
 136         MultipartRequestFlowCase flowCase = (MultipartRequestFlowCase) multipartRequestBody;
 137         MultipartRequestFlow flow = flowCase.getMultipartRequestFlow();
 138         OFSerializer<MatchV10> matchSerializer = registry.getSerializer(new MessageTypeKey<>(
 139                 EncodeConstants.OF10_VERSION_ID, MatchV10.class));
 140         matchSerializer.serialize(flow.getMatchV10(), output);
 141         output.writeByte(flow.getTableId().shortValue());
 142         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_FLOW_BODY, output);
 143         output.writeShort(flow.getOutPort().intValue());
 144     }
 145
 146     private void serializeAggregateBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
 147         MultipartRequestAggregateCase aggregateCase = (MultipartRequestAggregateCase) multipartRequestBody;
 148         MultipartRequestAggregate aggregate = aggregateCase.getMultipartRequestAggregate();
 149         OFSerializer<MatchV10> matchSerializer = registry.getSerializer(new MessageTypeKey<>(
 150                 EncodeConstants.OF10_VERSION_ID, MatchV10.class));
 151         matchSerializer.serialize(aggregate.getMatchV10(), output);
 152         output.writeByte(aggregate.getTableId().shortValue());
 153         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_AGGREGATE_BODY, output);
 154         output.writeShort(aggregate.getOutPort().intValue());
 155     }
 156
 157     private static void serializePortBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
 158         MultipartRequestPortStatsCase portstatsCase = (MultipartRequestPortStatsCase) multipartRequestBody;
 159         MultipartRequestPortStats portstats = portstatsCase.getMultipartRequestPortStats();
 160         output.writeShort(portstats.getPortNo().intValue());
 161         ByteBufUtils.padBuffer(PADDING_IN_MULTIPART_REQUEST_PORT_BODY, output);
 162     }
 163
 164     private static void serializeQueueBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
 165         MultipartRequestQueueCase queueCase = (MultipartRequestQueueCase) multipartRequestBody;
 166         MultipartRequestQueue queue = queueCase.getMultipartRequestQueue();
 167         output.writeShort(queue.getPortNo().intValue());
 168         ByteBufUtils.padBuffer(PADING_IN_QUEUE_BODY, output);
 169         output.writeInt(queue.getQueueId().intValue());
 170     }
 171
 172     private static void serializeExperimenterBody(MultipartRequestBody multipartRequestBody, ByteBuf output) {
 173         MultipartRequestExperimenterCase experimenterCase = (MultipartRequestExperimenterCase) multipartRequestBody;
 174         MultipartRequestExperimenter experimenter = experimenterCase.getMultipartRequestExperimenter();
 175         output.writeInt(experimenter.getExperimenter().intValue());
 176         output.writeBytes(experimenter.getData());
 177     }
 178
 179     @Override
 180     public void injectSerializerRegistry(SerializerRegistry serializerRegistry) {
 181         this.registry = serializerRegistry;
 182     }
 183
 184 }