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