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