openflowjava/openflow-protocol-impl/src/main/java/org/opendaylight/openflowjava/protocol/impl/deserialization/factories/QueueGetConfigReplyMessageFactory.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 package org.opendaylight.openflowjava.protocol.impl.deserialization.factories;
   9
  10 import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint16;
  11 import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint32;
  12
  13 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  14 import io.netty.buffer.ByteBuf;
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.Objects;
  18 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry;
  19 import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector;
  20 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  21 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  22 import org.opendaylight.openflowjava.util.ExperimenterDeserializerKeyFactory;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev150225.RateQueuePropertyBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.QueueId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.QueueProperties;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetQueueConfigOutputBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.get.config.reply.Queues;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.get.config.reply.QueuesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueuePropertyBuilder;
  33
  34 /**
  35  * Translates QueueGetConfigReply messages.
  36  *
  37  * @author timotej.kubas
  38  * @author michal.polkorab
  39  */
  40 @SuppressFBWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR") // FB doesn't recognize Objects.requireNonNull
  41 public class QueueGetConfigReplyMessageFactory implements OFDeserializer<GetQueueConfigOutput>,
  42         DeserializerRegistryInjector {
  43
  44     private static final byte PADDING_IN_QUEUE_GET_CONFIG_REPLY_HEADER = 4;
  45     private static final byte PADDING_IN_PACKET_QUEUE_HEADER = 6;
  46     private static final byte PADDING_IN_QUEUE_PROPERTY_HEADER = 4;
  47     private static final int PADDING_IN_RATE_QUEUE_PROPERTY = 6;
  48     private static final byte PACKET_QUEUE_LENGTH = 16;
  49     private DeserializerRegistry registry;
  50
  51     @Override
  52     public GetQueueConfigOutput deserialize(ByteBuf rawMessage) {
  53         Objects.requireNonNull(registry);
  54
  55         GetQueueConfigOutputBuilder builder = new GetQueueConfigOutputBuilder()
  56                 .setVersion(EncodeConstants.OF_VERSION_1_3)
  57                 .setXid(readUint32(rawMessage))
  58                 .setPort(new PortNumber(readUint32(rawMessage)));
  59         rawMessage.skipBytes(PADDING_IN_QUEUE_GET_CONFIG_REPLY_HEADER);
  60         builder.setQueues(createQueuesList(rawMessage));
  61         return builder.build();
  62     }
  63
  64     private List<Queues> createQueuesList(ByteBuf input) {
  65         List<Queues> queuesList = new ArrayList<>();
  66         while (input.readableBytes() > 0) {
  67             QueuesBuilder queueBuilder = new QueuesBuilder()
  68                     .setQueueId(new QueueId(readUint32(input)))
  69                     .setPort(new PortNumber(readUint32(input)));
  70             int length = input.readUnsignedShort();
  71             input.skipBytes(PADDING_IN_PACKET_QUEUE_HEADER);
  72             queueBuilder.setQueueProperty(createPropertiesList(input, length - PACKET_QUEUE_LENGTH));
  73             queuesList.add(queueBuilder.build());
  74         }
  75         return queuesList;
  76     }
  77
  78     private List<QueueProperty> createPropertiesList(ByteBuf input, int length) {
  79         int propertiesLength = length;
  80         List<QueueProperty> propertiesList = new ArrayList<>();
  81         while (propertiesLength > 0) {
  82             int propertyStartIndex = input.readerIndex();
  83             QueuePropertyBuilder propertiesBuilder = new QueuePropertyBuilder();
  84             QueueProperties property = QueueProperties.forValue(input.readUnsignedShort());
  85             propertiesBuilder.setProperty(property);
  86             int currentPropertyLength = input.readUnsignedShort();
  87             propertiesLength -= currentPropertyLength;
  88             input.skipBytes(PADDING_IN_QUEUE_PROPERTY_HEADER);
  89             if (property.equals(QueueProperties.OFPQTMINRATE) || property.equals(QueueProperties.OFPQTMAXRATE)) {
  90                 propertiesBuilder.addAugmentation(new RateQueuePropertyBuilder()
  91                     .setRate(readUint16(input))
  92                     .build());
  93                 input.skipBytes(PADDING_IN_RATE_QUEUE_PROPERTY);
  94             } else if (property.equals(QueueProperties.OFPQTEXPERIMENTER)) {
  95                 long expId = input.readUnsignedInt();
  96                 input.readerIndex(propertyStartIndex);
  97                 OFDeserializer<QueueProperty> deserializer = registry.getDeserializer(
  98                         ExperimenterDeserializerKeyFactory.createQueuePropertyDeserializerKey(
  99                                 EncodeConstants.OF13_VERSION_ID, expId));
 100                 propertiesList.add(deserializer.deserialize(input));
 101                 continue;
 102             }
 103             propertiesList.add(propertiesBuilder.build());
 104         }
 105         return propertiesList;
 106     }
 107
 108     @Override
 109     public void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry) {
 110         this.registry = deserializerRegistry;
 111     }
 112 }