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 org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  16 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
  17 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  18 import org.opendaylight.openflowjava.util.ByteBufUtils;
  19 import org.opendaylight.openflowjava.util.ExperimenterSerializerKeyFactory;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterIdMultipartRequest;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.match.v10.grouping.MatchV10;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.MultipartRequestBody;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCase;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCase;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortStatsCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestQueueCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.aggregate._case.MultipartRequestAggregate;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.experimenter._case.MultipartRequestExperimenter;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlow;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.port.stats._case.MultipartRequestPortStats;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.queue._case.MultipartRequestQueue;
  37
  38 /**
  39  * Translates StatsRequest messages
  40  * @author michal.polkorab
  41  */
  42 public class OF10StatsRequestInputFactory implements OFSerializer<MultipartRequestInput>, SerializerRegistryInjector {
  43
  44     private static final byte MESSAGE_TYPE = 16;
  45     private static final byte PADDING_IN_MULTIPART_REQUEST_FLOW_BODY = 1;
  46     private static final byte PADDING_IN_MULTIPART_REQUEST_AGGREGATE_BODY = 1;
  47     private static final byte PADDING_IN_MULTIPART_REQUEST_PORT_BODY = 6;
  48     private static final byte PADING_IN_QUEUE_BODY = 2;
  49
  50     private SerializerRegistry registry;
  51
  52     @Override
  53     public void serialize(final MultipartRequestInput message, final ByteBuf outBuffer) {
  54         ByteBufUtils.writeOFHeader(MESSAGE_TYPE, message, outBuffer, EncodeConstants.OFHEADER_SIZE);
  55         outBuffer.writeShort(message.getType().getIntValue());
  56         outBuffer.writeShort(createMultipartRequestFlagsBitmask(message.getFlags()));
  57         if (message.getMultipartRequestBody() instanceof MultipartRequestDescCase) {
  58             serializeDescBody(message.getMultipartRequestBody(), outBuffer);
  59         } else if (message.getMultipartRequestBody() instanceof MultipartRequestFlowCase) {
  60             serializeFlowBody(message.getMultipartRequestBody(), outBuffer);
  61         } else if (message.getMultipartRequestBody() instanceof MultipartRequestAggregateCase) {
  62             serializeAggregateBody(message.getMultipartRequestBody(), outBuffer);
  63         } else if (message.getMultipartRequestBody() instanceof MultipartRequestTableCase) {
  64             serializeTableBody(message.getMultipartRequestBody(), outBuffer);
  65         } else if (message.getMultipartRequestBody() instanceof MultipartRequestPortStatsCase) {
  66             serializePortBody(message.getMultipartRequestBody(), outBuffer);
  67         } else if (message.getMultipartRequestBody() instanceof MultipartRequestQueueCase) {
  68             serializeQueueBody(message.getMultipartRequestBody(), outBuffer);
  69         } else if (message.getMultipartRequestBody() instanceof MultipartRequestExperimenterCase) {
  70             serializeExperimenterBody(message.getMultipartRequestBody(), outBuffer);
  71         }
  72         ByteBufUtils.updateOFHeaderLength(outBuffer);
  73     }
  74
  75     private static int createMultipartRequestFlagsBitmask(final MultipartRequestFlags flags) {
  76         return ByteBufUtils.fillBitMask(0, flags.isOFPMPFREQMORE());
  77     }
  78
  79     /**
  80      * @param multipartRequestBody
  81      * @param output
  82      */
  83     private void serializeDescBody(final MultipartRequestBody multipartRequestBody,
  84             final ByteBuf output) {
  85         // The body of MultiPartRequestDesc is empty
  86     }
  87
  88     /**
  89      * @param multipartRequestBody
  90      * @param out
  91      */
  92     private void serializeTableBody(final MultipartRequestBody multipartRequestBody,
  93             final ByteBuf out) {
  94      // The body of MultiPartTable is empty
  95     }
  96
  97     private void serializeFlowBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
  98         MultipartRequestFlowCase flowCase = (MultipartRequestFlowCase) multipartRequestBody;
  99         MultipartRequestFlow flow = flowCase.getMultipartRequestFlow();
 100         OFSerializer<MatchV10> matchSerializer = registry.getSerializer(new MessageTypeKey<>(
 101                 EncodeConstants.OF10_VERSION_ID, MatchV10.class));
 102         matchSerializer.serialize(flow.getMatchV10(), output);
 103         output.writeByte(flow.getTableId().shortValue());
 104         output.writeZero(PADDING_IN_MULTIPART_REQUEST_FLOW_BODY);
 105         output.writeShort(flow.getOutPort().intValue());
 106     }
 107
 108     private void serializeAggregateBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
 109         MultipartRequestAggregateCase aggregateCase = (MultipartRequestAggregateCase) multipartRequestBody;
 110         MultipartRequestAggregate aggregate = aggregateCase.getMultipartRequestAggregate();
 111         OFSerializer<MatchV10> matchSerializer = registry.getSerializer(new MessageTypeKey<>(
 112                 EncodeConstants.OF10_VERSION_ID, MatchV10.class));
 113         matchSerializer.serialize(aggregate.getMatchV10(), output);
 114         output.writeByte(aggregate.getTableId().shortValue());
 115         output.writeZero(PADDING_IN_MULTIPART_REQUEST_AGGREGATE_BODY);
 116         output.writeShort(aggregate.getOutPort().intValue());
 117     }
 118
 119     private static void serializePortBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
 120         MultipartRequestPortStatsCase portstatsCase = (MultipartRequestPortStatsCase) multipartRequestBody;
 121         MultipartRequestPortStats portstats = portstatsCase.getMultipartRequestPortStats();
 122         output.writeShort(portstats.getPortNo().intValue());
 123         output.writeZero(PADDING_IN_MULTIPART_REQUEST_PORT_BODY);
 124     }
 125
 126     private static void serializeQueueBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
 127         MultipartRequestQueueCase queueCase = (MultipartRequestQueueCase) multipartRequestBody;
 128         MultipartRequestQueue queue = queueCase.getMultipartRequestQueue();
 129         output.writeShort(queue.getPortNo().intValue());
 130         output.writeZero(PADING_IN_QUEUE_BODY);
 131         output.writeInt(queue.getQueueId().intValue());
 132     }
 133
 134     private void serializeExperimenterBody(final MultipartRequestBody multipartRequestBody, final ByteBuf output) {
 135         MultipartRequestExperimenterCase expCase = (MultipartRequestExperimenterCase) multipartRequestBody;
 136         MultipartRequestExperimenter experimenter = expCase.getMultipartRequestExperimenter();
 137         long expId = experimenter.getAugmentation(ExperimenterIdMultipartRequest.class).getExperimenter().getValue();
 138         OFSerializer<MultipartRequestExperimenterCase> serializer = registry.getSerializer(
 139                 ExperimenterSerializerKeyFactory.createMultipartRequestSerializerKey(
 140                         EncodeConstants.OF10_VERSION_ID, expId));
 141         serializer.serialize(expCase, output);
 142     }
 143
 144     @Override
 145     public void injectSerializerRegistry(final SerializerRegistry serializerRegistry) {
 146         this.registry = serializerRegistry;
 147     }
 148 }