openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/factories/OF10StatsReplyMessageFactory.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.deserialization.factories;
  10
  11 import io.netty.buffer.ByteBuf;
  12
  13 import java.math.BigInteger;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16
  17 import org.opendaylight.openflowjava.protocol.impl.deserialization.OFDeserializer;
  18 import org.opendaylight.openflowjava.protocol.impl.util.ByteBufUtils;
  19 import org.opendaylight.openflowjava.protocol.impl.util.EncodeConstants;
  20 import org.opendaylight.openflowjava.protocol.impl.util.OF10ActionsDeserializer;
  21 import org.opendaylight.openflowjava.protocol.impl.util.OF10MatchDeserializer;
  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.protocol.rev130731.MultipartReplyMessage;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCase;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCaseBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCaseBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyExperimenterCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyExperimenterCaseBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCase;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCaseBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCase;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCase;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCase;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCaseBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.aggregate._case.MultipartReplyAggregateBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDescBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.experimenter._case.MultipartReplyExperimenterBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.MultipartReplyFlowBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStats;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStatsBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.MultipartReplyPortStatsBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStats;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStatsBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.MultipartReplyQueueBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStats;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStatsBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.MultipartReplyTableBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStats;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStatsBuilder;
  55
  56 /**
  57  * Translates StatsReply messages (OpenFlow v1.0)
  58  * @author michal.polkorab
  59  */
  60 public class OF10StatsReplyMessageFactory implements OFDeserializer<MultipartReplyMessage> {
  61
  62     private static final int DESC_STR_LEN = 256;
  63     private static final int SERIAL_NUM_LEN = 32;
  64     private static final byte PADDING_IN_FLOW_STATS_HEADER = 1;
  65     private static final byte PADDING_IN_FLOW_STATS_HEADER_02 = 6;
  66     private static final byte PADDING_IN_AGGREGATE_HEADER = 4;
  67     private static final byte PADDING_IN_TABLE_HEADER = 3;
  68     private static final byte MAX_TABLE_NAME_LENGTH = 32;
  69     private static final byte PADDING_IN_PORT_STATS_HEADER = 6;
  70     private static final byte PADDING_IN_QUEUE_HEADER = 2;
  71     private static final byte LENGTH_OF_FLOW_STATS = 88;
  72
  73     private static OF10StatsReplyMessageFactory instance;
  74
  75     private OF10StatsReplyMessageFactory() {
  76         // singleton
  77     }
  78
  79     /**
  80      * @return singleton factory
  81      */
  82     public static synchronized OF10StatsReplyMessageFactory getInstance() {
  83         if (instance == null){
  84             instance = new OF10StatsReplyMessageFactory();
  85         }
  86         return instance;
  87     }
  88
  89     @Override
  90     public MultipartReplyMessage bufferToMessage(ByteBuf rawMessage, short version) {
  91         MultipartReplyMessageBuilder builder = new MultipartReplyMessageBuilder();
  92         builder.setVersion(version);
  93         builder.setXid(rawMessage.readUnsignedInt());
  94         int type = rawMessage.readUnsignedShort();
  95         builder.setType(MultipartType.forValue(type));
  96         builder.setFlags(new MultipartRequestFlags((rawMessage.readUnsignedShort() & 0x01) != 0));
  97         switch (type) {
  98         case 0:  builder.setMultipartReplyBody(setDesc(rawMessage));
  99             break;
 100         case 1:  builder.setMultipartReplyBody(setFlow(rawMessage));
 101             break;
 102         case 2:  builder.setMultipartReplyBody(setAggregate(rawMessage));
 103             break;
 104         case 3:  builder.setMultipartReplyBody(setTable(rawMessage));
 105             break;
 106         case 4:  builder.setMultipartReplyBody(setPortStats(rawMessage));
 107             break;
 108         case 5:  builder.setMultipartReplyBody(setQueue(rawMessage));
 109             break;
 110         case 0xFFFF: builder.setMultipartReplyBody(setExperimenter(rawMessage));
 111             break;
 112         default:
 113             break;
 114         }
 115         return builder.build();
 116     }
 117
 118     private static MultipartReplyDescCase setDesc(ByteBuf input) {
 119         MultipartReplyDescCaseBuilder caseBuilder = new MultipartReplyDescCaseBuilder();
 120         MultipartReplyDescBuilder descBuilder = new MultipartReplyDescBuilder();
 121         byte[] mfrDescBytes = new byte[DESC_STR_LEN];
 122         input.readBytes(mfrDescBytes);
 123         String mfrDesc = new String(mfrDescBytes);
 124         descBuilder.setMfrDesc(mfrDesc.trim());
 125         byte[] hwDescBytes = new byte[DESC_STR_LEN];
 126         input.readBytes(hwDescBytes);
 127         String hwDesc = new String(hwDescBytes);
 128         descBuilder.setHwDesc(hwDesc.trim());
 129         byte[] swDescBytes = new byte[DESC_STR_LEN];
 130         input.readBytes(swDescBytes);
 131         String swDesc = new String(swDescBytes);
 132         descBuilder.setSwDesc(swDesc.trim());
 133         byte[] serialNumBytes = new byte[SERIAL_NUM_LEN];
 134         input.readBytes(serialNumBytes);
 135         String serialNum = new String(serialNumBytes);
 136         descBuilder.setSerialNum(serialNum.trim());
 137         byte[] dpDescBytes = new byte[DESC_STR_LEN];
 138         input.readBytes(dpDescBytes);
 139         String dpDesc = new String(dpDescBytes);
 140         descBuilder.setDpDesc(dpDesc.trim());
 141         caseBuilder.setMultipartReplyDesc(descBuilder.build());
 142         return caseBuilder.build();
 143     }
 144
 145     private static MultipartReplyFlowCase setFlow(ByteBuf input) {
 146         MultipartReplyFlowCaseBuilder caseBuilder = new MultipartReplyFlowCaseBuilder();
 147         MultipartReplyFlowBuilder flowBuilder = new MultipartReplyFlowBuilder();
 148         List<FlowStats> flowStatsList = new ArrayList<>();
 149         while (input.readableBytes() > 0) {
 150             FlowStatsBuilder flowStatsBuilder = new FlowStatsBuilder();
 151             int length = input.readUnsignedShort();
 152             flowStatsBuilder.setTableId(input.readUnsignedByte());
 153             input.skipBytes(PADDING_IN_FLOW_STATS_HEADER);
 154             flowStatsBuilder.setMatchV10(OF10MatchDeserializer.createMatchV10(input));
 155             flowStatsBuilder.setDurationSec(input.readUnsignedInt());
 156             flowStatsBuilder.setDurationNsec(input.readUnsignedInt());
 157             flowStatsBuilder.setPriority(input.readUnsignedShort());
 158             flowStatsBuilder.setIdleTimeout(input.readUnsignedShort());
 159             flowStatsBuilder.setHardTimeout(input.readUnsignedShort());
 160             input.skipBytes(PADDING_IN_FLOW_STATS_HEADER_02);
 161             byte[] cookie = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 162             input.readBytes(cookie);
 163             flowStatsBuilder.setCookie(new BigInteger(1, cookie));
 164             byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 165             input.readBytes(packetCount);
 166             flowStatsBuilder.setPacketCount(new BigInteger(1, packetCount));
 167             byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 168             input.readBytes(byteCount);
 169             flowStatsBuilder.setByteCount(new BigInteger(1, byteCount));
 170             flowStatsBuilder.setActionsList(OF10ActionsDeserializer
 171                     .createActionsList(input, length - LENGTH_OF_FLOW_STATS));
 172             flowStatsList.add(flowStatsBuilder.build());
 173         }
 174         flowBuilder.setFlowStats(flowStatsList);
 175         caseBuilder.setMultipartReplyFlow(flowBuilder.build());
 176         return caseBuilder.build();
 177     }
 178
 179     private static MultipartReplyAggregateCase setAggregate(ByteBuf input) {
 180         MultipartReplyAggregateCaseBuilder caseBuilder = new MultipartReplyAggregateCaseBuilder();
 181         MultipartReplyAggregateBuilder builder = new MultipartReplyAggregateBuilder();
 182         byte[] packetCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 183         input.readBytes(packetCount);
 184         builder.setPacketCount(new BigInteger(1, packetCount));
 185         byte[] byteCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 186         input.readBytes(byteCount);
 187         builder.setByteCount(new BigInteger(1, byteCount));
 188         builder.setFlowCount(input.readUnsignedInt());
 189         input.skipBytes(PADDING_IN_AGGREGATE_HEADER);
 190         caseBuilder.setMultipartReplyAggregate(builder.build());
 191         return caseBuilder.build();
 192     }
 193
 194     private static MultipartReplyTableCase setTable(ByteBuf input) {
 195         MultipartReplyTableCaseBuilder caseBuilder = new MultipartReplyTableCaseBuilder();
 196         MultipartReplyTableBuilder builder = new MultipartReplyTableBuilder();
 197         List<TableStats> tableStatsList = new ArrayList<>();
 198         while (input.readableBytes() > 0) {
 199             TableStatsBuilder tableStatsBuilder = new TableStatsBuilder();
 200             tableStatsBuilder.setTableId(input.readUnsignedByte());
 201             input.skipBytes(PADDING_IN_TABLE_HEADER);
 202             tableStatsBuilder.setName(ByteBufUtils.decodeNullTerminatedString(input, MAX_TABLE_NAME_LENGTH));
 203             long wildcards = input.readUnsignedInt();
 204             tableStatsBuilder.setWildcards(OF10MatchDeserializer.createWildcards(wildcards));
 205             tableStatsBuilder.setNwSrcMask(OF10MatchDeserializer.decodeNwSrcMask(wildcards));
 206             tableStatsBuilder.setNwDstMask(OF10MatchDeserializer.decodeNwDstMask(wildcards));
 207             tableStatsBuilder.setMaxEntries(input.readUnsignedInt());
 208             tableStatsBuilder.setActiveCount(input.readUnsignedInt());
 209             byte[] lookupCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 210             input.readBytes(lookupCount);
 211             tableStatsBuilder.setLookupCount(new BigInteger(1, lookupCount));
 212             byte[] matchedCount = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 213             input.readBytes(matchedCount);
 214             tableStatsBuilder.setMatchedCount(new BigInteger(1, matchedCount));
 215             tableStatsList.add(tableStatsBuilder.build());
 216         }
 217         builder.setTableStats(tableStatsList);
 218         caseBuilder.setMultipartReplyTable(builder.build());
 219         return caseBuilder.build();
 220     }
 221
 222     private static MultipartReplyPortStatsCase setPortStats(ByteBuf input) {
 223         MultipartReplyPortStatsCaseBuilder caseBuilder = new MultipartReplyPortStatsCaseBuilder();
 224         MultipartReplyPortStatsBuilder builder = new MultipartReplyPortStatsBuilder();
 225         List<PortStats> portStatsList = new ArrayList<>();
 226         while (input.readableBytes() > 0) {
 227             PortStatsBuilder portStatsBuilder = new PortStatsBuilder();
 228             portStatsBuilder.setPortNo((long) input.readUnsignedShort());
 229             input.skipBytes(PADDING_IN_PORT_STATS_HEADER);
 230             byte[] rxPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 231             input.readBytes(rxPackets);
 232             portStatsBuilder.setRxPackets(new BigInteger(1, rxPackets));
 233             byte[] txPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 234             input.readBytes(txPackets);
 235             portStatsBuilder.setTxPackets(new BigInteger(1, txPackets));
 236             byte[] rxBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 237             input.readBytes(rxBytes);
 238             portStatsBuilder.setRxBytes(new BigInteger(1, rxBytes));
 239             byte[] txBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 240             input.readBytes(txBytes);
 241             portStatsBuilder.setTxBytes(new BigInteger(1, txBytes));
 242             byte[] rxDropped = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 243             input.readBytes(rxDropped);
 244             portStatsBuilder.setRxDropped(new BigInteger(1, rxDropped));
 245             byte[] txDropped = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 246             input.readBytes(txDropped);
 247             portStatsBuilder.setTxDropped(new BigInteger(1, txDropped));
 248             byte[] rxErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 249             input.readBytes(rxErrors);
 250             portStatsBuilder.setRxErrors(new BigInteger(1, rxErrors));
 251             byte[] txErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 252             input.readBytes(txErrors);
 253             portStatsBuilder.setTxErrors(new BigInteger(1, txErrors));
 254             byte[] rxFrameErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 255             input.readBytes(rxFrameErr);
 256             portStatsBuilder.setRxFrameErr(new BigInteger(1, rxFrameErr));
 257             byte[] rxOverErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 258             input.readBytes(rxOverErr);
 259             portStatsBuilder.setRxOverErr(new BigInteger(1, rxOverErr));
 260             byte[] rxCrcErr = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 261             input.readBytes(rxCrcErr);
 262             portStatsBuilder.setRxCrcErr(new BigInteger(1, rxCrcErr));
 263             byte[] collisions = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 264             input.readBytes(collisions);
 265             portStatsBuilder.setCollisions(new BigInteger(1, collisions));
 266             portStatsList.add(portStatsBuilder.build());
 267         }
 268         builder.setPortStats(portStatsList);
 269         caseBuilder.setMultipartReplyPortStats(builder.build());
 270         return caseBuilder.build();
 271     }
 272
 273     private static MultipartReplyQueueCase setQueue(ByteBuf input) {
 274         MultipartReplyQueueCaseBuilder caseBuilder = new MultipartReplyQueueCaseBuilder();
 275         MultipartReplyQueueBuilder builder = new MultipartReplyQueueBuilder();
 276         List<QueueStats> queueStatsList = new ArrayList<>();
 277         while (input.readableBytes() > 0) {
 278             QueueStatsBuilder queueStatsBuilder = new QueueStatsBuilder();
 279             queueStatsBuilder.setPortNo((long) input.readUnsignedShort());
 280             input.skipBytes(PADDING_IN_QUEUE_HEADER);
 281             queueStatsBuilder.setQueueId(input.readUnsignedInt());
 282             byte[] txBytes = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 283             input.readBytes(txBytes);
 284             queueStatsBuilder.setTxBytes(new BigInteger(1, txBytes));
 285             byte[] txPackets = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 286             input.readBytes(txPackets);
 287             queueStatsBuilder.setTxPackets(new BigInteger(1, txPackets));
 288             byte[] txErrors = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 289             input.readBytes(txErrors);
 290             queueStatsBuilder.setTxErrors(new BigInteger(1, txErrors));
 291             queueStatsList.add(queueStatsBuilder.build());
 292         }
 293         builder.setQueueStats(queueStatsList);
 294         caseBuilder.setMultipartReplyQueue(builder.build());
 295         return caseBuilder.build();
 296     }
 297
 298     private static MultipartReplyExperimenterCase setExperimenter(ByteBuf input) {
 299         MultipartReplyExperimenterCaseBuilder caseBuilder = new MultipartReplyExperimenterCaseBuilder();
 300         MultipartReplyExperimenterBuilder builder = new MultipartReplyExperimenterBuilder();
 301         builder.setExperimenter(input.readUnsignedInt());
 302         byte[] data = new byte[EncodeConstants.SIZE_OF_LONG_IN_BYTES];
 303         input.readBytes(data);
 304         builder.setData(data);
 305         caseBuilder.setMultipartReplyExperimenter(builder.build());
 306         return caseBuilder.build();
 307     }
 308 }